From 6730344d9ac6e1b9c98a57f82ea441fefa652ed6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=C3=ABl=20DELSOL?= Date: Sun, 31 Jan 2021 16:29:21 +0100 Subject: [PATCH 1/4] init sources --- .docker/Dockerfile | 8 + .github/CODE_OF_CONDUCT.md | 46 + .github/CONTRIBUTING.md | 32 + .gitignore | 6 + .php_cs | 17 + .travis.yml | 34 + CHANGELOG.md | 4 + LICENSE | 19 + README.md | 46 + composer.json | 52 + docker-compose.yml | 10 + phpunit.xml.dist | 20 + src/AbstractDocument.php | 81 + src/Schema.php | 9 + src/Tag/AbstractTag.php | 97 + src/Tag/AbstractTagImport.php | 31 + src/Tag/AbstractTagOperationElement.php | 68 + src/Tag/AbstractTagType.php | 9 + src/Tag/Tag.php | 33 + src/Tag/TagAddress.php | 9 + src/Tag/TagAll.php | 9 + src/Tag/TagAnnotation.php | 9 + src/Tag/TagAny.php | 9 + src/Tag/TagAnyAttribute.php | 9 + src/Tag/TagAppinfo.php | 9 + src/Tag/TagAttribute.php | 17 + src/Tag/TagAttributeGroup.php | 39 + src/Tag/TagBinding.php | 9 + src/Tag/TagBody.php | 9 + src/Tag/TagChoice.php | 66 + src/Tag/TagComplexContent.php | 9 + src/Tag/TagComplexType.php | 9 + src/Tag/TagDefinitions.php | 9 + src/Tag/TagDocumentation.php | 47 + src/Tag/TagElement.php | 9 + src/Tag/TagEnumeration.php | 31 + src/Tag/TagExtension.php | 9 + src/Tag/TagField.php | 9 + src/Tag/TagGroup.php | 9 + src/Tag/TagHeader.php | 94 + src/Tag/TagImport.php | 9 + src/Tag/TagInclude.php | 9 + src/Tag/TagInput.php | 9 + src/Tag/TagKey.php | 9 + src/Tag/TagKeyref.php | 9 + src/Tag/TagList.php | 31 + src/Tag/TagMemberTypes.php | 9 + src/Tag/TagMessage.php | 15 + src/Tag/TagNotation.php | 9 + src/Tag/TagOperation.php | 9 + src/Tag/TagOutput.php | 9 + src/Tag/TagPart.php | 91 + src/Tag/TagPort.php | 9 + src/Tag/TagPortType.php | 9 + src/Tag/TagRedefine.php | 9 + src/Tag/TagRestriction.php | 39 + src/Tag/TagSchema.php | 9 + src/Tag/TagSelector.php | 9 + src/Tag/TagSequence.php | 9 + src/Tag/TagSimpleContent.php | 9 + src/Tag/TagSimpleType.php | 9 + src/Tag/TagTypes.php | 9 + src/Tag/TagUnion.php | 41 + src/Tag/TagUnique.php | 9 + src/Wsdl.php | 119 + tests/AbstractTestCase.php | 226 + tests/Document.php | 11 + tests/DocumentTest.php | 43 + tests/Tag/TagAttributeGroupTest.php | 247 + tests/Tag/TagAttributeTest.php | 30 + tests/Tag/TagChoiceTest.php | 313 + tests/Tag/TagDocumentationTest.php | 64 + tests/Tag/TagEnumerationTest.php | 60 + tests/Tag/TagHeaderTest.php | 230 + tests/Tag/TagImportTest.php | 30 + tests/Tag/TagListTest.php | 76 + tests/Tag/TagMessageTest.php | 23 + tests/Tag/TagRestrictionTest.php | 28 + tests/Tag/TagTest.php | 93 + tests/Tag/TagUnionTest.php | 121 + tests/WsdlTest.php | 144 + tests/resources/ActonService2.local.wsdl | 1055 + tests/resources/DeliveryService.wsdl | 2590 + tests/resources/OrderContract.wsdl | 1968 + .../VehicleSelectionService.wsdl | 692 + .../VehicleSelectionService_schema1.xsd | 3888 + .../VehicleSelectionService_schema2.xsd | 1023 + tests/resources/bingsearch.wsdl | 490 + tests/resources/ebaySvc.wsdl | 145483 +++++++++++++++ tests/resources/ews/messages.xsd | 5977 + tests/resources/ews/services.wsdl | 2776 + tests/resources/ews/types.xsd | 9122 + .../image/ImageViewService.local.wsdl | 166 + .../image/availableImagesRequest.xsd | 20 + .../image/availableImagesResponse.xsd | 28 + tests/resources/image/imageViewCommon.xsd | 56 + tests/resources/image/imagesRequest.xsd | 21 + tests/resources/image/imagesResponse.xsd | 32 + tests/resources/numeric_enumeration.xml | 12 + tests/resources/odigeo.wsdl | 241 + tests/resources/partner/PartnerService.0.xsd | 157 + tests/resources/partner/PartnerService.1.xsd | 42 + tests/resources/partner/PartnerService.10.xsd | 5 + tests/resources/partner/PartnerService.11.xsd | 4 + tests/resources/partner/PartnerService.12.xsd | 7 + tests/resources/partner/PartnerService.13.xsd | 7 + tests/resources/partner/PartnerService.14.xsd | 5 + tests/resources/partner/PartnerService.15.xsd | 5 + tests/resources/partner/PartnerService.16.xsd | 6 + tests/resources/partner/PartnerService.17.xsd | 21 + tests/resources/partner/PartnerService.18.xsd | 52 + tests/resources/partner/PartnerService.2.xsd | 9 + tests/resources/partner/PartnerService.3.xsd | 131 + tests/resources/partner/PartnerService.4.xsd | 6 + tests/resources/partner/PartnerService.5.xsd | 10 + tests/resources/partner/PartnerService.6.xsd | 6 + tests/resources/partner/PartnerService.7.xsd | 5 + tests/resources/partner/PartnerService.8.xsd | 9 + tests/resources/partner/PartnerService.9.xsd | 5 + .../partner/PartnerService.local.wsdl | 357 + tests/resources/whl.wsdl | 5459 + tests/resources/xmlmime.xml | 26 + 122 files changed, 185271 insertions(+) create mode 100644 .docker/Dockerfile create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .gitignore create mode 100644 .php_cs create mode 100644 .travis.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 docker-compose.yml create mode 100644 phpunit.xml.dist create mode 100644 src/AbstractDocument.php create mode 100644 src/Schema.php create mode 100644 src/Tag/AbstractTag.php create mode 100644 src/Tag/AbstractTagImport.php create mode 100644 src/Tag/AbstractTagOperationElement.php create mode 100644 src/Tag/AbstractTagType.php create mode 100644 src/Tag/Tag.php create mode 100644 src/Tag/TagAddress.php create mode 100644 src/Tag/TagAll.php create mode 100644 src/Tag/TagAnnotation.php create mode 100644 src/Tag/TagAny.php create mode 100644 src/Tag/TagAnyAttribute.php create mode 100644 src/Tag/TagAppinfo.php create mode 100644 src/Tag/TagAttribute.php create mode 100644 src/Tag/TagAttributeGroup.php create mode 100644 src/Tag/TagBinding.php create mode 100644 src/Tag/TagBody.php create mode 100644 src/Tag/TagChoice.php create mode 100644 src/Tag/TagComplexContent.php create mode 100644 src/Tag/TagComplexType.php create mode 100644 src/Tag/TagDefinitions.php create mode 100644 src/Tag/TagDocumentation.php create mode 100644 src/Tag/TagElement.php create mode 100644 src/Tag/TagEnumeration.php create mode 100644 src/Tag/TagExtension.php create mode 100644 src/Tag/TagField.php create mode 100644 src/Tag/TagGroup.php create mode 100644 src/Tag/TagHeader.php create mode 100644 src/Tag/TagImport.php create mode 100644 src/Tag/TagInclude.php create mode 100644 src/Tag/TagInput.php create mode 100644 src/Tag/TagKey.php create mode 100644 src/Tag/TagKeyref.php create mode 100644 src/Tag/TagList.php create mode 100644 src/Tag/TagMemberTypes.php create mode 100644 src/Tag/TagMessage.php create mode 100644 src/Tag/TagNotation.php create mode 100644 src/Tag/TagOperation.php create mode 100644 src/Tag/TagOutput.php create mode 100644 src/Tag/TagPart.php create mode 100644 src/Tag/TagPort.php create mode 100644 src/Tag/TagPortType.php create mode 100644 src/Tag/TagRedefine.php create mode 100644 src/Tag/TagRestriction.php create mode 100644 src/Tag/TagSchema.php create mode 100644 src/Tag/TagSelector.php create mode 100644 src/Tag/TagSequence.php create mode 100644 src/Tag/TagSimpleContent.php create mode 100644 src/Tag/TagSimpleType.php create mode 100644 src/Tag/TagTypes.php create mode 100644 src/Tag/TagUnion.php create mode 100644 src/Tag/TagUnique.php create mode 100644 src/Wsdl.php create mode 100644 tests/AbstractTestCase.php create mode 100644 tests/Document.php create mode 100644 tests/DocumentTest.php create mode 100644 tests/Tag/TagAttributeGroupTest.php create mode 100644 tests/Tag/TagAttributeTest.php create mode 100644 tests/Tag/TagChoiceTest.php create mode 100644 tests/Tag/TagDocumentationTest.php create mode 100644 tests/Tag/TagEnumerationTest.php create mode 100644 tests/Tag/TagHeaderTest.php create mode 100644 tests/Tag/TagImportTest.php create mode 100644 tests/Tag/TagListTest.php create mode 100644 tests/Tag/TagMessageTest.php create mode 100644 tests/Tag/TagRestrictionTest.php create mode 100644 tests/Tag/TagTest.php create mode 100644 tests/Tag/TagUnionTest.php create mode 100644 tests/WsdlTest.php create mode 100644 tests/resources/ActonService2.local.wsdl create mode 100644 tests/resources/DeliveryService.wsdl create mode 100644 tests/resources/OrderContract.wsdl create mode 100644 tests/resources/VehicleSelectionService/VehicleSelectionService.wsdl create mode 100644 tests/resources/VehicleSelectionService/VehicleSelectionService_schema1.xsd create mode 100644 tests/resources/VehicleSelectionService/VehicleSelectionService_schema2.xsd create mode 100644 tests/resources/bingsearch.wsdl create mode 100644 tests/resources/ebaySvc.wsdl create mode 100644 tests/resources/ews/messages.xsd create mode 100644 tests/resources/ews/services.wsdl create mode 100644 tests/resources/ews/types.xsd create mode 100644 tests/resources/image/ImageViewService.local.wsdl create mode 100644 tests/resources/image/availableImagesRequest.xsd create mode 100644 tests/resources/image/availableImagesResponse.xsd create mode 100644 tests/resources/image/imageViewCommon.xsd create mode 100644 tests/resources/image/imagesRequest.xsd create mode 100644 tests/resources/image/imagesResponse.xsd create mode 100644 tests/resources/numeric_enumeration.xml create mode 100644 tests/resources/odigeo.wsdl create mode 100644 tests/resources/partner/PartnerService.0.xsd create mode 100644 tests/resources/partner/PartnerService.1.xsd create mode 100644 tests/resources/partner/PartnerService.10.xsd create mode 100644 tests/resources/partner/PartnerService.11.xsd create mode 100644 tests/resources/partner/PartnerService.12.xsd create mode 100644 tests/resources/partner/PartnerService.13.xsd create mode 100644 tests/resources/partner/PartnerService.14.xsd create mode 100644 tests/resources/partner/PartnerService.15.xsd create mode 100644 tests/resources/partner/PartnerService.16.xsd create mode 100644 tests/resources/partner/PartnerService.17.xsd create mode 100644 tests/resources/partner/PartnerService.18.xsd create mode 100644 tests/resources/partner/PartnerService.2.xsd create mode 100644 tests/resources/partner/PartnerService.3.xsd create mode 100644 tests/resources/partner/PartnerService.4.xsd create mode 100644 tests/resources/partner/PartnerService.5.xsd create mode 100644 tests/resources/partner/PartnerService.6.xsd create mode 100644 tests/resources/partner/PartnerService.7.xsd create mode 100644 tests/resources/partner/PartnerService.8.xsd create mode 100644 tests/resources/partner/PartnerService.9.xsd create mode 100644 tests/resources/partner/PartnerService.local.wsdl create mode 100644 tests/resources/whl.wsdl create mode 100644 tests/resources/xmlmime.xml diff --git a/.docker/Dockerfile b/.docker/Dockerfile new file mode 100644 index 0000000..ab0f992 --- /dev/null +++ b/.docker/Dockerfile @@ -0,0 +1,8 @@ +FROM splitbrain/phpfarm:jessie + +RUN apt-get update && apt-get install -y git zip + +COPY --from=composer:latest /usr/bin/composer /usr/bin/composer +COPY . /var/www/ + +WORKDIR /var/www/ diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f565eec --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at contact@wsdltophp.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..32b1818 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via pull requests on [Github]. +Please make all pull requests to the `develop` branch, not the `master` branch. + +## Before posting an issue + +- If a command is failing, post the full output you get when running the command, with the `--verbose` argument + +## Pull Requests + +- **Create an issue** - Explain as detailed as possible the issue you encountered so we can understand the context of your pull request +- **[Symfony Coding Standard]** - The easiest way to apply the conventions is to run `composer lint` +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. +- **Create feature branches** - Don't ask us to pull from your master branch. +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. + +## Running Tests + +``` bash +$ composer test +``` + +**Happy coding**! + +[Github]: https://github.com/wsdltophp/domhandler +[Symfony Coding Standard]: http://symfony.com/doc/current/contributing/code/standards.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..841b5b6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +vendor +composer.lock +phpunit.xml +.idea +.phpunit.result.cache +coverage diff --git a/.php_cs b/.php_cs new file mode 100644 index 0000000..b96ef16 --- /dev/null +++ b/.php_cs @@ -0,0 +1,17 @@ +exclude('vendor') + ->in(__DIR__); + +return PhpCsFixer\Config::create() + ->setUsingCache(false) + ->setRules(array( + '@PSR2' => true, + 'binary_operator_spaces' => true, + 'no_whitespace_in_blank_line' => true, + 'ternary_operator_spaces' => true, + 'cast_spaces' => true, + 'trailing_comma_in_multiline_array' => true + )) + ->setFinder($finder); diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..636c2b6 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,34 @@ +language: php + +jobs: + include: + - name: 'Tests under PHP 7.4' + php: '7.4' + dist: bionic + - name: 'Tests under PHP 8.0' + php: '8.0' + dist: bionic + - name: 'Tests under PHP nightly' + php: 'nightly' + dist: bionic + + fast_finish: true + allow_failures: + - php: 'nightly' + +cache: + directories: + - $HOME/.composer/cache + +install: + - composer install + +script: + - php -dmemory_limit=-1 -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover + +after_script: + - wget https://scrutinizer-ci.com/ocular.phar + - php -dmemory_limit=-1 ocular.phar code-coverage:upload --format=php-clover coverage.clover + +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a65c233 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# CHANGELOG + +## 1.0.0 - 2021/01/29 +- Initial release after exporting source code from the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..086355c --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2021 Mikaël DELSOL + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a81f94 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# WSDL Handler + +> WSDL Handler provides handful methods to manipulate/browse a WSDL and its schemas. + +[![License](https://poser.pugx.org/wsdltophp/wsdlhandler/license)](https://packagist.org/packages/wsdltophp/wsdlhandler) +[![Latest Stable Version](https://poser.pugx.org/wsdltophp/wsdlhandler/version.png)](https://packagist.org/packages/wsdltophp/wsdlhandler) +[![Build Status](https://travis-ci.com/WsdlToPhp/WsdlHandler.svg)](https://travis-ci.com/github/WsdlToPhp/WsdlHandler) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/badges/quality-score.png)](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/) +[![Code Coverage](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/badges/coverage.png)](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/) +[![Total Downloads](https://poser.pugx.org/wsdltophp/wsdlhandler/downloads)](https://packagist.org/packages/wsdltophp/wsdlhandler) +[![StyleCI](https://styleci.io/repos/87977980/shield)](https://styleci.io/repos/87977980) +[![SensioLabsInsight](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30/mini.png)](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30) + +WsdlHandler uses the [decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) upon [WsdlHandler](https://github.com/WsdlToPhp/WsdlHandler). + +The source code has been originally created into the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project but it felt that it had the possibility to live by itself and to evolve independtly from the PackageGenerator project if necessary. + +## Testing using [Docker](https://www.docker.com/) +Thanks to the [Docker image](https://hub.docker.com/r/splitbrain/phpfarm) of [phpfarm](https://github.com/fpoirotte/phpfarm), tests can be run locally under *any* PHP version using the cli: +- php-7.4 + +First of all, you need to create your container which you can do using [docker-compose](https://docs.docker.com/compose/) by running the below command line from the root directory of the project: +```bash +$ docker-compose up -d --build +``` + +You then have a container named `wsdl_handler` in which you can run `composer` commands and `php cli` commands such as: +```bash +# install deps in container (using update ensure it does use the composer.lock file if there is any) +$ docker exec -it wsdl_handler php-7.4 /usr/bin/composer update +# run tests in container +$ docker exec -it wsdl_handler php-7.4 -dmemory_limit=-1 vendor/bin/phpunit +``` + +## Contributing + +Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. + +## FAQ + +Feel free to [create an issue](https://github.com/WsdlToPhp/WsdlHandler/issues/new). + +## License + +The MIT License (MIT). Please see [License File](LICENSE) for more information. + diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..8ac68c1 --- /dev/null +++ b/composer.json @@ -0,0 +1,52 @@ +{ + "name": "wsdltophp/wsdlhandler", + "type": "library", + "description": "Decorative design pattern to ease WSDL handling", + "keywords": [ + "xml", + "dom", + "xpath", + "php", + "wsdl", + "xsd" + ], + "homepage": "https://github.com/WsdlToPhp/WsdlHandler", + "license": "MIT", + "authors": [ + { + "name": "Mikaël DELSOL", + "email": "contact@wsdltophp.com", + "homepage": "https://www.wsdltophp.com", + "role": "Owner" + } + ], + "require": { + "php": ">=7.4", + "ext-dom": "*", + "wsdltophp/domhandler": "~2.0" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "~2.0", + "phpunit/phpunit": "^9" + }, + "config": { + "sort-packages": true + }, + "autoload": { + "psr-4": { + "WsdlToPhp\\WsdlHandler\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "WsdlToPhp\\WsdlHandler\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "lint": "vendor/bin/php-cs-fixer fix --ansi --diff --verbose" + }, + "support": { + "email": "contact@wsdltophp.com" + } +} diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..7d972cf --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,10 @@ +version: '3.4' + +services: + php: + build: + context: . + dockerfile: .docker/Dockerfile + volumes: + - .:/var/www:rw + container_name: wsdl_handler diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..af75cfb --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,20 @@ + + + + + ./ + + + ./tests + ./vendor + + + + + + + + ./tests + + + diff --git a/src/AbstractDocument.php b/src/AbstractDocument.php new file mode 100644 index 0000000..590f6ca --- /dev/null +++ b/src/AbstractDocument.php @@ -0,0 +1,81 @@ +nodeName), -1, 1)))))) { + $handlerName = $elementNameClass; + } + + return new $handlerName($element, $domDocument, $index); + } + + public function getNamespaceUri(string $namespace): string + { + $rootElement = $this->getRootElement(); + $uri = ''; + if ($rootElement instanceof ElementHandler && $rootElement->hasAttribute(sprintf('xmlns:%s', $namespace))) { + $uri = $rootElement->getAttribute(sprintf('xmlns:%s', $namespace))->getValue(); + } + + return $uri; + } +} diff --git a/src/Schema.php b/src/Schema.php new file mode 100644 index 0000000..d4c100f --- /dev/null +++ b/src/Schema.php @@ -0,0 +1,9 @@ +getParent() instanceof AbstractNodeHandler) { + $parentTags = $strict ? $additionalTags : $this->getSuitableParentTags($additionalTags); + $parentNode = $this->getParent()->getNode(); + while ($maxDeep-- > 0 && ($parentNode instanceof DOMElement) && !empty($parentNode->nodeName) && (!preg_match('/' . implode('|', $parentTags) . '/i', $parentNode->nodeName) || ($checkName && preg_match('/' . implode('|', $parentTags) . '/i', $parentNode->nodeName) && (!$parentNode->hasAttribute('name') || $parentNode->getAttribute('name') === '')))) { + $parentNode = $parentNode->parentNode; + } + if ($parentNode instanceof DOMElement) { + $parentNode = $this->getDomDocumentHandler()->getHandler($parentNode); + } else { + $parentNode = null; + } + } + + return $parentNode; + } + + protected function getSuitableParentTags(array $additionalTags = []): array + { + return array_merge([ + AbstractDocument::TAG_ELEMENT, + AbstractDocument::TAG_ATTRIBUTE, + AbstractDocument::TAG_SIMPLE_TYPE, + AbstractDocument::TAG_COMPLEX_TYPE, + ], $additionalTags); + } + + protected function getStrictParent(string $name, bool $checkName = false): ?AbstractNodeHandler + { + $parent = $this->getSuitableParent($checkName, [ + $name, + ], self::MAX_DEEP, true); + + if ($parent instanceof AbstractNodeHandler && $parent->getName() === $name) { + return $parent; + } + + return null; + } + + public function hasAttributeName(): bool + { + return $this->hasAttribute(Attribute::ATTRIBUTE_NAME); + } + + public function hasAttributeRef(): bool + { + return $this->hasAttribute(Attribute::ATTRIBUTE_REF); + } + + public function getAttributeName(): string + { + return $this->getAttribute(Attribute::ATTRIBUTE_NAME) instanceof Attribute ? $this->getAttribute(Attribute::ATTRIBUTE_NAME)->getValue() : ''; + } + + public function getAttributeRef(): string + { + return $this->getAttribute(Attribute::ATTRIBUTE_REF) instanceof Attribute ? $this->getAttribute(Attribute::ATTRIBUTE_REF)->getValue() : ''; + } + + public function hasAttributeValue(): bool + { + return $this->hasAttribute(Attribute::ATTRIBUTE_VALUE); + } + + public function getValueAttributeValue(bool $withNamespace = false, bool $withinItsType = true, ?string $asType = null) + { + return $this->getAttribute(Attribute::ATTRIBUTE_VALUE) instanceof Attribute ? $this->getAttribute(Attribute::ATTRIBUTE_VALUE)->getValue($withNamespace, $withinItsType, $asType) : ''; + } +} diff --git a/src/Tag/AbstractTagImport.php b/src/Tag/AbstractTagImport.php new file mode 100644 index 0000000..de8a3dd --- /dev/null +++ b/src/Tag/AbstractTagImport.php @@ -0,0 +1,31 @@ +hasAttribute(self::ATTRIBUTE_LOCATION)) { + $location = $this->getAttributeValue(self::ATTRIBUTE_LOCATION, true); + } elseif ($this->hasAttribute(self::ATTRIBUTE_SCHEMA_LOCATION)) { + $location = $this->getAttributeValue(self::ATTRIBUTE_SCHEMA_LOCATION, true); + } elseif ($this->hasAttribute(self::ATTRIBUTE_SCHEMA_LOCATION_)) { + $location = $this->getAttributeValue(self::ATTRIBUTE_SCHEMA_LOCATION_, true); + } + + if (!empty($location) && mb_substr($location, 0, 2) === './') { + $location = mb_substr($location, 2); + } + + return $location; + } +} diff --git a/src/Tag/AbstractTagOperationElement.php b/src/Tag/AbstractTagOperationElement.php new file mode 100644 index 0000000..9c25152 --- /dev/null +++ b/src/Tag/AbstractTagOperationElement.php @@ -0,0 +1,68 @@ +getStrictParent(AbstractDocument::TAG_OPERATION); + } + + public function hasAttributeMessage(): bool + { + return $this->hasAttribute(self::ATTRIBUTE_MESSAGE); + } + + public function getAttributeMessage(): string + { + return $this->hasAttributeMessage() ? $this->getAttribute(self::ATTRIBUTE_MESSAGE)->getValue() : ''; + } + + public function getAttributeMessageNamespace(): string + { + return $this->hasAttribute(self::ATTRIBUTE_MESSAGE) ? $this->getAttribute(self::ATTRIBUTE_MESSAGE)->getValueNamespace() : ''; + } + + public function getMessage(): ?TagMessage + { + $message = null; + $messageName = $this->getAttributeMessage(); + + if (!empty($messageName)) { + $message = $this->getDomDocumentHandler()->getElementByNameAndAttributes('message', [ + 'name' => $messageName, + ], true); + } + + return $message; + } + + public function getParts(): ?array + { + $parts = null; + $message = $this->getMessage(); + if ($message instanceof TagMessage) { + $parts = $message->getChildrenByName(AbstractDocument::TAG_PART); + } + + return $parts; + } + + public function getPart(string $partName): ?TagPart + { + $part = null; + $message = $this->getMessage(); + if ($message instanceof TagMessage && !empty($partName)) { + $part = $message->getPart($partName); + } + + return $part; + } +} diff --git a/src/Tag/AbstractTagType.php b/src/Tag/AbstractTagType.php new file mode 100644 index 0000000..4b58cb2 --- /dev/null +++ b/src/Tag/AbstractTagType.php @@ -0,0 +1,9 @@ +getFirstRestrictionChild() instanceof Restriction; + } + + public function getFirstRestrictionChild(): ?TagRestriction + { + return $this->getChildByNameAndAttributes(AbstractDocument::TAG_RESTRICTION, []); + } + + /** + * Checks if the given tag is the same direct parent of this current tag + * @param AbstractTag $tag + * @return bool + */ + public function isTheParent(AbstractTag $tag): bool + { + $parent = $this->getSuitableParent(); + + return $parent ? $parent->getNode()->isSameNode($tag->getNode()) : false; + } +} diff --git a/src/Tag/TagAddress.php b/src/Tag/TagAddress.php new file mode 100644 index 0000000..8b2087e --- /dev/null +++ b/src/Tag/TagAddress.php @@ -0,0 +1,9 @@ +getDomDocumentHandler()->getElementsByNameAndAttributes('attributeGroup', [ + 'ref' => sprintf('*:%s', $this->getAttributeName()), + ]); + /** + * In case of a referencing element that use this attributeGroup that is not namespaced, + * use the non namespaced value + */ + if (empty($attributeGroups)) { + $attributeGroups = $this->getDomDocumentHandler()->getElementsByNameAndAttributes('attributeGroup', [ + 'ref' => sprintf('*%s', $this->getAttributeName()), + ]); + } + foreach ($attributeGroups as $attributeGroup) { + $parent = $attributeGroup->getSuitableParent(); + /** + * In this case, this means the attribute is included in another attribute group, + * this means we must climb to its parent recursively until we find the elements referencing the top attributeGroup tag + */ + if ($parent instanceof TagAttributeGroup) { + $elements = array_merge($elements, $parent->getReferencingElements()); + } elseif ($parent instanceof AbstractTag) { + $elements[] = $parent; + } + } + + return $elements; + } +} diff --git a/src/Tag/TagBinding.php b/src/Tag/TagBinding.php new file mode 100644 index 0000000..baade8d --- /dev/null +++ b/src/Tag/TagBinding.php @@ -0,0 +1,9 @@ +getFilteredChildrenByName($tagName)); + } + + return $children; + } + + protected function getFilteredChildrenByName(string $tagName): array + { + return array_filter($this->getChildrenByName($tagName), [ + $this, + 'filterFoundChildren', + ]); + } + + /** + * This must ensure the current element, based on its tagName is not contained by another element than the choice. + * If it is contained by another element, then it is child/property of its parent element and does not belong to the choice elements + * @param AbstractTag $child + * @return bool + */ + protected function filterFoundChildren(AbstractTag $child): bool + { + $forbiddenParentTags = self::getForbiddenParentTags(); + $valid = true; + while ($child && $child->getParent() && !$this->getNode()->isSameNode($child->getParent()->getNode())) { + $valid = $valid && !in_array($child->getParent()->getName(), $forbiddenParentTags); + $child = $child->getParent(); + } + + return (bool) $valid; + } + + public static function getChildrenElementsTags(): array + { + return [ + AbstractDocument::TAG_ELEMENT, + AbstractDocument::TAG_GROUP, + AbstractDocument::TAG_CHOICE, + AbstractDocument::TAG_ANY, + ]; + } + + public static function getForbiddenParentTags(): array + { + return [ + AbstractDocument::TAG_COMPLEX_TYPE, + ]; + } +} diff --git a/src/Tag/TagComplexContent.php b/src/Tag/TagComplexContent.php new file mode 100644 index 0000000..0273eee --- /dev/null +++ b/src/Tag/TagComplexContent.php @@ -0,0 +1,9 @@ +getNodeValue(); + } + + /** + * Finds parent node of this documentation node without taking care of the name attribute for enumeration. + * This case is managed first because enumerations are contained by elements and + * the method could climb to its parent without stopping on the enumeration tag. + * Indeed, depending on the node, it may contain or not the attribute named "name" so we have to split each case. + * @param bool $checkName + * @param array $additionalTags + * @param int $maxDeep + * @param bool $strict + * @return AbstractNodeHandler|null + */ + public function getSuitableParent(bool $checkName = true, array $additionalTags = [], int $maxDeep = self::MAX_DEEP, bool $strict = false): ?AbstractNodeHandler + { + if (!$strict) { + $enumerationTag = $this->getStrictParent(AbstractDocument::TAG_ENUMERATION); + if ($enumerationTag instanceof TagEnumeration) { + return $enumerationTag; + } + } + + return parent::getSuitableParent($checkName, $additionalTags, $maxDeep, $strict); + } + + public function getSuitableParentTags(array $additionalTags = []): array + { + return parent::getSuitableParentTags(array_merge($additionalTags, [ + AbstractDocument::TAG_OPERATION, + AbstractDocument::TAG_ATTRIBUTE_GROUP, + ])); + } +} diff --git a/src/Tag/TagElement.php b/src/Tag/TagElement.php new file mode 100644 index 0000000..3900e21 --- /dev/null +++ b/src/Tag/TagElement.php @@ -0,0 +1,9 @@ +getValueAttributeValue(true); + } + + public function getRestrictionParent(): ?TagRestriction + { + return $this->getStrictParent(AbstractDocument::TAG_RESTRICTION); + } + + public function getRestrictionParentType(): string + { + /** @var TagRestriction|null $restrictionParent */ + $restrictionParent = $this->getRestrictionParent(); + + return $restrictionParent ? $restrictionParent->getAttributeBase() : ''; + } +} diff --git a/src/Tag/TagExtension.php b/src/Tag/TagExtension.php new file mode 100644 index 0000000..fd4537c --- /dev/null +++ b/src/Tag/TagExtension.php @@ -0,0 +1,9 @@ +getStrictParent(AbstractDocument::TAG_INPUT); + } + + public function getAttributeRequired(): bool + { + return $this->hasAttribute(self::ATTRIBUTE_REQUIRED) ? $this->getAttribute(self::ATTRIBUTE_REQUIRED)->getValue(true, true, 'bool') : true; + } + + public function getAttributeNamespace(): string + { + return $this->hasAttribute(Attribute::ATTRIBUTE_NAMESPACE) ? $this->getAttribute(Attribute::ATTRIBUTE_NAMESPACE)->getValue() : ''; + } + + public function getAttributePart(): string + { + return $this->hasAttribute(self::ATTRIBUTE_PART) ? $this->getAttribute(self::ATTRIBUTE_PART)->getValue() : ''; + } + + public function getPartTag(): ?TagPart + { + return $this->getPart($this->getAttributePart()); + } + + public function getHeaderType(): string + { + $part = $this->getPartTag(); + return $part instanceof TagPart ? $part->getFinalType() : ''; + } + + public function getHeaderName(): string + { + $part = $this->getPartTag(); + + return $part instanceof TagPart ? $part->getFinalName() : ''; + } + + public function getHeaderNamespace(): string + { + $namespace = $this->getHeaderNamespaceFromPart(); + if (empty($namespace)) { + $namespace = $this->getHeaderNamespaceFromMessage(); + } + + return $namespace; + } + + protected function getHeaderNamespaceFromPart(): string + { + $part = $this->getPartTag(); + $namespace = ''; + if ($part instanceof TagPart) { + $finalNamespace = $part->getFinalNamespace(); + if (!empty($finalNamespace)) { + $namespace = $this->getDomDocumentHandler()->getNamespaceUri($finalNamespace); + } + } + + return $namespace; + } + + protected function getHeaderNamespaceFromMessage(): string + { + $namespace = ''; + $messageNamespace = $this->getAttributeMessageNamespace(); + if (!empty($messageNamespace)) { + $namespace = $this->getDomDocumentHandler()->getNamespaceUri($messageNamespace); + } + + return $namespace; + } + + public function getHeaderRequired(): string + { + return $this->getAttributeRequired() ? self::REQUIRED_HEADER : self::OPTIONAL_HEADER; + } +} diff --git a/src/Tag/TagImport.php b/src/Tag/TagImport.php new file mode 100644 index 0000000..4024758 --- /dev/null +++ b/src/Tag/TagImport.php @@ -0,0 +1,9 @@ +hasAttribute(self::ATTRIBUTE_ITEM_TYPE) ? $this->getAttribute(self::ATTRIBUTE_ITEM_TYPE)->getValue() : ''; + } + + public function getItemType(): string + { + $itemType = $this->getAttributeItemType(); + // this means this is its simpleType's restriction child element that defines its type + if (empty($itemType)) { + $child = $this->getChildByNameAndAttributes(AbstractDocument::TAG_RESTRICTION, []); + if ($child instanceof TagRestriction && $child->hasAttributeBase()) { + $itemType = $child->getAttributeBase(); + } + } + + return $itemType; + } +} diff --git a/src/Tag/TagMemberTypes.php b/src/Tag/TagMemberTypes.php new file mode 100644 index 0000000..8446b7c --- /dev/null +++ b/src/Tag/TagMemberTypes.php @@ -0,0 +1,9 @@ +getChildByNameAndAttributes('part', [ + 'name' => $name, + ]); + } +} diff --git a/src/Tag/TagNotation.php b/src/Tag/TagNotation.php new file mode 100644 index 0000000..ee2c4e6 --- /dev/null +++ b/src/Tag/TagNotation.php @@ -0,0 +1,9 @@ +getAttributeMixedValue(self::ATTRIBUTE_ELEMENT, $returnValue); + } + + /** + * @param bool $returnValue + * @return AttributeHandler|string|int|null + */ + public function getAttributeType(bool $returnValue = true) + { + return $this->getAttributeMixedValue(self::ATTRIBUTE_TYPE, $returnValue); + } + + /** + * @param string $attributeName + * @param bool $returnValue + * @return AttributeHandler|string|int|null + */ + protected function getAttributeMixedValue(string $attributeName, bool $returnValue = true) + { + $value = $this->getAttribute($attributeName); + if ($returnValue) { + $value = $value instanceof AttributeHandler ? $value->getValue() : null; + } + + return $value; + } + + public function getFinalType(): string + { + $type = $this->getAttributeType(); + if (empty($type)) { + $elementName = $this->getAttributeElement(); + if (!empty($elementName)) { + $element = $this->getDomDocumentHandler()->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => $elementName, + ], true); + if ($element instanceof TagElement && $element->hasAttribute(self::ATTRIBUTE_TYPE)) { + $type = $element->getAttribute(self::ATTRIBUTE_TYPE)->getValue(); + } else { + $type = $elementName; + } + } + } + return $type; + } + + public function getFinalName(): string + { + $name = $this->getAttributeType(); + if (empty($name)) { + $name = $this->getAttributeElement(); + } + + return $name; + } + + public function getFinalNamespace(): ?string + { + $attribute = $this->getAttributeType(false); + if (!empty($attribute)) { + return $attribute->getValueNamespace(); + } + + $attribute = $this->getAttributeElement(false); + if (!empty($attribute)) { + return $attribute->getValueNamespace(); + } + + return null; + } +} diff --git a/src/Tag/TagPort.php b/src/Tag/TagPort.php new file mode 100644 index 0000000..c325c16 --- /dev/null +++ b/src/Tag/TagPort.php @@ -0,0 +1,9 @@ +getEnumerations()); + } + + public function getEnumerations(): array + { + return $this->getChildrenByName(AbstractDocument::TAG_ENUMERATION); + } + + public function getAttributeBase(): string + { + return $this->hasAttributeBase() ? $this->getAttribute(self::ATTRIBUTE_BASE)->getValue() : ''; + } + + public function hasAttributeBase(): bool + { + return $this->hasAttribute(self::ATTRIBUTE_BASE); + } + + public function hasUnionParent(): bool + { + return $this->getSuitableParent(false, [ + AbstractDocument::TAG_UNION, + ], self::MAX_DEEP, true) instanceof TagUnion; + } +} diff --git a/src/Tag/TagSchema.php b/src/Tag/TagSchema.php new file mode 100644 index 0000000..f985a7a --- /dev/null +++ b/src/Tag/TagSchema.php @@ -0,0 +1,9 @@ +parseMemberTypes(); + } + + public function hasMemberTypesAsChildren(): bool + { + return 0 < count($this->getMemberTypesChildren()); + } + + public function getMemberTypesChildren(): array + { + return $this->getChildrenByName(AbstractDocument::TAG_SIMPLE_TYPE); + } + + protected function parseMemberTypes(): array + { + $memberTypes = []; + $value = $this->hasAttribute(self::ATTRIBUTE_MEMBER_TYPES) ? $this->getAttribute(self::ATTRIBUTE_MEMBER_TYPES)->getValue(true) : ''; + if (!empty($value)) { + $values = explode(' ', $value); + foreach ($values as $val) { + $memberTypes[] = implode('', array_slice(explode(':', $val), -1, 1)); + } + } + + return $memberTypes; + } +} diff --git a/src/Tag/TagUnique.php b/src/Tag/TagUnique.php new file mode 100644 index 0000000..e7a425d --- /dev/null +++ b/src/Tag/TagUnique.php @@ -0,0 +1,9 @@ +externalSchemas[] = $schema; + + return $this; + } + + public function getExternalSchemas(): array + { + return $this->externalSchemas; + } + + public function getElementByName(string $name, bool $includeExternals = false): ?AbstractTag + { + return $this->useParentMethodAndExternals(__FUNCTION__, [ + $name, + ], $includeExternals, true); + } + + public function getElementByNameAndAttributes(string $name, array $attributes, bool $includeExternals = false): ?AbstractTag + { + return $this->useParentMethodAndExternals(__FUNCTION__, [ + $name, + $attributes, + ], $includeExternals, true); + } + + public function getElementsByName(string $name, bool $includeExternals = false): array + { + return $this->useParentMethodAndExternals(__FUNCTION__, [ + $name, + ], $includeExternals); + } + + public function getElementsByNameAndAttributes(string $name, array $attributes, ?DOMNode $node = null, bool $includeExternals = false): array + { + if ($includeExternals) { + $elements = $this->useParentMethodAndExternals(__FUNCTION__, [ + $name, + $attributes, + $node, + ]); + /** @var Schema $externalSchema */ + foreach ($this->getExternalSchemas() as $index => $externalSchema) { + $nodes = $externalSchema->searchTagsByXpath($name, $attributes, $node); + if (!empty($nodes)) { + $elements = array_merge($elements, $this->getElementsHandlers($nodes)); + break; + } + } + } else { + $elements = $this->useParentMethodAndExternals(__FUNCTION__, [ + $name, + $attributes, + $node, + ], $includeExternals); + } + + return $elements; + } + + /** + * Handles any method that exist within the parent class, + * in addition it handles the case when we want to use the external schemas to search in + * @param string $method + * @param array $parameters + * @param bool $includeExternals + * @param bool $returnOne + * @return mixed + */ + protected function useParentMethodAndExternals(string $method, array $parameters, bool $includeExternals = false, bool $returnOne = false) + { + $result = call_user_func_array([ + $this, + sprintf('parent::%s', $method), + ], $parameters); + + if ($includeExternals && (!$returnOne || empty($result))) { + $result = $this->useExternalSchemas($method, $parameters, $result, $returnOne); + } + + return $result; + } + + protected function useExternalSchemas(string $method, array $parameters, $parentResult, bool $returnOne = false) + { + $result = $parentResult; + + foreach ($this->getExternalSchemas() as $externalSchema) { + $externalResult = call_user_func_array([ + $externalSchema, + $method, + ], $parameters); + + if ($returnOne && !is_null($externalResult)) { + $result = $externalResult; + break; + } elseif (is_array($externalResult) && !empty($externalResult)) { + $result = array_merge($result, $externalResult); + } + } + + return $result; + } +} diff --git a/tests/AbstractTestCase.php b/tests/AbstractTestCase.php new file mode 100644 index 0000000..e108f55 --- /dev/null +++ b/tests/AbstractTestCase.php @@ -0,0 +1,226 @@ +getExternalSchemas())) { + $wsdl + ->addExternalSchema(self::getSchema(self::getPath('image/availableImagesRequest.xsd'))) + ->addExternalSchema(self::getSchema(self::getPath('image/availableImagesResponse.xsd'))) + ->addExternalSchema(self::getSchema(self::getPath('image/imagesRequest.xsd'))) + ->addExternalSchema(self::getSchema(self::getPath('image/imagesResponse.xsd'))) + ->addExternalSchema(self::getSchema(self::getPath('image/imageViewCommon.xsd'))); + } + + return $wsdl; + } + + public static function wsdlEbayPath(): string + { + return self::getPath('ebaySvc.wsdl'); + } + + public static function wsdlEbayInstance(): Wsdl + { + return self::getWsdl(self::wsdlEbayPath()); + } + + public static function wsdlOrderContractPath(): string + { + return self::getPath('OrderContract.wsdl'); + } + + public static function wsdlOrderContractInstance(): Wsdl + { + return self::getWsdl(self::wsdlOrderContractPath()); + } + + public static function wsdlOdigeoPath(): string + { + return self::getPath('odigeo.wsdl'); + } + + public static function wsdlOdigeoInstance(): Wsdl + { + return self::getWsdl(self::wsdlOdigeoPath()); + } + + public static function wsdlActonPath(): string + { + return self::getPath('ActonService2.local.wsdl'); + } + + public static function wsdlActonInstance(bool $addExternalSchemas = true): Wsdl + { + $wsdl = self::getWsdl(self::wsdlActonPath(), $addExternalSchemas); + + if ($addExternalSchemas && 0 == count($wsdl->getExternalSchemas())) { + $wsdl->addExternalSchema(self::getSchema(self::getPath('xmlmime.xml'))); + } + + return $wsdl; + } + + public static function wsdlPartnerPath(): string + { + return self::getPath('partner/PartnerService.local.wsdl'); + } + + public static function wsdlPartnerInstance(bool $addExternalSchemas = true): Wsdl + { + $wsdl = self::getWsdl(self::wsdlPartnerPath(), $addExternalSchemas); + + if ($addExternalSchemas && 0 == count($wsdl->getExternalSchemas())) { + for ($i = 0;$i < 19;$i++) { + $wsdl->addExternalSchema(self::getSchema(self::getPath(sprintf('partner/PartnerService.%s.xsd', $i)))); + } + } + + return $wsdl; + } + + public static function schemaNumericEnumerationPath(): string + { + return self::getPath('numeric_enumeration.xml'); + } + + public static function schemaNumericEnumerationInstance(): Schema + { + return self::getSchema(self::schemaNumericEnumerationPath()); + } + + public static function wsdlDeliveryServicePath(): string + { + return self::getPath('DeliveryService.wsdl'); + } + + public static function wsdlDeliveryServiceInstance(): Wsdl + { + return self::getWsdl(self::wsdlDeliveryServicePath()); + } + + public static function wsdlWhlPath(): string + { + return self::getPath('whl.wsdl'); + } + + public static function wsdlWhlInstance(): Wsdl + { + return self::getWsdl(self::wsdlWhlPath()); + } + + public static function wsdlBingPath(): string + { + return self::getPath('bingsearch.wsdl'); + } + + public static function wsdlBingInstance(): Wsdl + { + return self::getWsdl(self::wsdlBingPath()); + } + + public static function wsdlVehicleSelectionServicePath(): string + { + return self::getPath('VehicleSelectionService/VehicleSelectionService.wsdl'); + } + + public static function schemaVehicleSelectionServiceSchema1Path(): string + { + return self::getPath('VehicleSelectionService/VehicleSelectionService_schema1.xsd'); + } + + public static function schemaVehicleSelectionServiceSchema1Instance(): Schema + { + return self::getSchema(self::schemaVehicleSelectionServiceSchema1Path()); + } + + public static function schemaVehicleSelectionServiceSchema2Path(): string + { + return self::getPath('VehicleSelectionService/VehicleSelectionService_schema2.xsd'); + } + + public static function schemaVehicleSelectionServiceSchema2Instance(): Schema + { + return self::getSchema(self::schemaVehicleSelectionServiceSchema2Path()); + } + + public static function wsdlVehicleSelectionServiceInstance(bool $addExternalSchemas = true): Wsdl + { + $wsdl = self::getWsdl(self::wsdlVehicleSelectionServicePath(), $addExternalSchemas); + + if ($addExternalSchemas && 0 == count($wsdl->getExternalSchemas())) { + $wsdl + ->addExternalSchema(self::schemaVehicleSelectionServiceSchema1Instance()) + ->addExternalSchema(self::schemaVehicleSelectionServiceSchema2Instance()); + } + + return $wsdl; + } + + public static function schemaEwsMessagesPath(): string + { + return self::getPath('ews/messages.xsd'); + } + + public static function schemaEwsMessagesInstance(): Schema + { + return self::getSchema(self::schemaEwsMessagesPath()); + } + + public static function schemaEwsTypesPath(): string + { + return self::getPath('ews/types.xsd'); + } + + public static function schemaEwsTypesInstance(): Schema + { + return self::getSchema(self::schemaEwsTypesPath()); + } + + public static function getWsdl(string $wsdlPath, bool $addExternalSchemas = true): Wsdl + { + $wsdlKey = sprintf('%s_%s', $wsdlPath, ((int) $addExternalSchemas)); + if (!array_key_exists($wsdlKey, self::$instances)) { + $doc = new DOMDocument('1.0', 'utf-8'); + $doc->load($wsdlPath); + self::$instances[$wsdlKey] = new Wsdl($doc); + } + + return self::$instances[$wsdlKey]; + } + + public static function getSchema(string $schemaPath): Schema + { + if (!array_key_exists($schemaPath, self::$instances)) { + $doc = new DOMDocument('1.0', 'utf-8'); + $doc->load($schemaPath); + self::$instances[$schemaPath] = new Schema($doc); + } + + return self::$instances[$schemaPath]; + } + + public static function getPath(string $name): string + { + return sprintf('%s/%s/%s', __DIR__, 'resources', $name); + } +} diff --git a/tests/Document.php b/tests/Document.php new file mode 100644 index 0000000..660e64f --- /dev/null +++ b/tests/Document.php @@ -0,0 +1,11 @@ +load(self::wsdlBingPath()); + $bing = new Document($dom); + + $this->assertInstanceOf(TagComplexType::class, $bing->getElementByName(Wsdl::TAG_COMPLEX_TYPE)); + } + + public function testGetRootElement() + { + ($dom = new DOMDocument())->load(self::wsdlBingPath()); + $bing = new Document($dom); + + $this->assertSame('definitions', $bing->getRootElement()->getName()); + $this->assertInstanceOf(TagDefinitions::class, $bing->getRootElement()); + } + + public function testGetNamespaceUri() + { + ($dom = new DOMDocument())->load(self::wsdlBingPath()); + $bing = new Document($dom); + + $this->assertSame('http://www.w3.org/2001/XMLSchema-instance', $bing->getNamespaceUri('xsi')); + $this->assertSame('http://schemas.xmlsoap.org/wsdl/soap/', $bing->getNamespaceUri('soap')); + $this->assertSame('http://schemas.xmlsoap.org/wsdl/', $bing->getNamespaceUri('wsdl')); + $this->assertSame('http://schemas.xmlsoap.org/ws/2004/08/addressing', $bing->getNamespaceUri('wsa')); + $this->assertSame('http://schemas.microsoft.com/LiveSearch/2008/03/Search', $bing->getNamespaceUri('tns')); + $this->assertSame('http://www.w3.org/2001/XMLSchema', $bing->getNamespaceUri('xsd')); + } +} diff --git a/tests/Tag/TagAttributeGroupTest.php b/tests/Tag/TagAttributeGroupTest.php new file mode 100644 index 0000000..5532024 --- /dev/null +++ b/tests/Tag/TagAttributeGroupTest.php @@ -0,0 +1,247 @@ +getElementsByName(AbstractDocument::TAG_ATTRIBUTE_GROUP); + $attributeRefs = [ + 'PrimaryLangID_Group', + 'ID_Group', + 'CurrencyAmountGroup', + 'CurrencyCodeGroup', + 'PrivacyGroup', + 'TelephoneAttributesGroup', + 'FormattedInd', + 'TelephoneGroup', + 'DefaultIndGroup', + 'LanguageGroup', + 'ErrorWarningAttributeGroup', + 'ErrorWarningAttributeGroup', + 'CompanyID_AttributesGroup', + 'UniqueID_Group', + 'OTA_PayloadStdAttributes', + 'BookingChannelGroup', + 'ID_OptionalGroup', + 'CurrencyAmountGroup', + 'FeeTaxGroup', + 'IssuerNameGroup', + 'TelephoneInfoGroup', + 'PrivacyGroup', + 'PaymentCardDateGroup', + 'FormattedInd', + 'PrivacyGroup', + 'PrivacyGroup', + 'DefaultIndGroup', + 'PrivacyGroup', + 'TelephoneInfoGroup', + 'PrivacyGroup', + 'DefaultIndGroup', + 'FeeTaxGroup', + 'ChargeUnitGroup', + 'PrivacyGroup', + 'PrivacyGroup', + 'DefaultIndGroup', + 'MultimediaDescriptionGroup', + 'ID_OptionalGroup', + 'MultimediaItemGroup', + 'ID_OptionalGroup', + 'MultimediaDescriptionGroup', + 'MultimediaDescriptionGroup', + 'DateTimeSpanGroup', + 'CurrencyCodeGroup', + 'TelephoneInfoGroup', + 'CitizenCountryNameGroup', + 'GenderGroup', + 'BirthDateGroup', + 'CurrencyCodeGroup', + 'ProfileTypeGroup', + 'DateTimeSpanGroup', + 'RatePlanGroup', + 'InventoryGroup', + 'CodeInfoGroup', + 'CodeInfoGroup', + 'CodeInfoGroup', + 'PositionGroup', + 'DeadlineGroup', + 'CurrencyAmountGroup', + 'CurrencyCodeGroup', + 'ID_OptionalGroup', + 'CodeInfoGroup', + 'GenderGroup', + 'ID_OptionalGroup', + 'ID_OptionalGroup', + 'TelephoneInfoGroup', + 'ID_OptionalGroup', + 'ID_OptionalGroup', + 'ID_OptionalGroup', + 'ID_OptionalGroup', + 'PositionGroup', + 'ID_OptionalGroup', + 'RoomGroup', + 'CodeInfoGroup', + 'ID_OptionalGroup', + 'ID_OptionalGroup', + 'ID_Group', + 'GuestCountGroup', + 'HotelReferenceGroup', + 'ID_Group', + 'CurrencyCodeGroup', + 'HotelReferenceGroup', + 'StatusApplicationGroup', + 'RestrictionStatusGroup', + 'OTA_PayloadStdAttributes', + 'RoomGroup', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'HotelReferenceGroup', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'OTA_PayloadStdAttributes', + 'HotelReferenceGroup', + 'OTA_PayloadStdAttributes', + ]; + + $indexRef = 0; + foreach ($attributeGroups as $attributeGroup) { + if ($attributeGroup->getAttributeRef() !== '') { + $this->assertSame($attributeRefs[$indexRef++], $attributeGroup->getAttributeRef()); + } + } + } + + public function testGetAttributeNameMustReturnNameAttributeValueFromAttributeGroup() + { + $wsdl = self::wsdlWhlInstance(); + $attributeGroups = $wsdl->getElementsByName(AbstractDocument::TAG_ATTRIBUTE_GROUP); + $attributeNames = [ + 'ErrorWarningAttributeGroup', + 'LanguageGroup', + 'PrimaryLangID_Group', + 'OTA_PayloadStdAttributes', + 'CompanyID_AttributesGroup', + 'UniqueID_Group', + 'ID_Group', + 'PositionGroup', + 'BookingChannelGroup', + 'NameOptionalCodeGroup', + 'CodeInfoGroup', + 'DeadlineGroup', + 'FeeTaxGroup', + 'CurrencyAmountGroup', + 'CurrencyCodeGroup', + 'IssuerNameGroup', + 'FormattedInd', + 'PrivacyGroup', + 'TelephoneAttributesGroup', + 'TelephoneGroup', + 'TelephoneInfoGroup', + 'DefaultIndGroup', + 'PaymentCardDateGroup', + 'GenderGroup', + 'MultimediaItemGroup', + 'MultimediaDescriptionGroup', + 'RoomGroup', + 'ID_OptionalGroup', + 'ChargeUnitGroup', + 'DateTimeSpanGroup', + 'GuestCountGroup', + 'BirthDateGroup', + 'ProfileTypeGroup', + 'CitizenCountryNameGroup', + 'HotelReferenceGroup', + 'RestrictionStatusGroup', + 'InventoryGroup', + 'RatePlanGroup', + 'StatusApplicationGroup', + ]; + + $indexName = 0; + foreach ($attributeGroups as $attributeGroup) { + if ($attributeGroup->getAttributeName() !== '') { + $this->assertSame($attributeNames[$indexName++], $attributeGroup->getAttributeName()); + } + } + } + + public function testGetReferencingElementsMustReturnReferencingElementsFromAttributeGroup() + { + $wsdl = self::wsdlWhlInstance(); + $attributeGroups = $wsdl->getElementsByName(AbstractDocument::TAG_ATTRIBUTE_GROUP); + $attributeGroupCounts = [ + 'ErrorWarningAttributeGroup' => 2, + 'LanguageGroup' => 1, + 'PrimaryLangID_Group' => 20, + 'OTA_PayloadStdAttributes' => 20, + 'CompanyID_AttributesGroup' => 1, + 'UniqueID_Group' => 1, + 'ID_Group' => 3, + 'PositionGroup' => 2, + 'BookingChannelGroup' => 1, + 'NameOptionalCodeGroup' => 0, + 'CodeInfoGroup' => 5, + 'DeadlineGroup' => 1, + 'FeeTaxGroup' => 2, + 'CurrencyAmountGroup' => 4, + 'CurrencyCodeGroup' => 8, + 'IssuerNameGroup' => 1, + 'FormattedInd' => 5, + 'PrivacyGroup' => 11, + 'TelephoneAttributesGroup' => 4, + 'TelephoneGroup' => 4, + 'TelephoneInfoGroup' => 4, + 'DefaultIndGroup' => 4, + 'PaymentCardDateGroup' => 1, + 'GenderGroup' => 2, + 'MultimediaItemGroup' => 1, + 'MultimediaDescriptionGroup' => 3, + 'RoomGroup' => 2, + 'ID_OptionalGroup' => 13, + 'ChargeUnitGroup' => 1, + 'DateTimeSpanGroup' => 2, + 'GuestCountGroup' => 1, + 'BirthDateGroup' => 1, + 'ProfileTypeGroup' => 1, + 'CitizenCountryNameGroup' => 1, + 'HotelReferenceGroup' => 4, + 'RestrictionStatusGroup' => 1, + 'InventoryGroup' => 1, + 'RatePlanGroup' => 1, + 'StatusApplicationGroup' => 1, + ]; + + $testedCount = 0; + /** @var TagAttributeGroup $attributeGroup */ + foreach ($attributeGroups as $attributeGroup) { + if ($attributeGroup->getAttributeName() !== '') { + $elements = $attributeGroup->getReferencingElements(); + $this->assertCount($attributeGroupCounts[$attributeGroup->getAttributeName()], $elements, sprintf('Failed with attributeGroup is "%s"', $attributeGroup->getAttributeName())); + $this->assertContainsOnlyInstancesOf(Tag::class, $elements); + $testedCount++; + } + } + $this->assertCount($testedCount, $attributeGroupCounts); + } +} diff --git a/tests/Tag/TagAttributeTest.php b/tests/Tag/TagAttributeTest.php new file mode 100644 index 0000000..b48e1b8 --- /dev/null +++ b/tests/Tag/TagAttributeTest.php @@ -0,0 +1,30 @@ +getElementByNameAndAttributes(AbstractDocument::TAG_ATTRIBUTE, [ + 'name' => 'ShortText', + 'type' => 'whlsoap:StringLength1to64', + 'use' => 'optional', + ]); + + $this->assertInstanceOf(TagAttribute::class, $attribute); + + $parent = $attribute->getSuitableParent(); + $this->assertInstanceOf(TagAttributeGroup::class, $parent); + $this->assertSame(AbstractDocument::TAG_ATTRIBUTE_GROUP, $parent->getName()); + } +} diff --git a/tests/Tag/TagChoiceTest.php b/tests/Tag/TagChoiceTest.php new file mode 100644 index 0000000..265e740 --- /dev/null +++ b/tests/Tag/TagChoiceTest.php @@ -0,0 +1,313 @@ +assertSame([ + 'element', + 'group', + 'choice', + 'any', + ], TagChoice::getChildrenElementsTags()); + } + + public function testGetForbiddenParentTagsMustReturnTheListOfForbiddenParentTags() + { + $this->assertSame([ + 'complexType', + ], TagChoice::getForbiddenParentTags()); + } + + public function testGetChildrenElementsMustReturnAnArray() + { + $wsdl = self::schemaEwsMessagesInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByName(AbstractDocument::TAG_CHOICE); + + $this->assertTrue(is_array($choice->getChildrenElements())); + } + + /** + * + * + * + * + */ + public function testGetChildrenElementsMustReturnDirectChildrenTags() + { + $wsdl = self::schemaEwsMessagesInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_CHOICE, [ + 'maxOccurs' => '1', + 'minOccurs' => '0', + ]); + + $children = $choice->getChildrenElements(); + + $this->assertCount(2, $children); + $this->assertSame('IndexedPageFolderView', $children[0]->getAttributeName()); + $this->assertSame('FractionalPageFolderView', $children[1]->getAttributeName()); + } + + /** + * + * + * + * Formatted text content. + * + * + * + * + * An image for this paragraph. + * + * + * + * + * A URL for this paragraph. + * + * + * + * + * Formatted text content and an associated item or sequence number. + * + * + * + * + * + * + * The item or sequence number. + * + * + * + * + * + * + * + */ + public function testGetChildrenElementsMustReturnNestedChildrenTags() + { + $wsdl = self::wsdlWhlInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_CHOICE, [ + 'minOccurs' => '0', + 'maxOccurs' => 'unbounded', + ]); + + $children = $choice->getChildrenElements(); + + $this->assertCount(4, $children); + $this->assertSame('Text', $children[0]->getAttributeName()); + $this->assertSame('Image', $children[1]->getAttributeName()); + $this->assertSame('URL', $children[2]->getAttributeName()); + $this->assertSame('ListItem', $children[3]->getAttributeName()); + } + + /** + * + + The Hotel Descriptive Info Response is a message used to provide detailed descriptive information about a hotel property. + + + + + + + The presence of the empty Success element explicitly indicates that the OpenTravel message succeeded. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + A collection of hotel descriptive information. + + + + + + Hotel descriptive information. + + + + + + + Used to identify the specific hotel. + + + + + + + + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + */ + public function testGetChildrenElementsMustReturnFirstLevelNestedChildrenTagsOfHotelDescriptiveInfoRs() + { + $wsdl = self::wsdlWhlInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => 'HotelDescriptiveInfoRS', + ])->getChildByNameAndAttributes(AbstractDocument::TAG_CHOICE, []); + + $children = $choice->getChildrenElements(); + + $this->assertCount(4, $children); + $this->assertSame('Success', $children[0]->getAttributeName()); + $this->assertSame('Warnings', $children[1]->getAttributeName()); + $this->assertSame('HotelDescriptiveContents', $children[2]->getAttributeName()); + $this->assertSame('Errors', $children[3]->getAttributeName()); + } + + /** + * + + Returns information about hotel availability that meet the requested criteria. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + A collection of details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + + + + + + Details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + + + + + + + Used to specify an availability status at the room stay level for a property. + + + + + + + + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + */ + public function testGetChildrenElementsMustReturnFirstLevelNestedChildrenTagsOfHotelAvailRs() + { + $wsdl = self::wsdlWhlInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => 'HotelAvailRS', + ])->getChildByNameAndAttributes(AbstractDocument::TAG_CHOICE, []); + + $children = $choice->getChildrenElements(); + + $this->assertCount(4, $children); + $this->assertSame('Success', $children[0]->getAttributeName()); + $this->assertSame('Warnings', $children[1]->getAttributeName()); + $this->assertSame('RoomStays', $children[2]->getAttributeName()); + $this->assertSame('Errors', $children[3]->getAttributeName()); + } + + /** + * + + + + + + + + + + + + + + + + + + + + + + + + + */ + public function testGetChildrenElementsMustReturnFirstLevelNestedChildrenTagsOfDetails() + { + $wsdl = self::wsdlDeliveryServiceInstance(); + + /** @var TagChoice $choice */ + $choice = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => 'details', + 'form' => 'qualified', + 'minOccurs' => 0, + ])->getChildByNameAndAttributes(AbstractDocument::TAG_CHOICE, []); + + $children = $choice->getChildrenElements(); + + $this->assertCount(17, $children); + $this->assertSame('mutualSettlementDetailCalcCostShipping', $children[0]->getAttributeRef()); + $this->assertSame('mutualSettlementDetailRegisterStorage', $children[16]->getAttributeRef()); + } +} diff --git a/tests/Tag/TagDocumentationTest.php b/tests/Tag/TagDocumentationTest.php new file mode 100644 index 0000000..0c64bb0 --- /dev/null +++ b/tests/Tag/TagDocumentationTest.php @@ -0,0 +1,64 @@ +getElementsByName(AbstractDocument::TAG_DOCUMENTATION, true); + + $this->assertCount(14, $documentations); + $this->assertContainsOnlyInstancesOf(TagDocumentation::class, $documentations); + + $names = [ + 3 => 'availRequest', + 6 => 'imgRequest', + 8 => 'ImagesType', + 10 => 'DocumentType', + 11 => 'ProType', + 12 => 'SearchCriteriaType', + 13 => 'SearchItemType', + ]; + + $assertCount = 0; + /** @var TagDocumentation $documentation */ + foreach ($documentations as $index => $documentation) { + $parent = $documentation->getSuitableParent(); + if ($parent instanceof AbstractTag) { + $this->assertSame($names[$index], $parent->getAttributeName()); + ++$assertCount; + } + } + + $this->assertCount($assertCount, $names, sprintf('Unable to find suitable parent named %s', implode(', ', $names))); + } + + public function testGetSuitableParentAsEnumeration() + { + $wsdl = self::wsdlEbayInstance(); + $enumeration = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_ENUMERATION, [ + 'value' => 'Success', + ]); + + $this->assertSame('Success', $enumeration->getValue()); + + /** @var TagDocumentation $documentation */ + $documentation = $enumeration->getChildByNameAndAttributes(AbstractDocument::TAG_DOCUMENTATION, []); + + $this->assertSame('(out) Request processing succeeded', $documentation->getValue()); + $this->assertSame($documentation->getValue(), $documentation->getContent()); + $this->assertInstanceOf(TagDocumentation::class, $documentation); + $this->assertInstanceOf(TagEnumeration::class, $documentation->getSuitableParent()); + $this->assertSame($enumeration->getValue(), $documentation->getSuitableParent()->getValue()); + } +} diff --git a/tests/Tag/TagEnumerationTest.php b/tests/Tag/TagEnumerationTest.php new file mode 100644 index 0000000..76f825f --- /dev/null +++ b/tests/Tag/TagEnumerationTest.php @@ -0,0 +1,60 @@ +getElementsByName(AbstractDocument::TAG_ENUMERATION); + + /** + * @var int $index + * @var TagEnumeration $enumeration + */ + foreach ($enumerations as $index => $enumeration) { + $this->assertSame(sprintf('0%s', $index + 1), $enumeration->getValue()); + } + } + + public function testGetRestrictionParentTypeMustReturnToken() + { + $schema = self::schemaNumericEnumerationInstance(); + $enumerations = $schema->getElementsByName(AbstractDocument::TAG_ENUMERATION); + + /** @var TagEnumeration $enumeration */ + foreach ($enumerations as $enumeration) { + $this->assertSame('token', $enumeration->getRestrictionParentType()); + } + } + + public function testGetRestrictionParentMustReturnTheRestrictionTag() + { + $schema = self::schemaNumericEnumerationInstance(); + $enumerations = $schema->getElementsByName(AbstractDocument::TAG_ENUMERATION); + + /** @var TagEnumeration $enumeration */ + foreach ($enumerations as $enumeration) { + $this->assertInstanceOf(TagRestriction::class, $enumeration->getRestrictionParent()); + } + } + + public function testHasAttributeValueMustReturnTrue() + { + $schema = self::schemaNumericEnumerationInstance(); + $enumerations = $schema->getElementsByName(AbstractDocument::TAG_ENUMERATION); + + /** @var TagEnumeration $enumeration */ + foreach ($enumerations as $enumeration) { + $this->assertTrue($enumeration->hasAttributeValue()); + } + } +} diff --git a/tests/Tag/TagHeaderTest.php b/tests/Tag/TagHeaderTest.php new file mode 100644 index 0000000..496de3d --- /dev/null +++ b/tests/Tag/TagHeaderTest.php @@ -0,0 +1,230 @@ +getElementsByName(AbstractDocument::TAG_HEADER); + + foreach ($headers as $header) { + if ($header->getParentInput() instanceof TagInput) { + $this->assertInstanceOf(TagOperation::class, $header->getParentOperation()); + $this->assertInstanceOf(TagInput::class, $header->getParentInput()); + $this->assertSame('RequesterCredentials', $header->getAttributePart()); + $this->assertSame('RequesterCredentials', $header->getAttributeMessage()); + $this->assertSame('', $header->getAttributeNamespace()); + } + } + } + + public function testGetMessage() + { + $wsdl = self::wsdlEbayInstance(); + + $header = $wsdl->getElementByName(AbstractDocument::TAG_HEADER); + + $this->assertInstanceOf(TagMessage::class, $header->getMessage()); + } + + public function testGetPartMustReturnPartTag() + { + $wsdl = self::wsdlEbayInstance(); + + $header = $wsdl->getElementByName(AbstractDocument::TAG_HEADER); + + $this->assertInstanceOf(TagPart::class, $header->getPartTag()); + } + + public function testGetPartFinalTypeMustReturnFinalType() + { + $wsdl = self::wsdlEbayInstance(); + + $header = $wsdl->getElementByName(AbstractDocument::TAG_HEADER); + + $this->assertSame('CustomSecurityHeaderType', $header->getPartTag()->getFinalType()); + } + + public function testGetPartFinalNamespaceMustReturnFinalNamespace() + { + $wsdl = self::wsdlEbayInstance(); + + $header = $wsdl->getElementByName(AbstractDocument::TAG_HEADER); + + $this->assertSame('ns', $header->getPartTag()->getFinalNamespace()); + } + + public function testGetHeaderNamespaceMustReturnNamespace() + { + $wsdl = self::wsdlEbayInstance(); + + $header = $wsdl->getElementByName(AbstractDocument::TAG_HEADER); + + $this->assertSame('urn:ebay:apis:eBLBaseComponents', $header->getHeaderNamespace()); + } + + public function testGetAttributeRequiredMustReturnTrueOrFalse() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + /** @var TagHeader $clusterHeader */ + $clusterHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'ClusterHeader', + ]); + + $this->assertFalse($sessionHeader->getAttributeRequired()); + $this->assertTrue($clusterHeader->getAttributeRequired()); + } + + public function testGetHeaderTypeMustReturnHeaderType() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + /** @var TagHeader $clusterHeader */ + $clusterHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'ClusterHeader', + ]); + + $this->assertSame('SessionHeader', $sessionHeader->getHeaderType()); + $this->assertSame('ClusterHeader', $clusterHeader->getHeaderType()); + } + + public function testGetHeaderNameMustReturnHeaderName() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + /** @var TagHeader $clusterHeader */ + $clusterHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'ClusterHeader', + ]); + + $this->assertSame('SessionHeader', $sessionHeader->getHeaderName()); + $this->assertSame('ClusterHeader', $clusterHeader->getHeaderName()); + } + + public function testGetHeaderRequiredMustReturnRequiredOrOptional() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + /** @var TagHeader $clusterHeader */ + $clusterHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'ClusterHeader', + ]); + + $this->assertSame(TagHeader::OPTIONAL_HEADER, $sessionHeader->getHeaderRequired()); + $this->assertSame(TagHeader::REQUIRED_HEADER, $clusterHeader->getHeaderRequired()); + } + + public function testGetAttributeMessageNamespaceMustReturnMessageNamespace() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + /** @var TagHeader $clusterHeader */ + $clusterHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'ClusterHeader', + ]); + + $this->assertSame('tns', $sessionHeader->getAttributeMessageNamespace()); + $this->assertSame('tns', $clusterHeader->getAttributeMessageNamespace()); + } + + public function testGetPartsMustReturnPartTags() + { + $wsdl = self::wsdlActonInstance(); + + $binding = $wsdl->getElementByNameAndAttributes(AbstractDocument::TAG_BINDING, [ + 'name' => 'SoapBinding', + 'type' => 'tns:SOAP', + ]); + + $operation = $binding->getChildByNameAndAttributes(AbstractDocument::TAG_OPERATION, [ + 'name' => 'list', + ]); + + /** @var TagHeader $sessionHeader */ + $sessionHeader = $operation->getChildByNameAndAttributes(AbstractDocument::TAG_HEADER, [ + 'part' => 'SessionHeader', + ]); + + $this->assertCount(3, $parts = $sessionHeader->getParts()); + $this->assertContainsOnlyInstancesOf(TagPart::class, $parts); + } +} diff --git a/tests/Tag/TagImportTest.php b/tests/Tag/TagImportTest.php new file mode 100644 index 0000000..bd48c25 --- /dev/null +++ b/tests/Tag/TagImportTest.php @@ -0,0 +1,30 @@ +getElementsByName(AbstractDocument::TAG_IMPORT); + + $this->assertCount(19, $imports); + $this->assertContainsOnlyInstancesOf(TagImport::class, $imports); + + /** + * @var int $index + * @var TagImport $import + */ + foreach ($imports as $index => $import) { + $this->assertSame(sprintf('PartnerService.%d.xsd', $index), $import->getLocationAttributeValue()); + } + } +} diff --git a/tests/Tag/TagListTest.php b/tests/Tag/TagListTest.php new file mode 100644 index 0000000..a4068fa --- /dev/null +++ b/tests/Tag/TagListTest.php @@ -0,0 +1,76 @@ +getElementsByName(AbstractDocument::TAG_LIST); + + $this->assertCount(4, $lists); + $this->assertContainsOnlyInstancesOf(TagList::class, $lists); + + /** @var TagList $list */ + foreach ($lists as $list) { + $this->assertSame('int', $list->getItemType()); + } + } + + public function testGetItemTypeMustReturnCorrespondingValueFromRestrictionChildOrItemType() + { + $wsdl = self::schemaEwsTypesInstance(); + $lists = $wsdl->getElementsByName(AbstractDocument::TAG_LIST); + $types = [ + 'string', + 'string', + 'string', + 'string', + 'string', + 'DayOfWeekType', + 'string', + 'string', + 'string', + 'string', + 'string', + 'string', + 'string', + 'string', + 'string', + ]; + $itemTypes = [ + '', + '', + '', + '', + '', + 'DayOfWeekType', + '', + '', + '', + '', + '', + '', + '', + '', + '', + ]; + + $this->assertCount(15, $lists); + $this->assertContainsOnlyInstancesOf(TagList::class, $lists); + + /** @var TagList $list */ + foreach ($lists as $index => $list) { + $this->assertSame($itemTypes[$index], $list->getAttributeItemType()); + $this->assertSame($types[$index], $list->getItemType()); + } + } +} diff --git a/tests/Tag/TagMessageTest.php b/tests/Tag/TagMessageTest.php new file mode 100644 index 0000000..195fd96 --- /dev/null +++ b/tests/Tag/TagMessageTest.php @@ -0,0 +1,23 @@ +getElementsByName(AbstractDocument::TAG_MESSAGE); + + $this->assertContainsOnlyInstancesOf(TagMessage::class, $messages); + $this->assertInstanceOf(TagPart::class, $messages[0]->getPart('RequesterCredentials')); + } +} diff --git a/tests/Tag/TagRestrictionTest.php b/tests/Tag/TagRestrictionTest.php new file mode 100644 index 0000000..752cdd4 --- /dev/null +++ b/tests/Tag/TagRestrictionTest.php @@ -0,0 +1,28 @@ +getElementsByName(AbstractDocument::TAG_RESTRICTION); + + $this->assertCount(8, $restrictions); + $this->assertContainsOnlyInstancesOf(TagRestriction::class, $restrictions); + + /** @var TagRestriction $restriction */ + foreach ($restrictions as $restriction) { + $this->assertTrue($restriction->isEnumeration()); + $this->assertTrue($restriction->hasAttributeBase()); + $this->assertFalse($restriction->hasUnionParent()); + } + } +} diff --git a/tests/Tag/TagTest.php b/tests/Tag/TagTest.php new file mode 100644 index 0000000..85227f4 --- /dev/null +++ b/tests/Tag/TagTest.php @@ -0,0 +1,93 @@ +getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertInstanceOf(TagRestriction::class, $simpleType->getFirstRestrictionChild()); + } + + public function testHasRestrictionChildMustReturnTrue() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertTrue($simpleType->hasRestrictionChild()); + } + + public function testIsTheParentMustReturnFalse() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertFalse($simpleType->isTheParent($simpleType)); + } + + public function testIsTheParentMustReturnTrue() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertTrue($simpleType->getFirstRestrictionChild()->isTheParent($simpleType)); + } + + public function testHasAttributeNameReturnTrue() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertTrue($simpleType->hasAttributeName()); + } + + public function testHasAttributeNameReturnFalse() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertFalse($simpleType->getFirstRestrictionChild()->hasAttributeName()); + } + + public function testHasAttributeRefReturnFalse() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertFalse($simpleType->hasAttributeRef()); + } + + public function testHasAttributeValueReturnFalse() + { + /** @var Tag $simpleType */ + $simpleType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_SIMPLE_TYPE, [ + 'name' => 'SearchOption', + ]); + + $this->assertFalse($simpleType->hasAttributeValue()); + } +} diff --git a/tests/Tag/TagUnionTest.php b/tests/Tag/TagUnionTest.php new file mode 100644 index 0000000..71d2af4 --- /dev/null +++ b/tests/Tag/TagUnionTest.php @@ -0,0 +1,121 @@ +getElementsByName(AbstractDocument::TAG_UNION); + + $this->assertCount(2, $unions); + $this->assertContainsOnlyInstancesOf(TagUnion::class, $unions); + + $ok = false; + foreach ($unions as $union) { + switch ($union->getSuitableParent()->getAttributeName()) { + case 'RelationshipTypeOpenEnum': + $this->assertSame([ + 'RelationshipType', + 'anyURI', + ], $union->getAttributeMemberTypes()); + $ok |= true; + break; + case 'FaultCodesOpenEnumType': + $this->assertSame([ + 'FaultCodesType', + 'QName', + ], $union->getAttributeMemberTypes()); + $ok |= true; + break; + } + } + $this->assertTrue((bool) $ok); + } + + public function testHasMemberTypesAsChildrenMustReturnFalse() + { + $wsdl = self::wsdlOrderContractInstance(); + $unions = $wsdl->getElementsByName(AbstractDocument::TAG_UNION); + + $this->assertCount(2, $unions); + $this->assertContainsOnlyInstancesOf(TagUnion::class, $unions); + + $tests = 0; + /** @var TagUnion $union */ + foreach ($unions as $union) { + switch ($union->getSuitableParent()->getAttributeName()) { + case 'RelationshipTypeOpenEnum': + $this->assertFalse($union->hasMemberTypesAsChildren()); + $tests++; + break; + case 'FaultCodesOpenEnumType': + $this->assertFalse($union->hasMemberTypesAsChildren()); + $tests++; + break; + } + } + + $this->assertSame(2, $tests); + } + + public function testHasMemberTypesAsChildrenMustReturnTrue() + { + $schema = self::schemaEwsTypesInstance(); + $unions = $schema->getElementsByName(AbstractDocument::TAG_UNION); + + $this->assertCount(2, $unions); + $this->assertContainsOnlyInstancesOf(TagUnion::class, $unions); + + $tests = 0; + /** @var TagUnion $union */ + foreach ($unions as $union) { + switch ($union->getSuitableParent()->getAttributeName()) { + case 'ReminderMinutesBeforeStartType': + $this->assertTrue($union->hasMemberTypesAsChildren()); + $tests++; + break; + case 'PropertyTagType': + $this->assertTrue($union->hasMemberTypesAsChildren()); + $tests++; + break; + } + } + + $this->assertSame(2, $tests); + } + + public function testGetMemberTypesChildrenMustReturnTheChildren() + { + $schema = self::schemaEwsTypesInstance(); + $unions = $schema->getElementsByName(AbstractDocument::TAG_UNION); + + $this->assertCount(2, $unions); + $this->assertContainsOnlyInstancesOf(TagUnion::class, $unions); + + $tests = 0; + /** @var TagUnion $union */ + foreach ($unions as $union) { + switch ($union->getSuitableParent()->getAttributeName()) { + case 'ReminderMinutesBeforeStartType': + $this->assertCount(2, $union->getMemberTypesChildren()); + $tests++; + break; + case 'PropertyTagType': + $this->assertCount(1, $union->getMemberTypesChildren()); + $tests++; + break; + } + } + + $this->assertSame(2, $tests); + } +} diff --git a/tests/WsdlTest.php b/tests/WsdlTest.php new file mode 100644 index 0000000..e49b878 --- /dev/null +++ b/tests/WsdlTest.php @@ -0,0 +1,144 @@ +assertCount(0, self::wsdlBingInstance()->getExternalSchemas()); + } + + public function testGetElementByNameMustReturnTheTagComplexTypeFromTheWsdl() + { + $this->assertInstanceOf(TagComplexType::class, $complexType = self::wsdlBingInstance()->getElementByName(AbstractDocument::TAG_COMPLEX_TYPE)); + $this->assertSame('SearchRequest', $complexType->getAttributeValue('name')); + } + + public function testGetElementByNameAndAttributesMustReturnTheTagComplexTypeFromTheWsdl() + { + $this->assertInstanceOf(TagComplexType::class, $complexType = self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_COMPLEX_TYPE, [ + 'name' => 'SearchRequest', + ])); + $this->assertSame('SearchRequest', $complexType->getAttributeValue('name')); + } + + public function testGetElementsByNameMustReturnTheTagComplexTypesFromTheWsdl() + { + $this->assertCount(54, $complexTypes = self::wsdlBingInstance()->getElementsByName(AbstractDocument::TAG_COMPLEX_TYPE)); + $this->assertContainsOnlyInstancesOf(TagComplexType::class, $complexTypes); + } + + public function testGetElementsByNameAndAttributesMustReturnTheTagElementFromTheWsdl() + { + $this->assertCount(144, $elements = self::wsdlBingInstance()->getElementsByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'minOccurs' => 0, + 'maxOccurs' => 1, + ])); + $this->assertContainsOnlyInstancesOf(TagElement::class, $elements); + } + + public function testGetElementsByNameAndAttributesFromDomNodeMustReturnTheElementFromTheWsdl() + { + $fromNode = ($instance = self::wsdlBingInstance())->getElementByName(AbstractDocument::TAG_COMPLEX_TYPE)->getNode(); + + $this->assertCount(15, $elements = $instance->getElementsByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'minOccurs' => 0, + 'maxOccurs' => 1, + ], $fromNode)); + $this->assertContainsOnlyInstancesOf(TagElement::class, $elements); + } + + public function testAddExternalSchemaMustFillTheArrayWithOneSchema() + { + $this->assertCount( + 1, + self::wsdlVehicleSelectionServiceInstance(false) + ->addExternalSchema(self::schemaVehicleSelectionServiceSchema1Instance()) + ->getExternalSchemas() + ); + } + + public function testAddExternalSchemaMustFillTheArrayWithTheSchemas() + { + $this->assertCount(2, self::wsdlVehicleSelectionServiceInstance()->getExternalSchemas()); + } + + public function testGetElementByNameMustReturnNullFromTheWsdl() + { + $this->assertNull(self::wsdlVehicleSelectionServiceInstance()->getElementByName(AbstractDocument::TAG_COMPLEX_CONTENT, false)); + } + + public function testGetElementByNameMustReturnTheTagComplexContentFromTheExternalSchemas() + { + $this->assertInstanceOf(TagComplexContent::class, self::wsdlVehicleSelectionServiceInstance()->getElementByName(AbstractDocument::TAG_COMPLEX_CONTENT, true)); + } + + public function testGetElementByNameAndAttributesMustReturnNullFromTheWsdl() + { + $this->assertNull(self::wsdlBingInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => 'ActualRepairCost', + ])); + } + + public function testGetElementByNameAndAttributesMustReturnTheTagElementFromTheExternalSchemas() + { + $this->assertInstanceOf(TagElement::class, $element = self::wsdlVehicleSelectionServiceInstance()->getElementByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'name' => 'ActualRepairCost', + ], true)); + $this->assertSame('ActualRepairCost', $element->getAttributeValue('name')); + } + + public function testGetElementsByNameMustReturnAnEmptyArrayFromTheWsdl() + { + $this->assertEmpty(self::wsdlVehicleSelectionServiceInstance()->getElementsByName(AbstractDocument::TAG_COMPLEX_CONTENT)); + } + + public function testGetElementsByNameMustReturnTheComplexContentsFromTheExternalSchemas() + { + $this->assertCount(18, $complexContents = self::wsdlVehicleSelectionServiceInstance()->getElementsByName(AbstractDocument::TAG_COMPLEX_CONTENT, true)); + $this->assertContainsOnlyInstancesOf(TagComplexContent::class, $complexContents); + } + + public function testGetElementsByNameAndAttributesMustReturnAnEmptyArrayFromTheWsdl() + { + $this->assertEmpty(self::wsdlVehicleSelectionServiceInstance()->getElementsByNameAndAttributes(AbstractDocument::TAG_EXTENSION, [ + 'base' => 'xs:string', + ])); + } + + public function testGetElementsByNameAndAttributesMustReturnTheExtensionsFromTheExternalSchemas() + { + $this->assertCount(10, $extensions = self::wsdlVehicleSelectionServiceInstance()->getElementsByNameAndAttributes(AbstractDocument::TAG_EXTENSION, [ + 'base' => 'xs:string', + ], null, true)); + $this->assertContainsOnlyInstancesOf(TagExtension::class, $extensions); + } + + public function testGetElementsByNameAndAttributesDomNodeMustReturnTheExtensionsFromTheExternalSchemas() + { + $element = ($instance = self::wsdlVehicleSelectionServiceInstance())->getElementByNameAndAttributes(AbstractDocument::TAG_COMPLEX_TYPE, [ + 'name' => 'getHgvPlatformSubModelDataResponse', + ], true); + + $this->assertInstanceOf(TagComplexType::class, $element); + + $fromNode = $element->getNode(); + + $this->assertInstanceOf(DOMNode::class, $fromNode); + + $this->assertCount(30, $elements = $instance->getElementsByNameAndAttributes(AbstractDocument::TAG_ELEMENT, [ + 'form' => 'qualified', + ], $fromNode, true)); + $this->assertContainsOnlyInstancesOf(TagElement::class, $elements); + } +} diff --git a/tests/resources/ActonService2.local.wsdl b/tests/resources/ActonService2.local.wsdl new file mode 100644 index 0000000..0e870e5 --- /dev/null +++ b/tests/resources/ActonService2.local.wsdl @@ -0,0 +1,1055 @@ + + + + + + + + + ID for an object + + + + + + Enumerated type for objects + + + + + + + + + + + + + + + + + + + + + + + Field types for list columns + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Session Header Required for All API Calls Except Login + + + + + + + + + + Cluster Header (Cluster Id is provided to API enabled accounts) + + + + + + + + + + Partner Header (Partner key provided to Act-On Partners) to enable partner API functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Send Custom Message Content OR send a pre-configured template message OR re-send a previously sent message. + + + + The ID of the message template to use as the content of the message to send. You may also use an ID of a previously sent message to copy the message content to the new message. Delivery and response reports will be tracked for the message. + + + + + The ID of a previously sent message or triggered message to send. The delivery and response reports for the re-send will get merged with the existing reports for this message + + + + + Specify the content and format of the new message to be sent. + + + + + + The message subject + + + + + The rich-text HTML body part of the message. May only include fully qualified links and image references. + + + + + The plain-text TEXT body part of the message. + + + + + Optional header ID to use in the message body. The default header will be used if missing. To suppress the header, use -1 for the ID. + + + + + Optional footer ID to use in the message body (with opt-out link). The default footer will be used if missing. To suppress the footer, use -1 for the ID. + + + + + + + + + The parameters that specify the from, to, format, and launch time of the message to send. + + + + + + + One or more contact list (or segment) IDs with email addresses to send-to. + + + + + Optional: Selection set of one or more contacts to send to. If specified, only these contacts will be sent the email. + + + + + + Optional: one or more contact list (or segment) IDs with email addresses to exclude from the launch. + + + + + If true, duplicate email addresses will be suppressed during launch. + + + + + The "from" email address and name. The email must be a verified sender for the account. Uses the default for the user if not specified. + + + + + + + + + + + If specified and true, then send as plain-text only. Otherwise, send multipart-mime with both HTML and TEXT parts. + + + + + The date and time to schedule the launch. Default: immediate launch if not specified. + + + + + + + + + + + + + + The ID of the sent message. + + + + + + + + + + The unique contact ID for this contact record. + + + + + The email for this contact record. + + + + + The value of the merge-key used for this contact record. + + + + + + + + + Unique displayname of the new list, or a segment name to create of records merged into an existing list. + + + + + Optional name of the folder for the list after upload + + + + + Does the source data contain column headings in the first row of data. Optional flag (default = true if not specified). + + + + + + + + + + + + + + + + + + + + + + + + + The Uploaded List (attachment) - may be either comma (or tab) separated text file, or may be Excel spreadsheet. + + + + + Definition of columns in uploaded the source list. If this is an upload only (not a merge), then all source data columns that do not have a corresponding columnDef will be ignored. On a merge, if no source columnDef entries are specified then the first row of the source data must contain header names that exactly match the headers in the destination and all source columns will be merged. + + + + + + Optional list column type (e.g. EMAIL, FIRSTNAME, LASTNAME, etc) + + + + + Column Heading Displayname. If not specified or empty, then the column heading extracted from the first row of data is used (if available). A Fault will be generated if no unique heading is found. + + + + + Column index in the uploaded binaryData (zero-based) + + + + + True if this column should be ignored (not loaded into the list) + + + + + + + + Optional options if merging uploaded list into an existing list + + + + + + Mode of merge. UPSERT updates existing records and inserts new records. APPEND and APPEND_NO_DUPLICATES only append to the list. UPDATE only updates existing records. + + + + + + + + + + + + + The ID for the destination list into which records will be merged. + + + + + Optional override for merge column mappings. Default behavior is to match based on specified columnType, then on case-insensitive column heading match. + + + + + + Column heading of uploaded list + + + + + Mapped column heading in target list + + + + + + + + Optional flag. If true, create a segment from records merged into the list. If absent or false, no additional segment will be created. + + + + + Optional flag to request the uploadListResponse to report all records appended or updated. Use with caution if your upload may result in a large number of records as this may cause a large uploadListResponse body. + + + + + Optional heading name in the source data used to merge data into the destination list. (Default if missing is to use the identified EMAIL column in both source and destination list.) The merge column must exist in the source data and destination list or have a columnMap entry specified. + + + + + + + + + + + + + + The jobID of the upload/merge job. This jobID can be used to poll with the getUloadResults method to obtain the results of the upload when it completes. + + + + + + + + Request the results of an uploadList job. + + + + + + The jobID of an asynchronous upload + + + + + + + + + + + + The jobID returned in the uploadListResponse from the asynchrounous uploadList method call. This is the ID of the job for which you want to poll for the upload results. + + + + + The job status (pending or running) if the job has not yet completed. This will be the only reported result if the job has not yet completed. + + + + + + + The uploaded list Id. + + + + + The ID of the segment created with merged records (if requested) + + + + + Number of appended records after an upload or merge + + + + + Number of updated records after a merge. + + + + + Number of rejected records after an upload or merge. (see also rejectedRecords attachment) + + + + + Attachment list of records that were rejected on upload or merge. Missing if there were no rejected records after upload or merge. + + + + + List of records appended after a merge to an existing list. Only specified if the optional mergeReport option is true in the uploadList request. + + + + + + + + + + List of records updated after a merge to an existing list. Only specified if the optional mergeReport option is true in the uploadList request. + + + + + + + + + + List of records in the uploaded list that were unchanged from the matched records in the existing list. Only specified if the optional mergeReport option is true in the uploadList request. + + + + + + + + + + + + + + + + + + The ID of the list or segment to download + + + + + Specify the download format -- Excel spreadsheet or CSV + + + + + + + + + + + + + + + + + + Thie downloaded list attachment + + + + + + Delete a list or segment + + + + + + + + + + + Report the results of a sent message + + + + + + One or more messageIDs to report. The summary section of the report will roll-up the total and unique counts when more than one messageID is provided. + + + + + + + When specified, also reports detailed activity records for the specified types of action. + + + + + + The types of activity you want reported in the detail section (e.g. ALL, SENT, CLICKED, etc.) + + + + + + + + + + + + + + + + + + + + + + Optionally include the specified contact fields from the corresponding contact in the detailed action record, if available. + + + + + + The field heading name to include in the detailed action record report. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The ID of the contact that performed the action, if available. May be blank for anonymous activity. + + + + + The email address of the contact that performed the action, if available. May be blank for anonymous activity. + + + + + The name of the contact that performed the action, if available (blank for anonymous activity). + + + + + The time the action was recorded. + + + + + The action detail has action specific detail. For example, the link clicked, the reason for suppression etc. + + + + + The IP address of the client computer from the HTTP session when the action was recorded. Note that this may be the IP address of a proxy or firewall or ISP protecting the actual client system from the Internet. + + + + + The client browser reported by the HTTP session header when the action was recorded. + + + + + The client platform and operating system reported by the HTTP session header when the action was recorded. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Login to the service. This must be the first call to obtain the SessionID for all subsequent API calls + + + + + + + + + Obtain a listing of different types of items in the system (e.g. CONTACT_LISTS) + + + + + + + + + Upload a new contact list or merge records into an existing list. + + + + + + + + + Poll for the results of an asynchronous running upload/merge request + + + + + + + + + Download the records of a contact list + + + + + + + + + + + + + + + + + Schedule an email to be sent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Act-On Service + + + + + \ No newline at end of file diff --git a/tests/resources/DeliveryService.wsdl b/tests/resources/DeliveryService.wsdl new file mode 100644 index 0000000..4cb96f1 --- /dev/null +++ b/tests/resources/DeliveryService.wsdl @@ -0,0 +1,2590 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/OrderContract.wsdl b/tests/resources/OrderContract.wsdl new file mode 100644 index 0000000..d32836a --- /dev/null +++ b/tests/resources/OrderContract.wsdl @@ -0,0 +1,1968 @@ + + + + + + + + + + + + + + + + + + + + This is an optional identifier to be used by a system when several technical transactions are representing one business transaction. Example: Business transaction implemented via a request and call-back transaction. The call-back will have a new MessageId as it is a new message but might have the same CorrelationId. The definition of the values is owned by the system sending the transaction. + + + + + + + + + + + + + + + + + + + This is the identifier of the sending system. + + + + + This should be the timestamp for when the XML document was generated. + + + + + + + + + + + + This should be the timestamp for when the XML document was sent. It is important when a message will reside on a queue with retries etc and might only be sent later. The field should be re-set for every retry. The field is optional and if not present will be assumed to be the same as the GeneratedTimeStamp. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Query all the orders for a customer + + + + + + + + + + + + + Clarify customer identifier + + + + + + + + + + + A reference number used by a customer to identify the order + + + + + + + + + + + A reference number used by a customer to identify the order action + + + + + + + + + + + The service type of the order action + + + + + + + + + + + The ID used by the CSP to identify the ordered product + + + + + + + + + + + The ID used by the CSP to identify the installation address + + + + + + + + + + + The name of a project managed by the CSP that the order is related to + + + + + The earliest Service Required Date of the order action in date-time format + + + + + The latest Service Required Date of the order action in date-time format + + + + + Initial, In Negotiation, Amended, or any other status of the order action defined in OMS + + + + + + + + + + + Includes the cancelled and completed orders for the service + + + + + Optional element containing the structure in which the response will be requested. If not specified, the default structure is returned. + + + + + + + + + + + + + Detail order information for each order. + + + + + This is the name of the wholesale ISP that's stored on CBS. Field is required for B2B clients + + + + + + + + + + + + + + + + + + + The delivery address of the customer. This is a verified address on Location Register. + + + + + First line on delivery address + + + + + + + + Second line on delivery address + + + + + + + + Third line on delivery address + + + + + + + + The delivery city + + + + + + + + Postal code for the city + + + + + + + + + + + + Contains the access node infromation. + + + + + + + + Indicates the type of an action needed + + + + + + + + + + + + + Login object contains the username, password and localuser fields. They are all seen as compulsory. + + + + + Flag set if the user is an internal user + + + + + Contains the local user value for this login + + + + + String containing the password + + + + + + + + + + + String containing a user name used for system login + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the billing account number information. + + + + + + + + Contains the building name information. + + + + + + + + CBS order number + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the circuit category address information. + + + + + + + + Contains the circuit number information + + + + + + + + Contains the circuit speed information + + + + + + + + + + + + + Contains the city name information. + + + + + + + + + + + + + + + + + + Contains the contact cellphone information. + + + + + + + + Contains the contact person's information. + + + + + + + + Contains the contact telephone number information. + + + + + + + + region that will control the order + + + + + + + + + + + The category the customer falls into + + + + + + + + Contains the customer email address. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface name of the customer equipment + + + + + Name of the customer equipment + + + + + + + Contains the customer equipment name information + + + + + + + + + + + + + + + + + + + + + + + Contains the identification number of the customer. + + + + + + + + Contains the name of the customer. + + + + + + + + Contains the customer's postal address information. + + + + + + + + Contains the customer VAT number. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains a string data type, e.g. 2007-10-23 11:28:03. Usually a DateTime type is of this format; CCYY-MM-DDThh:mm:ss.s+zzzzzz + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the email address information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the fax number information. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CBS LAU Number + + + + + + + + Contains the local area network address information + + + + + + + + Lease line type + + + + + + + + Contains the date when the installation goes live. + + + + + + + + The unique locator id for the Service Request to be Deployed + + + + + + + + + + + + + + + + + + Contains the loopback IP address information + + + + + + + + Contains the managemenmt status information. + + + + + + + + + + + + + + + + + + + + + Circuit number for miscellaneous order item + + + + + + + + Order number for miscellaneous order item + + + + + + + + + + + The nett amount of the product including VAT. + + + + + + Number of requests to be conducted + + + + + + + + + + + + + + + + + + + + + + + + Contains the order action information + + + + + + + + Contains the order number information + + + + + + + + + + + + + Contains the order priority information + + + + + + + + Contains the order status information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface name of the peripheral equipment + + + + + Name of the peripheral equipment + + + + + + + Contains the peripheral equipment name information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the required port speed information + + + + + + + + Contains the postal address information. + + + + + + + + The code of the product that was sold. This must be SAP material number + + + + + + + + The name of a particular product + + + + + + + + + + + + + + + + + + + Circuit number for quality of service package order item + + + + + + + + Order number for quality of service package order item + + + + + + + + + + + + + The number of units sold. Must be the Absolute value. (Note: This should be = 1 since each item must be a separate line item). + + + + + + + + + Unique reference number allocated by web application to the customer order transaction. (Note: This reference number will be used to link the web order to the SAP order. The number will be returned with the SAP order number in the return interface file). + + + + + + + + + + + + + + + + + + + + + Cutomer Equipment Interface Name + + + + + Customer Equipment Device Name + + + + + + + + + + + Peripheral Equipment Interface Name + + + + + Peripheral Equipment Device Name + + + + + + + + + + + WAN IP Address + + + + + LAN IP Addresses + + + + + + + + + + CE Loopback IP Address + + + + + + + + + + + + + + + + + + + + + + + + The Service Request name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the required by date information + + + + + + + + + + Every result message needs to have a result code to indicate success, fail or reject. Success means that the request message was successful. Fail means that there is some failure of technical nature and it is possible the message might be successful if resent. Reject means that the message will be rejected again if resent. This is typically business related and might require manual intervention. For fail and reject, result message code and result message will give a more detail description of the error. + + + + + + If the result code is of type fail or reject an additional result message code should be specified. This message code should indicate what type of problem was experienced with the request message. The recommended way of using this field is to have two parts: system identifier + number Example: RIM02001, CBS0999 + + + + + + + + + + + + This is a more detail description, human readable and interpretable, of the result message code. + + + + + + + + + + + + + Contains the room information. + + + + + + + + + + + + + Circuit number for router order item + + + + + + + + Order number for router order item + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the service center information. + + + + + + + + Contains the required service type information + + + + + + + + The ServiceOrder Name + + + + + + + + + + + + + + + + + + + + + + + + Contains the service order job description information + + + + + + + + Contains the session token information. + + + + + + + + + + + + + + + + + + + Contains the site code information. + + + + + + + + Contains the name of the contact person for the site. + + + + + + + + Contains the contact number of the person for the site. + + + + + + + + Information about the site e.g. physical address + + + + + + + + Contains the installation address information. + + + + + + + + Contains the site name information. + + + + + + + + + + + + + Site of origin checkbox + + + + + + Site of origin pool + + + + + + + + Site of origin provider + + + + + + + + + + + + + + + + + + + + + The current state of the MPLS service request on ISC + + + + + + + + Street related information + + + + + + + + + What Task the service request is to conduct + + + + + + + + + The action of task to be done, has some enumerations. + + + + + + + + + + + + + + Contains the task identification number for the transaction. + + + + + + + + + + + + + + The unique identifier of this task + + + + + The date the action will be taken. + + + + + The employee that owns the task + + + + + The state of the task + + + + + The string containing the type of action to be taken in order to generate the correct reason list + + + + + The reason of the action + + + + + Comments about the action taken + + + + + + + + + + + + The type of Service Request + + + + + + + + + A class containing technical attributes for service orders. + + + + + Attribute unique key + + + + + Currently unavailable + + + + + The name of the attribute + + + + + Key referring the attribute template + + + + + The value of the attribute + + + + + Version of the attribute + + + + + Currently unavailable + + + + + Currently unavailable + + + + + + + + + + The data type of the attribute + + + + + + + + + + The default value to be used by this attribute + + + + + Flag stating if the attribute can be edited or not. + + + + + The employee that added the attribute + + + + + The field size of the data contained by this attribute + + + + + Flag stating if this is a mandatory attribute + + + + + The text mast + + + + + Sequence number + + + + + The date last updated + + + + + + + + + + + + + + + + + + + + + + The process that takes place when a customer makes an order + + + + + Transaction date in format ccyymmdd + + + + + An indicator whether the transaction was for an ad hoc customer/sale or a sales on a Telkom telephone account. Ad hoc customer/sale being a credit card sale being paid for online. Account sale being a sale that should be debited on the telephone account. SAP needs this to determine whether the transaction should post revenue or whether the revenue posting will be in Flexibill. Indicator: T = Telkom account sale N = Ad hoc customer sale + + + + + Unique reference number allocated by web application to the customer order transaction. (Note: This reference number will be used to link the web order to the SAP order. The number will be returned with the SAP order number in the return interface file). + + + + + + + + + + Contains the VPN name information. + + + + + + + + + + + + + + + + Contains the wide area network IP address information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/VehicleSelectionService/VehicleSelectionService.wsdl b/tests/resources/VehicleSelectionService/VehicleSelectionService.wsdl new file mode 100644 index 0000000..54857bc --- /dev/null +++ b/tests/resources/VehicleSelectionService/VehicleSelectionService.wsdl @@ -0,0 +1,692 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/VehicleSelectionService/VehicleSelectionService_schema1.xsd b/tests/resources/VehicleSelectionService/VehicleSelectionService_schema1.xsd new file mode 100644 index 0000000..2d2bccc --- /dev/null +++ b/tests/resources/VehicleSelectionService/VehicleSelectionService_schema1.xsd @@ -0,0 +1,3888 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/VehicleSelectionService/VehicleSelectionService_schema2.xsd b/tests/resources/VehicleSelectionService/VehicleSelectionService_schema2.xsd new file mode 100644 index 0000000..3866158 --- /dev/null +++ b/tests/resources/VehicleSelectionService/VehicleSelectionService_schema2.xsd @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/bingsearch.wsdl b/tests/resources/bingsearch.wsdl new file mode 100644 index 0000000..24be164 --- /dev/null +++ b/tests/resources/bingsearch.wsdl @@ -0,0 +1,490 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/ebaySvc.wsdl b/tests/resources/ebaySvc.wsdl new file mode 100644 index 0000000..9e26e2a --- /dev/null +++ b/tests/resources/ebaySvc.wsdl @@ -0,0 +1,145483 @@ + + + + + + + + + + + + Authentication information for the user on whose behalf the + application is making the request. Only registered eBay users are + allowed to make API calls. To verify that a user is registered, + your application needs to pass a user-specific value called an + "authentication token" in the request. This is equivalent to + signing in on the eBay Web site. As API calls do not pass session + information, you need to pass the user's authentication token every + time you invoke a call on their behalf. All calls require an + authentication token, except the calls you use to retrieve a token + in the first place. (For such calls, you use the eBay member's + username and password instead.) + + + + + Yes + + + + + + + + + + This call enables a seller to create an Unpaid Item case against a buyer, or to cancel a + single line item order. + <br/><br/> + <span class="tablenote"><b>Note:</b> + This call is only used by sellers to create an Unpaid Item case or to mutually cancel a + single line item order. Buyers must use the eBay Resolution Center or PayPal Resolution + Center (for orders that satisfy requirements) to create an Item Not Received or an Item + Significantly Not as Described case. + </span> + + + + Creates an Unpaid Item dispute against a buyer or + cancels a single line item order. + + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + + + + + + + + This enumerated value gives the explanation of why the buyer or seller opened a + case (or why seller canceled an order line item). Not all values contained in + <b>DisputeExplanationCodeType</b> are allowed in the + <b>AddDispute</b> call, and the values that are allowed must match + the <b>DisputeReason</b> value. + + + + AddDispute + Yes + PaymentMethodNotSupported, ShipCountryNotSupported, Unspecified, UPIAssistance, UPIAssistanceDisabled + + + Creating and Managing Disputes With Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-DisputesAPIManagement.html#UsingAddDispute + + + + + + + + The type of dispute being created. <b>BuyerHasNotPaid</b> and + <b>TransactionMutuallyCanceled</b> are the only values that may + be used with the <b>AddDispute</b> call. + + + + AddDispute + Yes + BuyerHasNotPaid, TransactionMutuallyCanceled + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + orders, but only one <b>ItemID</b>. To + identify a specific order line item, either an + <b>ItemID</b>/<b>TransactionID</b> pair or an + <b>OrderLineItemID</b> value must be passed in the request. So, + unless <b>OrderLineItemID</b> is used, this field is required. + <br> + + + 19 (ItemIDs usually consist of 9 to 12 digits) + + AddDispute + Conditionally + + + + + + + + The unique identifier of an order line item. An order line item is created once + a buyer purchases the item through a fixed-priced listing or by using the Buy It + Now feature in an auction listing, or when an auction listing ends with a + winning bidder. To identify a specific order line item, either an + <b>ItemID</b>/<b>TransactionID</b> pair or an + <b>OrderLineItemID</b> value must be passed in the request. So, + unless <b>OrderLineItemID</b> is used, this field is required. + <br> + + + 19 (TransactionIDs usually consist of 9 to 12 digits.) + + AddDispute + Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier of an order line item, + and is based upon the concatenation of <b>ItemID</b> and + <b>TransactionID</b>, with a hyphen in between these two IDs. To + identify a specific order line item, either an + <b>ItemID</b>/<b>TransactionID</b> pair or an + <b>OrderLineItemID</b> value must be passed in the request. So, + unless <b>ItemID</b>/<b>TransactionID</b> pair is used, + this field is required. + <br> + + + 50 + + AddDispute + Conditionally + + + + + + + + + + + + + + Type defining the response of the <b>AddDispute</b> call. Upon a successful + call, the response contains a newly created <b>DisputeID</b> value, which confirms that the Unpaid Item or Mutually Canceled Transaction case was successfully created. + + + + + + + + + The unique identifier of the Unpaid Item or Mutually Canceled Transaction case + that was successfully created with the <b>AddDispute</b> call. + + + + AddDispute + Always + + + + + + + + + + + + + + This call allows a seller to respond to an Item Not Received dispute opened by a buyer through PayPal's Purchase Protection program, or to update an Unpaid Item dispute. To respond to an Item Not Received or Item Significantly Not As Described case opened through eBay's Resolution Center, the seller should use the <a href="http://developer.ebay.com/Devzone/resolution-case-management/CallRef/index.html" target="_blank">Resolution Case Management API</a>, or manage the case through the eBay Resolution Center. + + + + Used to respond to a PayPal Purchase Protection dispute or update an Unpaid Item dispute. + + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + Buyer Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Disputes-Buyer.html + + + + + + + + + + The unique identifier of the eBay or PayPal dispute. This identifier is created by eBay or PayPal upon dispute creation. + + + + AddDisputeResponse + Yes + + + + + + + + The text of a comment or response being posted to the dispute. Required + when <b>DisputeActivity</b> is <b>SellerAddInformation</b>, <b>SellerComment</b>, or + <b>SellerPaymentNotReceived</b>; otherwise, optional. + + + + AddDisputeResponse + Conditionally + + + + + + + + The type of activity the seller is taking on the dispute. The allowed value is + determined by the current value of <b>DisputeState</b>, returned by <b>GetDispute</b> or + <b>GetUserDisputes</b>. Some values relate to Unpaid Item disputes and other values relate + to buyer-created disputes known as Item Not Received or Significantly Not As + Described disputes. + + + + AddDisputeResponse + Yes + + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + Buyer Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Disputes-Buyer.html + + + + + + + + The shipping carrier used to ship the item in dispute. Non-alphanumeric + characters are not allowed. This field (along with <b>ShipmentTrackNumber</b>) is + required if <b>DisputeActivity</b> is 'SellerShippedItem'. + + + + AddDisputeResponse + Conditionally + + + + + + + + The tracking number associated with one package of a shipment. The seller is + responsible for the accuracy of the shipment tracking number, as eBay only + verifies that the tracking number is consistent with the numbering scheme + used by the specified shipping carrier, but cannot verify the accuracy of + the tracking number. This field (along with <b>ShippingCarrierUsed</b>) is required + if <b>DisputeActivity</b> is 'SellerShippedItem'. + + + + AddDisputeResponse + Conditionally + + + + + + + + This timestamp indicates the date and time when the item under dispute was + shipped. This field is required if <b>DisputeActivity</b> is 'SellerShippedItem'. + + + + AddDisputeResponse + Conditionally + + + + + + + + + + + + + + Response to the <b>AddDisputeResponse</b> call. + + + + + + + + + + + + Defines and lists a new fixed-price listing. + The main difference between <b>AddFixedPriceItem</b> and <b>AddItem</b> is that + <b>AddFixedPriceItem</b> supports the creation of fixed-price listings only, + whereas <b>AddItem</b> supports all listing formats.<br> + <br> + Also, only <b>AddFixedPriceItem</b> supports multi-variation listings + and tracking inventory by SKU. <b>AddItem</b> does not support + Variations or the <b>InventoryTrackingMethod</b> field. + + + + Defines and lists a new fixed-price item. A fixed-price listing + can include multiple identical items. + + + AddItem, AddItems, AddToItemDescription, EndFixedPriceItem, + GetItem, GetCategories, RelistFixedPriceItem, + ReviseFixedPriceItem, VerifyAddFixedPriceItem + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html + + + Listing Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Multi-Variation Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + + + + + + + + Root container holding all values that define a new + fixed-price listing. + + + + AddFixedPriceItem + Yes + + + + + + + + + + + + + + Returns the item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the new listing (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Unique identifier for the new fixed-price listing. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddFixedPriceItem + Always + + + + + + + + The SKU value for an item is returned if the seller specified a SKU value through the <b>Item.SKU</b> in the request. In the case of a multivariation listing, variation-level SKU values are not returned in the response. To get this data, a <b>GetItem</b> call would have to be made by the seller. + + + + AddFixedPriceItem + Conditionally + + + + + + + + Starting date and time for the new listing. This value is based + on the time the listing was received and processed, or the + time the item will be listed if the seller specified + Item.ScheduleTime in the request. + + + + AddFixedPriceItem + Always + + + + + + + + Date and time when the new listing ends. This is the starting time + plus the listing duration. + + + + AddFixedPriceItem + Always + + + + + + + + Child elements contain the estimated listing fees for the new item listing. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + + + + eBay.com Fees + http://pages.ebay.com/help/sell/fees.html + + + AddFixedPriceItem + Always + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Final Value Fees + http://pages.ebay.com/help/sell/fvf.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Using Feature Packs to Save on Upgrade Fees + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Desc-FeaturePacks.html + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or if it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + AddFixedPriceItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + AddFixedPriceItem + Conditionally + + + + + + + + The nature of the discount, if a discount is applied. + + + + AddFixedPriceItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + AddFixedPriceItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. + Each <b>Recommendation</b> container provides a message to the + seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>AddFixedPriceItem</b> request, and if + at least one listing recommendation exists for the newly created listing. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item based on eBay's listing + recommendation(s). + + + + AddFixedPriceItem + Conditionally + + + + + + + + + + + + + + Defines a single new item and lists it on a specified eBay site.&nbsp;<b>Also for Half.com</b>. + Returns the item ID for the new listing, and returns fees the seller will incur for the + listing (not including the Final Value Fee, which cannot be calculated until + the item is sold). + + + + AddFixedPriceItem, AddItems, AddToItemDescription, GetItem, + GetSellerList, RelistItem, ReviseItem, + VerifyAddItem + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html + + + Listing Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + half + + + + + + + + + Root container holding all values that define a new + listing. + <br> + <br> + Applicable to Half.com. + + + + AddItem + Yes + + + + + + + + + + + + + + Returns the Item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the new listing (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Unique identifier for the new listing. + <br> + <br> + Applicable to Half.com. + <br> + <br> + <span class="tablenote"><b>Note:</b> + Although eBay represents Item IDs as strings in the schema, we recommend you store + them as 64-bit signed integers. If you choose to store Item IDs as strings, allocate + at least 19 characters (assuming decimal digits are used) to hold them. eBay will + increase the size of IDs over time, and your code should be prepared to handle IDs of + up to 19 digits. For more information about Item IDs, see <a href=" + https://ebaydts.com/eBayKBDetails?KBid=468"> + Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. + </span> + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddItem + Always + + + + + + + + Starting date and time for the new listing. + <br> + <br> + Applicable to Half.com (for Half.com, the start time is always the time the item was listed). + + + + AddItem + Always + + + + + + + + Date and time when the new listing ends. This is the starting time plus the listing + duration. + <br> + <br> + Applicable to Half.com (for Half.com the actual end time is GTC, not the end time + returned in the response). + + + + AddItem + Always + + + + + + + + Child elements contain the estimated listing fees for the new item listing. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + <br> + <br> + Applicable to Half.com, but the values are not applicable to Half.com listings. + + + + AddItem + Always + + + eBay.com Fees + http://pages.ebay.com/help/sell/fees.html + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Final Value Fees + http://pages.ebay.com/help/sell/fvf.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Using Feature Packs to Save on Upgrade Fees + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Desc-FeaturePacks.html + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + <br> + <br> + Not applicable to Half.com. + + + 10 + + AddItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + <br> + <br> + Not applicable to Half.com. + + + 10 + + AddItem + Conditionally + + + + + + + + The nature of the discount, if a discount applied. + + + + AddItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + AddItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>AddItem</b> request, and if + at least one listing recommendation exists for the newly created listing. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item based on eBay's listing + recommendation(s). + + + + AddItem + Conditionally + + + + + + + + + + + + + + Creates listings from Selling Manager templates. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the template you are using to list an item. + You can obtain a SaleTemplateID by calling GetSellingManagerInventory. + + + + AddItemFromSellingManagerTemplate + No + + + + + + + + Start time for the listing. + + + + AddItemFromSellingManagerTemplate + No + + + + + + + + <b>Currently, only the + following can be specified as children of this + container: payment methods, + the PayPal email address, and CategoryMappingAllowed. </b> + This container is intended for specifying + item values that differ from values in the + template specified in the SaleTemplateID field. + However, currently, the only children that + are allowed for this container are payment methods and + a PayPal email address. + + + + AddItemFromSellingManagerTemplate + No + + + + + + + + + + + + + + Returns values indicating information for a new listing. + + + + + + + + + The unique identifier for the listing that was created by the + AddItemFromSellingManagerTemplate request. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddItemFromSellingManagerTemplate + Always + + + + + + + + Start time for the listing that was created by the + AddItemFromSellingManagerTemplate request. + + + + AddItemFromSellingManagerTemplate + Always + + + + + + + + End time for the listing that was created by the + AddItemFromSellingManagerTemplate request. + This value is equal to the start time plus the listing duration. + + + + AddItemFromSellingManagerTemplate + Always + + + + + + + + Child elements contain the estimated listing fees for the new item listing. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + + + + AddItemFromSellingManagerTemplate + Always + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + Not applicable to Half.com. + + + 10 + + AddItemFromSellingManagerTemplate + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + Not applicable to Half.com. + + + 10 + + AddItemFromSellingManagerTemplate + Conditionally + + + + + + + + + + + + + + Defines from one to five items and lists them on a specified eBay site. + + + + AddItem, AddToItemDescription, EndItems, GetItem, + GetSellerList, RelistItem, ReviseItem, VerifyAddItem + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html + + + Listing Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + + + + + + + + Defines a single item to be listed on eBay. This container is similar to an <b>AddItem</b> request. Up to five of these containers can be included in one <b>AddItems</b> request. + + + 1 + 5 + + AddItems + Yes + + + + + + + + + + + + + + The response of the <b>AddItems</b> call. The response includes the + Item IDs of the newly created listings, the eBay category each item is listed under, + the seller-defined SKUs of the items (if any), the listing recommendations for each item + (if applicable), the start and end time of each listing, and the estimated fees that + each listing will incur. + + + + + + + + + One <b>AddItemResponseContainer</b> container is returned for each + listing that is being created with the <b>AddItems</b> call. Each + container includes the <b>ItemID</b> of each newly created listings, + the eBay category each item is listed under, the seller-defined SKUs of the + items (if any), the listing recommendations for each item (if applicable), the + start and end time of each listing, and the estimated fees that each listing + will incur. + + + + AddItems + Always + + + + + + + + + + + + + + Enables a buyer and seller in an order relationship to + send messages to each other's My Messages Inboxes. + + + + AddMemberMessagesAAQToBidder, AddMemberMessageRTQ, DeleteMyMessages, + GetMemberMessages, ReviseMyMessages, ReviseMyMessagesFolders + + + + + + + + + + The unique ID of the item about which the question was asked. + + + + AddMemberMessageAAQToPartner + Yes + + + + + + + + Container for the message. Includes the message body, plus other values + related to the message. + + + + AddMemberMessageAAQToPartner + Yes + + + + + + + + + + + + + + Response to the <b>AddMemberMessageAAQToPartner</b> call. + + + + + + + + + + + + Enables a seller to reply to a question about an active item listing. + + + + AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, DeleteMyMessages, + GetMemberMessages, GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders + + + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/CRM-Communications.html + CommunicationBetweenMembers + + + + + + + + + + The unique ID of the item about which the question was asked. This field + is not required in the request, if the request includes a RecipientID + in the MemberMessage container. + + + + AddMemberMessageRTQ + No + + + + + + + + Container for the message. Includes the message body (which should answer + the question that an eBay user asks you (the seller) about an active + listing), plus other values related to the message. + + + + AddMemberMessageRTQ + Yes + + + + + + + + + + + + + + Response to the <b>AddMemberMessageRTQ</b> call. + + + + + + + + + + + + Enables a seller to send up to 10 messages to bidders, or to users who have + made offers via Best Offer, regarding an active item listing. + + + + AddMemberMessageAAQToPartner, AddMemberMessageRTQ, DeleteMyMessages, + GetMemberMessages, GetMyMessages, GetUserContactDetails, ReviseMyMessages, + ReviseMyMessagesFolders + + + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/CRM-Communications.html + CommunicationBetweenMembers + + + + + + + + + + Allows a seller to send up to 10 messages to + bidders and users who have made offers (via Best + Offer) during an active listing. + + + 10 + + AddMemberMessagesAAQToBidder + Yes + + + + + + + + + + + + + + Type defining the <b>AddMemberMessagesAAQToBidderResponseContainer</b> container, which consists + of the <b>Ack</b> field (indicating the result of the send message operation) and the <b>CorrelationID</b> + field (used to track multiple send message operations performed in one call). + + + + + + + + + Container consisting of the <b>Ack</b> field (indicating the result of the send message + operation) and the <b>CorrelationID</b> field (used to track multiple send + message operations performed in one call). + + + 10 + + AddMemberMessagesAAQToBidder + Always + + + + + + + + + + + + + + The <b>AddOrder</b> call can be used by a seller to combine two or more unpaid order line items from the same buyer into one order with multiple line items (called a + Combined Invoice order). Once multiple line items are combined into one order, the buyer can make one single payment for each line item in the order. If possible and agreed to, the seller can then ship multiple line items in the same shipping package, saving on shipping costs, and possibly passing that savings down to the buyer through Combined Shipping Discount rules set up in My eBay. + + + Combines two or more order line items into a single order, enabling a buyer to pay for all of those order line items with a single payment. + + GetItemTransactions, GetOrders + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Checkouts.html#ReviewingandModifyinganOrderLineItem + Reviewing and Modifying an Order Line Item + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + The root container of the <b>AddOrder</b> request. In this + call, the seller identifies two or more unpaid order line items from the same buyer + through the <b>TransactionArray</b> container, specifies one or + more accepted payment methods through the <b>PaymentMethods</b> + field(s), and specifies available shipping services and other shipping details + through the <b>ShippingDetails</b> container. + + + + AddOrder + Yes + + + + + + + + + + + + + + Returns a unique identifier for the order. A buyer may make a single + payment to purchase all of the order line items included + in the order. + + + + + + + + + The unique identifier for the Combined Invoice order. This value is created by eBay upon a successful <b>AddOrder</b> call. This value can be used as an input filter in <a href="GetOrders.html">GetOrders</a> and <a href="GetOrderTransactions.html">GetOrderTransactions</a> to retrieve the order. + + + + AddOrder + Always + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Timestamp that indicates the date and time that the Combined Invoice order was created. + + + + AddOrder + Always + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + + Creates a new Second Chance Offer (that is, an offer for an unsold item) + for one of that item's non-winning bidders. + + + GetAllBidders, VerifyAddSecondChanceItem + + Making Second Chance Offers for Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-SecondChanceOffers.html + + + + + + + + + + Specifies the bidder from the original, ended listing to whom the seller + is extending the second chance offer. Specify only one + RecipientBidderUserID per call. If multiple users are specified (each in a + RecipientBidderUserID node), only the last one specified receives the + offer. + + + + AddSecondChanceItem + Yes + + + + + + + + The amount the offer recipient must pay to purchase the item + from the second chance offer listing. Use only when the original + item was listed in an eBay Motors vehicle category (or in some + categories on U.S. and international sites for + high-priced items, such as items in many U.S. and Canada + Business and Industrial categories) and it ended unsold + because the reserve price was not met. Otherwise, eBay + establishes the price and no price should be submitted. + + + + AddSecondChanceItem + No + + + + + + + + Specifies the length of time the second chance offer listing will be + active. The recipient bidder has that much time to purchase the item or + the listing expires. + + + + AddSecondChanceItem + Yes + + + + + + + + Specifies the item ID for the original, ended listing from which the + second chance offer item comes. A new ItemID is returned for the second + chance offer item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddSecondChanceItem + Yes + + + + + + + + Message content. Cannot contain HTML, asterisks, or quotes. This content + is included in the second chance offer email sent to the recipient, which + can be retrieved with GetMyMessages. + + + 1000 + + AddSecondChanceItem + No + + + + + + + + + + + + + + Type defining the response container of an <b>AddSecondChanceItem</b> call. This response container consists of the <b>ItemID</b> of the listing in which a Second Chance offer is being offered, as well as the start and end time that the Second Chance offer is available to the previous bidder (identified through the <b>RecipientBidderUserID</b> in the request). + + + + + + + + + Contains the item ID for the new second chance + offer listing. Different from the original ItemID passed in the request. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddSecondChanceItem + Always + + + + + + + + Indicates the date and time when the new second chance offer listing + became active and the recipient user could purchase the item. + + + + AddSecondChanceItem + Always + + + + + + + + Indicates the date and time when the second chance offer listing expires, + at which time the listing ends (if the recipient user does not purchase + the item first). + + + + AddSecondChanceItem + Always + + + + + + + + + + + + + + Adds a new product folder to a user's Selling Manager account. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Name of the new Selling Manager inventory folder. + + + + AddSellingManagerInventoryFolder + No + + + + + + + + Unique Folder ID of parent folder. If no <b>ParentFolderID</b> is submitted, Folder + is added to root level. + + + + AddSellingManagerInventoryFolder + No + + + + + + + + Contains comments that will be associated with this folder. + + + + AddSellingManagerInventoryFolder + No + + + + + + + + + + + + + + Returns the status of an add folder operation. + + + + + + + + + New ID of the folder newly created in the user's Selling Manager account. + + + + AddSellingManagerInventoryFolder + Always + + + + + + + + + + + + + + Creates a Selling Manager product. Sellers use Selling Manager products to store SYI forms for use + as listing templates. + + + + Creates a Selling Manager product, which contains templates for repeat listings. + + AddSellingManagerTemplate,GetSellingManagerTemplates,AddSellingManagerInventoryFolder + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Contains product information that the seller has recorded, such as a product + description and inventory and restocking details. + + + + AddSellingManagerProduct + Yes + + + + + + + + Unique identifier of the folder. This ID is created when the folder is added and is returned by the + <b>AddSellingManagerInventoryFolder</b> call. + + + + AddSellingManagerProduct + No + + + + + + + + Specifies an eBay category associated with the product, + defines Item Specifics that are relevant to the product, + and defines variations available for the product + (which may be used to create multivariation listings). + + + + AddSellingManagerProduct + Yes + + + + + + + + + + + + + + Response for the <b>AddSellingManagerProduct</b> call. + + + + + + + + + The details of the product. + + + + AddSellingManagerProduct + Always + + + + + + + + + + + + + + Adds a Selling Manager template. + One product can have up to 20 templates associated with it. + + + GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Contains the data in your template, i.e. the data needed to + list an item. The item data you specify will be used + when you list items from the template you are adding. + + + + AddSellingManagerTemplate + Yes + + + + + + + + The name you provide for the template. If you don't specify + a name, then <b>Item.Title</b> is used as the name. + + + + AddSellingManagerTemplate + No + + + + + + + + The ID of the product with which the template will be associated. + Before calling <b>AddSellingManagerTemplate</b>, you can obtain a product ID + from the response of an <b>AddSellingManagerProduct</b> call. + That is, after you add a product using <b>AddSellingManagerProduct</b>, a product ID is + returned in the <b>SellingManagerProductDetails.ProductID</b> field. + The <b>GetSellingManagerTemplates</b> + call also returns product IDs. + Alternatively, you can obtain information about a user's existing + products, including the product IDs, by calling <b>GetSellingManagerInventory</b>. + + + + AddSellingManagerTemplate + Yes + + + + + + + + + + + + + + Contains values indicating template information for a newly-exported item. + + + + + + + + + ID of the primary category in which the item would be listed. + + + + AddSellingManagerTemplate + Always + + + + + + + + ID of the secondary category (if any) in which the item would be listed. + + + + AddSellingManagerTemplate + Always + + + + + + + + The ID of the Selling Manager template. Store this value, for use in + other Selling Manager calls. + + + + AddSellingManagerTemplate + Always + + + + + + + + Ignore this value. For the output value that indicates the + ID of the product associated with the template, + use SellingManagerProductDetails.ProductID. + + + + AddSellingManagerTemplate + Always + + + + + + + + The name of the template, as it will appear in Selling Manager Pro. + This name is the input value you provided in the SaleTemplateName field. + If you didn't specify a value for + SaleTemplateName, then Item.Title is used as the name. + + + + AddSellingManagerTemplate + Always + + + + + + + + The details of the product with which the template is associated. + + + + AddSellingManagerTemplate + Always + + + + + + + + Child elements contain the estimated listing fees for the new listing template. + Note that the fee will only be charged when an item is created from the template. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + + + + AddSellingManagerTemplate + Always + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Using Feature Packs to Save on Upgrade Fees + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Desc-FeaturePacks.html + + + + + + + + + + + + + + Appends a horizontal rule, then a message about what time the + addition was made by the seller, and then the seller-specified text. + + + + Changing Item Descriptions + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-ModifyingDetails.html + + AddItem, ReviseItem + + + + + + + + + Unique item ID that identifies the target item listing, the description + of which is appended with the text specified in Description. + + + 19 (Note: The eBay database specifies 38. Item IDs are usually 9 to 12 digits) + + AddToItemDescription + Yes + + + + + + + + Specifies the text to append to the end of the listing's description. + Text appended to a listing's description must abide by the rules + applicable to this data (such as no JavaScript) as is the case when + first listing the item. + + + + AddToItemDescription + Yes + + + + + + + + + + + + + + Indicates the success or failure of the attempt to add text to the end of the + item description in the listing. + + + + + + + + + + + + This call is use to add one or more order line items to an eBay user's My eBay Watch List. An auction item or a single-variation, fixed-price listing is identified with an <b>ItemID</b> value. To add a specific item variation to the Watch List from within a multi-variation, fixed-price listing, the user will use the <b>VariationKey</b> container instead. + + + GetMyeBayBuying, GetMyeBaySelling, RemoveFromWatchList + + + + + + + + + The <b>ItemID</b> of the item that is to be added to the eBay user's Watch List. + The item must be a currently active item, and the total number + of items in the user's + Watch List (after the items in the request have been added) cannot exceed + the maximum allowed number of Watch List items. One or more <b>ItemID</b> fields can be specified. A separate error node will be + returned for each item that fails.<br> + <br> + Either <b>ItemID</b> or <b>VariationKey</b> is required + (but do not pass in both). + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddToWatchList + No + + + + + + + + A variation (or set of variations) that you want to add to the Watch List. + Use this to watch a particular variation (not the entire item). + Either the top-level <b>ItemID</b> or <b>VariationKey</b> is required + (but do not pass in both). + + + + AddToWatchList + Conditionally + + + + + + + + + + + + + + Indicates the number of items currently in the user's Watch List and the maximum + number of items allowed in the Watch List. + + + + + + + + + The number of items in the user's watch list (after those specified + in the call request have been added) + + + + AddToWatchList + Always + + + + + + + + The maximum number of items allowed in watch lists. Currently this + value is the same for all sites and all users. + + + + AddToWatchList + Always + + + + + + + + + + + + + + Ends the eBay Motors listing specified by ItemID and creates a new Transaction + Confirmation Request (TCR) for the item, thus enabling the TCR recipient to + purchase the item. You can also use this call to see if a new TCR can be created + for the specified item. + + + + Ends the eBay Motors listing specified by ItemID and creates a new Transaction + Confirmation Request (TCR) for the item, thus enabling the TCR recipient to + purchase the item. You can also use this call to see if a new TCR can be created + for the specified item. + + GetBestOffers, GetBidderList, GetItem, GetSellerList + + Learning About Bidders + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-Bidders.html + + + Enabling Best Offer + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-BestOffer.html + + + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/CRM-Communications.html + CommunicationBetweenMembers + + + + + + + + + + Specifies the user to whom the seller is offering the Transaction + Confirmation Request. + + + + AddTransactionConfirmationItem + Yes + + + + + + + + If true, specifies that the seller is verifying whether a new Transaction + Confirmation Request (TCR) can be created. Thus, if this value is passed + as true, then no Transaction Confirmation Request is actually made. If + VerifyEligibilityOnly is not passed, or is false, a Transaction + Confirmation Request is actually made. + + + + AddTransactionConfirmationItem + No + + + + + + + + Specifies the postal code of the user to whom the seller is offering the + Transaction Confirmation Request. Required only if the user does not meet + the other options listed in RecipientRelationCodeType. An error is + returned if RecipientUserID and RecipientPostalCode do not match for more + than 3 times for a seller per day. + + + + AddTransactionConfirmationItem + No + + + + + + + + Specifies the current relationship between the seller and the potential + buyer. A seller can make a Transaction Confirmation Request (TCR) for an + item to a potential buyer if the buyer meets one of several criteria. A + TCR is sent by a seller to one of the following: a bidder, a best offer + buyer, a member with an ASQ question, or any member with a postal code. + See the values and annotations in RecipientRelationCodeType. + + + + AddTransactionConfirmationItem + Yes + + + + + + + + The amount the offer recipient must pay to buy the item + specified in the Transaction Confirmation Request (TCR). + A negotiated amount between the buyer and the seller. + + + + AddTransactionConfirmationItem + Yes + + + + + + + + Specifies the length of time the item in the Transaction Confirmation + Request (TCR) will be available for purchase. + + + + AddTransactionConfirmationItem + Yes + + + + + + + + The ItemID of the item that the seller wants to end in order to create a + Transaction Confirmation Request (TCR). + + + + AddTransactionConfirmationItem + Yes + + + + + + + + Comments the seller wants to send to the recipient (bidder, best offer + buyer, member with an ASQ question, or member with a postal code). + + + + AddTransactionConfirmationItem + No + + + + + + + + + + + + + + Returns an item ID for a new Transaction Confirmation Request (TCR). + + + + + + + + + The new item ID for the item in the new Transaction Confirmation Request (TCR). + This field is not returned if the request was only used to verify that a new TCR could be created. + + + + AddTransactionConfirmationItem + Conditionally + + + + + + + + The date and time when the item in the new Transaction Confirmation Request (TCR) + becomes available for purchase. + + + + AddTransactionConfirmationItem + Always + + + + + + + + The date and time when the item in the new Transaction Confirmation Request (TCR) + is no longer available for purchase. + + + + AddTransactionConfirmationItem + Always + + + + + + + + + + + + + + Enables a seller to do various tasks after the creation of a single line item or + multiple line item order. Typically, this call is used after the + buyer has paid for the order, but it can be called by the + seller beforehand. Typical post-payment tasks available to this call include + marking the order as paid, marking the order as shipped, providing shipment tracking + details, and leaving feedback for the buyer. + + + + + + + + + + + Unique identifier for an eBay item listing. An <b>ItemID</b> can be paired up + with a corresponding <b>TransactionID</b> and used in the <b>CompleteSale</b> request + to identify a single line item order. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item order, <b>OrderID</b> + must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + + + 19 (Note: The eBay database specifies 38. ItemIDs + are usually 9 to 12 digits) + + CompleteSale + Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). The + <b>TransactionID</b> can be paired up with the corresponding <b>ItemID</b> and used in + the <b>CompleteSale</b> request to identify a single line item order. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item order, <b>OrderID</b> + must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + CompleteSale + Conditionally + + + + + + + + This container is used by the seller to leave feedback for the buyer for the + order line item identified in the call request. The seller must include and + specify all fields of this type, including the buyer's eBay User ID, the + Feedback rating (a seller can only leave a buyer a "Positive" rating), and a + comment, which helps justify the Feedback rating. The eBay User ID must match + the buyer who bought the order line item, or an error will occur. An error will + also occur if Feedback has already been left for the buyer (either through API + or the Web flow). + <br><br> + To determine if Feedback has already been left for an order line item, you can + call <b class="con">GetFeedback</b>, passing in the + <b class="con">OrderLineItemID</b> value in the call request. + + + + CompleteSale + No + + + + + + + + The seller includes and sets this field to true if the order has been + shipped. If the call is successful, the order line item(s) are marked as + Shipped in My eBay. + <br><br> + If the seller includes and sets this field to false, the order line item(s) + are marked (or remain) as Not Shipped in My eBay. + <br><br> + If this field is not included, the shipped status of the order line + item(s) remain unchanged in My eBay. + <br><br> + If shipment tracking information is provided for an order line item through + the Shipment container in the same request, the order line item is marked as + shipped automatically and the <b>Shipped</b> field is not + required. + + + + + CompleteSale + No + + + + + + + + The seller includes and sets this field to true if the buyer has paid for + the order. If the call is successful, the + order line item(s) are marked as Paid in My eBay. + <br><br> + If the seller includes and sets this field to false, the order line item(s) + are marked (or remain) as Not Paid in My eBay. + <br><br> + If this field is not included, the paid status of the order line + item(s) remain unchanged in My eBay. + + + + CompleteSale + No + + + + + + + + This field is required if <b>CompleteSale</b> is being used for a Half.com + order. The value should be set to <i>Half</i>, which is the only applicable + <b>ListingType</b> value for this call. + + + + CompleteSale + Half + Conditionally + + + + + + + + Container consisting of shipment tracking information, shipped time, and an + optional text field to provide additional details to the buyer. Setting the + tracking number and shipping carrier automatically marks the item as shipped + and the <b>Shipped</b> field is not required. + <br><br> + (If you supply <b>ShipmentTrackingNumber</b> you must also supply + <b>ShippingCarrierUsed</b>, otherwise you will get an error. + <br><br> + To modify the shipping tracking number and/or carrier, supply the new number + in <b>ShipmentTrackingNumber</b> or supply the value for + <b>ShippingCarrierUsed</b> or both. The old number and carrier + are deleted and the new ones are added. + <br><br> + To simply delete the current tracking details altogether, supply empty + <b>Shipment</b> tags. + <br> + <br> + <span class="tablenote"><b>Note:</b> + Top-Rated sellers must have a record of uploading shipment tracking + information (through site or through API) for at least 90 percent of their order line + items (purchased by U.S. buyers) to keep their status as Top-Rated sellers. For more + information on the requirements to becoming a Top-Rated Seller, see the + <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top-Rated Seller and qualifying for Top-Rated Plus</a> + customer support page. + </span> + <br> + + + + CompleteSale + No + + + + + + + + A unique identifier that identifies a single line item or multiple line + item order. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For multiple line item orders, the <b>OrderID</b> value is created by eBay + when the buyer is purchasing multiple order line items from the same seller at the same time. + For multiple line item orders not going through the eBay Cart flow, a Combined Invoice order can be created by the seller + through the <b>AddOrder</b> call. The <b>OrderID</b> can be used in the <b>CompleteSale</b> + request to identify a single or multiple line item order. + <br><br> + <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if + these fields are also specified in the same request. + + + + CompleteSale + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. For a single line item order, the + <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field in the + <b>CompleteSale</b> request. + <br><br> + Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line + item order, or the <b>OrderID</b> is used to identify a single or multiple line + item order, the <b>OrderLineItemID</b> must be specified. + For a multiple line item order, <b>OrderID</b> must be + used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are + ignored if present in the same request. + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + CompleteSale + No + + + + + + + + + + + + + + Indicates the success or failure of the attempt to leave feedback for the buyer, + change the paid status in My eBay, and/or change the shipped status in My eBay. + <br><br> + Applies to half.com. + <br><br> + When <b>CompleteSale</b> is applied to a specified order (by specifying <b>OrderID</b>), it + also applies to the child transactions associated with the order. An <b>OrderID</b> cannot be used with half.com items. + + + + + + + + + + + + Returns the ID of a user who has gone through an application's consent flow + process for obtaining an authorization token. + + + FetchToken, GetSessionID, GetTokenStatus, RevokeToken + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + + + + + + + + A string obtained by making a GetSessionID call, passed in redirect + URL to the eBay signin page. + + + + ConfirmIdentity + Yes + + + + + + + + + + + + + + Confirms the identity of the user by returning the UserID and the EIASToken belonging to + the user. + + + + + + + + + Unique eBay user ID for the user. + + + + ConfirmIdentity + Always + + + + + + + + + + + + + + Removes selected messages for a given user. + + + + AddMemberMessagesAAQToBidder, AddMemberMessageRTQ, GetMemberMessages, + GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders + + + + + + + + + + This field is deprecated. + + + + + + + + + + Contains a list of up to 10 MessageID values. + + + + DeleteMyMessages + No + + + + + + + + + + + + + + The response to DeleteMyMessagesRequestType. If the request was successful, + DeleteMyMessages returns nothing. + + + + + + + + + + + + + Removes an inventory folder when a user deletes it in My eBay. + This call is subject to change without notice; the deprecation process is inapplicable + to this call. + + + + Removes a Selling Manager inventory folder. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Unique ID of the folder to be deleted. + + + + DeleteSellingManagerInventoryFolder + No + + + + + + + + + + + + + + Returns the status of delete folder operation. + + + + + + + + + + + + + Removes the association of Selling Manager automation rules + to an item. Returns the remaining rules in the response. + <br><br> + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the item from which to delete automation rules. + + + + DeleteSellingManagerItemAutomationRule + Yes + + + + + + + + If true, the automated relisting rules are removed from the item. + + + + DeleteSellingManagerItemAutomationRule + No + + + + + + + + If true, the automated second chance offer rule is removed from the item. + + + + DeleteSellingManagerItemAutomationRule + No + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified item. + + + + + + + + + Contains the remaining automated listing rules associated with this item. + + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains the remaining automated relisting rules associated with this item. + + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains the remaining automated second chance offer rule associated with this item. + + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rules (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + + + + + + + + + + + + Deletes a Selling Manager product. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + ID of the product to be deleted. + + + + DeleteSellingManagerProduct + Yes + + + + + + + + + + + + + + Response for deleting a Selling Manager product. + + + + + + + + + The details of the product. + + + + DeleteSellingManagerProduct + Always + + + + + + + + + + + + + + Deletes a Selling Manager template. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + ID of the template to be deleted. + You can obtain a SaleTemplateID by calling GetSellingManagerInventory. + + + + DeleteSellingManagerTemplate + Yes + + + + + + + + + + + + + + Response for deleting a Selling Manager template. + + + + + + + + + The unique identifier of the template. + + + + DeleteSellingManagerTemplate + Always + + + + + + + + The name of the Selling Manager template. + + + + DeleteSellingManagerTemplate + Always + + + + + + + + + + + + + + + Removes the association of Selling Manager automation rules + to a template. Returns the remaining rules in the response. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates,SetSellingManagerTemplateAutomationRule + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the template from which you want to remove automation rules. + You can obtain a SaleTemplateID by calling GetSellingManagerInventory. + + + + DeleteSellingManagerTemplateAutomationRule + Yes + + + + + + + + If true, the automated listing rules are removed from the template. + + + + DeleteSellingManagerTemplateAutomationRule + No + + + + + + + + If true, the automated relisting rules are removed from the template. + + + + DeleteSellingManagerTemplateAutomationRule + No + + + + + + + + If true, the automated second chance offer rule is removed from the template. + + + + DeleteSellingManagerTemplateAutomationRule + No + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified template. + + + + + + + + + Contains the remaining automated listing rules associated with this template. + + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains the remaining automated relisting rules associated with this template. + + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains the remaining automated second chance offer rule associated with this template. + + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rules (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + + + Enables a seller who has opted into the automated Unpaid Item Assistant + mechanism to disable the Unpaid Item Assistant at the order line item + level. This call can be made whether or not a Unpaid Item dispute + exists for the order line item. If a dispute has already been created by the + Unpaid Item Assistant, it is converted to a "manual" dispute for the seller to + manage like any other manually-created dispute. + + + + http://pages.ebay.com/sell/UPI/upiassistant/index.html + Unpaid Item Assistant + + + http://pages.ebay.com/sell/UPI/standardprocess/index.html + Understanding the New Unpaid Item Process + + + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. To identify a + specific order line item for which to disable the Unpaid Item Assistant + mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a + <b>DisputeID</b> (if a dispute record already exists) is required in the request. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + DisableUnpaidItemAssistance + Conditionally + + + + + + + + The unique identifier of an order line item (transaction). An order line + item is created once there is a commitment from a buyer to + purchase an item. To identify a specific order line item for which to + disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> + pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> (if a dispute record already + exists) is required in the request. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + DisableUnpaidItemAssistance + Conditionally + + + + + + + + A unique identifier for an Unpaid Item dispute. Any order line item can + only have one dispute record, so <b>DisputeID</b> can be used in the request to + identify a specific order line item. If an <b>ItemID</b>/<b>TransactionID</b> pair or an + <b>OrderLineItemID</b> is used to identify an order line item, <b>DisputeID</b> cannot be used and will be ignored if it is included in the request. + + + + DisableUnpaidItemAssistance + No + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. To identify a specific order line item for which to + disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> + pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> is required in the request. + + + 100 + + DisableUnpaidItemAssistance + Conditionally + + + + + + + + + + + + + + Response to DisableUnpaidItemAssistance request. + + + + + + + + + + + + + Ends the specified fixed-price listing before the date and time at which + it would normally end (per the listing duration). + + + EndItem, RelistFixedPriceItem + + Ending Items Early + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-EndingEarly.html + + + + + + + + + + Unique item ID that identifies the item listing that you want to end. + <br><br> + In the EndFixedPriceItem request, either ItemID or SKU is required. + If both are passed in and they don't refer to the same listing, eBay + ignores SKU and considers only the ItemID. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + EndFixedPriceItem + Conditionally + + + + + + + + Indicates the seller's reason for ending the listing early. This field + is required if the seller is ending the item early and the item did + not successfully sell. + + + + EndFixedPriceItem + Yes + + + + + + + + The unique SKU of the item being ended. A SKU (stock keeping unit) is + an identifier defined by a seller. SKU can only be used to end an + item if you listed the item by using AddFixedPriceItem or + RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU + at the time the item was listed. (These criteria are necessary to + uniquely identify the listing by a SKU.) + <br><br> + In the EndFixedPriceItem request, either ItemID or SKU is required. If + both are passed in and they don't refer to the same listing, eBay + ignores SKU and considers only the ItemID. + <br><br> + To remove a SKU when you revise or relist an item, use DeletedField in + the revision or relist call. + + + 50 + + EndFixedPriceIteme> + Conditionally + + + + + + + + + + + + + + Acknowledgement that includes SKU, as well as the date and time the auction was + ended due to the call to EndFixedPriceItem. + + + + + + + + + Timestamp that indicates the date and time (GMT) that the specified item listing + was ended. + + + + EndFixedPriceItem + Always + + + + + + + + If a SKU (stock-keeping unit) exists for the item listing, it is returned in + the response. + + + 50 + + EndFixedPriceIteme> + Conditionally + + + + + + + + + + + + + + Ends the specified item listing before the date and time at which it would normally end per the listing duration.&nbsp;<b>Also for Half.com</b>. + + + AddItem, EndFixedPriceItem, EndItems, RelistItem + + Ending Items Early + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-EndingEarly.html + + + + + + + + + + Unique item ID that identifies the item listing to end. + <br><br> + For Half.com listings, you can either specify ItemID or + SellerInventoryID. + <br><br> + Applicable to Half.com. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + EndItem + Yes + + + + + + + + Indicates the seller's reason for ending the listing early. + This field is required if the seller is ending the item early and + the item did not successfully sell. + <br><br> + Applicable to Half.com. + + + + EndItem + Yes + + + + + + + + Unique identifier that the seller specified when they listed the + Half.com item. For Half.com items, you can either specify ItemID or + SellerInventoryID. If you specify both ItemID and SellerInventoryID, + they must be for the same item (otherwise an error will occur). + <br><br> + Applicable only to Half.com. + + + + EndItem + Conditionally + + + + + + + + + + + + + + Includes the acknowledgement of date and time the auction was + ended due to the call to EndItem. + + + + + + + + + Indicates the date and time (returned in GMT) the specified item listing + was ended. + Also applicable to Half.com. + + + + EndItem + Always + + + + + + + + + + + + + + Ends up to 10 specified item listings before the date and time at which it would normally end per the listing duration.&nbsp;<b>Also for Half.com</b>. + + + AddItems, EndItem, RelistItem + + Ending Items Early + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-EndingEarly.html + + + + + + + + + + A single container for an end item request. Multiple containers should be used to end multiple items. Up to ten (10) containers can be included + per a given EndItems request. + + + 10 + + EndItems + Yes + + + + + + + + + + + + + + Contains a response of the resulting status of ending each item. + + + + + + + + + Returns a response for an individually ended item. Multiple containers will be listed if multiple items are ended. + + + + EndItems + Always + + + + + + + + + + + + + + Gives approved sellers the ability to extend the default and + ongoing lifetime of pictures uploaded to eBay. + + + + UploadSiteHostedPictures + + + + + + + + + + The URL of the image hosted by eBay Picture Services. + + + + ExtendSiteHostedPictures + No + + + + + + + + The number of days by which to extend the expiration date for the + specified image. + + + + ExtendSiteHostedPictures + No + + + + + + + + + + + + + + Returns the URL of an eBay Picture Services image whose expiration date was + extended. + + + + + + + + + The URL of the site-hosted picture whose expiration date was extended through the <b<ExtendSiteHostedPictures</b< call. This field will be returned if the expiration date of the site-hosted picture was successfully extended. + + + + ExtendSiteHostedPictures + Conditionally + + + + + + + + + + + + + + Retrieves an authentication token for a user.&nbsp;<b>Also for Half.com</b>. + + + ConfirmIdentity, GetSessionID, GetTokenStatus, RevokeToken + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + Getting Tokens for Applications with Multiple Users + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens-MultipleUsers.html#GettingaTokenviaFetchToken + + + + + + + + + + A value associated with the token retrieval request. SecretID is + defined by the application, and is passed in the redirect URL to the + eBay sign-in page. eBay recommends using a UUID for the secret ID + value. You must also set Username (part of the RequesterCredentials) + for the particular user of interest. SecretID and Username are not + required if SessionID is present. + + + + FetchToken + No + + + + + + + + A value associated with the token retrieval request. eBay generates the + session ID when the application makes a GetSessionID request. SessionID + is passed in the redirect URL to the eBay sign-in page. The advantage + of using SessionID is that it does not require UserID as part of the + FetchToken request. SessionID is not required if SecretID is present. + + + + FetchToken + No + + + + + + + + + + + + + + Includes the authentication token for the user and the date it expires. + + + + + + + + + The authentication token for the user. + + + + FetchToken + Always + + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + + + + + + Date and time at which the token returned in eBayAuthToken expires + and can no longer be used to authenticate the user for that application. + + + + FetchToken + Always + + + + + + + + The REST authentication token for the user. + + + + FetchToken + Conditionally + + + + + + + + + + + + + + Returns a seller's invoice data for their eBay account, including the account's + summary data. + + + GetSellerDashboard, GetUser + + Getting Account Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + Testing Applications + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-SandboxTesting.html + + + + + + + + + + This field is used by the user to control which account entries are returned. The user has options to retrieve all new account entries (since last invoice), all account entries between two specified dates, or all account entries from a specified invoice. If this field is not include + + + LastInvoice + + GetAccount + No + + + + + + + + This field is used to retrieve all account entries from a specific invoice, which is identified through this <b>InvoiceDate</b> field with the timestamp of the account invoice. This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'SpecifiedInvoice'; otherwise, this field will be ignored. + + + + GetAccount + Conditionally + + + + + + + + This field is used to retrieve all account entries dating back to the timestamp passed into this <b>BeginDate</b> field up until the timestamp passed into the <b>EndDate</b> field. The <b>BeginDate</b> value can not be set back any further than four months into the past. + <br/><br/> + The allowed date formats are <em>YYYY-MM-DD</em> and <em>YYYY-MM-DD HH:mm:ss</em> The <b>BeginDate</b> value must be less than or equal to the <b>EndDate</b> value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if <em>YYYY-MM-DD</em> format used) or wanted to retrieve a specific account entry (if <em>YYYY-MM-DD HH:mm:ss</em> format used). + <br/><br/> + This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. fiedDates' is used, both the <b>BeginDate</b> and <b>EndDate</b> must be included. + + + + GetAccount + Conditionally + + + + + + + + This field is used to retrieve all account entries dating up to the timestamp passed into this <b>EndDate</b> field dating back to the timestamp passed into the <b>BeginDate</b> field. The <b>EndDate</b> value can not be set for a future date. + <br/><br/> + The allowed date formats are <em>YYYY-MM-DD</em> and <em>YYYY-MM-DD HH:mm:ss</em> The <b>EndDate</b> value must be more than or equal to the <b>BeginDate</b> value. The user might use the same values in both fields if that user wanted to retrieve all account entries from a specific day (if <em>YYYY-MM-DD</em> format used) or wanted to retrieve a specific account entry (if <em>YYYY-MM-DD HH:mm:ss</em> format used). + <br/><br/> + This field is only applicable if the <b>AccountHistorySelection</b> value is set to 'BetweenSpecifiedDates'; otherwise, this field will be ignored. If 'BetweenSpecifiedDates' is used, both the <b>BeginDate</b> and <b>EndDate</b> must be included. + + + + GetAccount + Conditionally + + + + + + + + This container is used to control how many account entries are returned on each page of data in the response. <b>PaginationType</b> is used by numerous Trading API calls, and the default and maximum values for the <b>EntriesPerPage</b> field differs with each call. For the <b>GetAccount</b> call, the default value is 500 (account entries) per page, and maximum allowed value is 2000 (account entries) per page. + + + + GetAccount + No + + + + + + + + By default, the current balance of the user's account will not be returned in the call response. To retrieve the current balance of their account, the user should include the <b>ExcludeBalance</b> flag in the request and set its value to 'false'. The current balance on the account will be shown in the <b>AccountSummary.CurrentBalance</b> field in the call response. + + + true + + GetAccount + No + + + + + + + + Specifies whether to return account summary information in an + AccountSummary node. Default is true, to return AccountSummary. + + + + GetAccount + No + + + + + + + + Specifies whether to retrieve the rate used for the currency conversion for usage transactions. + + + + GetAccount + No + + + + + + + + Specifies how account entries should be sorted in the response, by an + element and then in ascending or descending order. + + + + GetAccount + No + + + + + + + + Specifies the currency used in the account report. Do not specify Currency + in the request unless the following conditions are met. First, the user has + or had multiple accounts under the same UserID. Second, the account + identified in the request uses the currency you specify in the request. An + error is returned if no account is found that uses the currency you specify + in the request. + + + + GetAccount + No + + + + + + + + Specifies the item ID for which to return account entries. If ItemID is + used, all other filters in the request are ignored. If the specified item + does not exist or if the requesting user is not the seller of the item, an + error is returned. + + + + GetAccount + No + + + + + + + + + + + + + + Returns information about an eBay seller's own account. + + + + + + + + + Specifies the seller's unique account number. + + + + GetAccount + Always + + + + + + + + Contains summary data for the seller's account, such as the overall + balance, bank account and credit card information, and amount and + date of any past due balances. Can also contain data for + one or more additional accounts, if the user has changed country + of residence. + + + + GetAccount + Conditionally + + + + + + + + Indicates the currency used for monetary amounts in the report. + + + + GetAccount + Always + + + + + + + + This container holds an array of account entries. The account entries that are returned are dependent on the selection that the user made in the <b>AccountHistorySelection</b> field in the call request. Each <b>AccountEntry</b> container consists of one credit, one debit, or one administrative action on the account. It is possible that no <b>AccountEntry</b> containers will be returned if no account entries exist since the last invoice (if 'LastInvoice' value is used), between the specified dates (if 'BetweenSpecifiedDates' value is used), or on a specified invoice (if 'SpecifiedInvoice' value is used). + + + + GetAccount + Conditionally + + + + + + + + This container shows the total number of account entries and the total number of account entry pages that exist based on the filters used in the <b>GetAccount</b> call request. The total number of account entry pages is partly controlled by the <b>Pagination.EntriesPerPage</b> value that is set in the request. + + + + GetAccount + Always + + + + + + + + If this boolean value is returned as 'true', there are more account entries to view on one or more pages of data. To view additional entries, the user would have to make additional <b>GetAccount</b> calls and increment the value of the <b>Pagination.PageNumber</b> field by '1' to view additional pages of account entries. + + + + GetAccount + Conditionally + + + + + + + + This integer value indicates the number of account entries that are being returned per virtual page of data. This value will be the same value passed into + the <b>Pagination.EntriesPerPage</b> field in the request. + + + + GetAccount + Always + + + + + + + + This integer value indicates the current page number of account entries that is currently being shown. This value will be the same value passed into + the <b>Pagination.PageNumber</b> field in the request. + + + + GetAccount + Always + + + + + + + + + + + + + + Retrieves sales lead information for a lead generation listing. + + + DetailLevel + + + + + + + + + The unique identifier of an item listed on the eBay site. + Returned by eBay when the item is created. This ID must correspond + to an ad format item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetAdFormatLeads + No + + + + + + + + Filters the leads based on their status. + + + + GetAdFormatLeads + No + + + + + + + + Boolean which indicates whether to return mail messages for this lead in a MemberMessage node. + + + + GetAdFormatLeads + No + + + + + + + + Used with EndCreationTime to limit the returned leads for a user to only + those with a creation date greater than or equal to the specified date and + time. + + + + GetAdFormatLeads + Conditionally + + + + + + + + Used with StartCreationTime to limit the returned leads for a user to only + those with a creation date less than or equal to the specified date and + time. + + + + GetAdFormatLeads + Conditionally + + + + + + + + + + + + + + Returns number of leads and contact and other information for each lead. One + AdFormatLead node is returned for each lead. + + + + + + + + + Contains contact and other information for one lead. One node is + returned for each lead. Only returned at a detail level of ReturnAll. At + least one lead must be available for the specified item to return + AdFormatLead. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The total number of leads returned. Only returned if you do not + specify a detail level. + + + + GetAdFormatLeads +
DetailLevel: none
+ Always + + + + + + + + + + + + + + Provides three modes for retrieving a list of the users that bid on + a listing. + + + AddSecondChanceItem + + Making Second Chance Offers for Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-SecondChanceOffers.html#ExtendingaSecondChanceOffer + detailed information on working with the result set. + + + Making Second Chance Offers for Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-SecondChanceOffers.html + + + + + + + + + + The ID of the item. The bidders who bid on this item are returned. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetAllBidders + Yes + + + + + + + + Specifies which bidder information to return. + + + + GetAllBidders + Yes + + + + + + + + Specifies whether return BiddingSummary container for each offer. + + + + GetAllBidders + Conditionally + + + + + + + + + + + + + + Includes the list of bidders for the requested item as part of the general item listing data. Some bidder information is anonymous + to protect bidders from fraud. If the seller makes this API call, the actual ids of all bidders on the seller's item are returned. + If a bidder makes this API call, the bidder's actual id will be returned. Information for all competing bidders or outside watchers + are returned as anonymized userIDs. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + + + Contains a list of OfferType objects. Each + OfferType object represents the data for one bidder and bid. + + + + GetAllBidders + Always + + + + + + + + eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate. + + + + GetAllBidders + Always + + + + + + + + Bid amount offered by the HighBidder. + + + + GetAllBidders + Always + + + + + + + + Specifies an active or ended listing's status in eBay's processing workflow. + If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing + can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. + + + + GetAllBidders + Always + + + + + + + + + + + + + + Reports how many calls your application has made and is allowed to make per hour or day.&nbsp;<b>Also for Half.com</b>. + + + + http://developer.ebay.com/support/certification + Compatible Application Check + + + + + + + + + + + + + + + + Responds to a call to GetApiAccessRules. + + + + + + + + + Contains the description of an API access rule, including the + call name, the application's current daily and hourly usage, + and other values. + + + + GetApiAccessRules + Always + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + A version of the Item Specifics definitions (attribute meta-data) + for the site. + Typically, an application passes the version value that was + returned the last time the application executed this call. + Filter that causes the call to return only the characteristic sets + for which the attribute meta-data has changed since the specified + version. If not specified, all characteristics sets are returned. + The latest version value is not necessarily greater than the + previous value that was returned. Therefore, when comparing + versions, only compare whether the value has changed. + + + + + + + + + + + + An array of characteristic setIDs (which always correspond to + attribute set IDs). + Each characteristic setcorresponds to a level in the eBay + category hierarchy at + which all items share common characteristics. + Multiple categories can be mapped to the same characteristic set. + AttributeSetIDs is an optional input. When IDs are specified, + the call only returns meta-data for the corresponding + characteristic sets. + When no IDs are specified, the call returns all the current + attribute meta-data in the system. + + + + + + + + + + + + If true, includes a list of CategoryMapping nodes in the response. + Each CategoryMapping node specifies category information as well as + attributes and values that your application can auto-fill for + items listed in that category. See the eBay Features Guide for more + information about options for maintaining category data and + auto-filling Item Specifics. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Current version of the Item Specifics meta-data system for + the site. + This value changes each time changes are made to the meta-data. + The current version value is not necessarily greater than + the previous value. Therefore, when comparing versions, only + compare whether the value has changed. + + + + + + + + + + + + A string containing a list of all the attributes that are + applicable to the site (or characteristic sets in the request), + along with related meta-data. + The meta-data specifies all the possible values of each attribute, + the logic for presenting attributes to a user, and rules for + validating the user's selections. Individual + elements are not described in the eBay schema format. + For information about each element in the AttributeData string, + see the attribute model documentation in the + eBay Features Guide (see links below).<br> + <br> + Because this is returned as a string, the XML markup elements + are escaped with character entity references (e.g., + &amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt; + ...). + See the appendices in the eBay Features Guide for general + information about string data types. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + Child elements contain data related to one XSL file. + Multiple XSLFile objects can be returned. However, currently only + one is returned. + + + + + + + + + + + + + + + + + Retrieves Best Offers. + + + DetailLevel + RespondToBestOffer, PlaceOffer + + Enabling Best Offer + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-BestOffer.html + + + Email and Address Privacy Policy + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + + + The ID of the listing for which Best Offer information is to be returned. + See the description of GetBestOffers + for details related to who makes the request and how + ItemID and BestOfferID can be omitted. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetBestOffers + No + + + + + + + + The ID of the Best Offer for which information is to be returned. + See the description of GetBestOffers + for details related to who makes the request and how + ItemID and BestOfferID can be omitted. + + + + GetBestOffers + No + + + + + + + + This optional filter controls whether only active Best Offers are retrieved or + all Best Offers (even Best Offers that were declined or all no longer the "best + offer"). The "All" value can only be specified if an <b>ItemID</b> + value is also supplied in the request. + + + Active + + GetBestOffers + All, Active + No + + + + + + + + Specifies how to create virtual pages in the returned list (such as total + number of entries and total number of pages to return). + + + + GetBestOffers + No + + + + + + + + + + + + + + All Best Offers for the item according to the filter or Best Offer + ID (or both) used in the input. + For the notification client usage, this response includes a + single Best Offer. + + + + + + + + + All Best Offers for the item according to the filter or + Best Offer id (or both) used in the input. The buyer and + seller messages are returned only if the detail level is + defined. Includes the buyer and seller message only if the + ReturnAll detail level is used. + Only returned if Best Offers have been made. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The item for which Best Offers are being returned. + Only returned if Best Offers have been made. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A collection of details about the Best Offers received for a specific item. Empty if there are no Best Offers. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Specifies the number of the page of data to return in the response. + Default is 1 for most calls. For some calls, the default is 0. Specify a + positive value equal to or lower than the number of pages available (which you + determine by examining the results of your initial request). + See the documentation for other individual calls to determine the correct + default value. For GetOrders, PageNumber is only applicable to Half.com (is not + applicable to eBay.com). + + + + 1 + 1 + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Provides information about the data returned, including the number of pages and the number + of entries. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + + + Retrieves all items the user is currently bidding on, and the ones they have won + or purchased. + + + AddItem, GetItem, GetSellerList, RelistItem, ReviseItem + + + + + + Retrieves all items the user is currently bidding on, and the ones they have won + or purchased. + + + + + + + + Indicates whether or not to limit the result set to active items. If true, only + active items are returned and the EndTimeFrom and EndTimeTo filters are + ignored. If false (or not sent), both active and ended items are returned. + + + + GetBidderList + No + + + + + + + + Used in conjunction with EndTimeTo. Limits returned items to only those for + which the item's end date is on or after the date-time specified. Specify an + end date within 30 days prior to today. Items that ended more than 30 days + ago are omitted from the results. If specified, EndTimeTo must also be + specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. + (For information on how to convert between your local time zone and GMT, see + Time Values Note.) This field is ignored if ActiveItemsOnly is true. + + + + GetBidderList + Conditionally + + + + + + + + Used in conjunction with EndTimeFrom. Limits returned items to only those for + which the item's end date is on or before the date-time specified. If + specified, EndTimeFrom must also be specified. Express date-time in the format + YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is + true. Note that for GTC items, whose end times automatically increment by 30 + days every 30 days, an EndTimeTo within in the first 30 days of a listing will + refer to the listing's initial end time. + + + + GetBidderList + Conditionally + + + + + + + + The user for whom information should be returned. If + provided, overrides user defined via RequesterCredentials + in header. + + + + GetBidderList + No + + + + + + + + You can control some of the fields returned in the response by specifying one + of two values in the GranularityLevel field: Fine or Medium. Fine returns + more fields than the default, while setting this field to Medium returns an + abbreviated set of results. + + + Yes + + GetBidderList + No + + + + + + + + + + + + + + Response to a GetBidderList call, which retrieves all items the user is currently bidding on, or + has won or purchased. + + + + + + Response to GetBidderListRequest. + + + + + + + + Data for one eBay bidder. + + + + GetBidderList + Always + + + + + + + + Array of items the bidder has bid on, has won or has lost. + + + + GetBidderList + Always + + + + + + + + + + + + + + Retrieves the latest eBay category hierarchy for a given eBay site. + Information returned for each category includes the category name + and the unique ID for the category (unique within the eBay site for which + categories are retrieved). A category ID is a required input when you list most items. + + + + Retrieves the latest eBay category hierarchy for a given eBay site. + Information returned for each category includes the category name + and the unique ID for the category (unique within the eBay site for which + categories are retrieved). A category ID is a required input when you list most items. + + DetailLevel + + Categories + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Categories.html + + + GetCategoryFeatures, + GetCategoryMappings, GetCategorySpecifics, GetSuggestedCategories + + + + + + + + + + Specifies the eBay site for which to retrieve the category + hierarchy. + Use the numeric site code (e.g., 77 for eBay Germany). + Only necessary if you want to retrieve category data + for a site other than the site from which you are + submitting the request. + <br> + <br> + NOTE: If you are using the GetCategories call with eBay Motors, you + must set the Site ID in the Request Header to 0, and then set + the CategorySiteID to 100. These are both required fields when + using GetCategories with eBay Motors. + + + + GetCategories + No + The site ID of the request + + + + + + + + Specifies the ID of the highest-level category to return, + along with its subcategories. + If no parent category is specified, all categories are + returned for the specified site. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) + To determine available category IDs, call GetCategories with + no filters and use a DetailLevel value of ReturnAll. + If you specify multiple parent categories, the hierarchy for + each one is returned. + + + + GetCategories + No + + + + + + + + + Specifies the maximum depth of the category hierarchy to retrieve, + where the top-level categories (meta-categories) are at level 1. + Retrieves all category nodes with a category level less than or + equal to this value. + If not specified, retrieves categories at all applicable levels. + As with all calls, the actual data returned will vary depending + on how you configure other fields in the request + (including DetailLevel). + + + + GetCategories + No + 0 + + + + + + + + This flag controls whether all eBay categories (that satisfy input filters) are + returned, or only leaf categories (you can only list items in leaf categories) + are returned. The default value is 'true', so if this field is omitted, all eBay + categories will be returned. If you only want to retrieve leaf categories, + include this flag and set it to 'false'. The actual data returned will vary + depending on how you configure other fields in the request. + + + + GetCategories + No + true + + + + + + + + + + + + + + Contains the category data for the eBay site specified as input. The category + data is contained in a CategoryArrayType object, within which are zero, one, or + multiple CategoryType objects. Each CategoryType object contains the detail data + for one category. Other fields tell how many categories are returned in a call, + when the category hierarchy was last updated, and the version of the category + hierarchy (all three of which can differ from one eBay site to the next). + + + + + + + + + List of the returned categories. The category array contains one CategoryType + object for each returned category. Returns empty if no detail level is specified. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + Indicates the number of categories returned (i.e., the number of CategoryType + objects in CategoryArray). + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + Indicates the last date and time that eBay modified the category hierarchy for the + specified eBay site. + + + + GetCategories +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + Indicates the version of the category hierarchy on the + specified eBay site. + + + + GetCategories +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + If true, ReservePriceAllowed indicates that all categories on the + site allow the seller to specify a reserve price for an item. + If false, this field is not returned in the response and all categories on the site do not normally allow sellers to specify reserve prices. + The Category.ORPA (override reserve price allowed) field can override (or toggle) + the reserve price allowed setting for a given category. + For example, if ReservePriceAllowed is false and Category.ORPA is true, + the category overrides the site setting and supports reserve prices. + If ReservePriceAllowed is true and Category.ORPA is true, the category + overrides the site setting and does not support reserve prices. + + + + GetCategories +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + Indicates the lowest possible reserve price allowed for any item + listed in any category on the site. You can use the fields returned by GetCategoryFeatures to determine if a different Minimum Reserve Price is defined for the category you want to use. + + + + GetCategories +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + If true, ReduceReserveAllowed indicates that all categories on the + site allow the seller to reduce an item's reserve price. + If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an + item's reserve price. + The Category.ORRA (override reduce reserve price) field can override (or toggle) + the reserve price reduction setting for a given category. + For example, if ReduceReserveAllowed is false and Category.ORRA is true, + the category overrides the site setting and supports reducing reserve prices. + If ReduceReserveAllowed is true and Category.ORRA is true, the category + overrides the site setting and does does not support reducing reserve prices. + + + + GetCategories +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + + + + + + + No longer recommended in general, although this call may still be used to + determine whether a category is catalog-enabled. All other features of this call + are no longer functional. + + + + No longer recommended. + + + + + + + + + + ID of a category for which to retrieve mappings. + If not specified, the call + retrieves a map for all categories. + + + 10 + + GetCategory2CS + No + + + + + + + + A version of the mappings for the site. + Typically, an application passes the version value that was returned the last + time the application executed this call. + Filter that causes the call to return only the categories + for which the mappings have changed since the specified version. + If not specified, all category-to-characteristics set mappings are returned. + This value changes each time changes are made to the mappings. + The current version value is not necessarily greater than the previous + value. Therefore, when comparing versions, only compare whether the + value has changed. + + + + GetCategory2CS + No + + + + + + + + + + + + + + Only applicable for determining whether a category is catalog-enabled. + + + 773 + Avoid + GetCategoryFeatures, FindProducts + 889 + + + + + + + + + Contains data about categories that are mapped to characteristics sets. + Use this data to determine:<br> + - The names and IDs of the characteristics sets<br> + - The availability of the Pre-filled Item Information feature for listings in that category + (i.e., whether the category is catalog-enabled)<br> + - For catalog-enabled categories, the available product search methods<br> + - The current version information for the complete mapping<br> + - The version information for each characteristics set + + + + GetCategory2CS +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains data about categories (if any) whose characteristics set mappings have changed + since the version specified in the request. When a characteristics set mapping + changes, the data appears in both the UnmappedCategoryArray object + (to indicate that the change occurred) and the MappedCategoryArray object. + + + + GetCategory2CS +
DetailLevel: ReturnAll
+ Conditionally + 773 + Avoid + + 889 + + + + + + + + Current version of the mappings for the site. + This value changes each time changes are made to the mappings. + The current version value is not necessarily greater than the previous + value. Therefore, when comparing versions, only compare whether the + value has changed. + + + + GetCategory2CS +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + A list of one or more characteristics sets mapped to the category, if any. Use this + information when working with Item Specifics (Attributes) and Pre-filled Item + Information (Catalogs) functionality. + + + + GetCategory2CS +
DetailLevel: ReturnAll
+ Conditionally + 773 + Avoid + GetCategoryFeatures + 889 + + + + + + + + + + + + + + Returns information about the features that are applicable to different categories, + such as listing durations, shipping term requirements, and Best Offer support. + + + DetailLevel + + Categories + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Categories.html + + GetCategories, GetCategorySpecifics, GeteBayDetails + + + + + + + + + Specifies the category for which you want to retrieve the feature settings. + <br><br> + Specify a CategoryID, set DetailLevel to ReturnAll, and set + ViewAllNodes to true to return the default site settings, the + overrides for the specified category, plus all the child + categories that have overrides on the features they inherit. + <br><br> + If you also set AllFeaturesForCategory to true, eBay returns the site + defaults, plus all the settings for the specified category. Child + category information is not returned in this case. + <br><br> + If CategoryID is not specified, eBay returns the feature settings for + the site. To return details on all categories that have overrides on + the properties they inherit, set DetailLevel to ReturnAll, and set + ViewAllNodes to true. If you also set AllFeaturesForCategory to true, + eBay returns only the site defaults with no child category information. + + + 10 + + GetCategoryFeatures + No + + + + + + + + A level of depth in the category hierarchy. Retrieves all category + nodes with a CategoryLevel less than or equal to the LevelLimit + value. + + + + GetCategoryFeatures + No + + + + + + + + You must set DetailLevel to ReturnAll in order to correctly populate the + response when you set ViewAllNodes to true. In this case, eBay returns the + site defaults along with all the categories that override the feature + settings they inherit. Here, each Category container shows only the + features that it has overridden from its parent node. + <br><br> + If you also specify a CategoryID, eBay returns the details for that category, + along with containers for each of its child categories that have feature + overrides. + <br><br> + Note that if ViewAllNodes is set to false (the default) and DetailLevel is + set to ReturnAll, eBay returns only the leaf categories that have features + that override the settings they inherit. In this case, the call will not + return leaf categories that do not have overrides. + + + + GetCategoryFeatures + No + false + + + + + + + + Use this field if you want to know if specific features are enabled at the site + or root category level. Multiple <b>FeatureID</b> elements can be + used in the request. If no <b>FeatureID</b> elements are used, the + call retrieves data for all features, as applicable to the other request + parameters. + + + + DutchBINEnabled, DigitalDeliveryEnabled, BasicUpgradePack, ExpressEnabled, ExpressPicturesRequired, ExpressConditionRequired, TransactionConfirmationRequestEnabled, StoreInventoryEnabled, MaximumBestOffersAllowed, ClassifiedAdMaximumBestOffersAllowed, ClassifiedAdContactByEmailAvailable, ClassifiedAdPayPerLeadEnabled, ItemSpecificsEnabled, CombinedFixedPriceTreatment, PayPalRequiredForStoreOwner, AttributeConversionEnabled, PaymentOptionsGroup, VINSupported, VRMSupported, SellerProvidedTitleSupported, DepositSupported + GetCategoryFeatures + No + + + + + + + + + Use this switch to view all of the feature settings for a specific category. + All feature settings are returned, regardless of the site default settings. + This element works in conjunction with CategoryID--refer to the notes for + that element for more details. + <br><br> + If you also set FeatureID, eBay returns the status of the specified + features only, for the specified category. + + + + GetCategoryFeatures + No + false + + + + + + + + + + + + + + + + + + Returns the current version of the set of feature meta-data. + Compare this value to the version of the last version you + downloaded to determine whether the data may have changed. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + category hierarchy were last updated. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + A category whose feature settings are different from the settings of its parent category.<br> + <br> + For example, suppose there is a branch of the category tree with 5 category levels + (L1, L2, L3, L4, and L5). Suppose the feature settings for SiteDefaults, L1, L4, and L5 + are all "A", and the settings for L2 and L3 are "B". In this case:<br> + L1's settings (A) match the site default, so L1 is not returned.<br> + L2's settings (B) are different from L1's, so L2 is returned.<br> + L3's settings (B) are the same as L2's, so L3 is not returned<br> + L4's settings (A) are different from L3's, so L4 is returned<br> + L5's settings (A) are the same as L4's, so L5 is not returned.<br> + <br> + If you specified a particular FeatureID in the request, this field + only returns feature settings for that feature. + Only returned when the category is different from its parent. + If the category has children and they aren't returned, + it means the children inherit the category's feature settings. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Returns the feature settings defined for most categories on the site. + Most categories share these settings. However, some categories can + override some settings, as indicated in the Category nodes + (if any). + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Always + + + + + + + + Returns definitions of the various features on the site, + or the features you requested in FeatureID (if any). + Each feature has a node within FeatureDefinitions. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + + + Retrieves a map of old category IDs and corresponding active + category IDs defined for the site to which the request is sent. + + + + GetCategories, GetCategoryFeatures + + DetailLevel + + Maintaining Category Data + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Categories-DataMaintenance.html#MappingOldCategoryIDstoCurrentIDs + + + Maintaining Category Data + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Categories-DataMaintenance.html + + + + + + + + + + A version of the category mapping for the site. Filters + out data from the call to return only the category + mappings for which the data has changed since the + specified version. If not specified, all category + mappings are returned. Typically, an application passes + the version value of the last set of category mappings + that the application stored locally. The latest version + value is not necessarily greater than the previous value + that was returned. Therefore, when comparing versions, + only compare whether the value has changed. + + + + GetCategoryMappings + No + + + + + + + + + + + + + + Returns a map of old category IDs and corresponding active category IDs defined + for the site to which the request was sent. Typically used to update an older item + definition with a new category ID prior to listing the item. + + + + + + + + + Mapping between an old category ID and an active category ID. Returned when + category mappings exist and the value of CategoryVersion is different from + the current version on the site. + + + + GetCategoryMappings +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Version value assigned to the current category mapping data for the site. + Compare this value to the version value the application stored with the mappings + the last time the application executed the call. If the versions are the same, + the data has not changed since the last time the data was retrieved and stored. + + + + GetCategoryMappings +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + + + + + + + Returns the most popular custom Item Specific names and values for each + category you request. + + + + AddItem, GetCategories, GetCategoryFeatures + + samples + + Working with Custom Item Specifics + + + + + + + + + + + An eBay category ID. This call retrieves recommended + Item Specifics (if any) for each category you specify. + To determine which categories support listing with custom + Item Specifics, use GetCategoryFeatures. + <br><br> + <span class="tablenote"><b>Note:</b> + This call may return recommendations for categories that don't + support listing with custom Item Specifics. That is, the + presence of recommendations for a category does not necessarily + mean that AddItem supports custom Item Specifics for that + category and site. + </span> + <br><br> + The request requires either CategoryID, CategorySpecifics.CategoryID, or + CategorySpecificsFileInfo (or the call returns an error). CategoryID and + CategorySpecific.CategoryID can both be used in the same request. + (CategorySpecific offers more options to control the response.) + Some input fields, such as IncludeConfidence, only work when + CategoryID or CategorySpecifics.CategoryID is specified. + <br><br> + You can specify multiple categories, but more categories can result in + longer response times. If your request times out, specify fewer IDs. If you + specify the same ID twice, we use the first instance. + + + + 100 + GetCategorySpecifics + Conditionally + + + + + + + + Causes the recommendation engine to check whether the list of + popular Item Specifics for each specified category has changed + since this date and time. If specified, this call returns no + Item Specifics; it only returns whether the data has changed + for any of the requested categories.<br> + <br> + Typically, you pass in the Timestamp that was + returned the last time you refreshed the list of names and values + for the same categories. If the Updated flag returns true for any + categories in the response, call GetCategorySpecifics again + for those categories to get the latest names and values. + (As downloading all the data may affect your application's + performance, it may help to only download Item Specifics + for a category if they have changed since you last checked.) + + + + GetCategorySpecifics + Conditionally + + + + + + + + Maximum number of Item Specifics to return + per category (where each Item Specific is identified + by a unique name within the category). + Use this to retrieve fewer results per category. + For example, if you only want up to 2 per category + (the top 2 most popular names), specify 2. + + + 1 + 30 + 10 + + GetCategorySpecifics + No + + + + + + + + Maximum number of values to retrieve per item specific. + The best practice for using this field depends on your use case. + For example, if you want all possible values (such as all brands + and sizes in a clothing category), then specify a very large + number. (This is recommended in most cases.) If you only want the most popular value (like the most popular color), then specify a small number. + + + 1 + 2147483647 + 25 + + GetCategorySpecifics + No + + + + + + + + The name of one Item Specific name to find values for. + Use this if you want to find out whether a name + that the seller provided has recommended values. + If you specify multiple categories in the request, + the recommendation engine returns all matching + names and values it finds for each of those categories. + At the time of this writing, this value is case-sensitive. + (Wildcards are not supported.)<br> + <br> + Name and CategorySpecific.ItemSpecific can be used in the + request. (If you plan to only use one or the other in your application, + you should use ItemSpecific, as it may offer more options in the future.) + + + 30 + + GetCategorySpecifics + No + + + + + + + + Applicable with request version 609 and higher. (This + does not retrieve data at all if your request version is lower + than 609.) + Contains a category for which you want recommended + Item Specifics, and (optionally) names and values to help + you refine the recommendations. + You can specify multiple categories (but more categories + can result in longer response times). If you specify the same + category twice, we use the first instance.<br> + <br> + Depending on how many recommendations are found, your request + may time out if you specify too many categories. + (Typically, you can download recommendations for about 275 + categories at a time.)<br> + <br> + CategoryID and CategorySpecific.CategoryID can be used + in the request. (If you plan to only use one or the other in + your application, you should use CategorySpecific, + as it may offer more options in the future.) + + + 275 + + GetCategorySpecifics + Conditionally + + + + + + + + If true, the Relationship node is not returned for any + recommendations. Relationship recommendations tell you whether + an Item Specific value has a logical dependency another + Item Specific.<br> + <br> + For example, in a clothing category, Size Type could be + recommended as a parent of Size, because Size=Small would + mean something different to buyers depending on whether + Size Type=Petite or Size Type=Plus.<br> + <br> + In general, it is a good idea to retrieve and use relationship + recommendations, as this data can help buyers find the items + they want more easily. + + + + GetCategorySpecifics + false + No + + + + + + + + If true, returns eBay's level of confidence in the popularity of + each name and value for the specified category. + Some sellers may find this useful when + choosing whether to use eBay's recommendation or their own + name or value.<br> + <br> + Requires CategoryID to also be passed in.<br> + <br> + If you try to use this with CategorySpecificsFileInfo + but without CategoryID, the request fails and no + TaskReferenceID or FileReferenceID is returned. + + + + GetCategorySpecifics + false + No + + + + + + + + If true, the response includes FileReferenceID and + TaskReferenceID. Use these IDs as inputs to the downloadFile + call in the eBay File Transfer API. That API lets you retrieve + a single (bulk) GetCategorySpecifics response with all the Item + Specifics recommendations available for the requested site ID. + (The downloadFile call downloads a .zip file as an + attachment.)<br> + <br> + Either CategorySpecificsFileInfo or a CategoryID is required + (or you can specify both). <br> + <br> + <span class="tablenote"><b>Note:</b> + You can use the File Transfer API without using or learning + about the Bulk Data Exchange API or other + Large Merchant Services APIs. + </span> + <br> + + + + GetCategorySpecifics + Conditionally + + + downloadFile in the File Transfer API + http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html + + + + + + + + + + + + + + Calls made form seller or buyer find out what the most relevant tags and values are for a given category + + + + + + + + + Contains the most popular Item Specifics, if any, for a category + specified in the request, or contains information about whether + the recommendations have changed for that category since + the LastUpdateTime you requested. <br> + <br> + The most relevant Item Specifics (as determined by eBay) + are returned first. In many cases, the values are returned in + alphabetical order.<br> + <br> + This node returns empty (or it's not returned) for a category if + there is no applicable data (such as when you request a parent category, a category that has no popular Item Specifics yet, + or a duplicate category that was already returned). + If you pass in the CategoryID and Name fields together, but no + matching values are found for the name, eBay returns the name + with no values (even if the name is not recommended).<br> + <br> + If GetCategoryFeatures indicates that custom Item Specifics are + enabled for a category, but GetCategorySpecifics doesn't + return any recommendations for that category, the seller can still + specify their own custom Item Specifics in that category. + + + 275 + + GetCategorySpecifics + Conditionally + + + + + + + + Use TaskReferenceID and FileReferenceID as inputs to the + downloadFile call in the eBay File Transfer API. That API lets + you retrieve a single (bulk) GetCategorySpecifics response with + all the Item Specifics recommendations available for the + requested site ID. (The downloadFile call downloads a .zip file + as an attachment.)<br> + <br> + Only returned when CategorySpecificsFileInfo is passed in the + request. + + + + GetCategorySpecifics + Conditionally + + + downloadFile in the File Transfer API + http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html + + + + + + + + Use TaskReferenceID and FileReferenceID as inputs to the + downloadFile call in the eBay File Transfer API. That API lets + you retrieve a single (bulk) GetCategorySpecifics response with + all the Item Specifics recommendations available for the + requested site ID. (The downloadFile call downloads a .zip file + as an attachment.)<br> + <br> + Only returned when CategorySpecificsFileInfo is passed in the + request. + + + + GetCategorySpecifics + Conditionally + + + downloadFile in the File Transfer API + http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html + + + + + + + + + + + + + + Retrieves a botblock token and URLs for an image or audio clip that the user is to + match. + + + ValidateChallengeInput, PlaceOffer + + + + + + + + + + + + + Response to GetChallengeToken request. + + + + + + + + + Botblock token that is used to validate that the user is a human and not a bot. + + + + GetChallengeToken + Always + + + + + + + + The URL of the image your application should display to + the user for a botblock challenge. + + + + GetChallengeToken + Always + + + + + + + + The URL of the audio clip your application should provide for sight-impaired users. + The audio clip corresponds to the image. + + + + GetChallengeToken + Always + + + + + + + + + + + + + + Searches for nonprofit charity organizations that meet the + criteria specified in the request. + It is recommended that you use at least one input filter, because this call + no longer returns all charities when made without filters. + + + + AddFixedPriceItem, AddItem, AddItems, GetItem, GetItemTransactions, + GetSellerTransactions, GetSellerList, RelistFixedPriceItem, RelistItem, + ReviseFixedPriceItem, ReviseItem, VerifyAddItem, VerifyRelistItem + + + Identifying Listings that Benefit Nonprofits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-NonprofitSupport.html + + + + + + + + + + A unique identification number assigned by eBay to registered nonprofit + charity organizations. + + + + GetCharities + No + + + + + + + + A name assigned to a specified nonprofit + organization. Accepts full charity nonprofit name + or partial name as input. For example, enter a + CharityName of "heart" (case-insensitive) to + return all charity nonprofits that start with + "heart." Use with a MatchType value of "Contains" + to return all charity nonprofits that contain the + string "heart." + + + 150 + + GetCharities + No + + + + + + + + Accepts a case-insensitive string used to + find a nonprofit charity organization. Default + behavior is to search the CharityName field. Use + with an IncludeDescription value of true to + include the Mission field in the search. + + + 350 (characters) + + GetCharities + No + + + + + + + + Region that the nonprofit charity organization is associated + with. A specific nonprofit charity organization may be associated + with only one region. Meaning of input values differs depending on + the site. See GetCharities in the API Developer's Guide for the meaning + of each input/output value. CharityRegion input value must be + valid for that SiteID. + + + + GetCharities + No + + + + + + + + Domain (mission area) that a nonprofit charity organization + belongs to. Nonprofit charity organizations may belong to multiple + mission areas. Meaning of input values differs depending on the + site. + + + + GetCharities + No + + + + + + + + Used with Query to search for charity nonprofit + organizations. A value of true will search the Mission field as + well as the CharityName field for a string specified in Query. + + + + GetCharities + No + + + + + + + + Indicates the type of string matching to use when a value is submitted in + CharityName. If no value is specified, default behavior is "StartsWith." + Does not apply to Query. + + + + GetCharities + No + + + + + + + + Used to decide if the search is only for featured charities. + A value of true will search for only featured charities. + + + + GetCharities + No + + + + + + + + Reserved for future use. + + + + + + + + + + + + + + + + Contains information about charity nonprofit organizations that meet the + criteria specified in the request. + + + + + + + + + Contains information about charity nonprofit organizations that + meet the criteria specified in the request. One Charity node is + returned for each applicable nonprofit charity organization. The + CharityID value is returned as an id attribute of this node. If no + nonprofit charity organization is applicable, this node is not + returned. + + + + GetCharities + Conditionally + + + + + + + + + + + + + + Retrieves a token required for the GetUserAlerts call in the Client Alerts API. + + + SetNotificationPreferences + + http://developer.ebay.com/DevZone/client-alerts/docs/CallRef/index.html + Client Alerts API Call Reference + + + + + + + + + + + + + + Returns a Client Alerts token. + + + + + + + + + This token string is required for the Login call in the Client Alerts API. + The Client Alerts GetUserAlerts call, which returns alerts about events + associated with a specific user, requires Login. + + + + GetClientAlertsAuthToken + Always + + + + + + + + A Client Alerts token expires after seven days. + + + + GetClientAlertsAuthToken + Always + + + + + + + + + + + + + + Retrieves top-ranked contextual eBay keywords and categories + for a specified web page. + + + SG, HK + + + + + + + + + The URL of the web page from which eBay is to extract keywords. + + + + GetContextualKeywords + Yes + + + + + + + + Web page encoding by which the URL is to be handled, such as ISO-8859-1. + + + + GetContextualKeywords + Yes + + + + + + + + The ID of the category to which keywords are to be limited. + Zero or more category IDs can be specified. + + + + GetContextualKeywords + No + + + + + + + + + + + + + + Response to a GetContextualKeywords request. + + + + + + + + + An array of either keyword/category pairs or categories, with ranking and score. + + + + GetContextualKeywords + Always + + + + + + + + + + + + + + <b>No longer recommended.</b> The eBay Store Cross Promotions are no longer + supported in the Trading API. Retrieves a list of upsell or cross-sell items associated + with the specified Item ID. + + + GetPromotionRules, SetPromotionalSale + + Cross-Promotions + + + + + + + + + + + The unique ID of the referring item. The cross-promoted + items will supplement this item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetCrossPromotions + Yes + + + + + + + + The cross-promotion method you want to use for the + returned list, either UpSell or CrossSell. + + + + GetCrossPromotions + Yes + + + + + + + + The role of the person requesting to view the cross-promoted + items, either seller or buyer. Default is buyer. + + + + GetCrossPromotions + No + + + + + + + + + + + + + + <b>No longer recommended.</b> The eBay Store Cross Promotions are no longer supported in the Trading API, so the + <b>CrossPromotion</b> container will either not be returned, or, if it is + returned, the data in the container may not be accurate. Returns a list of either upsell or cross-sell items for a given item ID. + The list can be filtered by the viewer's role, either buyer or seller. + + + + + + + + + eBay Store Cross Promotions are no longer supported in the Trading API, so the + <b>CrossPromotion</b> container will either not be returned, or, if it + is returned, the data in the container may not be accurate. A list of cross-promoted + items defined for a specific referring item. The list is either upsell or cross-sell + items, according to the value of <b>PromotionMethod</b> in + <b>GetCrossPromotionsRequest</b>. + <br> + Not applicable to Half.com. + + + + GetCrossPromotions + Always + + + + + + + + + + + + + Retrieves the DescriptionTemplates for a category. + + + + + + + Retrieves Theme and Layout specifications for the display of an item's description. + + + + Using Description Templates + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/DescTemplates.html + + + + + + + + + + The category for which to retrieve templates. Enter any + category ID, including Motors vehicle categories. This + is ignored if you also send MotorVehicles. + + + 10 + + GetDescriptionTemplates + No + + + + + + + + If specified, only those templates modified on or after the + specified date are returned. If not specified, all templates are returned. + + + + GetDescriptionTemplates + No + + + + + + + + Indicates whether to retrieve templates for motor vehicle + categories for eBay Motors (site 100). If true, templates + are returned for motor vehicle categories. If false, + templates are returned for non-motor vehicle categories + such as Parts and Accessories. If included as an input field (whether true or false), this overrides any value provided for CategoryID. + + + + GetDescriptionTemplates + No + + + + + + + + + + + + + Returns one or more DescriptionTemplate nodes. Each DescriptionTemplate node contains the information for one Theme or one Layout. DescriptionTemplate.DescriptionTemplateType indicates whether it contains data for a Theme or a Layout. + + + + + + + Returned after calling GetDescriptionTemplatesRequest. + + + + + + + + + The information for one Theme or one Layout. There + can be multiple DescriptionTemplates. + + + + GetDescriptionTemplates + Always + + + + + + + + The number of Layout templates returned (that is, the + number of DescriptionTemplates for which Type is "Layout"). + + + + GetDescriptionTemplates + Always + + + + + + + + The ID of a returned layout that is obsolete. There can be zero or more IDs. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + The ID of a returned theme that is obsolete. There can be zero or more IDs. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + Data for one theme group. There can be multiple + ThemeGroups in the response. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + The number of Theme templates returned (that is, the number + of DescriptionTemplates for which Type is "Theme"). + + + + GetDescriptionTemplates + Always + + + + + + + + + + + + + + Retrieves the details of a specific eBay dispute corresponding to the supplied dispute ID. + + + + AddDispute, AddDisputeResponse, GetItemTransactions, GetSellerTransactions, + GetUserDisputes, SellerReverseDispute + + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + Buyer Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Disputes-Buyer.html + + + Getting Details About a Dispute + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-DisputesGettingDetails.html + + + + + + + + + + The unique identifier of an eBay dispute. The caller passes in this value to + retrieve detailed information on a specific dispute. + + + + GetDispute + Yes + + + + + + + + + + + + + + Returned after calling GetDisputeRequest. Returns the record of + a dispute, including the dispute state and other information. + <br><br>Both Sellers and Buyers can use the SellerClosedDispute in + Platform Notifications to receive a notification when a dispute has been closed. + The notification includes the same data that is returned in the GetDispute response. + + + + + + + + + The dispute record, containing information about + the buyer, seller, dispute state, dispute status, + comments added to the dispute, or resolutions. + + + + GetDispute + Always + + + + + + + + + + + + + + The <b>GetFeedback</b> call is to used to retrieve one, many, or all Feedback records for a specific eBay user. There is a filter option in the call request to limit Feedback records to those that are received, or to those that are left for other buyers, as well as a filter option to limit Feedback records to those that are received as a buyer or seller. + + + DetailLevel + LeaveFeedback, GetSellerDashboard, GetSellerTransactions + + Leaving and Retrieving Feedback + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Introduction to Feedback + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Getting Feedback Left By Another User + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + + + + + + + + The user's eBay User ID is specified in this field. If this field is used, all retrieved Feedback data will be for this eBay user. Specifies the user whose feedback data is to be returned. If this field is omitted in the call request, all retrieved Feedback records will be for the eBay user making the call. + + + + GetFeedback + No + + + + + + + + The unique identifier of a Feedback record. This field is used if the user wants to retrieve a specific Feedback record. If <b>FeedbackID</b> is specified in the call request, all other input fields are ignored. + + + + GetFeedback + No + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items, but only one <b>ItemID</b>. If <b>ItemID</b> is + specified in the <b>GetFeedback</b> request, the returned Feedback record(s) are + restricted to the specified <b>ItemID</b>. The maximum number of Feedback records that can be returned is 100. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetFeedback + No + + + + + + + + Unique identifier for an eBay order line item. A + <b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as + an input filter in the <b>GetFeedback</b> request. If an <b>ItemID</b>/<b>TransactionID</b> + pair or an <b>OrderLineItemID</b> value is used to retrieve a Feedback record + on a specific order line item, the <b>FeedbackType</b> and <b>Pagination</b> + fields (if included) are ignored. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetFeedback + No + + + + + + + + This field is used to retrieve Feedback records of a specific type (Positive, Negative, or Neutral) in + <b>FeedbackDetailArray</b>. You can include one or two <b> + CommentType</b> fields in the request. If no + <b>CommentType</b> value is specified, + Feedback records of all types are returned. + + + + GetFeedback + No + + + + + + + + This field is used to restrict retrieved Feedback records to those that the user left for other buyers, Feedback records received as a seller, Feedback records received as a buyer, or Feedback records received as a buyer and seller. The default value is <b>FeedbackReceived</b>, so if the <b>FeedbackType</b> field is omitted in the request, all Feedback records received by the user as a buyer and seller are returned in the response. "Feedback Left" data will not be returned in the call response. + + + FeedbackReceived + + GetFeedback + No + + + + + + + + Controls the pagination of the result set. Child elements, <b>EntriesPerPage</b> and + <b>PageNumber</b>, specify the maximum number of individual feedback records to return + per call and which page of data to return. Only applicable if <b>DetailLevel</b> is + set to <b>ReturnAll</b> and the call is returning feedback for a <b>UserID</b>. Feedback + summary data is not paginated, but when pagination is used, it is returned + after the last feedback detail entry. + <br><br> + Accepted values for <b>Pagination.EntriesPerPage</b> for GetFeedback is 25 (the + default), 50, 100, and 200. If you specify a value of zero, or a value + greater than 200, the call fails with an error. If you specify a value between + one and twenty-four, the value is rounded up to 25. Values between 26 and 199 + that are not one of the accepted values are rounded down to the nearest + accepted value. + + + + GetFeedback + No + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. An <b>OrderLineItemID</b> can be used as an + input filter in the <b>GetFeedback</b> request. If an <b>OrderLineItemID</b> value is + used to retrieve a feedback record on a specific order line item, the + <b>FeedbackType</b> and <b>Pagination</b> fields (if included) are ignored. + + + 100 + + GetFeedback + No + + + + + + + + + + + + + + The GetFeedback response contains the feedback summary if a + TransactionID or ItemID is specified, and contains the specified user's total + feedback score and feedback summary data if a UserID is specified. If no + value is supplied, the feedback score and feedback summary for the requesting + user will be returned. + <br> + If a detail level value of ReturnAll is specified, an array of all feedback + records will be returned. + + + + + + + + + Contains the individual feedback records for the user or order line item specified in the request. There is one FeedbackDetailType + object for each feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify FeedbackID in the request. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the number of FeedbackDetailType objects returned in the + FeedbackDetailArray property. Only applicable if feedback details are + returned. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Summary feedback data for the user. Contains counts of positive, neutral, + and negative feedback for pre-defined time periods. Only applicable if feedback details are returned. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates the total feedback score for the user. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Contains information regarding the pagination of data (if pagination is + used), including total number of pages and total number of entries. This + is only applicable when a User ID or no ID (requester option) is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates the number of entries (feedback detail) that are being + returned per page of data (i.e., per call). + Only returned if entries are returned. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates which page of data was just returned. Will be the same as the + value specified in Pagination.PageNumber. (If the input is + higher than the total number of pages, the call fails with an error.) + Only returned if items are returned. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Unique item ID that identifies the Dutch auction listing for which to + retrieve a list of the high bidders. + <br> + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + Contains a list of zero, one, or multiple OfferType objects. Each + OfferType object represents the data for one high bidder. See the schema + documentation for OfferType for details on its properties and their + meanings. + + + + + + + + + + + + Specifies an active or ended listing's status in eBay's processing workflow. + If a listing ends with a sale (or sales), eBay needs to update the sale + details (e.g., winning bidder) and other information. This processing can take + several minutes. If you retrieve a sold item, use this listing status + information to determine whether eBay has finished processing the listing so + that you can be sure the winning bidder and other details are correct and + complete. + <br> + + + + + + + + + + + + + + + + + Returns item data such as title, description, price information, seller information, and so on, for the specified <b>ItemID</b>. &nbsp;<b>Also for Half.com</b>. + + + DetailLevel + half + + AddItem, AddFixedPriceItem, GetItems, GetSellerEvents, GetSellerList, + RelistItem, ReviseItem + + + Retrieving Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Items-Retrieving.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + + + + + + + + Specifies the <b>ItemID</b> that uniquely identifies the item listing for which + to retrieve the data. + <br><br> + <b>ItemID</b> is a required input in most cases. <b>SKU</b> can be used instead in certain + cases (see the description of SKU). If both <b>ItemID</b> and <b>SKU</b> are specified for + items where the inventory tracking method is <b>ItemID</b>, <b>ItemID</b> takes precedence. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetItem + Conditionally + + + + + + + + Indicates if the caller wants to include watch count for that item in the + response. You must be the seller of the item to retrieve the watch count. + + + + GetItem + No + + + + + + + + This flag should no longer be used as eBay Store Cross Promotions are no + longer supported by the Trading API. + <br><br> + Specifies whether or not to include cross-promotion information for + the item in the call response. + + + + GetItem + No + + + + + + + + If <code>true</code>, the response returns the <b>ItemSpecifics</b> node + (if the listing has custom Item Specifics).<br> + <br> + Item Specifics are well-known aspects of items in a given + category. For example, items in a washer and dryer category + might have an aspect like Type=Top-Loading; whereas + items in a jewelry category might have an aspect like + Gemstone=Amber.<br> + <br> + Including this field set to <code>true</code> also returns the <strong>UnitInfo</strong> node, which enables European Union sellers to provide the required price-per-unit information so buyers can accurately compare prices for certain types of products. + <br/><br/> + (This does not cause the response to include ID-based + attributes. To also retrieve ID-based attributes, + pass <b>DetailLevel</b> in the request with the value + <b>ItemReturnAttributes</b> or <b>ReturnAll</b>.) + + + + GetItem + No + + Working with Custom Item Specifics + + + + + + + + + + If true, an associated tax table is returned in the response. + If no tax table is associated with the item, then no + tax table is returned, even if <b>IncludeTaxTable</b> is set to true. + + + + GetItem + No + + + + + + + + Retrieves an item that was listed by the user identified + in AuthToken and that is being tracked by this SKU.<br> + <br> + A SKU (stock keeping unit) is an identifier defined by a seller. + Some sellers use SKUs to track complex flows of products + and information on the client side. + eBay preserves the SKU on the item, enabling you + to obtain it before and after an order line item is created. + (SKU is recommended as an alternative to + ApplicationData.)<br> + <br> + In <b>GetItem</b>, <b>SKU</b> can only be used to retrieve one of your + own items, where you listed the item by using <b>AddFixedPriceItem</b> + or <b>RelistFixedPriceItem</b>, + and you set <b>Item.InventoryTrackingMethod</b> to <b>SKU</b> at + the time the item was listed. (These criteria are necessary to + uniquely identify the listing by a SKU.)<br> + <br> + Either <b>ItemID</b> or <b>SKU</b> is required in the request. + If both are passed, they must refer to the same item, + and that item must have <b>InventoryTrackingMethod</b> set to <b>SKU</b>. + + + 50 + + GetItem + Conditionally + + + + + + + + Variation-level SKU that uniquely identifies a Variation within + the listing identified by <b>ItemID</b>. Only applicable when the + seller listed the item with Variation-level SKU (<b>Variation.SKU</b>) + values. Retrieves all the usual <b>Item</b> fields, but limits the + <b>Variations</b> content to the specified Variation. + If not specified, the response includes all Variations. + + + + GetItem + No + + + + + + + + Name-value pairs that identify one or more Variations within the + listing identified by <b>ItemID</b>. Only applicable when the seller + listed the item with Variations. Retrieves all the usual <b>Item</b> + fields, but limits the Variations content to the specified + Variation(s). If the specified pairs do not match any Variation, + eBay returns all Variations.<br> + <br> + To retrieve only one variation, specify the full set of + name/value pairs that match all the name-value pairs of one + Variation. <br> + <br> + To retrieve multiple variations (using a wildcard), + specify one or more name/value pairs that partially match the + desired variations. For example, if the listing contains + Variations for shirts in different colors and sizes, specify + Color as Red (and no other name/value pairs) to retrieve + all the red shirts in all sizes (but no other colors). + + + + GetItem + No + + + + + + + + A unique identifier for an order line item (transaction). An order line item is created + when a buyer commits to purchasing an item. + <br><br> + Since you can change active multiple-quantity fixed-price listings even + after one of the items has been purchased, the <b>TransactionID</b> is + associated with a snapshot of the item data at the time of the purchase. + <br><br> + After one item in a multi-quantity listing has been sold, sellers can not + change the values in the Title, Primary Category, Secondary Category, + Listing Duration, and Listing Type fields. However, all other fields are + editable. + <br><br> + Specifying a <b>TransactionID</b> in the <b>GetItem</b> request allows you to retrieve + a snapshot of the listing as it was when the order line item was created. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetItem + Conditionally + + + + + + + + This field is used to specify whether to retrieve Parts Compatibility information. If <code>true</code>, any compatible applications associated with the item will be returned in the response (<b class="con"> Item.ItemCompatibilityList</b>). If no compatible applications have been specified for the item, no item compatibilities will be returned. + <br><br> + If <code>false</code> or not specified, the response will return a compatibility count (<b class="con">ItemCompatibilityCoun</b>t) when parts compatibilities have been specified for the item. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories categories, for the eBay US Motors (100), UK (3), AU (15) and DE (77) sites only. + + + false + + GetItem + No + + + ItemCompatibilityCount + #Response.Item.ItemCompatibilityCount + + + ItemCompatibilityList + #Response.Item.ItemCompatibilityList + + + Listing Items with Parts Compatibility + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CompatibleParts.html + + + + + + + + + + + + + + Contains the item data returned by the call. The data for the specified item + listing is returned in an ItemType object. + + + + + + + + + ItemType object that contains the data for the specified item. + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + + + + + + + No longer recommended. + + + 805 + Avoid + + 915 + + + + + + + + + Specifies the data for a single item and configures the recommendation engines to use + when processing the item. + To retrieve recommendations for multiple items, pass a separate + GetRecommendationsRequestContainer for each item. In this case, + pass a user-defined correlation ID for each item to identify the matching response. + + + + GetItemRecommendations + Yes + + + + + + + + + + + + + + GetItemRecommendations returns recommended changes or opportunities for improvement + related to listing data that was passed in the request. + This call supports batch requests. That is, it can retrieve recommendations for multiple + items at once. + + + + + + + + + Specifies recommended changes or opportunities for improving the data of a single item. + If multiple items were processed, a separate GetRecommendationsResponseContainer + is returned for each item. Each container includes a user-defined correlation ID + to help you match items in the request to recommendations in the response. + + + + GetItemRecommendations + Always + + + + + + + + + + + + + + Returns shipping cost estimates for an item for every calculated shipping service + that the seller has offered with the listing. This is analogous to the Shipping + Calculator seen in both the buyer and seller web pages. + + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + + + + The item ID that uniquely identifies the item listing for which + to retrieve the data. Required input. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetItemShipping + Yes + + + + + + + + Number of items sold to a single buyer and to be shipped together. + + + + GetItemShipping + No + + + + + + + + Destination country postal code (or zip code for US). Ignored if no + country code is provided. Optional tag for some countries. More likely to + be required for large countries. + + + + GetItemShipping + Conditionally + + + + + + + + Destination country code. If DestinationCountryCode is US, + a postal code is required and it represents the US zip code. + + + US + + GetItemShipping + Conditionally + + + + + + + + + + + + + + Contains the data returned by the call. The shipping details for the specified + item are returned in a ShippingDetails object. + + + + + + + + + Shipping-related details for the specified item. Any error about shipping services + (returned by a vendor of eBay's who calculates shipping costs) is returned in + ShippingRateErrorMessage. Errors from a shipping service are likely to be related to + issues with shipping specifications, such as package size and the selected shipping + method not supported by a particular shipping service. + <br> + <br> + If a buyer buys multiple quantities of an item and the resultant total + weight exceeds the weight limit of the shipping service, GetItemShipping + returns the shipping cost and shipping service and internally groups the + items in separate packages. A shipping service is removed from + ShippingDetails only if the weight of a single item exceeds the weight + limit of the shipping service. + + + + GetItemShipping + Always + + + + + + + + This container is returned in <b>GetItemShipping</b> if In-Store Pickup is set for the listing. + <br/><br/> + In a future release, a fulfillment duration element will be added to this container and will be used to determine when the item will be ready for pickup in a store (immediately, two hours after sale, two days after sale, etc.). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + This container is only returned if the version of the API is greater than or equal to 869. + + + + GetItemShipping + Conditionally + + + + + + + + + + + + + + Retrieves order line item information for a specified <b>ItemID</b>. & + nbsp;<b>Also for Half.com</b>. The call returns zero, one, or + multiple order line items, depending on the number of items sold from the listing. + <br><br> + You can retrieve order line item data for a specific time range or + number of days. If you don't specify a range or number of days, order line item + data will be returned for the past 30 days. + + + DetailLevel + GetSellerTransactions, GetOrders, GetOrderTransactions + + Email and Address Privacy Policy + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + the conditions under which buyer and seller email and address are returned. + + + Retrieving Order Line Item Data and Managing Orders + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html#RetrievingtheOrderLineItemsforaSingleIte + + + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. When you use + <b>ItemID</b> alone, eBay returns all order line items that are associated with + the <b>ItemID</b> (listing). If you pair <b>ItemID</b> with a specific <b>TransactionID</b>, + data on a specific order line item is returned. If <b>OrderLineItemID</b> is + specified in the request, any <b>ItemID</b>/<b>TransactionID</b> pair specified in the + same request will be ignored. + <br> + <br> + <span class="tablenote"><b>Note:</b> + <b>GetItemTransactions</b> doesn't support SKU as an input because this + call requires an identifier that is unique across your active + and ended listings. Even when <b>InventoryTrackingMethod</b> is set to + <b>SKU</b> in a listing, the SKU is only unique across your active + listings (not your ended listings). To retrieve order line items + by SKU, use <b>GetSellerTransactions</b> or <b>GetOrderTransactions</b> instead. + </span> + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetItemTransactions + Yes + + + + + + + + The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving + order line items associated with the specified <b>ItemID</b>. The <b>ModTimeFrom</b> + field is the starting date range. All eBay order line items that were + last modified within this date range are returned in the output. The + maximum date range that may be specified is 30 days. This field is not + applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in + the request or if the <b>NumberOfDays</b> date filter is used. + <br><br> + If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> + time filter is used and it defaults to 30 (days). + + + + GetItemTransactions + No + + + + + + + + The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving + order line items associated with the specified <b>ItemID</b>. The <b>ModTimeTo</b> + field is the ending date range. All eBay order line items that were last + modified within this date range are returned in the output. The maximum + date range that may be specified is 30 days. If the <b>ModTimeFrom</b> field is + used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to + the present time or to 30 days past the <b>ModTimeFrom</b> value (if + <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not + applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in + the request or if the <b>NumberOfDays</b> date filter is used. + <br><br> + If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> + time filter is used and it defaults to 30 (days). + + + + GetItemTransactions + No + + + + + + + + Include a <b>TransactionID</b> field in the request if you want to retrieve the + data for a specific order line item (transaction). If a <b>TransactionID</b> is + provided, any specified time filter is ignored. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetItemTransactions + No + + + + + + + + Child elements control pagination of the output. Use the <b>EntriesPerPage</b> + property to control the number of order line items to + return per call and the <b>PageNumber</b> property to specify the specific page + of data to return. If multiple pages of order line items are returned + based on input criteria and Pagination properties, <b>GetItemTransactions</b> + will need to be called multiple times (with the <b>PageNumber</b> value being + increased by 1 each time) to scroll through all results. + + + + GetItemTransactions + No + + + + + + + + Indicates whether to include the Final Value Fee (FVF) for all order + line items in the response. The Final Value Fee is + returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is + assessed right after the creation of an order line item. + + + + GetItemTransactions + No + + + + + + + + Include this field and set it to True if you want the <b>ContainingOrder</b> + container to be returned in the response under each <b>Transaction</b> node. + For single line item orders, the <b>ContainingOrder.OrderID</b> value takes the + value of the <b>OrderLineItemID</b> value for the order line item. For + <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> orders, + the <b>ContainingOrder.OrderID</b> value will be shared by at + least two order line items (transactions) that are part of the same order. + + + false + + GetItemTransactions + No + + + + + + + + The default behavior of <b>GetItemTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com. + + + + GetItemTransactions + No + CustomCode, eBay, Half + + + + + + + + This time filter specifies the number of days (24-hour periods) in the + past to search for order line items. All eBay order line items that were + either created or modified within this period are returned in the + response. If specified, <b>NumberOfDays</b> will override any date range + specified with the <b>ModTimeFrom</b>/<b>ModTimeTo</b> time filters. This field is not + applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in + the request. + + + 30 + 1 + 30 + + GetItemTransactions + No + + + + + + + + If included in the request and set to True, all variations defined for + the item are returned at the root level, including variations + that have no sales. If not included in the request or set to false, the + variations with sales are still returned in separate <b>Transaction</b> nodes. This information is intended to help sellers to reconcile their + local inventory with eBay's records, while processing order line items + (without requiring a separate call to <b>GetItem</b>). + + + + GetItemTransactions + false + No + + + + + + + + A unique identifier for an eBay order line item. This field is created + as soon as there is a commitment to buy from the seller, and its value + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. If you want to retrieve data on a + specific order line item, you can use an <b>OrderLineItemID</b> value in the + request instead of the <b>ItemID</b>/<b>TransactionID</b> pair. If an <b>OrderLineItemID</b> is + provided, any specified time filter is ignored. + + + 100 + + GetItemTransactions + No + + + + + + + + + + + + + + Returns an array of order line item (transaction) data for the item specified in the request. + The results can be used to create a report of data that is commonly + necessary for order processing. + Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>. + The set of order line items returned is limited to those that were modified between + the times specified in the request's <b>ModTimeFrom</b> and <b>ModTime</b> filters. + Also returns the <b>Item</b> object that spawned the order line items. + If pagination filters were specified in the request, returns meta-data describing + the effects of those filters on the current response and the estimated effects if + the same filters are used in subsequent calls. + <br><br> + Data from the <b>TransactionArray</b> may be used to trigger the following Platform + Notifications: EndOfAuction, AuctionCheckoutComplete, FixedPriceEndOfTransaction, + CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout, + FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped, + and ItemMarkedAsPaid. Each notification will be based on the state of the item + (a 'snapshot' of the item) at the time the order line item was created. + + + + + + + + + Contains the total number of pages (<b>TotalNumberOfPages</b>) and the total number + of entries (<b>TotalNumberOfEntries</b>) that could be returned given repeated calls + that use the same selection criteria as the call that returned this response. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + Indicates whether there are additional order line items (transactions) to retrieve. + That is, indicates whether more pages of data are available to be + returned, given the filters that were specified in the request. + Returns false for the last page of data. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + Number of order line items (transactions) returned per page (per call). May be a higher value + than <b>ReturnedTransactionCountActual</b> if the page returned is the last page + and more than one page of data exists. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + Page number for the page of order line items the response returned. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + Number of order line items retrieved in the current page of results just returned. + May be a lower value than <b>TransactionsPerPage</b> if the page returned is the last + page and more than one page of data exists. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + <b>Item</b> object that spawned the order line item. It is a purchase from this item's listing + that the order line item represents. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + List of <b>Transaction</b> objects representing the order line items resulting + from the listing. Each <b>Transaction</b> object contains the data for one purchase + (of one or more items in the same listing). The <b>Transaction.Item</b> field is not + returned because the <b>Item</b> object is returned at the root level of the response. + See the reference guide for more information about the fields that are returned. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Conditionally + + + + + + + + Indicates whether the item's seller has the preference enabled that shows + that the seller prefers PayPal as the method of payment for an item. This + preference is indicated on an item's View Item page and is intended to + influence a buyer to use PayPal + to pay for the item. + + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + + + + + + + Returns orders in which the user was involved and for which feedback + is still needed from either the buyer or seller. + + + + GetMyeBayBuying, GetMyeBaySelling, GetMyeBayReminders + + + + + + + + + + Specifies how the returned feedback items should be sorted. + Valid values are Title, EndTime, QuestionCount, FeedbackLeft, + FeedbackReceivedDescending, UserIDDescending, TitleDescending, + and EndTimeDescending. + + + + GetItemsAwaitingFeedback + No + + + + + + + + Specifies the number of entries per page and the page number to return + in the result set. + + + + GetItemsAwaitingFeedback + No + + + + + + + + + + + + + + Response to GetItemsAwaitingFeedback. + + + + + + + + + Contains the items awaiting feedback. + Returned only if there are items that do not yet + have feedback. + + + + GetItemsAwaitingFeedback + Always + + + + + + + + + + + + + + Retrieves a list of the messages buyers have posted about your + active item listings. + + + + AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, AddMemberMessageRTQ, + DeleteMyMessages, GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders + + + Communication Between Members + + + + + + + + + + + The ID of the item the message is about. + <br><br> + For ASQ messages, either the ItemID, or a date range + (specified with StartCreationTime and EndCreationTime), + or both must be included. ItemID is otherwise ignored. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetMemberMessages + Conditionally + + + + + + + + The type of message. Note that GetMemberMessages does not return + messages when this field is set to AskSellerQuestion. + + + + GetMemberMessages + AskSellerQuestion, All + Yes + + + + + + + + The status of the message. + + + + GetMemberMessages + Conditionally + + + + + + + + If included in the request and set to True, only public messages (viewable + in the Item listing) are returned. If omitted or set to False in the + request, all messages (that match other filters in the request) are returned + in the response. + + + + GetMemberMessages + No + + + + + + + + Used as beginning of date range filter. If specified, + filters the returned messages to only those with a + creation date greater than or equal to the specified + date and time. + <br><br> + For CEM messages, StartCreationTime and EndCreationTime + must be provided. + <br><br> + For ASQ messages, either the ItemID, or a date range + (specified with StartCreationTime and EndCreationTime), + or both must be included. + + + + GetMemberMessages + Conditionally + + + + + + + + Used as end of date range filter. If specified, filters + the returned messages to only those with a creation date + less than or equal to the specified date and time. + <br><br> + For CEM messages, StartCreationTime and EndCreationTime + must be provided. + <br><br> + For ASQ messages, either the ItemID, or a date range + (specified with StartCreationTime and EndCreationTime), + or both must be included. + + + + GetMemberMessages + Conditionally + + + + + + + + Standard pagination argument used to reduce response. + + + + GetMemberMessages + No + + + + + + + + An ID that uniquely identifies the message for a given user to be retrieved. + Used for the AskSellerQuestion notification only. + + + + GetMemberMessages + No + + + + + + + + An eBay ID that uniquely identifies a user. For + GetMemberMessages, this is the sender of the message. If + included in the request, returns only messages from the + specified sender. + + + + GetMemberMessages + No + + + + + + + + + + + + + + + + + + The returned member messages. Returned if messages that meet the request criteria exist. + Note that GetMemberMessages does not return + messages when, in the request, the MailMessageType is AskSellerQuestion. + + + + GetMemberMessages + Conditionally + + + + + + + + Shows the pagination of data returned by requests. + + + + GetMemberMessages + Always + + + + + + + + Specifies whether the response has more items. + + + + GetMemberMessages + Always + + + + + + + + + + + + + + Returns a seller's Ask Seller a Question (ASQ) subjects, each in + its own Subject node. + + + + SetMessagePreferences + + + + + + + + + + The ID of the user to retrieve ASQ subjects for. This + value must be specified in the request, but does not + need to be the same user as the user making the + request. + + + + GetMessagePreferences + Yes + + + + + + + + If true, indicates that the ASQ subjects for the + specified user should be returned. + + + + GetMessagePreferences + No + + + + + + + + + + + + + + Contains the ASQ subjects for the user specified in the request. + + + + + + + + + Returns a seller's ASQ subjects, each in its own Subject + node. If the seller has not customized the ASQ subjects + using SetMessagePreferences, the call will return the + current default values. Returned if + IncludeASQPreferences = true was specified in the + request. + + + + GetMessagePreferences + Conditionally + + + + + + + + + + + + + + Retrieves information about the messages sent to a given user. + + + + Retrieves information about the messages sent to + a user. + + DetailLevel + + AddMemberMessageAAQToPartner, AddMemberMessageRTQ, + AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMemberMessages, + ReviseMyMessages, ReviseMyMessagesFolders + + + Communication Between Members + + + + Notifications for Buyers and Sellers + http://developer.ebay.com/DevZone/guides/ebayfeatures/Notifications/Notifications.html + + + + + + + + + + This container is deprecated. + + + + + + + + + + + Container consisting of one to 10 MessageID fields. + + + + GetMyMessages + Conditionally + + + + + + + + A unique identifier for a My Messages folder. If a FolderID is provided, + only messages from the specified folder are returned in the response. + + + + GetMyMessages + No + + + + + + + + The beginning of the date-range filter. + Filtering takes into account the entire timestamp of when messages were sent. + Messages expire after one year. + + + + GetMyMessages + No + + + + + + + + The end of the date-range filter. See StartTime + (which is the beginning of the date-range filter). + + + + GetMyMessages + Conditionally + + + + + + + + This field is currently available on the US site. A container for IDs that + uniquely identify messages for a given user. If provided at the time of message + creation, this ID can be used to retrieve messages and will take precedence + over message ID. + + + + GetMyMessages + No + + + + + + + + Specifies how to create virtual pages in the returned list (such as total + number of entries and total number of pages to return). + Default for EntriesPerPage with GetMyMessages is 25. + + + + GetMyMessages + No + + + + + + + + If this field is included in the request and set to True, only High Priority + messages are returned in the response. + + + + GetMyMessages + No + + + + + + + + + + + + + + Contains information about the messages sent to + a user. Depending on the detail level, this + information can include message counts, + resolution and flagged status, message + headers, and message text. + + + + + + + + + Summary data for a given user's + messages. This includes the numbers of + new messages, flagged messages, and total messages. + The amount and type of data returned is the same + whether or not the request includes specific + MessageIDs. + Always/Conditionally returned logic assumes a + detail level of ReturnMessages. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + This container was deprecated in 685 version. Alerts are now considered + Flagged messages. + + + + + + + + + + + Contains the message information for each + message specified in MessageIDs. The amount and + type of information returned varies based on the + requested detail level. Contains one + MyMessagesMessageType object per message. + Returned as an empty node if user has no + messages. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + + + + + + + Returns items from the Buying section of the user's My eBay + account, including items that the user is watching, bidding on, has + won, has not won, and has made best offers on. + + + GetItemsAwaitingFeedback, GetMyeBayReminders, GetMyeBaySelling + + My eBay + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-MyeBay.html + + DetailLevel + + + + + + + + + Returns the list of items being watched by the user. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items on which the user has bid. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items on which the user has placed best offers. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items on which the use has bid. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items on which the user has bid on and lost. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of searches that the user has saved in My eBay. Returned + only if the user has saved searches. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of favorite sellers that the user has saved in My eBay. + Returned only if the user has saved a list of favorite sellers. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of second chance offers made by the user. Returned only + if the user has made second chance offers. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Indicates whether or not the Bid Assistant feature is being used. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items the user has won, and subsequently deleted from + their My eBay page. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns the list of items (auctions) the user did not win and were + subsequently deleted from their My eBay page. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + Returns a summary of the user's buying activity. + <br><br> + With a request version of 605 or higher, the buying summary container is + not included in the response by default. Add a BuyingSummary element in + the request with an Include field set to true to receive a BuyingSummary + container in your response. + <br><br> + With a request version lower than 605, the BuyingSummary is always + returned by default. Add a BuyingSummary element with an Include field + set to false to exclude the BuyingSummary from your response. + + + + GetMyeBayBuying + No + + + + + + + + Returns the user defined lists, which are lists created by the user in the eBay + UI and filled with items, or sellers, or searches using the + "Add to List" feature. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBayBuying + No + + + + + + + + If true, the Variations node is omitted for all multi-variation + listings in the response. + If false, the Variations node is returned for all + multi-variation listings in the response. <br> + <br> + Please note that if the seller includes a large number of + variations in many listings, retrieving variations (setting this + flag to false) may degrade the call's performance. Therefore, + when this is false, you may need to reduce the total + number of items you're requesting at once (by using other input + fields, such as Pagination). + + + + GetMyeBayBuying + No + false + + + + + + + + + + + + + + Returns items from All Buying or All Favorites in the user's My eBay account. + + + + + + + + + Contains a summary of the items the user has bid on. Returned at all detail + levels. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Always + + + + + + + + Contains the items the user is watching. Only returned if items exist that + meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains all the items the buyer has bid on. + Only returned if items exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the items the user has placed Best Offers on. Only returned if + items exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the items the user has bid on and won. Only returned if items + exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the items the user has bid on and lost. Only returned if items + exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains a list of the user's favorite searches. Only returned if the + user has Favorite Searches. The search name, search query, and search + elements, such as QueryKeywords, SortOrder, and Condition are returned. + <br><br> + You can paste the Search Query response, that comes back as a URL, into a browser + to re-play the Favorite Search. + <br><br> + The search elements that are returned by this call can be used as input + for the Shopping API FindItemsAdvanced request. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains a list of the user's favorite sellers. Only returned if items + exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the list of second chance offers the user has received. Only + returned if items exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + Contains the items that were bid on using the Bid Assistant feature. + + + + + + + + + + + Contains the items the buyer has bid on, won, and deleted from My eBay. + Only returned if items exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the items the buyer has bid on, lost, and deleted from My eBay. + Only returned if items exist that meet the request criteria. + + + + GetMyeBayBuying +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains the items, searches, or sellers that the user has saved to this + list using the "Add to list" feature. The name of the list is given by the + "Name" element. Returned only if UserDefineLists is specified in the request. + + + + GetMyeBayBuying + Conditionally + + + + + + + + + + + + + + Requests totals for the Buying and Selling reminders from the user's + My eBay account. + + + + GetItemsAwaitingFeedback, GetMyeBayBuying, GetMyeBaySelling + + + My eBay + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-MyeBay.html + + + + + + + + + + Specifies the type of buying reminders for which you want information. + + + + GetMyeBayReminders + No + + + + + + + + Specifies the type of selling reminders for which you want information. + + + + GetMyeBayReminders + No + + + + + + + + + + + + + Returns totals of various reminder types from the user's My eBay account. + + + + + + + Returns totals of various reminder types from the user's My eBay account. + + + + + + + + + Contains the buying reminders in the user's My eBay account that match + the request criteria. + + + + GetMyeBayReminders + Conditionally + + + + + + + + Contains the selling reminders in the user's My eBay account that match + the request criteria. + + + + GetMyeBayReminders + Conditionally + + + + + + + + + + + + + + Returns items from the Selling section of the user's My eBay account, + including items that the user is currently selling (the Active list), + items that have bids, sold items, and unsold items. + + + DetailLevel + GetItemsAwaitingFeedback, GetMyeBayBuying, GetMyeBayReminders + + My eBay + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-MyeBay.html + + + Managing Selling and Reminders with My eBay + http://pages.ebay.com/help/myebay/manage-selling.html + + + + + + + + + + Returns the list of items the user has scheduled to sell but whose + listings have not yet opened. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns the list of items the user is actively selling (the currently + active listings). + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns the list of items the user has sold. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns the list of items the user has listed, but whose listings + have ended without being sold. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Return the list of active items on which there are bids. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns the list of items the user sold, and then deleted from + their My eBay page. Allowed values for DurationInDays are 0-90. + <br><br> + Set Include to true to return the default response set. + + Return the list of active items on which there are bids. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns the list of items the user either ended or did not sell, and + subsequently were deleted them from their My eBay page. Allowed + values for DurationInDays are 0-90. + <br><br> + Set Include to true to return the default response set. + + + + GetMyeBaySelling + No + + + + + + + + Returns a summary of the user's buying activity. + <br><br> + With a request version of 605 or higher, the selling summary container is + not included in the response by default. Add a SellingSummary element in + the request with an Include field set to true to receive a SellingSummary + container in your response. + <br><br> + With a request version lower than 605, the SellingSummary is always + returned by default. Add a SellingSummary element with an Include field + set to false to exclude the SellingSummary from your response. + + + + GetMyeBaySelling + No + + + + + + + + If true, the Variations node is omitted for all multi-variation + listings in the response. + If false, the Variations node is returned for all + multi-variation listings in the response. <br> + <br> + Please note that if the seller includes a large number of + variations in many listings, retrieving variations (setting this + flag to false) may degrade the call's performance. Therefore, + when this is false, you may need to reduce the total + number of items you're requesting at once (by using other input + fields, such as Pagination). + + + + GetMyeBaySelling + No + false + + + + + + + + + + + + + + Returns summary and detail information about items the user is selling, + items scheduled to sell, currently listed, sold, and closed but not sold. + + + + + + + + + Contains summary information about the items the user is selling. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Contains the items the user has scheduled for sale, but whose listings have + not yet started. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains the items the user is selling that have active listings. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains the items the user has sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains the items whose listings have ended but that have not sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains summary information about the items the user is selling. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + This container is no longer applicable to <b>GetMyeBaySelling</b>. + + + + + + + + Contains the items the seller has sold and deleted from My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains the items with listings that were ended or did not sell and have been deleted from My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + + + Retrieves the requesting application's notification preferences. Details are only returned for events for which a + preference has been set. For example, if you enabled notification for the EndOfAuction event and later disabled it, + the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no + details would be returned regarding EndOfAuction. + + + SetNotificationPreferences, GetNotificationsUsage + + Working with Platform Notifications + http://developer.ebay.com/DevZone/guides/ebayfeatures/Notifications/Notifications.html + + + + + + + + + + Specifies the type of preferences to retrieve. For example, preferences can be associated with a user, with + an application, or with events. + + + + GetNotificationPreferences + Yes + + + + + + + + + + + + + + Contains the requesting application's notification preferences. + GetNotificationPreferences retrieves preferences that you have + deliberately set. For example, if you enable the EndOfAuction event and + then later disable it, the response shows the EndOfAuction event + preference as Disabled. But if you have never set a preference for the + EndOfAuction event, no EndOfAuction preference is returned at all. + + + + + + + + + Specifies application-based event preferences that have been enabled. + + + + GetNotificationPreferences + Conditionally + + + + + + + + Specifies application delivery URL Name associated with this user. + + + + GetNotificationPreferences + Conditionally + + + + + + + + Specifies user-based event preferences that have been enabled or disabled. + + + + GetNotificationPreferences + Conditionally + + + + + + + + Returns user data for notification settings, such as set mobile phone. + + + + GetNotificationPreferences + Conditionally + + + + + + + + Contains names and values assigned to a notification event. + Currently can only be set for wireless applications. + + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + + + Retrieves usage information about platform notifications for a given application. + You can use this notification information to troubleshoot issues with platform + notifications. You can call this up to 50 times per hour for a given application. + + + GetNotificationPreferences, SetNotificationPreferences + + Working with Platform Notifications + http://developer.ebay.com/DevZone/guides/ebayfeatures/Notifications/Notifications.html + + + + + + + + + + Specifies the start date and time for which notification information + will be retrieved. StartTime is optional. If no StartTime is specified, + the default value of 24 hours prior to the call time is used. If no + StartTime is specified or if an invalid StartTime is specified, date + range errors are returned in the response. For a StartTime to be valid, + it must be no more than 72 hours before the time of the call, it cannot + be more recent than the EndTime, and it cannot be later than the time of + the call. If an invalid StartTime is specified, the default value is + used. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Specifies the end date and time for which notification information + will be retrieved. EndTime is optional. If no EndTime is specified, + the current time (the time the call is made) is used. If no EndTime + is specified or if an invalid EndTime is specified, date range errors + are returned in the response. For an EndTime to be valid, it must be no + more than 72 hours before the time the of the call, it cannot be before + the StartTime, and it cannot be later than the time of the call. If an + invalid EndTime is specified, the current time is used. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Specifies an item ID for which detailed notification information will be + retrieved. ItemID is optional. If no ItemID is specified, the response + will not include any individual notification details. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetNotificationsUsage + Conditionally + + + + + + + + + + + + + + Returns an array of notifications sent to a given application identified by the appID + (comes in the credentials). The result can be used by third-party developers troubleshoot + issues with notifications. + Zero, one or many notifications can be returned in the array. The set of notifications + returned is limited to those that were sent between the StartTime and EndTime specified + in the request. If StartTime or EndTime filters were not found in the request, then + the response will contain the data for only one day (Now-1day). By default, maximum + duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies + to Notifications,MarkDownMarkUpHistory and NotificationStatistics. + + Notifications are sent only if the ItemID is included in the request. If there is no + ItemID, then only Statistics and MarkDownMarkUpHistory information is included. + + + + + + + + + Returns the start date and time for the notification information that is + returned by this call. The oldest date allowed for this field is Now-3days. + Default is Now-1day. + + + + GetNotificationsUsage + Always + + + + + + + + Returns the end date and time for the notification information that is + returned by this call. The default is Now. + + + + GetNotificationsUsage + Always + + + + + + + + List of notification objects representing the notifications sent to an + application for the given time period. It will only be returned if ItemID + was specified in the input request. + + + + GetNotificationsUsage + Conditionally + + + + + + + + List of objects representing MarkUp or MarkDown history for a given appID + and for given StartTime and EndTime. This node will always be returned. + + + + GetNotificationsUsage + Always + + + + + + + + Summary information about number of notifications that were successfully + delivered, queued, failed, connection attempts made, connection timeouts, + http errors for the given appID and given time period. By default, statistics + for only one day (Now-1day) is included. Maximum time duration allowed is 3 days + (Now-3days). + + + + GetNotificationsUsage + Always + + + + + + + + + + + + + + Use this call to retrieve information about one or more orders based on OrderIDs, ItemIDs, or SKU values. &nbsp;<b>Also for Half.com</b>. + + + DetailLevel + GetOrders, GetItemTransactions, GetSellerTransactions + + Basic Building Blocks + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-BuildingBlocks.html#OrderLineItems + + + + + + + + + + An array of ItemTransactionIDs. + + + + GetOrderTransactions + Conditionally + + + + + + + + An array of OrderIDs. You can specify, at most, twenty OrderIDs. + + + + GetOrderTransactions + Conditionally + + + + + + + + The default behavior of <b>GetOrderTransactions</b> is to retrieve all orders originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com. + + + + GetOrderTransactions + No + CustomCode, eBay, Half + + + + + + + + Indicates whether to include Final Value Fee (FVF) in the response. For most + listing types, the Final Value Fee is returned in Transaction.FinalValueFee. + The Final Value Fee is returned on a transaction-by-transaction basis for + FixedPriceItem listing type. For all other listing + types, the Final Value Fee is returned when the listing status is Completed. + This value is not returned if the auction ended with Buy It Now. + + + + GetOrderTransactions + No + + + + + + + + + + + + + + Response to GetOrderTransactions request. + + + + + + + + + An array of Orders. + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + + + + + + + Retrieves the orders for which the authenticated user is a participant, either as the buyer + or the seller.&nbsp;<b>Also for Half.com</b>. The call returns all the + orders that meet the request specifications. + + + DetailLevel + AddOrder, GetItemTransactions, GetOrderTransactions + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + A container for eBay order IDs. If one or more order IDs are specified in this + container, no other call-specific input fields are applicable. + <br><br> + Not applicable to Half.com. + + + + GetOrders + Conditionally + + + + + + + + The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields + specify a date range for retrieving orders. The <b>CreateTimeFrom</b> field is the + starting date range. All eBay orders that were created within this date range are + returned in the output. The maximum date range that may be specified with the + <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields is 90 + days. <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date + filters are ignored if the <b>NumberOfDays</b> date filter is used in the request, or if + one or more order IDs are passed in the request. + <br> + Applicable to Half.com. + + + + GetOrders + Conditionally + + + + + + + + The <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields specify a date range for retrieving + orders. The <b>CreateTimeTo</b> field is the ending date range. All eBay orders that were + created within this date range are returned in the output. The maximum + date range that may be specified with the <b>CreateTimeFrom</b> and <b>CreateTimeTo</b> fields + is 90 days. If the <b>CreateTimeFrom</b> field is used and the + <b>CreateTimeTo</b> field is omitted, the "TimeTo" value defaults to the present time or + to 90 days past the <b>CreateTimeFrom</b> value (if <b>CreateTimeFrom</b> value is more than 90 + days in the past). <b>CreateTimeFrom</b>/<b>CreateTimeTo</b> date filters are ignored if the + <b>NumberOfDays</b> date filter is used in the request, or if one or more order IDs are + passed in the request. + <br><br> + <span class="tablenote"><strong>Note:</strong> + If a GetOrders call is made within a few seconds after the creation of a multiple + line item order, the caller runs the risk of retrieving orders that are in an + inconsistent state, since the order consolidation involved in a multi-line item order + may not have been completed. For + this reason, it is recommended that sellers include the + <b>CreateTimeTo</b> field in the call, and set its value to: <i> + Current Time</i> - 2 minutes. + <br><br> + Applicable to Half.com. + + + + GetOrders + Conditionally + + + + + + + + Filters the returned orders based on the role of the user. The user's role is + either buyer or seller. If this field is used with a date filter, returned orders + must satisfy both the date range and the OrderRole value. + <br> + Applicable to eBay.com and Half.com. + + + + GetOrders + Conditionally + + + + + + + + The field is used to retrieve orders that are in a specific state. If this field is used with a date filter, only orders that satisfy both the date range and the <b>OrderStatus</b> value are retrieved. + <br><br> + For eBay orders, this field's value can be set to 'Active', 'Completed', 'Canceled' or 'Inactive' to retrieve orders in these states. The 'Shipped' value is only applicable for Half.com orders. + <br><br> + To retrieve Half.com orders, this field's value should be set to 'Shipped', and the <b>ListingType</b> field should be included and set to 'Half'. + <br><br> + If one or more <b>OrderID</b> values are specified through the <b>OrderIDArray</b> container, the <b>OrderStatus</b> field should not be used, and it is ignored if it is used. + + + + GetOrders + Active, All, Completed, Shipped, Canceled, Inactive, CancelPending + Conditionally + + + + + + + + Specify Half to retrieve Half.com orders. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Do not use this field if you are retrieving eBay orders. + <br><br> + This field cannot be used as a listing type filter on eBay.com. If not + provided, or if you specify any value other than Half, this field has + no useful effect and the call retrieves eBay orders of all types. Also, + you can't retrieve both eBay and Half.com orders in the same response. + </span> + + + + GetOrders + Half + Conditionally + + + + + + + + If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all + the data. Each result set is returned as a page of entries. Use the + Pagination filters to control the maximum number of entries to + retrieve per page (i.e., per call), the page number to retrieve, and + other data. + + + + GetOrders + No + + + + + + + + The ModTimeFrom and ModTimeTo fields specify a date range for retrieving + existing orders that have been modified within this time window (for example, + 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' status). The + ModTimeFrom field is the starting date range. All eBay orders that were last + modified within this date range are returned in the output. The maximum date + range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 + days. ModTimeFrom/ModTimeTo date filters are ignored if the + CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the + request, or if one or more order IDs are passed in the request. + <br><br> + Applicable to Half.com. + + + + GetOrders + Conditionally + + + + + + + + The ModTimeFrom and ModTimeTo fields specify a date range for retrieving + existing orders that have been modified within this time window (for example, + 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' + status). The ModTimeTo field is the ending date range. All eBay orders that were + last modified within this date range are returned in the output. The maximum + date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 + days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the + "TimeTo" value defaults to the present time (if ModTimeFrom value is less than + 30 days in the past) or to 30 days past the ModTimeFrom value. + ModTimeFrom/ModTimeTo date filters are ignored if the + CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the + request, or if one or more order IDs are passed in the request. + <br><br> + Applicable to Half.com. + + + + GetOrders + Conditionally + + + + + + + + This filter specifies the number of days (24-hour periods) in the past to search + for orders. All eBay orders that were either created or modified within this + period are returned in the output. This field cannot be used in conjunction with + the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters. This date + filter is ignored if one or more order IDs are passed in the request. + <br><br> + Applicable to Half.com. + + + 1 + 30 + + GetOrders + Conditionally + + + + + + + + Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the + response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final + Value Fee is assessed right after the creation of an eBay order line item. + <br> + + + + GetOrders + Conditionally + + + + + + + + Specifies how orders returned by this call should be sorted (using <strong>LastModifiedTime</strong> as the sort key). A value of <code>Ascending</code> returns the earliest modified orders first, and a value of <code>Descending</code> returns the latest modified orders first. + <br/><br/> + Default: <code>Ascending</code> + + + + GetOrders + Conditionally + + + + + + + + + + + + + + Returns the set of orders that match the order IDs or filter criteria specified. + + + + + + + + + Contains information regarding the pagination of + data, including the total number of pages and the total + number of orders. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + A true value indicates that there are more orders to be + retrieved. Additional GetOrders calls with higher page numbers or more + entries per page must be made to retrieve these orders. If false, no more + orders are available or no orders match the request (based on the input + filters). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The set of orders that match the order IDs or filter criteria specified. + Also applicable to Half.com (only returns orders that have not been marked as shipped). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates the number of orders that can be + returned per page of data (i.e., per call). This is the same value + specified in the Pagination.EntriesPerPage input (or the default value, if + EntriesPerPage was not specified). This is not necessarily the actual + number of orders returned per page (see ReturnedOrderCountActual). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates the page number of data returned in the response. + This is the same value specified in the + Pagination.PageNumber input. If orders are returned, the first page is 1. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates the total number of orders returned. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + + + + + + + Requests information about folders or pictures in a Picture Manager account + or the account settings. + + + 667 + NoOp + 803 + + Requests information about folders or pictures in a Picture + Manager account or the account settings. + + PictureManagerDetailLevel + + + + + + + + + The ID of a folder in the user's Picture Manager album for which you want information. + If you specify both FolderID and PictureURL, the picture must exist + in the folder. + + + 667 + NoOp + 803 + + GetPictureManagerDetails + No + + + + + + + + The URL of a picture in the user's Picture Manager album. + If you specify both FolderID and PictureURL, the picture must + exist in the folder. + + + 667 + NoOp + 803 + + GetPictureManagerDetails + No + + + + + + + + The type of information you want returned, about pictures and folders, + the account subscription, or both. Use this element rather than the generic DetailLevel element defined in AbstractRequestType. You can use the following values: ReturnAll, ReturnSubscription, or ReturnPicture. + + + Yes + 667 + NoOp + 803 + + GetPictureManagerDetails + No + + + + + + + + + + + + + + Responds with information about content in a Picture Manager album + or the account settings. + + + 667 + NoOp + 803 + + + + + + + + + Contains details of the account settings, folders or + pictures in the user's album, or both. + + + 667 + NoOp + 803 + + GetPictureManagerDetails +
PictureManagerDetailLevel: none, ReturnSubscription, ReturnPicture, ReturnAll
+ Always + + + + + + + + + + + + + + Requests a list of Picture Manager options and allowed values, + such as subscription type and picture display. + + + 667 + NoOp + 803 + + Requests a list of Picture Manager options and allowed values. + This call will soon be deprecated. + + + + + + + + + + + + + Returns a list of Picture Manager options and allowed values. + + + 667 + NoOp + 803 + + + + + + + + + A type of Picture Manager subscription, with a subscription level, fee, + and allowed storage size. + + + 667 + NoOp + 803 + + GetPictureManagerOptions + Always + + + + + + + + A global definition for displaying pictures, with a maximum size. + + + 667 + NoOp + 803 + + GetPictureManagerOptions + Always + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + 773 + NoOp + 889 + FindProducts (Shopping API) + + + + + + + + + + Specifies the ID of a product in the family to be retrieved, + along with pagination and sorting instructions. + ProductSearch is a required input. + + + + GetProductFamilyMembers + Yes + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + 773 + NoOp + FindProducts (Shopping API) + 889 + + + + + + + + + Container for one or more DataElement fields containing supplemental helpful data. + A DataElement field is an HTML snippet that specifies hints for the user, help links, + help graphics, and other supplemental information that varies per characteristics set. + Usage of this information is optional and may require developers to inspect the information + to determine how it can be applied in an application. + + + + GetProductFamilyMembers + Always + + + + + + + + Contains the attributes and summary product details for all products that match + the product ID (or IDs) passed in the request. + + + + GetProductFamilyMembers + Always + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + A version of the product finder attribute definitions for the site. + Typically, an application passes the version value that was returned the last + time the application executed this call. + Filter that causes the call to return only the Product Finders + for which the attribute meta-data has changed since the specified version. + The latest version value is not necessarily greater than the previous + value that was returned. Therefore, when comparing versions, only + compare whether the value has changed. + + + + + + + + + + + + A number that uniquely identifies a product finder. <br> + <br> + For sell-side searches, you can determine the + product finder IDs for a category by calling GetCategory2CS.<br> + <br> + For buy-side searches, you can't use GetCategory2CS to reliably determine + the product finder IDs for an eBay category. + GetProductFinder may work for some attributes. Alternatively, you can + use the pfid parameter from the URL of the Product Finder search page + on the site you're interested in. + See the Knowledge Base article referenced below for more details.<br> + <br> + Multiple categories can be mapped to the same product finder ID. + You can pass zero or multiple IDs in the request. When IDs are specified, the call + only returns product finder meta-data for the specified product finders. + When no IDs are specified, the call returns all the current product finder + meta-data available on the site. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Current version of the product search page data for the site. + This value changes each time changes are made to the search page data. + The current version value is not necessarily greater than the previous + value. Therefore, when comparing versions, only compare whether the + value has changed. + + + + + + + + + + + + A string containing a list of search attributes that can be used in a + "Product Finder" style query, along with related meta-data. The meta-data + specifies possible values of each attribute, the logic for presenting + attributes to a user, and rules for validating the user's selections. For + backward compatibility, this data is in the same XML format that was used + in the Legacy XML API so that you can apply the same Product Finder XSL + stylesheet to it. That is, individual elements are not described using the + new eBay XML schema format. For information about each element in the + ProductFinderData string, see the product finder model documentation in + the eBay Features Guide (see links below).<br> + <br> + Because this is returned as a string, the XML markup is escaped with + character entity references (e.g., &amp;lt;eBay&amp;gt;&amp;lt;ProductFinders&amp;gt;...). + See the appendices in the eBay Features Guide for general information about + string data types. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + The name of the XSL file to retrieve. If not specified, the call + returns the latest versions of all available XSL files. + Currently, this call only retrieves the product_finder.xsl file. + FileName is an optional input. + + + + + + + + + + + + The desired version of the XSL file. Required if FileName is specified. + If not specified, the call returns the latest versions of all + available XSL files that could be returned by the call. + (Currently, this call only retrieves the product_finder.xsl file.) + This is not a filter for retrieving changes to the XSL file. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Child elements specify data related to one XSL file. + In theory, multiple XSLFile objects can be returned. + Currently, this call only retrieves the product_finder.xsl file. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + A version of the search page definitions for the site. Typically, an + application passes the version value that was returned the last time the + application executed this call. Filter that causes the call to return only + the search pages for which the attribute meta-data has changed since the + specified version. The latest version value is not necessarily greater + than the previous value that was returned. Therefore, when comparing + versions, only compare whether the value has changed. + + + + + + + + + + + + A characteristic set ID that is associated with a + catalog-enabled category that supports product search pages. + You can pass an array of these IDs in the request. + Each characteristic set corresponds to a level in the + eBay category hierarchy at which all items share common characteristics. + Multiple categories can be mapped to the same characteristic set. + Each ID is used as a filter to limit the response content to fewer + characteristic sets. When IDs are specified, the call only returns + search page data for the corresponding characteristic sets. + When no IDs are specified, the call returns all the current + search page data in the system. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Current version of the product search page data for the site. + This value changes each time changes are made to the search page data. + The current version value is not necessarily greater than the previous + value. Therefore, when comparing versions, only compare whether the + value has changed. + + + + + + + + + + + + A list of catalog search criteria and sort keys associated with a catalog-enabled category, + plus supplemental information to help the seller understand how to make selections. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Specifies the keywords or attributes that make up the product query, with + pagination instructions. ProductSearch is a required input. To search for + multiple different products at the same time (i.e., to perform a batch + search), pass in multiple ProductSearch properties. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Container for one or more DataElement fields containing supplemental + helpful data. A DataElement field is an HTML snippet that specifies hints + for the user, help links, help graphics, and other supplemental + information that varies per characteristic set. Usage of this information + is optional and may require you to inspect the information to determine + how it can be applied in an application. Also returned with warnings when + no matches are found. + + + + + + + + + + + + Contains the attributes and product details that match the attributes or + query keywords passed in the request. Always returned when product search + results are found. + + + + + + + + + + + + + + + + + his type is deprecated as the call is no longer available. + + + + + + + + + + + + + + Specifies the context in which the call is being executed, which will imply + certain validation rules. Use this property to make sure you retrieve the + appropriate version of product information and attribute meta-data + when you are listing, revising, or relisting an item with Pre-filled Item Information. + + + + + + + + + + + + A catalog product identifies a prototype description + of a well-known type of item, such as a popular book. + As this call supports batch requests, you can pass in an array of products + to retrieve data for several products at the same time. + + + + + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + + + + + + A string containing a list of all the attributes that are applicable + to the products specified in the request, along with related meta-data. + The meta-data specifies the pre-filled values of each attribute, the + possible values of attributes that are not pre-filled, the logic for presenting + the attributes to a user, and rules for validating the user's selections. + <br><br> + For backward compatibility, this data is in + the same XML format that was used in the Legacy XML API so that you can + apply the same Item Specifics XSL stylesheet to it. That is, individual + elements are not described using the unified schema format. + <br><br> + The data is based on the GetAttributesCS response (AttributeData), with + additional information that is specific to catalog products. + Product and attribute information is nested within a set of Product tags. + The product-specific data is merged into the attribute data so that the same + XSL stylesheet used to render the results of GetAttributeCS can be used to render + catalog product data. See GetAttributesXSL. + <br><br> + See the Attribute Meta-Data Model section of the eBay Features Guide + for information about each element in the ProductSellingPagesData string. + <br><br> + Because the content is returned as a string, the XML markup elements are escaped with + character entity references (e.g.,&amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt;...). + See the appendices in the eBay Features Guide for general information about + string data types. + + + + + + + + + + + + + + + + + <b>No longer recommended.</b> eBay Store Cross Promotions are no + longer supported in the Trading API. Retrieves all promotion rules associated with the specified item or store category. + + + + Cross-Promotions + + + + + + + + + + + The unique ID of the item for which to retrieve promotion rules. + Mutually exclusive with StoreCategoryID. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetPromotionRules + Conditionally + + + + + + + + The unique ID of the store category for which to retrieve promotion rules. + Mutually exclusive with ItemID. + + + + GetPromotionRules + Conditionally + + + + + + + + The type of promotion. (CrossSell: items that are related to or + useful in combination with this item. UpSell: items that are more + expensive than or of higher quality than this item.) + + + + GetPromotionRules + Yes + + + + + + + + + + + + + + Returns all promotion rules associated with the specified item or store category. + <strong>Note:</strong> eBay Store Cross Promotions are no longer supported in the + Trading API. + + + + + + + + + An array of promotion rules associated with the item or store category + specified in the request. + + + + GetPromotionRules + Always + + + + + + + + + + + + + + Retrieves information about promotional sales set up by an eBay store owner + (the authenticated caller). + + + + GetPromotionRules, SetPromotionalSale, SetPromotionalSaleListings + + + Putting Store Items on Sale + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + The ID of the promotional sale about which you want information. If you do + not specify this field, then all promotional sales for the seller making + the call are returned or only those promotional sales matching the + specified promotional sale status filter, PromotionalSaleStatus. + <br><br> + If PromotionalSaleID and PromotionalSaleStatus are both specified, the + single promotional sale specified by ID is returned only if its status + matches the specified status filter. + + + + GetPromotionalSaleDetails + No + + + + + + + + Specifies the promotional sales to return, based upon their status. For + example, specify "Scheduled" to retrieve only promotional sales with a + Status of Scheduled. If you want to retrieve promotional sales for more + than one status, you can repeat the field with an additional status value, + such as Active. + <br><br> + If this field is used together with PromotionalSaleID, the single + promotional sale specified by ID is returned only if its status + matches the specified status filter. + <br><br> + If neither field is used, all of the seller's promotional sales are + returned, regardless of status. + + + No filtering + + GetPromotionalSaleDetails + No + + + + + + + + + + + + + + Contains information about promotional sales. This call + is part of the Promotional Price Display feature. + + + + + + + + + Contains information about a promotional sale or sales. If you did not + specify a PromotionalSaleID in the request, then all promotional sales + for the seller are returned. Promotional sales enable sellers to add + discounts and/or free shipping to items. + + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + + + + + + + Retrieves a brief summary of the requester's status as an eBay seller. + + + GetAccount, GetFeedback, GetUser + + About Your Seller Dashboard (eBay US online help) + http://pages.ebay.com/help/myebay/seller-dashboard.html + + + Zum Thema Verkaufer-Cockpit (eBay Germany online help) + http://pages.ebay.de/help/myebay/seller-dashboard.html + + + + + + + + + + + + + + Returns a brief summary of the requester's status as an eBay seller. The status + information can help an eBay seller monitor their selling performance and keep + their account in good standing. + + + + + + + + + Provides information about the visibility level you have earned for your + listings. The higher your search standing rating, the higher your items + will be placed in search results sorted by Best Match. Because your search + standing rating is directly tied to your customer service record, this + rating is an important way that eBay rewards you as a good seller--it + encourages you to give buyers the best possible shopping experience. + <br><br> + This element is not returned for all sites. + + + + GetSellerDashboard + Conditionally + + + About Your Seller Dashboard: Search Standing + http://pages.ebay.com/help/myebay/seller-dashboard.html#standing + + + Zum Thema Verkaeufer-Cockpit: Platzierung in der Suche + http://pages.ebay.de/help/myebay/seller-dashboard.html#standing + + + + + + + + Provides information about the PowerSeller discount level you have earned, + if any. As a PowerSeller, you can earn discounts on your monthly invoice + Final Value Fees based on how well you're rated as a seller. Only returned + for members of the eBay US or Canada PowerSeller program. + + + + GetSellerDashboard + Conditionally + + + About Your Seller Dashboard: PowerSeller Discount + http://pages.ebay.com/help/myebay/seller-dashboard.html#discount + + + Zum Thema Verkaeufer-Cockpit: PowerSeller-Rabatt + http://pages.ebay.de/help/myebay/seller-dashboard.html#discount + + + + + + + + Provides information about your PowerSeller status, such as whether or not + you meet the PowerSeller requirements. Your PowerSeller status directly + affects your discount (SellerFeeDiscount). + <br><br> + For eBay Germany and France, you must be a registered business seller to + see your PowerSeller status. + + + + GetSellerDashboard + Conditionally + + + About Your Seller Dashboard: PowerSeller Status + http://pages.ebay.com/help/myebay/seller-dashboard.html#status + + + PowerSeller Benefits and Requirements + http://pages.ebay.com/services/buyandsell/welcome.html + + + Zum Thema Verkaeufer-Cockpit: PowerSeller-Status + http://pages.ebay.de/help/myebay/seller-dashboard.html#status + + + + + + + + This container is no longer returned in <b>GetSellerDashboard</b>. + + + + + + + About Your Seller Dashboard: Policy Compliance + http://pages.ebay.com/help/myebay/seller-dashboard.html#compliance + + + Rules for Sellers + http://pages.ebay.com/help/policies/seller-rules-overview.html + + + Zum Thema Verkaeufer-Cockpit: Einhaltung der Grundsaetze + http://pages.ebay.de/help/myebay/seller-dashboard.html#compliance + + + + + + + + Rates your level of customer service. This information helps you to keep + track of how well you are providing members with positive buying + experiences. + <br><br> + This element is not returned for all sites. + + + + GetSellerDashboard + Conditionally + + + About Your Seller Dashboard: Buyer Satisfaction + http://pages.ebay.com/help/myebay/seller-dashboard.html#buyer + + + Zum Thema Verkaeufer-Cockpit: Kaeuferzufriedenheit + http://pages.ebay.de/help/myebay/seller-dashboard.html#buyer + + + + + + + + The status of your latest eBay invoice. Includes any alerts issued to your + account to help you identify possible problems. + + + + GetSellerDashboard + Always + + + About Your Seller Dashboard: Account Status + http://pages.ebay.com/help/myebay/seller-dashboard.html#account + + + Zum Thema Verkaeufer-Cockpit: Kontostand + http://pages.ebay.de/help/myebay/seller-dashboard.html#account + + + + + + + + Provides information about the seller's performance within different eBay + regions. A seller's performance rating can be Top-Rated, Above Standard, + Standard, and Below Standard. + + + + GetSellerDashboard + Always + + + Top-Rated Seller Status + http://pages.ebay.com/help/sell/top-rated.html + + + About Your Seller Dashboard: Performance Status + http://pages.ebay.com/help/myebay/seller-dashboard.html#performance + + + Zum Thema Verkaeufer-Cockpit: Leistung + http://pages.ebay.de/help/myebay/seller-dashboard.html#performance + + + + + + + + + + + + + + Retrieves price changes, item revisions, description revisions, + and other changes that have occurred within the last 48 hours + related to a seller's eBay listings. + + + DetailLevel + + Working with Seller Events + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-ChangeTracking.html + + + + + + + + + + eBay user ID for the seller whose events are to be returned. + If not specified, retrieves events for the user identified by + the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about + their own listings and bidders who know the user IDs of their sellers + will be able to make this API call successfully. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetSellerEvents + No + + + + + + + + Describes the earliest (oldest) time to use in a time range filter based + on item start time. Must be specified if StartTimeTo is specified. Either + the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. + If you do not specify the corresponding To filter, + it is set to the time you make the call. + For better results, the time period you use should be less than 48 hours. + If 3000 or more items are found, use a smaller time range.<br> + <br> + Include a 2-minute, overlapping buffer between requests. + For example, if StartTimeTo was 6:58 in a prior request, + the current request should use 6:56 in StartTimeFrom + (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). + + + + KB article: Best Practices for GetSellerEvents and GetSellerTransactions + https://ebaydts.com/eBayKBDetails?KBid=222 + + + GetSellerEvents + Conditionally + + + + + + + + Describes the latest (most recent) date to use in a time range filter + based on item start time. If you specify the corresponding From filter, + but you do not include StartTimeTo, the StartTimeTo is set to + the time you make the call. + + + + GetSellerEvents + No + + + + + + + + Describes the earliest (oldest) date to use in a time range filter based + on item end time. Must be specified if EndTimeTo is specified. Either + the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. + If you do not specify the corresponding To filter, + it is set to the time you make the call.<br> + <br> + For better results, the time range you use should be less than 48 hours. + If 3000 or more items are found, use a smaller time range.<br> + <br> + Include a 2-minute, overlapping buffer between requests. + For example, if EndTimeTo was 6:58 in a prior request, + the current request should use 6:56 in EndTimeFrom + (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). + + + + KB article: Best Practices for GetSellerEvents and GetSellerTransactions + https://ebaydts.com/eBayKBDetails?KBid=222 + + + GetSellerEvents + Conditionally + + + + + + + + Describes the latest (most recent) date to use in a time range filter + based on item end time. If you specify the corresponding From filter, + but you do not include EndTimeTo, then EndTimeTo is set + to the time you make the call. + + + + GetSellerEvents + No + + + + + + + + Describes the earliest (oldest) date to use in a time range filter based + on item modification time. Must be specified if ModTimeTo is specified. Either + the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. + If you do not specify the corresponding To filter, + it is set to the time you make the call.<br> + <br> + Include a 2-minute, overlapping buffer between requests. + For example, if ModTimeTo was 6:58 in a prior request, + the current request should use 6:56 in ModTimeFrom + (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). + <br><br> + For better results, the time range you use should be less than 48 hours. + If 3000 or more items are found, use a smaller time range. + <br><br> + If an unexpected item is returned (including an old item + or an unchanged active item), please ignore the item. + Although a maintenance process may have triggered a change in the modification time, + item characteristics are unchanged. + + + + KB article: Best Practices for GetSellerEvents and GetSellerTransactions + https://ebaydts.com/eBayKBDetails?KBid=222 + + + GetSellerEvents + Conditionally + + + + + + + + Describes the latest (most recent) date and time to use in a time range filter + based on the time an item's record was modified. If you specify + the corresponding From filter, but you do not include ModTimeTo, + then ModTimeTo is set to the time you make the call. + Include a 2-minute buffer between the current time and + the ModTimeTo filter. + + + + GetSellerEvents + No + + + + + + + + Default is true. If true, response includes only items that have been modified + within the ModTime range. If false, response includes all items. + + + + GetSellerEvents + No + + + + + + + + Specifies whether to include WatchCount in Item nodes returned. WatchCount + is the number of watches buyers have placed on the item from their My eBay + accounts. + + + + GetSellerEvents + No + + + + + + + + Specifies whether to force the response to include + variation specifics for multi-variation listings. <br> + <br> + If false (or not specified), eBay keeps the response as small as + possible by not returning Variation.VariationSpecifics. + It only returns Variation.SKU as an identifier + (along with the variation price and other selling details). + If the variation has no SKU, then Variation.VariationSpecifics + is returned as the variation's unique identifier.<br> + <br> + If true, Variation.VariationSpecifics is returned. + (Variation.SKU is also returned, if the variation has a SKU.) + This may be useful for applications that don't track variations + by SKU.<br> + <br> + Ignored when HideVariations=true.<br> + <br> + Please note that if the seller includes a large number of + variations in many listings, using this flag may degrade the + call's performance. Therefore, when you use this flag, you may + need to reduce the total number of items you're requesting at + once. For example, you may need to use shorter time ranges in + the EndTime, StartTime, or ModTime filters. + + + false + + GetSellerEvents + No + + + + + + + + Specifies whether to force the response to hide + variation details for multi-variation listings.<br> + <br> + If false (or not specified), eBay returns variation details (if + any). In this case, the amount of detail can be controlled by + using IncludeVariationSpecifics.<br> + <br> + If true, variation details are not returned (and + IncludeVariationSpecifics has no effect). This may be useful for + applications that use other calls, notifications, alerts, + or reports to track price and quantity details. + + + false + + GetSellerEvents + No + + + + + + + + + + + + + + Contains the items returned by the call. Items for which a seller event has + occurred (and that meet any filters specified as input) are returned in an + ItemArrayType object, within which are zero, one, or multiple ItemType objects. + Each ItemType object contains the detail data for one item listing. + + + + + + + + + Indicates the latest (most recent) date for any date-based filtering specified as + input. Specifically, this field contains the value you specified in the StartTimeTo, EndTimeTo, or ModTimeTo filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time. + + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Collection of items whose last modified time matches + the filters specified in the request. + Returns empty if no items were modified within the + time range of the request. + If 1 to 2999 items are returned, then the results are + complete. If 3000 or more items are returned, it usually means + additional items exist within the time range you requested, + but they were not all returned. To retrieve complete results, + use a smaller time range in the request so that fewer than + 3000 are returned per response. + + + + KB article: Best Practices for GetSellerEvents and GetSellerTransactions + https://ebaydts.com/eBayKBDetails?KBid=222 + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + + + + + + + Returns a list of the items posted by the authenticated user, including + the related item data. + + + DetailLevel, GranularityLevel + AddItem, GetBidderList, GetItem, RelistItem, ReviseItem + + GetSellerList + + + + Browsing a Seller's Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Items-Retrieving.html + + + GetBidderList + + + + + + + + + + Specifies the seller whose items will be returned. UserID is an optional + input. If not specified, retrieves listings for the user identified by the + authentication token passed in the request. Note that since user + information is anonymous to everyone except the bidder and the seller + (during an active auction), only sellers looking for information about + their own listings and bidders who know the user IDs of their sellers will + be able to make this API call successfully. + + + + GetSellerList + No + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + Specifies the list of Motors Dealer sellers for which a special set of + metrics can be requested. Applies to eBay Motors Pro applications only. + + + + GetSellerList + No + + + + + + + + Specifies the earliest (oldest) date to use in a date range filter based on + item end time. Specify either an end-time range or a start-time range + filter in every call request. Each of the time ranges must be a value less than + 120 days. + + + + GetSellerList + Conditionally + + + + + + + + Specifies the latest (most recent) date to use in a date range filter based + on item end time. Must be specified if EndTimeFrom is specified. + + + + GetSellerList + Conditionally + + + + + + + + Specifies the order in which returned items are sorted (based on the end + dates of the item listings). Valid values: + <br> + 0 = No sorting<br> + 1 = Sort in descending order<br> + 2 = Sort in ascending order<br> + + + + GetSellerList + No + + + + + + + + Specifies the earliest (oldest) date to use in a date range filter based on + item start time. Each of the time ranges must be a value less than + 120 days. In all calls, at least one date-range filter must be specified + (i.e., you must specify either the end time range or start time range + in every request). + + + + GetSellerList + Conditionally + + + + + + + + Specifies the latest (most recent) date to use in a date range filter based + on item start time. Must be specified if StartTimeFrom is specified. + + + + GetSellerList + Conditionally + + + + + + + + Contains the data controlling the pagination of the returned values. + If you set a DetailLevel in this call, you must set pagination values. + The Pagination field contains + the number of items to be returned per page of data (per call), + and the page number to return with the current call. + + + + GetSellerList + Yes + + + + + + + + Specifies the subset of item and user fields to return. See GetSellerList + in the eBay Features Guide for a list of the fields that are returned + for each granularity level. For GetSellerList, use DetailLevel or + GranularityLevel in a request, but not both. For GetSellerList, if + GranularityLevel is specified, DetailLevel is ignored. + + + + GetSellerList + + + Yes + + GetSellerList + No + + + + + + + + Container for a set of SKUs. + Filters (reduces) the response to only include active listings + that the seller listed with any of the specified SKUs. + If multiple listings include the same SKU, they are + all returned (assuming they also match the other criteria + in the GetSellerList request).<br> + <br> + SKUArray can be used to retrieve items listed by the user + identified in AuthToken or in UserID.<br> + <br> + <span class="tablenote"><b>Note:</b> + Listings with matching SKUs are returned regardless of their + Item.InventoryTrackingMethod settings. + </span> + + + + GetSellerList + No + + + + + + + + Specifies whether to include WatchCount in Item nodes returned. + WatchCount is only returned with DetailLevel ReturnAll. + + + + GetSellerList + No + + + + + + + + Specifies whether to return only items that were administratively ended + based on a policy violation. + + + + GetSellerList + No + + + + + + + + The category ID for the items retrieved. + If you specify CategoryID in a GetSellerList call, + the response contains only items in the category you specify. + + + + GetSellerList + No + + + + + + + + If true, the Variations node is returned for all multi-variation + listings in the response.<br> + <br> + Please note that if the seller includes a large number of + variations in many listings, using this flag may degrade the + call's performance. Therefore, when you use this flag, you + may need to reduce the total number of items you're requesting + at once. + For example, you may need to use shorter time ranges in the + EndTime or StartTime filters, fewer entries per page in + Pagination, and/or SKUArray. + + + + GetSellerList + No + + + + + + + + + + + + + + Contains a list of the items listed by the seller specified as input. The list of + items is returned in an ItemArrayType object, in which are returned zero, one, or + multiple ItemType objects. Each ItemType object contains the detail data for one + item listing. + + + + + + + + + Contains information regarding the pagination of data (if pagination is + used), including total number of pages and total number of entries. + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + If true, there are more items yet to be retrieved. Additional + GetSellerList calls with higher page numbers or more items per page must + be made to retrieve these items. Not returned if no items match the + request. + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contains the list of the seller's items, one ItemType object per item. + Returns empty if no items are available that match the request. + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Indicates the number of items that are being returned per page of data + (i.e., per call). Will be the same as the value specified in the + Pagination.EntriesPerPage input. Only returned if items are returned. + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates which page of data was just returned. Will be the same as the + value specified in the Pagination.PageNumber input. (If the input is + higher than the total number of pages, the call fails with an error.) + Only returned if items are returned. + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the total number of items returned (i.e., the number of + ItemType objects in ItemArray). + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Indicates the seller whose items are returned. The seller is the eBay + member whose UserID was passed in the request. If UserID was not + specified, the seller is the user who made the request (identified by + eBayAuthToken). + + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + + + + + + + + + + + + <b>Half.com only.</b>&nbsp;Retrieves a summary of pending or paid payments that Half.com created for the + seller identified by the authentication token in the request. Only retrieves + payments that occurred within a particular pay period. Each payment is for one + order line item in one order. An order can contain order line items for + multiple items from multiple sellers, but this call only retrieves payments that + are relevant to one seller. The financial value of a payment is typically based on + an amount that a buyer paid to Half.com for an order line item, with adjustments for + shipping costs and Half.com's commission. For most sellers, each month contains + two pay periods: One from the 1st to the 15th of the month, and one from the 16th + to the last day of the month. Sellers can refer to their account information on + the Half.com site to determine their pay periods. (You cannot retrieve a seller's + pay periods by using eBay API.) When a buyer makes a purchase and an + order is created, Half.com creates a payment for the seller and marks it as + Pending in the seller's Half.com account. Within a certain number of days after + the pay period ends, Half.com settles payments for that period and marks each + completed payment as Paid. See the Half.com Web site online help for more + information about how payments are managed. + + + IssueRefund + + Half.com + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-Half.html + + + + + + + + + + Filter to retrieve only items with the specified payment status (Paid or + Pending). "Pending payments" are payments that Half.com has created but + that have not yet been sent to the seller's financial institution. Pending + payments are typically available once a buyer pays for an order. As + Half.com processes payments by using periodic batch jobs, the + GetSellerPayments response might not include an order line item's payment for + up to 20 minutes after the buyer has paid. You can retrieve pending + payments for the current pay period. Pending payments that have not been + settled yet can also be retrieved for previous pay periods. "Paid + payments" are payments that Half.com processed during previous pay + periods. Paid payments might not appear in the seller's financial + institution account balance until a certain number of days after the + current pay period ends (see the Half.com online help for details). You + can only retrieve paid payments for one previous pay period at a time. + + + + GetSellerPayments + Canceled + Yes + + + + + + + + Time range filter that retrieves Half.com payments that were created within + a single pay period. Sellers can refer to the Half.com site to determine + their pay periods. PaymentTimeFrom is the earliest (oldest) time and + PaymentTimeTo is the latest (most recent) time in the range. Half.com pay + periods start and end at midnight Pacific time, but the time values are + stored in the database in GMT (not Pacific time). See "Time Values" in the + eBay Features Guide for information about converting between GMT and + Pacific time. <br> + <br> + If you specify a PaymentStatus of Pending, add a buffer of one hour (or one + day) to both ends of the time range to retrieve more data than you need, and + then filter the results on the client side as needed. If any pending + payments match the request, the response may include all payments since the + beginning of the period. <br> + <br> + If you specify a PaymentStatus of Paid, the time range must contain one + full pay period. That is, PaymentTimeFrom must be earlier or equal the + start time of the pay period, and PaymentTimeTo must be later than or + equal to the end time of the pay period. Otherwise, no paid payments are + returned. For example, if the pay period starts on 2005-09-16 and ends on + 2005-09-30, you could specify an earlier PaymentTimeFrom value of + 2005-09-16T00:00:00.000Z and a later PaymentTimeTo value of + 2005-10-01T12:00:00.000Z. <br> + <br> + If you specify a time range that covers two pay periods, only the payments + from the most recent pay period are returned. The earliest time you can + specify is 18 months ago. + + + + GetSellerPayments + Yes + + + + + + + + Time range filter that retrieves Half.com payments for a single pay + period. See the description of PaymentTimeTo for details about using this + time range filter. For paid payments, this value should be equal to or + later than the end of the last day of the pay period, where the time is + converted to GMT. For example, if the period ends on 2005-09-30, you could + specify 2005-10-01T09:00:00.000Z, which is later than the end of the last + day. + + + + GetSellerPayments + Yes + + + + + + + + If many payments are available, you may need to call GetSellerPayments + multiple times to retrieve all the data. Each result set is returned as a + page of entries. Use this Pagination information to indicate the maximum + number of entries to retrieve per page (i.e., per call), the page number + to retrieve, and other data. + + + + GetSellerPayments + No + + + + + + + + + + + + + + Returns a summary of pending or paid payments that Half.com created for the seller + identified by the authentication token in the request. Only returns payments that + occurred within a particular pay period. Each payment is for one transaction for + one item in one order. An order can contain transactions for multiple items from + multiple sellers, but this call only retrieves payments that are relevant to one + seller. Payments are only issued for items and transactions that the seller has + confirmed (see the Half.com online help for details). The financial value of a + payment is typically based on an amount that a buyer paid to Half.com for a + transaction, plus the shipping cost the buyer paid to Half.com for the item, minus + Half.com's commission. For most sellers, each month contains two pay periods: One + from the 1st to the 15th of the month, and one from the 16th to the last day of + the month. Payments are submitted to the seller's financial institution a certain + number of days after the current pay period ends (see the Half.com online help for + details). + + + + + + + + + Contains information regarding the pagination of data (if pagination is used), + including total number of pages and total number of entries. + + + + GetSellerPayments + Always + + + + + + + + If true, there are more payments yet to be retrieved. Additional + GetSellerPayments calls with higher page numbers or more entries per page + must be made to retrieve these payments. If false, no more payments are + available or no payments match the request (based on the payment status + and time filter). + + + + GetSellerPayments + Always + + + + + + + + Information about a single payment that matches the criteria in the + request. A payment is between Half.com and a seller. Each payment is for + one transaction for one item in one order. An order can contain + transactions for multiple items from multiple sellers, but this call only + retrieves payments that are relevant to one seller. The financial value of + a payment is typically based on an amount that a buyer paid to Half.com + for a transaction, plus the shipping cost the buyer paid for the item, + minus Half.com's commission. Payments can also describe refunds that the + seller has issued. Multiple SellerPayment entries can be returned per page + of results. Typically, they are returned in reverse chronological order + (most recent PaidTime first). Only returned if payments exist that match + the request. + + + + GetSellerPayments + Conditionally + + + + + + + + Indicates the number of payments that can be returned per page of data + (i.e., per call). This is the same as the value specified in the + Pagination.EntriesPerPage input (or the default value, if EntriesPerPage + was not specified). This is not necessarily the actual number of payments + returned per page (see ReturnedPaymentCountActual). + + + + GetSellerPayments + Always + + + + + + + + Indicates which page of data holds the current result set. Will be the + same as the value specified in the Pagination.PageNumber input. (If the + input is higher than the total number of pages, the call fails with an + error.) If no payments are returned, the value is 0. If payments are + returned, the first page number is 1. + + + + GetSellerPayments + Always + + + + + + + + Indicates the total number of payments returned (i.e., the number of + SellerPayment entries returned. + + + + GetSellerPayments + Always + + + + + + + + + + + + + + Retrieves order line item (transaction) information for the user for which the + call is made, and not for any other user.&nbsp;<b>Also for + Half.com</b>. (To retrieve order line items for another seller's listings, use + GetItemTransactions.) + + + + Retrieves order line item (transaction) information for the user for which the + call is made, and not for any other user.&nbsp;<b>Also for + Half.com</b>. (To retrieve order line items for another seller's listings, use + GetItemTransactions.) + + DetailLevel + GetItemTransactions, GetOrderTransactions + + Email and Address Privacy Policy + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + the conditions under which buyer and seller email and address are returned + + + Retrieving Order Line Item Data and Managing Orders + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html#RetrievingtheOrderLineItemsforaSpecificS + + + + + + + + + + The ModTimeFrom and ModTimeTo fields specify a date range for retrieving + order line items associated with the seller. The ModTimeFrom + field is the starting date range. All of the seller's order line items that were + last modified within this date range are returned in the output. The + maximum date range that may be specified is 30 days. This field is not + applicable if the NumberOfDays date filter is used. + <br><br> + If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays + time filter is used and it defaults to 30 (days). + + + + GetSellerTransactions + No + + + + + + + + The ModTimeFrom and ModTimeTo fields specify a date range for retrieving + order line items associated with the seller. The ModTimeTo + field is the ending date range. All of the seller's order line items that were last + modified within this date range are returned in the output. The maximum + date range that may be specified is 30 days. If the ModTimeFrom field is + used and the ModTimeTo field is omitted, the ModTimeTo value defaults to + the present time or to 30 days past the ModTimeFrom value (if + ModTimeFrom value is more than 30 days in the past). This field is not + applicable if the NumberOfDays date filter is used. + <br><br> + If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays + time filter is used and it defaults to 30 (days). + + + + GetSellerTransactions + No + + + + + + + + Child elements control pagination of the output. Use EntriesPerPage property to + control the number of transactions to return per call and PageNumber property to + specify the page of data to return. + + + + GetSellerTransactions + No + + + + + + + + Indicates whether to include Final Value Fee (FVF) in the response. For most + listing types, the Final Value Fee is returned in Transaction.FinalValueFee. + The Final Value Fee is returned for each order line item. + <br> + + + + GetSellerTransactions + No + + + + + + + + Include this field and set it to True if you want the ContainingOrder + container to be returned in the response under each Transaction node. + For single line item orders, the ContainingOrder.OrderID value takes the + value of the OrderLineItemID value for the order line item. For Combined Invoice orders, the ContainingOrder.OrderID value will be shared by at + least two order line items (transactions) that are part of the same + order. + + + false + + GetSellerTransactions + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Container for a set of SKUs. + Filters (reduces) the response to only include order line items + for listings that include any of the specified SKUs. + If multiple listings include the same SKU, order line items for + all of them are returned (assuming they also match the other + criteria in the GetSellerTransactions request).<br> + <br> + You can combine SKUArray with InventoryTrackingMethod. + For example, if you also pass in InventoryTrackingMethod=SKU, + the response only includes order line items for listings that + include InventoryTrackingMethod=SKU and one of the + requested SKUs. + + + + GetSellerTransactions + No + + + + + + + + The default behavior of <b>GetSellerTransactions</b> is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com. + + + + GetSellerTransactions + No + CustomCode, eBay, Half + + + + + + + + NumberOfDays enables you to specify the number of days' worth of new and modified + order line items that you want to retrieve. The call response contains the + order line items whose status was modified within the specified number of days since + the API call was made. NumberOfDays is often preferable to using the ModTimeFrom + and ModTimeTo filters because you only need to specify one value. If you use + NumberOfDays, then ModTimeFrom and ModTimeTo are ignored. For this field, one day + is defined as 24 hours. + + + 30 + + GetSellerTransactions + No + + + + + + + + Filters the response to only include order line items for listings + that match this InventoryTrackingMethod setting. <br> + <br> + For example, if you set this to SKU, the call returns + order line items for your listings that are tracked by SKU. + If you set this to ItemID, the call omits order line items + for your listings that are tracked by SKU. + If you don't pass this in, the call returns all order line items, + regardless of whether they are tracked by SKU or ItemID.<br> + <br> + <span class="tablenote"><b>Note:</b> + To specify InventoryTrackingMethod when you create a listing, + use AddFixedPriceItem or RelistFixedPriceItem. + AddFixedPriceItem and RelistFixedPriceItem are defined in + the Merchant Data API (part of Large Merchant Services). + </span> + <br> + <br> + You can combine SKUArray with InventoryTrackingMethod. + For example, if you set this to SKU and you also pass in + SKUArray, the response only includes order line items for listings + that include InventoryTrackingMethod=SKU and one of the + requested SKUs. + + + + GetSellerTransactions + No + + + + + + + + If true, returns the Tax code for the user. + + + false + + GetSellerTransactions + No + + + + + + + + + + + + + + Returns an array of order line item (transaction) data for the seller specified in the request. + The results can be used to create a report of data that is commonly + necessary for order processing. + Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>. + The set of order line items returned is limited to those that were modified between + the times specified in the request's <b>ModTimeFrom</b> and <b>ModTimeTo</b> filters. + The order line items returned are sorted by <b>Transaction.Status.LastTimeModified</b>, + ascending order (that is, order line items that more recently were modified are returned last). + Also returns information about the seller whose order line items were requested. + If pagination filters were specified in the request, returns meta-data describing + the effects of those filters on the current response and the estimated effects if + the same filters are used in subsequent calls. + + + + + + + + + Container consisting of the total number of order line items that match the input + criteria and the total number of pages that must be scrolled through to view all order + line items. To scroll through each page of order line item data, make subsequent + <b>GetSellerTransactions</b> calls, incrementing the <b>Pagination.PageNumber</b> + field by a value of '1' each time. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + This flag indicates whether there are additional pages of order line items to view. + This field will be returned as 'true' if there are additional pages or order line items + to view, or 'false' if the current page of order line item data is the last page of + data. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + This value indicates the number of order line items returned per page (per call) and is + controlled by the <b>Pagination.EntriesPerPage</b> value passed in the call + request. Unless it is the last (or possibly only) page of data (<b>HasMoreTransactions=false</b>), + the <b>TransactionsPerPage</b> value should equal the + <b>Pagination.EntriesPerPage</b> value passed in the call request. + <br> + <br> + <span class="tablenote"><b>Note:</b> + Due to the fact that item data on the eBay platform has a shorter retention period than + order data, it is possible that some retrieved pages will contain no data. For pages + that contain no data, the <b>ReturnedTransactionCountActual</b> value will + be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do + have data. Therefore, we recommend that you scroll through each page of data (making + subsequent <b>GetSellerTransactions</b> calls and incrementing the + <b>Pagination.PageNumber</b> value by '1' each time) until you reach the + last page, indicated by <b>HasMoreTransactions=false</b>. + </span> + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + This value indicates the page number of retrieved order line items that match the input + criteria. This value is controlled by the <b>Pagination.PageNumber</b> + value passed in the call request. To scroll through all pages of order line items that match the + input criteria, you increment the <b>Pagination.PageNumber</b> value by '1' + with each subsequent <b>GetSellerTransactions</b> call. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + This value indicates the total number of (non-empty) order line items retrieved in the + current page of results. The <b>ReturnedTransactionCountActual</b> value + will be lower than the <b>TransactionsPerPage</b> value if one or more + empty order line items are retrieved on the page. + <br> + <br> + <span class="tablenote"><b>Note:</b> + Due to the fact that item data on the eBay platform has a shorter retention period than + order data, it is possible that some retrieved pages will contain no data. For pages + that contain no order line item data, the <b>ReturnedTransactionCountActual</b> value will + be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do + have data. Therefore, we recommend that you scroll through each page of data (making + subsequent <b>GetSellerTransactions</b> calls and incrementing the + <b>Pagination.PageNumber</b> value by '1' each time) until you reach the + last page, indicated by <b>HasMoreTransactions=false</b>. + </span> + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + Contains information about the seller whose order line items are being returned. + See the reference guide for information about the <b>Seller</b> object fields + that are returned. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + List of <b>Transaction</b> objects representing the seller's recent sales. + Each <b>Transaction</b> object contains the data for one purchase + (of one or more items in the same listing). + See the reference guide for more information about the fields that are returned + for each order line item. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the seller has the preference enabled that shows that the seller + prefers PayPal as the method of payment for an item. This preference is indicated on + an item's View Item page and is intended to influence a buyer to use PayPal + to pay for the item. + + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + + + + + + + + + + + + Retrieves Selling Manager alerts. + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + + + + Type defining the call-specific response fields for the <b>GetSellingManagerAlerts</b> + call. + + + + + + + + + Container consisting of details related to a Selling Manager alert. Alert types + include listing automation, inventory, PaisaPay (India only), item sold, and + a general alert. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + + + + + + + + Retrieves a log of emails sent, or scheduled to be sent, to buyers. + <br><br> + The standard Trading API + deprecation process is not applicable to this call. + + + + Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes + success or failure status. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Unique identifier for the eBay item listing associated with the Selling + Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is + specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be + used to identify the Selling Manager email log to retrieve. You can + use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> + or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale + record (<b>SaleRecordID</b>). All four of these fields are returned under the + <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. + + + + GetSellingManagerEmailLog + Conditionally + + + + + + + + Unique identifier for the order line item (transaction) associated with + the Selling Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> + value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields + must be used to identify the Selling Manager email log to retrieve. + You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, + <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling + Manager sale record (<b>SaleRecordID</b>). All four of these fields are + returned under the <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. + + + + GetSellingManagerEmailLog + No + + + + + + + + A unique identifier that identifies a single line item or multiple line item + (Combined Invoice) order associated with the Selling Manager email log. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b> value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order through + the eBay site (or when the seller creates Combined Invoice order through + <b>AddOrder</b>). If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and + <b>ItemID</b>/<b>TransactionID</b> pair are not required. + + + 50 + + GetSellingManagerEmailLog + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Specifies the earliest (oldest) and latest (most recent) dates to use in a + date range filter based on email sent date. Each of the time ranges can be + up to 90 days. + + + + GetSellingManagerEmailLog + No + + + + + + + + A unique identifier for an eBay order line item that is associated with + the Selling Manager email log. This field is created as soon as there + is a commitment to buy from the seller, and its value is based upon the + concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between + these two IDs. You can use <b>GetSellingManagerSoldListings</b> to retrieve the + <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the + Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are + returned under the <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an + <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> + request, the <b>OrderLineItemID</b> is required. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + GetSellingManagerEmailLog + Conditionally + + + + + + + + + + + + + + Returns the log of emails not sent. + + + + + + + + + Email logs associated with this order. + + + + GetSellingManagerEmailLog + Always + + + + + + + + + + + + + + + Retrieves a paginated list containing details of a user's Selling Manager inventory. + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + + Retrieves a paginated listing of a user's Selling Manager inventory. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Sets the sorting method for the results. + + + + GetSellingManagerInventory + No + + + + + + + + Specifies the inventory folder containing the requested inventory information. + + + + GetSellingManagerInventory + No + + + + + + + + Details about how many Products to return per page and which page to view. + + + + GetSellingManagerInventory + No + + + + + + + + Order to be used for sorting retrieved product lists. + + + + GetSellingManagerInventory + No + + + + + + + + Specifies types and values to search for in the seller's listings. + + + + GetSellingManagerInventory + No + + + + + + + + Specifies a store category whose products will be returned. + + + + GetSellingManagerInventory + No + + + + + + + + Container for the list of filters that can be applied to the inventory information requested. + + + + GetSellingManagerInventory + No + + + + + + + + + + + + + + Contains a list of the products created by the seller. The list of products is returned as a set + of tags, in which are returned zero, one, or multiple SellingManagerProductType objects. Each + SellingManagerProductType object contains the information about for one Selling Manager product + and any Selling Manager templates the product contains. + + + + + + + + + Returns the date the inventory counts were last calculated. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Container for information about the requested products and templates. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Contains the total number of pages (TotalNumberOfPages) and the total + number of products entries (TotalNumberOfEntries) that can be returned + on repeated calls with the same format and report criteria. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + + + + + + + Retrieves Selling Manager inventory folders. + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + If a FolderID is submitted, all child-folders below this folder will be returned. + + + + GetSellingManagerInventoryFolder + No + + + + + + + + Specifies the number of levels of subfolders to be returned. If 0, the parent folder + is returned. If 1, the parent and child folders are returned. If 2, the parent and + two levels of child folders are returned. Ignored if FullRecursion is set to True. + + + 1 + + GetSellingManagerInventoryFolder + No + + + + + + + + Displays the entire tree of a user's folders. If this is provided, FolderID and MaxDepth + need not be given. + + + + GetSellingManagerInventoryFolder + No + + + + + + + + + + + + + + Returns the folder structure of the input folderID. + + + + + + + + + Details of the requested folder. + + + + GetSellingManagerInventoryFolder + Always + + + + + + + + + + + + + + + Retrieves the set of Selling Manager automation rules + associated with an item. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + SetSellingManagerItemAutomationRule + + + + + + + + + The ID of the item whose Selling Manager automation rules + you want to retrieve. + + + + GetSellingManagerItemAutomationRule + Yes + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified item. + + + + + + + + + The information for the automated listing rule associated with the item. + This field is only returned if the item was listed from a template. + The value in this field refers to that template's automated listing rule. + + + + GetSellingManagerItemAutomationRule + Conditionally + + + + + + + + The information for the automated relisting rule associated with the item. + + + + GetSellingManagerItemAutomationRule + Conditionally + + + + + + + + The information for the automated second chance offer rule associated with the item. + + + + GetSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rule (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + GetSellingManagerItemAutomationRule + Conditionally + + + + + + + + + + + + + + Retrieves the data for one or more Selling Manager sale records. + <br><br> + The standard Trading API + deprecation process is not applicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Unique identifier for the eBay item listing associated with the Selling + Manager sale record. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is + specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be + used to identify the Selling Manager sale record to retrieve. You can + use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> + or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale + record (<b>SaleRecordID</b>). All four of these fields are returned under the + <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Unique identifier for the order line item (transaction) associated with + the Selling Manager sale record. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> + value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields + must be used to identify the Selling Manager sale record to retrieve. + You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, + <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling + Manager sale record (<b>SaleRecordID</b>). All four of these fields are + returned under the <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + A unique identifier that identifies a single line item or multiple line item + (Combined Invoice) order associated with the Selling Manager sale record(s). + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b>value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order through + the eBay site (or when the seller creates Combined Invoice order through + <b>AddOrder</b>). If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and + <b>ItemID</b>/<b>TransactionID</b> pair are not required. + + + + GetSellingManagerSaleRecord + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + A unique identifier for an eBay order line item that is associated with + the Selling Manager sale record. This field is created as soon as there + is a commitment to buy from the seller, and its value is based upon the + concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between + these two IDs. You can use <b>GetSellingManagerSoldListings</b> to retrieve the + <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the + Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are + returned under the <b>SellingManagerSoldTransaction</b> container of the + <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an + <b>ItemID</b>/<b>Transaction</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> + request, the <b>OrderLineItemID</b> is required. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + + + + + + + Response to a GetSellingManagerSaleRecord call. + + + + + + + + + Contains the data in a Selling Manager sale record. + + + + GetSellingManagerSaleRecord + Always + + + + + + + + + + + + + + Returns a Selling Manager user's sold listings. + <br><br> + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + + Retrieves information about items that a seller has sold. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Search filters for sold listings. + + + + GetSellingManagerSoldListings + No + + + + + + + + Listings with this store category ID will be listed. + + + + GetSellingManagerSoldListings + No + + + + + + + + This holds the list of filters that can be applicable for sold listings. + + + + GetSellingManagerSoldListings + No + + + + + + + + Requests listing records that are more than 90 days old. Records are archived between 90 + and 120 days after being created, and thereafter can only be retrieved using this tag. + + + + GetSellingManagerSoldListings + No + + + + + + + + Field to be used to sort the response. + + + + GetSellingManagerSoldListings + No + + + + + + + + Order to be used for sorting the requested listings. + + + + GetSellingManagerSoldListings + No + + + + + + + + Details about how many listings to return per page and which page to view. + + + + GetSellingManagerSoldListings + No + + + + + + + + Specifies the earliest (oldest) and latest (most recent) dates to use in a date + range filter based on item start time. A time range can be up to 120 + days. + + + + GetSellingManagerSoldListings + No + + + + + + + + + + + + + + Returns a Selling Manager user's sold listings. Response can be filtered by date, search + values, and stores. + + + + + + + + + Returns a Selling Manager user's sold listings. + + + + GetSellingManagerSoldListings + Always + + + + + + + + Contains the total number of pages (TotalNumberOfPages) and the total + number of products entries (TotalNumberOfEntries) that can be returned + on repeated calls with the same format and report criteria. + + + + GetSellingManagerSoldListings + Always + + + + + + + + + + + + + + + Retrieves the set of Selling Manager automation rules associated + with a Selling Manager template. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates,SetSellingManagerTemplateAutomationRule + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + SetSellingManagerTemplateAutomationRule + + + + + + + + + The ID of the Selling Manager template whose Selling Manager + automation rules you want to retrieve. + You can obtain a SaleTemplateID by calling GetSellingManagerInventory. + + + + GetSellingManagerTemplateAutomationRule + Yes + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified template. + + + + + + + + + The information for the automated listing rule associated with the template. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The information for the automated relisting rule associated with the template. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The information for the automated second chance offer rule associated with the template. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rule (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + + + Retrieves Selling Manager templates. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the template whose data will be returned. + A SaleTemplateID is the ID of a Selling Manager template. + A Selling Manager template contains the data needed to list an item. + One or more template IDs can be specified, each in + its own container. + You can obtain a SaleTemplateID by calling GetSellingManagerInventory. + + + + GetSellingManagerTemplates + Yes + + + + + + + + + + + + + + Contains the templates requested on input. + Each SellingManagerTemplateType object in the response contains the data for one + Selling Manager template. + + + + + + + + + Contains the data of the templates requested on input. + A Selling Manager template contains the data needed to list an item. + Empty if no items are available that match the request. + + + + GetSellingManagerTemplates + Always + + + + + + + + + + + + + + Retrieves a session ID that identifies a user and your application when you make a FetchToken request. + + + ConfirmIdentity, FetchToken, GetTokenStatus, RevokeToken + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + Getting a Token via FetchToken + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens-MultipleUsers.html#GettingaTokenviaFetchToken + + + Setting Up the Application to Receive Tokens + http://developer.ebay.com/Devzone/xml/docs/HowTo/Tokens/GettingTokens.html#step1 + + + + + + + + + + The runame provided must match the one that will be used for validation + during the creation of a user token. + + + + GetSessionID + Yes + + + + + + + + + + + + + + Contains the generated SessionID, which is a unique identifier for authenticating data entry during the process that creates a user token. + + + + + + + + + A 40-character identifier supplied by eBay to an application. Used to confirm the + identities of the user and the application in a URL redirect during the + process in which the user agrees to let the application wield a user token that + grants the application the right to access eBay data on behalf of the user. + Subsequently also used as input for the FetchToken API call. The + SessionID is valid for five minutes after it is retrieved. + + + + GetSessionID + Always + + + + + + + + + + + + + + Returns the shipping discount profiles defined by the user, along with other Combined + Invoice-related details such as packaging and handling costs. + + + + AddItem, GetItem, RelistItem, RevisteItem, SetShippingDiscountProfiles, VerifyAddItem + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + Response to call of GetShippingDiscountProfiles. + + + + + + + + + The three-digit code of the currency to be used for shipping cost discounts and + insurance for Combined Invoice orders. A discount profile can only be associated + with a listing if the <b>CurrencyID</b> value of the profile matches the + <b>Item.Currency</b> value specified in a listing. + + + + GetShippingDiscountProfiles + Always + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Details of an individual discount profile defined by the + user for flat rate shipping--one for each profile defined by the user. + Empty if no shipping discount profiles were defined. + + + + GetShippingDiscountProfiles + Always + + + + + + + + Details of an individual discount profile defined by the + user for calculated shipping--one for each profile defined by the user. + Empty if no shipping discount profiles were defined. + + + + GetShippingDiscountProfiles + Always + + + + + + + + Indicates whether the user defined a promotional discount (the discount is active + as soon as it exists). + + + + GetShippingDiscountProfiles + Always + + + + + + + + This container is used by the seller to specify/modify packaging and handling discounts that are applied + for Combined Invoice orders. This container is only returned if it is set for the Shipping Discount Profile. + + + + GetShippingDiscountProfiles + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + The data for the specific promotional shipping discount. + Returned only if it has been defined. + + + + GetShippingDiscountProfiles + Conditionally + + + + + + + + The data for the domestic insurance for Combined Invoice. + Returned only if it has been defined. + + + + GetShippingDiscountProfiles + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + The data for the international insurance for Combined Invoice. + Returned only if it has been defined. + + + + GetShippingDiscountProfiles + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This field indicates the number of days after the sale of an + item in which the buyer or seller can combine multiple and mutual order + line items into one Combined Invoice order. In a Combined Invoice order, + the buyer makes one payment for all order line items, hence only unpaid + order line items can be combined into a Combined Invoice order. + + + + GetShippingDiscountProfiles + Always + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + + Retrieves configuration information for the eBay store owned by the specified + UserID, or by the caller. + + + + GetStoreCategoryUpdateStatus, GetStoreCustomPage, GetStoreOptions, + SetStore, SetStoreCategories, SetStoreCustomPage + + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + Editing the Store Settings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + If this is set to True, only the category structure of the store is + returned. If this is not specified or set to False, the complete store + configuration is returned. + + + + GetStore + Conditionally + + + + + + + + Specifies the category ID for the topmost category to return (along with + the subcategories under it, the value of the LevelLimit property + determining how deep). This tag is optional. If RootCategoryID is not + specified, then the category tree starting at that root Category is + returned. + + + + GetStore + Conditionally + + + + + + + + Specifies the limit for the number of levels of the category hierarchy + to return, where the given root category is level 1 and its children are + level 2. Only categories at or above the level specified are returned. + This tag is optional. If LevelLimit is not set, the complete category + hierarchy is returned. Stores support category hierarchies up to 3 + levels only. + + + + GetStore + Conditionally + + + + + + + + Specifies the user whose store data is to be returned. If not specified, + then the store returned is that for the requesting user. + + + + GetStore + No + + + + + + + + + + + + + + Returns the data describing a seller's eBay store, including name, description, + URL, and other information. The caller making the request must be the owner + of an eBay store. If the authenticated caller does not have an eBay store, the + response is an error. A successful response contains either the complete store + configuration or information about the category hierarchy for the store only. + + + + + + + + + The data describing the store configuration. + + + + GetStore + Always + + + + + + + + + + + + + + Returns the status of the processing for category-structure changes specified + with a call to SetStoreCategories. + + + GetStore, SetStore, SetStoreCategories + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + The task ID returned by the SetStoreCategories call. If the + SetStoreCategories call was processed asynchronously, the TaskID will be + a positive number. If SetStoreCategories returned a TaskID with a value of + 0, the change was completed at the time the call was made (and there is + no need to check status). + + + + GetStoreCategoryUpdateStatus + Yes + + + + + + + + + + + + + + Returns the store category structure update status, when a prior + SetStoreCategories call was processed asynchronously. If a SetStoreCategories + request affects many listings, then the category structure changes will be + processed asynchronously. If not many listings are affected by category structure + changes, the status is returned in the SetStoreCategories response. + + + + + + + + + The status (Pending, InProgress, Complete, or Failed) of an update to the + store category structure. + + + + GetStoreCategoryUpdateStatus + Always + + + + + + + + + + + + + + Retrieves the custom page or pages for the authenticated user's Store. + + + GetStoreOptions, GetStore, SetStore, SetStoreCustomPage + + Managing Custom Pages + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + If a PageID is specified, then that page is returned, and the returned page + contains the page Content. If no PageID is specified, then all pages are + returned, without the page Content. + + + + GetStoreCustomPage + No + + + + + + + + + + + + + + Contains the custom page or pages for the user's Store. + + + + + + + + + The custom page or custom pages. + + + + GetStoreCustomPage + Always + + + + + + + + + + + + + + Retrieves the current list of eBay store configuration settings. + + + GetStore + + Editing the Store Settings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + + + + + Contains the current list of options for Store configurations. + + + + + + + + + The current set of basic themes. Each basic theme definition + specifies a valid color scheme for the theme. + + + + GetStoreOptions + Always + + + + + + + + The current set of advances themes. Unlike basic themes, you + can use any color scheme with an advanced theme. These themes + are suitable for more advanced customization. + + + + GetStoreOptions + Always + + + + + + + + The current set of Store logos. These logos are used in the Store header. + + + + GetStoreOptions + Always + + + + + + + + The current set of eBay Store subscription tiers and corresponding + subscription prices. + + + + GetStoreOptions + Always + + + + + + + + The maximum number of categories in this store. + + + + GetStoreOptions + Always + + + + + + + + The maximum number of category levels in this store. + + + + GetStoreOptions + Always + + + + + + + + + + + + + + Retrieves a user's Store preferences. + + + SetStore, SetStorePreferences + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + + + + Contains the Store preferences retrieved for a user. + + + + + + + + + The user's Store preferences. + + + + GetStorePreferences + Always + + + + + + + + + + + + + + Returns a list of up to 10 categories that have the highest percentage of listings + whose titles or descriptions contain the keywords you specify. + + + + AddItem, GetCategories, GetCategoryMappings, GetItemRecommendations + + + + + + + + + + Specifies the search string, consisting of one or + more words to search for in the listing title. + The words "and" and "or" are treated like any other + word. + + + 350 (characters) + + GetSuggestedCategories + Yes + + + + + + + + + + + + + + Returns a list of categories with the highest number + of listings whose titles or descriptions contain the keywords + specified in a GetSuggestedCategoriesRequest. + + + + + + + + + Contains the categories that contain listings + that match the query string in the request. The array + can have up to 10 categories. Not returned if no categories match + the query in the request. + + + + GetSuggestedCategories + Conditionally + + + + + + + + Indicates the number of categories in the array. + + + + GetSuggestedCategories + Always + + + + + + + + + + + + + + Retrieves the tax table for a user on a given site or retrieves the valid + jurisdictions (if any) for a given site. + + + SetTaxTable + DetailLevel + + Enabling Multi-jurisdiction Sales Tax + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-SalesTax.html + + + + + + + + + + + + + + Response to GetTaxTableRequest. + + + + + + + + + The last time (in GMT) that the tax table was updated. + Only returned if the user previously created a tax table + and if the site has jurisdictions. + LastUpdateTime is useful for synchronization. If you cache the user's + tax table, you can use GetTaxTable to check if it has changed and + whether you need to update the cached tax table. + + + + GetTaxTable +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + A container of tax jurisdiction information unique to + a user/site combination. Empty if not set for user. + If DetailLevel is not specified, information is only + returned for the jurisdictions for which the user provided tax + information. If DetailLevel is ReturnAll, tax information + is returned for all possible jurisdictions, whether + specified by the user or not. ShippingIncludedInTax and + SalesTaxPercent are returned but are empty. + + + + GetTaxTable +
DetailLevel: ReturnAll, none
+ Always + + + + + + + + + + + + + + Requests current status of user token. + + + FetchToken, RevokeToken + + + + + + + + + + + + + + + Returns token status. + + + + + + + + + Returns token status and details. For example, if revoked, whether by eBay, the user, or the application, and also when revoked. + + + + GetTokenStatus + Always + + + + + + + + + + + + + + Retrieves data pertaining to a single eBay user. Callers can use this call to + return their own user data or the data of another eBay user. Unless the caller + passes in an ItemID that identifies a current or past common order, not all + data (like email addresses) will be returned in the User object. + + + DetailLevel + + GetAccount, GetFeedback, GetSellerDashboard,GetSellerEvents, + GetSellerList, GetSellerTransactions, GetUserPreferences + + + Managing User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + + + Specify the item ID for a successfully concluded listing in which the + requestor and target user were participants (one as seller and the other + as buyer). Necessary to return certain data (like an email address). Not + necessary if the requestor is retrieving their own data. ItemID is an + optional input. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetUser + No + + + + + + + + Specify the user whose data you want returned by the call. UserID is + optional. If not specified, eBay returns data pertaining to the + requesting user (as specified with the eBayAuthToken). + + + + GetUser + No + + + + + + + + This field is deprecated. + + + 579 + NoOp + + false + + + + + + + + + + If the <b>IncludeFeatureEligibility</b> flag is included and set to 'true', the call response will include a <b>QualifiesForSelling</b> flag which indicates if the eBay user is eligible to sell on eBay, and a <b>IncludeFeatureEligibility</b> container which indicates which selling features are available to the user. + + + + GetUser + No + + + + + + + + + + + + + + Contains the data retrieved by the call. User data is returned in a User object. + + + + + + + + + Contains the returned user data for the specified eBay user. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + + + Returns contact information for a specified user, given that a bidding relationship + (as either a buyer or seller) exists between the caller and the user. + + + + AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMemberMessages, + ReviseMyMessages, ReviseMyMessagesFolders + + + + + + + + + + An eBay item ID that uniquely identifies a currently active item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetUserContactDetails + Yes + + + + + + + + An eBay ID that uniquely identifies a given user for whom the caller is seeking + information. This is the user's eBay username. Either a seller's or bidder's + username can be specified here, as long as a bidding relationship exists between + the requester and the user specified by this field. That is, a bidder must be + bidding on the seller's active item, or have made an offer on the item via Best + Offer. + + + + GetUserContactDetails + Yes + + + + + + + + An eBay ID that uniquely identifies the person who is making the call. This is the + requester's eBay username. Either a seller's or bidder's username can be specified + here, as long as a bidding relationship exists between the requester and the + user for whom information is being requested. + + + + GetUserContactDetails + Yes + + + + + + + + + + + + + + Returns contact information to a seller for both bidders + and users who have made offers (via Best Offer) during + an active listing. + + + + + + + + + An eBay ID that uniquely identifies a given + user. The eBay username of the requested + contact. + + + + GetUserContactDetails + Always + + + + + + + + Contact information for the requested contact. + Note that the email address is NOT returned. + + + + GetUserContactDetails + Always + + + + + + + + The date and time that the requested contact + registered with eBay. + + + + GetUserContactDetails + Always + + + + + + + + + + + + + + Requests a list of disputes the requester is involved in as buyer or seller. + eBay Buyer Protection Item Not Received and Significantly Not As Described cases + are not returned with this call. To retrieve eBay Buyer Protection cases, the + getUserCases call of the Resolution Case Management API must be used instead. + + + + Requests a list of disputes the requester is involved in as buyer or seller. + eBay Buyer Protection Item Not Received and Significantly Not As Described cases + are not returned with this call. + + DetailLevel + AddDispute, AddDisputeResponse, GetDispute, SellerReverseDispute + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + Buyer Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Disputes-Buyer.html + + + Getting Details About a Dispute + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-DisputesGettingDetails.html + + + + + + + + + + An inclusive filter that isolates the returned disputes to a certain + type such as Item Not Received or Unpaid Item disputes. eBay Buyer + Protection cases are not retrieved with this call, even if the + ItemNotReceivedDisputes filter is included in the request. + + + + GetUserDisputes + No + + + + + + + + The value and sequence to use to sort the returned disputes. + + + + GetUserDisputes + No + + + + + + + + A filter that retrieves disputes whose DisputeModifiedTime is later + than or equal to this value. Specify the time value in GMT. + See the eBay Web Services documentation for information about specifying time values. + For more precise control of the date range filter, it is a good practice to also + specify ModTimeTo. Otherwise, the end of the date range is the present time. + Filtering by date range is optional. You can use date range filters in combination + with other filters like DisputeFilterType to control the amount of data returned. + + + + GetUserDisputes + No + + + + + + + + A filter that retrieves disputes whose DisputeModifiedTime is earlier + than or equal to this value. Specify the time value in GMT. + See the eBay Features Guide for information about specifying time values. + For more precise control of the date range filter, it is a good practice to also + specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned. + Filtering by date range is optional. You can use date range filters in combination + with other filters like DisputeFilterType to control the amount of data returned. + + + + GetUserDisputes + No + + + + + + + + The virtual page number of the result set to display. A result set has a number of disputes + divided into virtual pages, with 200 disputes per page. The response can only display one page. + The first page in the result set is number 1. Required. If not specified, a warning is returned + and Pagination.PageNumber is set to 1 by default. + + + + GetUserDisputes + Yes + + + + + + + + + + + + + + Returns a list of disputes that involve the calling user + as buyer or seller, in response to a GetUserDisputesRequest. + + + + + + + + + The index of the first dispute in the current result set, relative + to the total number of disputes available. + Primarily useful for interpreting paginated results. + For example, if 228 disputes are available and + 200 results are returned per page: The first page returns + a StartingDisputeID value of 1 and the second page returns a + StartingDisputeID value of 201. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The index of the last dispute in the current result set, relative + to the total number of disputes available. + Primarily useful for interpreting paginated results. + For example, if 228 disputes are available and + 200 results are returned per page: The first page returns + an EndingDisputeID value of 200 and the second page returns an + EndingDisputeID value of 228. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The array of disputes returned. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The number of disputes on each virtual page in the result set. + The virtual page returned is determined by PageNumber. + Default is 200. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The page of the total result set returned in the call. The entire result set + is virtual and the call returns only one page of it. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The number of disputes that involve the requester as + buyer or seller and match a given filter type. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The result of the pagination, including the total number + of virtual pages in the result set and the total number of + disputes returned. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + + + + + + + Retrieves the specified user preferences for the authenticated caller. + + + SetUserPreferences + + Managing User Preferences + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + + + If included and set to true, the seller's preference for receiving contact + information for unsuccessful bidders is returned in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's combined payment preferences are + returned in the response. These preferences are used to allow Combined Invoice + orders. + <br><br> + <span class="tablenote"><strong>Note:</strong> + The <strong>CombinedPaymentPreferences.CombinedPaymentOption</strong> field is the only + preference that should be managed with the <strong>GetUserPreferences</strong> and + <strong>SetUserPreferences</strong> calls. All other combined payment preferences should be + managed with the <strong>SetDiscountProfiles</strong> and <strong>GetDiscountProfiles</strong> calls. + </span> + + + false + + GetUserPreferences + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This container should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + + + + + + + + + + If included and set to true, the seller's payment preferences are returned + in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's preferences for the end-of-auction + email sent to the winning bidder is returned in the response. These + preferences are only applicable for auction listings. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's favorite item preferences are + returned in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's ProStores preferences are + returned in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's preference for sending an email to + the buyer with the shipping tracking number is returned in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's preference for requiring that the + buyer supply a shipping phone number upon checkout is returned in the + response. Some shipping carriers require the receiver's phone number. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, all of the seller's excluded shipping locations + are returned in the response. The returned list mirrors the seller's current + Exclude shipping locations list in My eBay's Shipping Preferences. An + excluded shipping location in My eBay can be an entire geographical region + (such as Middle East) or only an individual country (such as Iraq). Sellers + can override these default settings for an individual listing by using the + Item.ShippingDetails.ExcludeShipToLocation field in the AddItem family of + calls. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's Unpaid Item Assistant preferences + are returned in the response. The Unpaid Item Assistant automatically opens + an Unpaid Item dispute on the behalf of the seller. + <br><br> + <span class="tablenote"><strong>Note:</strong> + To return the list of buyers excluded from the Unpaid Item Assistant + mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be + included and set to true in the request. Excluded buyers can be viewed in + the UnpaidItemAssistancePreferences.ExcludedUser field. + </span> + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the seller's preference for sending a purchase + reminder email to buyers is returned in the response. + + + false + + GetUserPreferences + No + + + + + + + + If included and set to true, the list of eBay user IDs on the Unpaid Item + Assistant Excluded User list is returned through the + UnpaidItemAssistancePreferences.ExcludedUser field in the response. For + excluded users, an Unpaid Item dispute is not automatically filed through + the UPI Assistance mechanism. The Excluded User list is managed through the + SetUserPreferences call. + <br><br> + <span class="tablenote"><strong>Note:</strong> + To return the list of buyers excluded from the Unpaid Item Assistant + mechanism, the ShowUnpaidItemAssistancePreference field must also be + included and set to true in the request. + </span> + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to true, the seller's Business Policies profile information is + returned in the response. This information includes a flag that indicates whether or + not the seller has opted into Business Policies, as well as Business Policies profiles + (payment, shipping, and return policy) active on the seller's account. + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to true, the <b>SellerReturnPreferences</b> container is returned in the response and indicates whether or not the seller has opted in to eBay Managed Returns. + <br><br> + eBay Managed Returns are currently only available on the US and UK sites. + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to true, the seller's preference for offering the Global Shipping Program to international buyers will be returned in <strong>OfferGlobalShippingProgramPreference</strong>. + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to true, the seller's same day handling cut off time is returned in <strong>DispatchCutoffTimePreference.CutoffTime</strong>. + + + false + + GetUserPreferences + No + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + details about dispatch cut off times + + + + + + + + If this flag is included and set to <code>true</code>, the <strong>GlobalShippingProgramListingPreference</strong> field is returned. A returned value of <code>true</code> indicates that the seller's new listings will enable the Global Shipping Program by default. + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to <code>true</code>, the <strong>OverrideGSPServiceWithIntlServicePreference</strong> field is returned. A returned value of <code>true</code> indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. + <br/><br/> + A returned value of <code>false</code> indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country. + + + false + + GetUserPreferences + No + + + + + + + + If this flag is included and set to <code>true</code>, the <strong>PickupDropoffSellerPreference</strong> field is returned. A returned value of <code>true</code> indicates that the seller's new listings will enable the Click and Collect feature by default. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + false + + GetUserPreferences + No + + + + + + + + If true, the seller's preferences related to the Out-of-Stock feature will be returned. This feature is set using the + <a href="SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences</a> call. + <br/> + + + false + + Using the Out-of-Stock Feature for more details + ../../../../guides/ebayfeatures/Development/Listings-UseOutOfStock.html + + + GetUserPreferences + No + + + + + + + + + + + + + + Contains some or all of the authenticated user's preferences. The preferences are + grouped in sets and are returned according to the flag settings in the request. + + + + + + + + + Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This container is returned when <b>ShowBidderNoticePreferences</b> is included and set to 'true' in the request. This preference is only applicable for auction listings. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's combined payment preferences. These preferences are used to allow Combined Invoice orders. This container is returned when ShowCombinedPaymentPreferences is included and set to 'true' in the request. + <br><br> + <span class="tablenote"><b>Note:</b> + Calculated and flat-rate shipping preferences are no longer managed using the <b>SetUserPreferences</b> and <b>GetUserPreferences</b> calls. Instead, use the <b>SetDiscountProfiles</b> and <b>GetDiscountProfiles</b> calls to manage shipping discounts for Combined Invoice orders. + </span> + + Combined Invoice + ../../../../guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + + + + + GetUserPreferences + Conditionally + + + + + + + + This container is no longer supported as eBay Store Cross Promotions are no longer supported in the Trading API. This container will be removed from the Trading WSDL and API Call Reference docs in a future release. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's payment preferences. This container is returned when <b>ShowSellerPaymentPreferences</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. This container is returned when <b>ShowSellerFavoriteItemPreferences</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. This container is returned when <b>ShowEndOfAuctionEmailPreferences</b> is included and set to 'true' in the request. These preferences are only applicable for auction listings. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's preference for sending an email to the buyer with the shipment tracking number. This container is returned when <b>ShowEmailShipmentTrackingNumberPreference</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. This container is returned when <b>ShowRequiredShipPhoneNumberPreference</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + + Container consisting of the seller's ProStores preferences. This container is returned when <b>ShowProStoresPreference</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. This container is returned if <b>ShowUnpaidItemAssistancePreference</b> is included and set to 'true' in the request. + <br><br> + <span class="tablenote"><b>Note:</b> + To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the <b>ShowUnpaidItemAssistanceExclusionList</b> field must also be included and set to 'true' in the request. Excluded buyers can be viewed in the <b>UnpaidItemAssistancePreferences.ExcludedUser</b> field. + </span> + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's shipping preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the <b>Item.ShippingDetails.ExcludeShipToLocation</b> field in the Add/Revise/Relist calls. This container is returned if the <b>ShowSellerExcludeShipToLocationPreference</b> field is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of a seller's preference for sending a purchase reminder email to buyers. This container is returned if the <b>ShowPurchaseReminderEmailPreferences</b> field is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + This flag is set with the <b>SellerThirdPartyCheckoutDisabled</b> field of the <b>SetUserPreferences</b> call, and is used to disable the use of a third-party application to handle the checkout flow for a seller. If true, Third-Party Checkout is disabled and any checkout flow initiated on the seller's application is redirected to the eBay checkout flow. This field is only returned if the <b>SellerThirdPartyCheckoutDisabled</b> field has been set with the <b>SetUserPreferences</b> call. + + + + GetUserPreferences + Conditionally + + + + + + + + Parent response container consisting of high-level information for all Business Policies defined for the user's account. This container is returned if <b>ShowSellerProfilePreferences</b> is included and set to 'true' in the <b>GetUserPreferences</b> request (and one or more Business Policies are defined for the user's account). + + + + GetUserPreferences + Conditionally + + + + + + + + Container consisting of the <b>OptedIn</b> flag that indicates whether or not the seller has opted in to eBay Managed Returns. This container is only returned if <b>ShowSellerReturnPreferences</b> is included and set to 'true' in the request. + + + + GetUserPreferences + Conditionally + + + + + + + + This flag indicates whether the seller has opted in to the Global Shipping Program and is able to offer global shipping to international buyers. Returned when <b>ShowGlobalShippingProgramPreference</b> is included and set to 'true'. + + + + GetUserPreferences + Conditionally + + + + + + + + Contains information about a seller's order cut off time preferences for same-day shipping. If the seller specifies a value of '0' in <b>Item.DispatchTimeMax</b> to offer same-day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by <b>DispatchCutoffTimePreference.CutoffTime</b>. + + + + Specifying Shipping Services + ../../../../guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + + + GetUserPreferences + Conditionally + + + + + + + + If the <b>ShowGlobalShippingProgramListingPreference</b> field is submitted and set to 'true', this flag is returned. A returned value of 'true' indicates that the seller's new listings will enable the Global Shipping Program by default. + + + + GetUserPreferences + Conditionally + + + + + + + + If the <b>ShowOverrideGSPServiceWithIntlServicePreference</b> field is submitted and set to 'true', this flag is returned. A returned value of 'true' indicates that for the seller's listings that specify an international shipping service for any Global Shipping-eligible country, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. + <br/><br/> + A returned value of 'false' indicates that the Global Shipping program will take precedence over any international shipping service as the default option in Global Shipping-eligible listings for shipping to any Global Shipping-eligible country. + + + + GetUserPreferences + Conditionally + + + + + + + + This boolean field is returned if the <b>ShowPickupDropoffPreferences</b> field is included and set to 'true' in the request. This field will be returned as 'true' if the seller has enabled the Click and Collect feature at the account level. All of the seller's new listings will enable the Click and Collect feature by default. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The Click and Collect feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + + GetUserPreferences + Conditionally + + + + + + + + This boolean field is returned if the <b>ShowOutOfStockControlPreference</b> field is included and set to 'true' in the request. This field will be returned as 'true' if the seller has set <a href SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference> to 'true'. + + + + Using the Out-of-Stock Feature for more details + ../../../../guides/ebayfeatures/Development/Listings-UseOutOfStock.html + + + GetUserPreferences + Conditionally + + + + + + + + + + + + + + Retrieves details for VeRO reason codes and their descriptions. You can specify a + reason code ID to get details for a specific reason on the site specified in the + request header. If ReasonCodeID is not passed in the request, all reason codes are + returned. Set ReturnAllSites to true to retrieve reason codes for all sites. + You must be a member of the Verified Rights Owner (VeRO) Program to use this call. + + + + Retrieves details about VeRO reason codes for a given site or all sites. You must + be a member of the Verified Rights Owner (VeRO) Program to use this call. + + GetVeROReportStatus, VeROReportItems + + + + + + + + + Unique identifier for a reason code. If this ReasonCodeID is passed then + only details of this ReasonCodeID will be returned. If no reason code is + specified, all reason codes are returned. + + + + + + + GetVeROReasonCodeDetails + Conditionally + + + + + + + + Set to true to retrieve reason codes for all sites. If not specified, + reason codes are returned for the site specified in the request header + only. + If ReasonCodeID is specified, this parameter is ignored. + + + false + + GetVeROReasonCodeDetails + No + + + + + + + + + + + + + + Contains the reason codes for all sites. + + + + + + + + + Contains the list of the status codes for a site. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + + + + + + + Retrieves status information about VeRO reported items you have submitted. You + can receive the status of individual items you have reported or, by specifying + VeROReportPacketID, you can retrieve status for all items reported with a given + VeROReportItems request. You can also retrieve items that were reported during a + given time period. If no input parameters are specified, status is returned on all + items you have reported in the last two years. + You must be a member of the Verified Rights Owner (VeRO) Program to use this + call. + + + + Retrieves status information about VeRO reported items. You must be a member of + the Verified Rights Owner (VeRO) Program to use this call. + + GetVeROReasonCodeDetails, VeROReportItems + + + + + + + + + Packet identifier associated with the reported items for which you want to + retrieve status. By default, reported item details are not returned when + you specify the packet ID in the request. Applies only to items reported + with VeROReportItems. + + + + + + + GetVeROReportStatus + No + + + + + + + + Item ID for an item reported for alleged infringement. Applies to items + reported with VeROReportItems or by other means (e.g., through the + web flow). + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetVeROReportStatus + No + + + + + + + + Set to true to return reported item details when you specify VeROReportPacketID in the request. + + + false + + GetVeROReportStatus + No + + + + + + + + Limits returned items to only those that were submitted on or after the + date-time specified. If specified, TimeTo must also be specified. + Express the date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. + (For information on how to convert between your local time zone + and GMT, see Time Values Note.) Applies to items reported with + VeROReportItems or by other means (e.g., through the web flow). + Infringement reporting data is maintained for two years after the date of + submission. + This field is ignored if VeROReportPacketID or ItemID is specified. + + + + GetVeROReportStatus + No + + + + + + + + Limits returned items to only those that were submitted on or before the + date-time specified. If specified, TimeFrom must also be specified. + Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. + (For information on how to convert between your local time zone + and GMT, see Time Values Note.) Applies to items reported with + VeROReportItems or by other means (e.g., through the web flow). + Infringement reporting data is maintained for two years after the date of + submission. + This field is ignored if VeROReportPacketID or ItemID is specified. + + + + GetVeROReportStatus + No + + + + + + + + Contains the data controlling the pagination of the returned values: how + many items are returned per page of data (per call) and the number of the + page to return with the current call. + + + + GetVeROReportStatus + No + + + + + + + + + + + + + + Contains status information for items reported by the VeRO Program member. + + + + + + + + + Contains information regarding the pagination of data (if pagination is + used), including total number of pages and total number of entries. + + + + GetVeROReportStatus + Conditionally + + + + + + + + If true, there are more items yet to be retrieved. Additional + calls with higher page numbers or more items per page must + be made to retrieve these items. Not returned if no items match the + request. + + + + GetVeROReportStatus + Conditionally + + + + + + + + Indicates the maximum number of ItemType objects that can be returned in + ReportedItemDetails for any given call. + + + 1 + 200 + + GetVeROReportStatus + Conditionally + + + + + + + + Indicates the page of data returned by the current call. For instance, + for the first set of items can be returned, this field has a value of + one. + + + 1 + + + GetVeROReportStatus + Conditionally + + + + + + + + The packet ID for status being returned. + + + + + + + GetVeROReportStatus + Conditionally + + + + + + + + Status of the packet. + + + + GetVeROReportStatus + Conditionally + + + + + + + + Contains the list of the reported item details. + Returns empty if no items are available that match the request. + + + + GetVeROReportStatus + Conditionally + + + + + + + + + + + + + + Retrieves data for a specific, active Want It Now post identified by a post ID. + The response includes the following fields: CategoryID, Description, PostID, + Site, StartTime, ResponseCount, and Title. Although GetWantItNowSearchResults + returns most of this information, only GetWantItNowPost returns Description for + a post. + + + 847 + 849 + NoOp + + GetWantItNowSearchResults, RespondToWantItNowPost + + Want It Now + + + + + + + + + + + Specifies the post ID that uniquely identifies the Want It Now post for + which to retrieve the data. PostID is a required input. PostID is unique + across all eBay sites. + + + + GetWantItNowPost + Yes + + + + + + + + + + + + + + Contains the Want It Now post data returned by the call. The data for the + specified post listing is returned in a WantItNowPostType object. + + + 847 + 849 + NoOp + + + + + + + + + + Contains the data defining a single Want It Now post. + + + + GetWantItNowPost + Always + + + + + + + + + + + + + + Retrieves a list of active Want It Now posts that match specified keywords + and/or a specific category ID. The response contains the following data: + CategoryID, PostID, StartTime, ResponseCount, Site, and Title. To get the post + description (Description), you must use GetWantItNowPost to retrieve individual + posts. + + + 847 + 849 + NoOp + + GetWantItNowPost, RespondToWantItNowPost + + Want It Now + + + + + + + + + + + Limits the result set to just those Want It Now posts listed in the + specified category. Defaults to all categories if no category ID is + specified. If the specified category ID does not match an existing + category for the site, an invalid-category error message is returned. + Controls the set of listings to return (not the details to return for each + listing). + You must specify a Query and/or a CategoryID in the request. + + + 10 + + GetWantItNowSearchResults + No + + + + + + + + Specifies a search string. The search string consists of one or more + keywords to search for in the listing title. Note that the post + description will also be searched if SearchInDescription is enabled. + By default, requests return a list of Want It Now posts that include all + of the keywords specified in the Query. All words used in the query, + including "and," "or," and "the," will be treated as keywords. You can, + however, use modifiers and wildcards (e.g., +, -, and *) in the Query + field to create more complex searches. Be careful when using spaces before + or after modifiers and wildcards (+, -, or *), as the spaces can affect + the query logic. + See the eBay Web Services Guide for a list of valid search keyword query + operators and examples. + + + 350 (characters) + + GetWantItNowSearchResults + No + + + + + + + + If true, include the description field of Want It Now posts in the keyword search. Want + It Now posts returned are those where specified search keywords appear in + either the description or the title. This is the default behavior if SearchInDescription + is not specified. If false, only the title will be searched. SearchInDescription is an + optional input. + + + + GetWantItNowSearchResults + No + + + + + + + + If true, the search applies to all eBay sites. If false, the search is + limited to the site specified in the URL query string when the call is + made. + + + + GetWantItNowSearchResults + No + + + + + + + + Controls the pagination of the result set. Child elements specify the + maximum number of item listings to return per call and which page of data + to return. + + + + GetWantItNowSearchResults + No + + + + + + + + + + + + + Response contains the Want It Now posts that have the specified keyword(s) in the + title and (optionally) the description. + + + 847 + 849 + NoOp + + + + + + + + Response contains the Want It Now posts that have the specified keyword(s) in the + title and (optionally) the description. + + + + + + + + + Contains the returned Want It Now posts, if any. The data for each post is + returned in a WantItNowPostType object. + + + + GetWantItNowSearchResults + Always + + + + + + + + Indicates whether there are additional Want It Now posts that meet the + search criteria. + + + + GetWantItNowSearchResults + Always + + + + + + + + Indicates the maximum number of Want It Now posts that can be returned in + a WantItNowPostArray for a request. This value can be specified in the + request by EntriesPerPage in Pagination in the request. + + + + GetWantItNowSearchResults + Always + + + + + + + + Indicates the page of data returned by the current call. + + + + GetWantItNowSearchResults + Always + + + + + + + + Indicates the results of the pagination, including the total number of + pages of data there are to be returned and the total number of posts there + are to be returned. + + + + GetWantItNowSearchResults + Always + + + + + + + + + + + + + + Retrieves eBay IDs and codes (e.g., site IDs and shipping service + codes), enumerated data (e.g., payment methods), and other common eBay + meta-data. This call enables you to keep certain data up to date in your + applications without referring to the schema, the documentation, or the + eBay online help. Other data is returned for your reference, but you may + need to refer to the schema or the documentation for information about + valid values and usage. + <br><br> + In some cases, the data returned in the response will vary according to + the site that you use for the request. + <br><br> + If you use GeteBayDetails in preparation for listing in the US Motors Parts + and Accessories categories, use site ID 0 (which is the site ID of the US + site) when you call GeteBayDetails. + <br><br> + Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the + recoupment terms before adding items to the site. This agreement allows eBay to reimburse + a buyer during a dispute and then recoup the cost from the seller. Information about whether a site + is a recoupment site is returned in the GeteBayDetailsResponse.RecoupmentPolicyDetails container. + + + + + + + + + + + A designation of what kind of information you wish returned for the + specified eBay site. If omitted, all details are returned. The + possible values for input (the enumeration values of + DetailNameCodeType) are the same name as fields returned by the + response. See the documentation for the GeteBayDetails response to + better understand the DetailName options. + + + + GeteBayDetails + No + + + + + + + + + + + + + Details about a specified site in response to <b>GeteBayDetailsRequest</b>. + If no <b>DetailName</b> + field is identified in the request, all elements of <b>GeteBayDetailsResponse</b> are + returned. Otherwise, eBay returns only the elements corresponding to the specified + <b>DetailName</b> fields. UpdateTime gives the time of modification of the most recently + modified <b>DetailName</b>. + + + + + + + Details about a specified site in response to <b>GeteBayDetailsRequest</b>. + If no <b>DetailName</b> + field is identified in the request, all elements of <b>GeteBayDetailsResponse</b> are + returned. Otherwise, eBay returns only the elements corresponding to the specified + <b>DetailName</b> fields. <b>UpdateTime</b> gives the time of modification of the most recently + modified <b>DetailName</b>. + + + + + + + + + Lists the country code and associated name of the countries supported by + the eBay system, regardless of the site specified in the request. + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the currencies supported by the eBay system, regardless of the site + specified in the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>CurrencyDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> filters are + used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + A dispatch time specifies the maximum number of business days a seller commits + to for shipping an item to domestic buyers after receiving a cleared payment. + Returns all dispatch times in the system, regardless of the site specified in + the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>DispatchTimeMaxDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + <b>Deprecated </b> <br /> + Use <b>GetCategoryFeatures</b> instead, and pass in + <b>PaymentMethods</b> as a <b>FeatureID</b> value in the request. + + + + + GetCategoryFeatures + GetCategoryFeatures.html + + GeteBayDetails + Conditionally + + + + + + + + No longer returned; replaced by <b>ShippingLocationDetails</b>. + + + + + GeteBayDetails + Conditionally + + + ShippingLocationDetails + #Response.ShippingLocationDetails + + + + + + + + Lists the regions and locations supported by eBay's shipping services. Returns + all shipping locations supported by eBay, regardless of the site specified in + the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ShippingLocationDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the shipping services supported by the specified eBay site. Returns only + the shipping services that are applicable to the site specified in the + request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ShippingServiceDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists all available eBay sites and their associated SiteID numbers. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>SiteDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Details the different tax jurisdictions or tax regions applicable to the + site specified in the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>TaxJurisdiction</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + TaxTable.TaxJurisdiction in SetTaxTable + SetTaxTable.html#Request.TaxTable.TaxJurisdiction + + + Item.UseTaxTable in AddItem + AddItem.html#Request.Item.UseTaxTable + + + GeteBayDetails + Conditionally + + + + + + + + Lists eBay URLs that are applicable to the site specified in the request.\ + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>URLDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the details of the time zones supported by the eBay system. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>TimeZoneDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + The site's validation rules (e.g., string lengths) for custom Item Specifics. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ItemSpecificDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the suggested unit-of-measurement strings to use with Item Specifics + descriptions. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>UnitOfMeasurementDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + No longer returned. + + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the various shipping packages supported by the specified site. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ShippingPackageDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the shipping carriers supported by the specified site. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ShippingCarrierDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the return policies supported by the eBay site specified in the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ReturnPolicyDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the minimum starting prices for the supported types of eBay listings. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ListingStartPriceDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Lists the threshold values that can be passed in throught the <b>BuyerRequirementDetails</b> container in the Add/Revise/Relist API calls. Buyer Requirements allow the seller to block buyers who have unpaid item defects, policy violations, low Feedback scores, and/or other undesirable qualities/statistics. Buyer Requirements are set at the seller's account level, but by using a <b>BuyerRequirementDetails</b> container in an Add/Revise/Relist API call, the values in that container will override values set at the account level. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>BuyerRequirementDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Details the listing features available for the site specified in the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ListingFeatureDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Site-level validation rules for multi-variation listings (for example, the + maximum number of variations per listing). Use <b>GetCategoryFeatures</b> to + determine which categories on a site support variations. Use + <b>GetCategorySpecifics</b> for rules related to recommended or required variation + specifics. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>VariationDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GetCategoryFeatures + GetCategoryFeatures.html#Response.Category.VariationsEnabled + + + GetCategorySpecifics + GetCategorySpecifics.html + + + GeteBayDetails + Conditionally + + + + + + + + Lists the locations supported by the <b>ExcludeShipToLocation</b> feature. These are + locations that a seller can list as areas where they will not ship an item. + + + + GeteBayDetails + Conditionally + + + + + + + + The time of the most recent modification to any feature detail. If specific + feature details are passed in the request, gives the most recent modification time + of those feature details. + + + + GeteBayDetails + Always + + + + + + + + Details the recoupment policies for the site specified in the request. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>RecoupmentPolicyDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + A shipping service category supported for the site. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>ShippingCategoryDetails</b> is included as a + <b>DetailName</b> filter in the request, or if no <b>DetailName</b> + filters are used in the request. + </span> + Each shipping service supported for a site is automatically categorized by eBay into one of the + shipping categories available for that site depending on how the shipping service shipping time + aligns with the shipping times specified by eBay for each category. + <br><br> + Notice that you cannot specify a ShippingCategory + as an input to any API call - eBay does this categorizing automatically. ShippingCategory is read-only data + that is returned in the <b>ShippingServiceDetails</b> container. One possible use of this data is to segregate shipping + services by ShippingCategory in a pick list. (For an example of this, see the Services pulldown menu in the + Give buyers shipping details form in the eBay Sell Your Item flow.) + <br><br> + One way to populate the picklist would be to call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ShippingServiceDetails</b>. + Then sort these results by ShippingCategory and populate the picklist. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + + + Gets the official eBay system time in GMT. + + + + + + + + + + + + + + + + + The Timestamp field indicates the official eBay system time in GMT. + For information about converting between GMT and other time zones, + see "Time Values" in the Data Types appendix in the eBay Features Guide. + + + + + + + + + + + + + <b>Half.com only.</b>&nbsp;Issues a refund for a specific + Half.com order line item. This can only be called by a seller. Sellers do not + have the ability to issue a general refund (a refund not tied to an order line + item) to a buyer. + + + GetSellerPayments + + Half.com + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-Half.html + + + + + + + + + + Unique identifier for the Half.com item listing. Unless an + <b>OrderLineItemID</b> is specified in the <b>IssueRefund</b> request, the <b>ItemID</b> is + required along with the corresponding <b>TransactionID</b> to identify the + order line item that will be refunded. You can use <b>GetSellerPayments</b> to + retrieve the <b>ItemID</b> and/or <b>TransactionID</b> associated with the order line + item. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + IssueRefund + Yes + + + + + + + + Unique identifier for a Half.com order line item (transaction). An order + line item is created once there is a commitment from a buyer to purchase + an item. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used to + identify the order line item that will be refunded. Unless an + <b>OrderLineItemID</b> is specified in the <b>IssueRefund</b> request, the + <b>TransactionID</b> is required along with the corresponding <b>ItemID</b>. You can + use <b>GetSellerPayments</b> to retrieve the <b>ItemID</b> and/or <b>TransactionID</b> + associated with the order line item. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + IssueRefund + Yes + + + + + + + + Explanation of the reason that the refund is being issued. + + + + IssueRefund + Yes + + + + + + + + Explanation of the costs that the refund amount covers. + + + + IssueRefund + Yes + + + + + + + + The amount the seller wants to refund to the buyer, in US Dollars (USD). + Must be greater than 0.00. Half.com allows a maximum of the original item + sale price (order line item price plus original shipping reimbursement) plus + return shipping costs (the amount the buyer paid to return the item). + Typically, the return shipping cost is based on the current cost of + shipping the individual item (not the discounted cost calculated during + the original checkout for a Combined Invoice order). You can also issue a + partial refund for the amount you want the buyer to receive. If + RefundType=Full or RefundType=FullPlusShipping and you do not pass + <b>RefundAmount</b> in the request, Half.com will calculate the refund amount for + you. If you pass <b>RefundAmount</b> in the request, the amount you specify will + override Half.com's calculated value. Required if RefundType= + CustomOrPartial. + + + + IssueRefund + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Note to the buyer. Cannot include HTML. + + + 400 + + IssueRefund + No + + + + + + + + A unique identifier for an eBay order line item. This field is created + as soon as there is a commitment to buy from the seller, and its value + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. The <b>OrderLineItemID</b> value is used to + identify the order line item that will be refunded. Unless an + <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>IssueRefund</b> request, the + <b>OrderLineItemID</b> is required. You can use <b>GetSellerPayments</b> to retrieve + the <b>OrderLineItemID</b> associated with the order line item. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + IssueRefund + No + + + + + + + + + + + + + +Indicates the refund amount that a seller issued to a buyer for a single Half.com order line item. +Refunds may only be issued for a specific order line item. Sellers do not have the ability to issue a +general refund (not tied to an order line item) to a buyer. + + + + + + + + + Total amount that the seller asked Half.com to refund to + a buyer for a Half.com order line item. + + + + IssueRefund + Always + + + + + + + + Total amount that Half.com refunded to the buyer (which could include the refund amount + from the seller plus a refund amount from Half.com). + + + + IssueRefund + Always + + + + + + + + + + + + + + Enables a buyer and seller to leave feedback for their order partner at the + conclusion of a successful order. Feedback is left at the order line item level, + so multiple line item orders may have multiple Feedback entries.&nbsp;<b> + Also for Half.com</b>. + + + GetFeedback, GetSellerDashboard, GetSellerTransactions + + Leaving and Retrieving Feedback + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Introduction to Feedback + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Leaving Feedback for Another User + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items, but only one <b>ItemID</b>. Unless an + <b>OrderLineItemID</b> is specified in the <b>LeaveFeedback</b> request, the <b>ItemID</b> is + required along with the <b>TargetUser</b> to identify an order line item + existing between the caller and the <b>TargetUser</b> that requires feedback. A + Feedback entry will be posted for this order line item. If there are + multiple order line items between the two order partners that still + require feedback, the <b>TransactionID</b> will also be required to isolate the + targeted order line item. Feedback cannot be left for order line items + with creation dates more than 60 days in the past. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + LeaveFeedback + Conditionally + + + + + + + + Textual comment that explains, clarifies, or justifies the Feedback rating + specified in <b>CommentType</b>. + <br><br> + This comment will still be displayed even if submitted Feedback is withdrawn. + + + 80 + + LeaveFeedback + Yes + + + + + + + + This value indicates the Feedback rating for the user specified in the + <b>TargetUser</b> field. This field is required in <b>LeaveFeedback</b>. + <br><br> + A Positive rating increases the user's Feedback score, a Negative rating decreases the user's Feedback score, and a Neutral rating does not affect the user's Feedback score. + <br><br> + Sellers cannot leave Neutral or Negative ratings for buyers. + + + + LeaveFeedback + Withdrawn, IndependentlyWithdrawn + Yes + + + + + + + + Unique identifier for an eBay order line item (transaction). If there + are multiple order line items between the two order partners that still + require feedback, the <b>TransactionID</b> is required along with the + corresponding <b>ItemID</b> and <b>TargetUser</b> to isolate the targeted order line + item. If an <b>OrderLineItemID</b> is included in the response to identify a + specific order line item, none of the preceding fields (<b>ItemID</b>, + <b>TransactionID</b>, <b>TargetUser</b>) are needed. Feedback cannot be left for order + line items with creation dates more than 60 days in the past. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + LeaveFeedback + Conditionally + + + + + + + + This eBay User ID identifies the recipient user for whom the feedback is being + left. + + + + LeaveFeedback + Yes + + + + + + + + Container for detailed seller ratings (DSRs). If a buyer is providing DSRs, + they are specified in this container. Sellers have access to the number of + ratings they've received, as well as to the averages of the DSRs they've + received in each DSR area (i.e., to the average of ratings in the + item-description area, etc.). + + + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + LeaveFeedback + No + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. If an <b>OrderLineItemID</b> is included in + the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>TargetUser</b> fields are not + required. Feedback cannot be left for order line items with creation + dates more than 60 days in the past. + + + 100 + + LeaveFeedback + Conditionally + + + + + + + + + + + + + + LeaveFeedback response message includes an acknowledgement if the + feedback was successfully left. + + + + + + + + + The ID of the feedback that has been left. + + + + LeaveFeedback + Always + + + + + + + + + + + + + + Moves a Selling Manager inventory folder. + <br><br> + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Unique ID of the folder that will be moved. User can retrieve the FolderId + using GetSellingManagerInventoryFolder. + + + + MoveSellingManagerInventoryFolder + Yes + + + + + + + + Unique folder ID for the new parent folder. If no NewParentFolderID is + submitted, the folder is moved to the root level. + + + + MoveSellingManagerInventoryFolder + No + + + + + + + + + + + + + + Returns the status of move folder operation. + + + + + + + + + + + + Enables the authenticated user to make a bid, a Best Offer, or + a purchase on the item specified by the ItemID input field. + + + + Enabling Best Offer + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-BestOffer.html + + + API License Agreement + http://developer.ebay.com/join/licenses/Default.aspx + + + eBay User Agreement + http://pages.ebay.com/help/policies/user-agreement.html + + + PlaceOffer API License Agreement Addendum + http://developer.ebay.com/terms/PlaceOffer_API_License_Addendum_uv.pdf + + + API Logo Usage Requirements + http://developer.ebay.com/join/licenses/apilogousage + + + Filing a Support Ticket + http://developer.ebay.com/support/developersupport/request + + + eBay Partner Network + https://www.ebaypartnernetwork.com/ + + GetChallengeToken, GetBestOffers + + + + + + + + + Specifies the type of offer being made. If the item is a + competitive-bidding listing, the offer is a bid. If the item is a + fixed-price listing, then the offer purchases the item. If the item is a + competitive-bidding listing and the offer is of type with an active, + unexercised Buy It Now option, then the offer can either purchase the + item or be a bid. See the schema documentation for OfferType for details + on its properties and their meanings. + + + + PlaceOffer + Yes + + + + + + + + Unique item ID that identifies the item listing for which the action is being + submitted. + <br><br> + If the item was listed with Variations, you must also specify + VariationSpecifics in the request to uniquely identify the + variant being purchased. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + PlaceOffer + Yes + + + + + + + + If a warning message exists and BlockOnWarning is true, + the warning message is returned and the bid is blocked. If no warning message + exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning + is false, the bid is placed, regardless of warning. + + + + PlaceOffer + No + + + + + + + + Container for affiliate-related tags, which enable the tracking of user + activity. If you include AffiliateTrackingDetails in your PlaceOffer call, then + it is possible to receive affiliate commissions based on calls made by your + application. (See the <a href= + "http://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a> + for information about commissions.) Please note that affiliate tracking is not + available in the Sandbox environment, and that affiliate tracking is not + available when you make a best offer. + + + + Affiliate Tracking Concepts + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-AffiliateTrackingConcepts.html + + + PlaceOffer + No + + + + + + + + Name-value pairs that identify a single variation within the + listing identified by ItemID. Required when the seller + listed the item with Item Variations.<br> + <br> + If you want to buy items from multiple variations in the same + listing, use a separate PlaceOffer request for each variation. + For example, if you want to buy 3 red shirts and 2 black shirts + from the same listing, use one PlaceOffer request for the + 3 red shirts, and another PlaceOffer request for the 2 + black shirts. + + + + PlaceOffer + Conditionally + + + + + + + + + + + + + + The <b>PlaceOffer</b> response notifies you about the success and result + of the call. + + + + + + + + + Indicates the current bidding/purchase state of the item listing regarding + the offer extended using <b>PlaceOffer</b>. See the schema documentation for + the <b>SellingStatus</b> object, the properties of which contain such + post-offer information as the current high bidder, the current price for + the item, and the bid increment. + + + + PlaceOffer + Always + + + + + + + + Unique identifier for an eBay order line item (transaction). The + <b>TransactionID</b> field is only returned if the <b>Offer.Action</b> field was set + to <b>Purchase</b> in the input and the purchase was successful. A Purchase + action in <b>PlaceOffer</b> can be used for a fixed-price listing, or for an + auction listing where the Buy It Now option is available. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + PlaceOffer + Conditionally + + + + + + + + Container consisting of the status for a Best Offer. This container is + only returned if applicable based on the listing and the value set for + <b>Offer.Action</b> field in the request. + + + + PlaceOffer + Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. The <b>OrderLineItemID</b> field is only + returned if the <b>Offer.Action</b> field is set to <b>Purchase</b> in the input and + the purchase is successful. A Purchase action in <b>PlaceOffer</b> can be used + for a fixed-price listing, or for an auction listing where the Buy It + Now option is available. + <br> + + + 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) + + PlaceOffer + Conditionally + + + + + + + + + + + + + + Enables a seller to relist a single fixed-price listing that has ended on a specified eBay site. If the item was being watched when the listing ended, it will continue to be watched when the item is relisted. + + + + AddFixedPriceItem, RelistItem, ReviseFixedPriceItem, GetCategories + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Relisting Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-RelistingItems.html + + + Relisting Your Item + http://pages.ebay.com/help/sell/relist.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenRevisingandRelis + + + + + + + + + + Child elements hold the values for item properties that change for the + relisted item. Item is a required input. At a minimum, the Item.ItemID + property must be set to the ID of the original listing (a + listing that ended in the past 90 days). By default, the new listing's + Item object properties are the same as those of the original (ended) + listing. By setting a new value in the Item object, the new listing + uses the new value rather than the original value from the old + listing. + + + + RelistFixedPriceItem + Yes + + + + + + + + Specifies the name of the field to delete from a listing. + See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Listings-RelistingItems.html">Relisting Items</a> for rules on deleting values when relisting items. + Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences). + The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted). + <br> + <br> + Some data (such as <b>Variation</b> nodes within <b>Variations</b>) + can't be deleted by using a <b>DeletedField</b> tag. See the relevant field + descriptions for how to delete such data.<br> + <br> + + <br> + <br> + Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL). + Do not change the case of letters in the middle of a field name. + For example, item.picturedetails.galleryUrl is not allowed.<br><br> + To delete a listing enhancement like 'BoldTitle', specify the value you are deleting; + for example, Item.ListingEnhancement[BoldTitle]. + + + + RelistFixedPriceItem + Conditionally + + + + + + + + + + + + + + Returns the Item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the relisted item (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Unique item ID for the relisted item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + RelistFixedPriceItem + Always + + + + + + + + Item-level SKU for the new listing, if the seller specified + Item.SKU in the listing. Variation SKUs are not returned + (see GetItem instead). + + + + RelistFixedPriceItem + Conditionally + + + + + + + + Child elements contain the estimated listing fees for the relisted item. + The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. + + + + RelistFixedPriceItem + Always + + + + + + + + Date and time the relisting became active on the eBay site. + + + + RelistFixedPriceItem + Always + + + + + + + + Date and time when the relisted item ends. This is the starting time plus + the listing duration. + + + + RelistFixedPriceItem + Always + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + RelistFixedPriceItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + RelistFixedPriceItem + Conditionally + + + + + + + + The nature of the discount, if a discount is applied. + + + + RelistFixedPriceItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + RelistFixedPriceItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>RelistFixedPriceItem</b> request, and if + at least one listing recommendation exists for the newly relisted item. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item based on eBay's listing + recommendation(s). + + + + RelistFixedPriceItem + Conditionally + + + + + + + + + + + + + + Enables a seller to relist a single listing that has ended on a specified eBay site. If the item was being watched when the listing ended, it will continue to be watched when the item is relisted. + + + + AddItem, AddToItemDescription, GetItem, GetItemRecommendations, + GetSellerList, RelistFixedPriceItem, ReviseItem + + + Relisting Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-RelistingItems.html + + + https://ebaydts.com/eBayKBDetails?KBid=1542 + Best practices for relisting items + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenRevisingandRelis + + + + + + + + + + Child elements hold the values for item properties that change for the + relisted item. Item is a required input. At a minimum, the Item.ItemID + property must be set to the ID of the listing being relisted (a + listing that ended in the past 90 days). By default, the new listing's + Item object properties are the same as those of the original (ended) + listing. By setting a new value in the Item object, the new listing + uses the new value rather than the corresponding value from the old + listing. + + + + RelistItem + Yes + + + + + + + + Specifies the name of the field to delete from a listing. + See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Listings-RelistingItems.html">Relisting Items</a> for rules on deleting values when relisting items. + Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences). + The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted). + <br><br> + + Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL). + Do not change the case of letters in the middle of a field name. + For example, item.picturedetails.galleryUrl is not allowed.<br><br> + To delete a listing enhancement like 'BoldTitle', specify the value you are deleting; + for example, Item.ListingEnhancement[BoldTitle]. + + + + RelistItem + Conditionally + + + + + + + + + + + + + + Returns the Item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the relisted item (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Unique item ID for the new listing. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + RelistItem + Always + + + + + + + + Child elements contain the estimated listing fees for the new item + listing. The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. + + + + RelistItem + Always + + + + + + + + Date and time the new listing became active on the eBay site. + + + + RelistItem + Always + + + + + + + + Date and time when the new listing ends. This is the starting time plus + the listing duration. + + + + RelistItem + Always + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + RelistItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + RelistItem + Conditionally + + + + + + + + The nature of the discount, if a discount is applied. + + + + RelistItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + RelistItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>RelistItem</b> request, and if + at least one listing recommendation exists for the newly relisted item. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item based on eBay's listing + recommendation(s). + + + + RelistItem + Conditionally + + + + + + + + + + + + + + Enables a user to remove one or more items from their My eBay watch list. + + + AddToWatchList, GetMyeBayBuying, GetMyeBaySelling + + + + + + + + + The ID of the item to be removed from the + watch list. Either ItemID, RemoveAllItems, or VariationKey must + be specified, but NOT more than one of these. + Multiple ItemID fields can be specified in the same request. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + RemoveFromWatchList + Conditionally + + + + + + + + If true, then all the items in the user's + watch list are removed. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. + + + + RemoveFromWatchList + Conditionally + + + + + + + + A variation (or set of variations) that you want to remove + from the watch list. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. + + + + RemoveFromWatchList + Conditionally + + + + + + + + + + + + + + Returns information about the user's My eBay watch list. + + + + + + + + + The current number of items in the user's watch list (after those + specified in the call request have been removed) + + + + RemoveFromWatchList + Always + + + + + + + + The maximum number of items allowed in watch lists. Currently this value + is 200, and is the same for all sites and all users. + + + + RemoveFromWatchList + Always + + + + + + + + + + + + + + Enables the seller of a Best Offer item to accept, decline, or counter offers + made by bidders. Best offers can be declined in bulk, using the same message + from the seller to the bidders of all rejected offers. + + + GetBestOffers + + Enabling Best Offer + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-BestOffer.html + + + + + + + + + + Specifies the item for which the BestOffer data is to be returned. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + RespondToBestOffer + Yes + + + + + + + + The ID of a Best Offer for the item. + + + + RespondToBestOffer + Yes + + + + + + + + The action taken on the Best Offer by the seller (e.g., + Accept, Decline, or Counter). Bulk Accept and Bulk + Counter are not supported. That is, you cannot accept or + counter multiple offers in a single call. You can, + however, decline multiple offers in a single call. + + + + RespondToBestOffer + Yes + + + + + + + + A comment from the seller to the buyer. + + + 250 + + RespondToBestOffer + Conditionally + + + + + + + + The counter offer price. When Action is set to Counter, + you must specify the amount for the counter offer with + CounterOfferPrice. The value of CounterOfferPrice cannot + exceed the Buy It Now price for a single quantity item. + The value of CounterOfferPrice may exceed the Buy It Now + price if the value for CounterOfferQuantity is greater + than 1. + + + + RespondToBestOffer + Conditionally + + + + + + + + The quantity of items in the counter offer. When Action is set to + Counter you must specify the quantity of items for the + counter offer with CounterOfferQuantity. + + + + RespondToBestOffer + Conditionally + + + + + + + + + + + + + + Contains a list of BestOffers that were either accepted or declined. + + + + + + + + + A list of BestOffers that were either accepted or declined. + + + + RespondToBestOffer + Always + + + + + + + + + + + + + + Used to reply to feedback that has been left for a user, or to post a + follow-up comment to a feedback comment the user has left for someone else. + + + GetFeedback, LeaveFeedback + + + + + + + + + A unique identifier for a Feedback record. Buying and selling partners + leave feedback for one another after the completion of an order. + Feedback is left at the order line item (transaction) level, so a + Feedback comment for each line item in a Combined Invoice order is + expected from the buyer and seller. A unique <b>FeedbackID</b> is created + whenever a buyer leaves feedback for a seller, and vice versa. A + <b>FeedbackID</b> is created by eBay when feedback is left through the eBay + site, or through the <b>LeaveFeedback</b> call. <b>FeedbackIDs</b> can be retrieved + with the <b>GetFeedback</b> call. In the <b>RespondToFeedback</b> call, <b>FeedbackID</b> can + be used as an input filter to respond to a specific Feedback comment. + Since Feedback is always linked to a unique order line item, an + <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> can also be used to + respond to a Feedback comment. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + RespondToFeedback + Conditionally + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be + paired up with a corresponding <b>TransactionID</b> and used as an input filter + to respond to a Feedback comment in the <b>RespondToFeedback</b> call. Unless + the specific Feedback record is identified by a <b>FeedbackID</b> or an + <b>OrderLineItemID</b> in the request, an <b>ItemID</b>/<b>TransactionID</b> pair is + required. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + RespondToFeedback + Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). A + <b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as + an input filter to respond to a Feedback comment in the + <b>RespondToFeedback</b> call. Unless the specific Feedback record is + identified by a <b>FeedbackID</b> or an <b>OrderLineItemID</b> in the request, an + <b>ItemID</b>/<b>TransactionID</b> pair is required. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + RespondToFeedback + No + + + + + + + + The eBay user ID of the caller's order partner. The caller is either + replying to or following up on this user's Feedback comment. + + + + RespondToFeedback + Yes + + + + + + + + Specifies whether the response is a reply or a follow-up to a Feedback + comment left by the user identified in the <b>TargetUserID</b> field. + + + + RespondToFeedback + Yes + + + + + + + + Textual comment that the user who is subject of feedback may leave in + response or rebuttal to the Feedback comment. Alternatively, when the + <b>ResponseType</b> is <b>FollowUp</b>, this value contains the text of the follow-up + comment. + + + 80 (125 for the Taiwan site) + + RespondToFeedback + Yes + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. Since Feedback is always linked to a + unique order line item, an <b>OrderLineItemID</b> can be used to respond + to a Feedback comment. + <br><br> + Unless an <b>ItemID</b>/<b>TransactionID</b> pair or a <b>FeedbackID</b> is used to identify + a Feedback record, the <b>OrderLineItemID</b> must be specified. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + RespondToFeedback + Conditionally + + + + + + + + + + + + + + Indicates the success or failure of the attempt to reply + to feedback that has been left for a user, or to post a + follow-up comment to a feedback comment a user has left + for someone else. + + + + + + + + + + + + Enables a seller to respond to a Want It Now post with an item listed on the eBay + site. Responses appear on the Want It Now post page, with the item title, the + price of the item, the number of bids on the item, and the time left before the + listing ends. If the item has a picture, the picture is also included on the Want + It Now post page. + + + 847 + 849 + NoOp + + + GetWantItNowSearchResults, GetWantItNowPost + + + Want It Now + + + + + + + + + + + The unique identifier of an item listed on the eBay site. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + RespondToWantItNowPost + Yes + + + + + + + + The unique identifier of a Want It Now post on the eBay site. + + + + RespondToWantItNowPost + Yes + + + + + + + + + + + + + + Indicates the success or failure of the attempt to respond to a Want It Now post. + + + 847 + 849 + NoOp + + + + + + + + + + + + + A seller can use this call to update the payment details, the shipping details, + and the status of an order. + + + ReviseItem + + Checkout + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Checkouts.html + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be + paired up with a corresponding <b>TransactionID</b> and used as an input filter + for <b>ReviseCheckoutStatus</b>. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + (Combined Invoice) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item (Combined Invoice) order, <b>OrderID</b> + should be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + <br /> + <br /> + It is also possible to identify a single line item order with a + <b>ItemID</b>/<b>BuyerID</b> combination, but this is not the most ideal + approach since an error is returned if there are multiple + order line items for that combination. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + ReviseCheckoutStatus + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Unique identifier for an eBay order line item (transaction). An order + line item is created once there is a commitment from a buyer to purchase + an item. Since an auction listing can only have one order line item + during the duration of the listing, the <b>TransactionID</b> for + auction listings is always 0. Along with its corresponding <b>ItemID</b>, a + <b>TransactionID</b> is used and referenced during an order checkout flow and + after checkout has been completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be + used as an input filter for <b>ReviseCheckoutStatus</b>. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + (Combined Invoice) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item (Combined Invoice) order, <b>OrderID</b> + must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + ReviseCheckoutStatus + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + A unique identifier that identifies a single line item or multiple line + item (Combined Invoice) order. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b> value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order through + the eBay site. A Combined Invoice order can also be created by the + seller through the <b>AddOrder</b> call. The <b>OrderID</b> can be used as an input + filter for <b>ReviseCheckoutStatus</b>. + <br><br> + <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if + these fields are also specified in the same request. + + + + ReviseCheckoutStatus + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + The total amount paid by the buyer. For a motor vehicle purchased on eBay Motors, + <b>AmountPaid</b> is the total amount paid by the buyer for the deposit. + <b>AmountPaid</b> is optional if <b>CheckoutStatus</b> is Incomplete and required if it + is Complete. + + + + ReviseCheckoutStatus + Conditionally + + + + + + + + Payment method used by the buyer. This field is required if <b> + CheckoutStatus</b> is Complete and the payment method is a trusted + payment method other than PayPal. See eBay's + <a href="http://pages.ebay.com/help/policies/accepted-payments-policy.html">Accepted Payments Policy</a>. + If the payment method is PayPal, this field should not be used since only PayPal can set this field's + value to "PayPal". ReviseCheckoutStatus cannot be used for a non-trusted + payment method. + <b>Note:</b>Required or allowed payment methods vary by site and category. + + + + ReviseCheckoutStatus + PayPal + Conditionally + + + Specifying a Payment Method + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-PaymentMethod.html#DeterminingthePaymentMethodsAllowedforaC + information to help you determine which payment methods you are required or allowed to specify + + + + + + + + The current checkout status of the order. Often, the seller or + application will mark this value as 'Complete' if payment has been made. + + + + ReviseCheckoutStatus + Yes + + + + + + + + The shipping service selected by the buyer from among the shipping services + offered by the seller (such as UPS Ground). For a list of valid values, call + GeteBayDetails with DetailName set to ShippingServiceDetails. The + ShippingServiceDetails.ValidForSellingFlow flag must also be present. + Otherwise, that particular shipping service option is no longer valid and + cannot be offered to buyers through a listing. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> <strong>ReviseCheckoutStatus</strong> is not available for the Global Shipping program; specifying InternationalPriorityShipping as a value for this field will produce an error. + </span> + + + ShippingServiceCodeType + + ReviseCheckoutStatus + No + + + + + + + + An indicator of whether shipping costs were included in the + taxable amount. . + + + + ReviseCheckoutStatus + No + + false + + + + + + + + + + + + + + + + + + Enumeration value that indicates whether shipping insurance was offered to and + selected by the buyer. + + + + ReviseCheckoutStatus + No + + + + + + + + This field is used to mark the order as paid or awaiting payment in My eBay. If you specify 'Paid', My eBay displays an icon for each line item in the order to indicate that the order status is Paid. If you specify 'Pending', this indicates that the order is awaiting payment (some applications may use 'Pending' when the buyer has paid, but the funds have not yet been sent to the seller's financial institution). + <br> + <br> + <b>ReviseCheckoutStatus</b> cannot be used to update payment and checkout + status for a non-trusted payment method. See eBay's <a href=" + http://pages.ebay.com/help/policies/accepted-payments-policy.html"> + Accepted Payments Policy</a> for more information on trusted + payment methods. If the payment method is PayPal, this field should not + be used since PayPal automatically set this field's value to "Paid" upon + receiving the buyer's payment. + + + + ReviseCheckoutStatus + No + Paid, Pending + + + + + + + + Discount or charge agreed to by the buyer and seller. A positive value + indicates that the amount is an extra charge being paid to the seller by + the buyer. A negative value indicates that the amount is a discount given + to the buyer by the seller. + + + + ReviseCheckoutStatus + No + + + + + + + + For internal use. + + + + ReviseCheckoutStatus + No + + + + + + + + eBay user ID for the order's buyer. A single line item order can + actually be identified by a <b>BuyerID</b>/<b>ItemID</b> pair, but this approach is + not recommended since an error is returned if there are multiple + order line items for that combination. <b>BuyerID</b> is ignored if any other valid + filter or filter combination is used in the same request. + + + + ReviseCheckoutStatus + Conditionally + + + + + + + + The amount of money paid for shipping insurance. + + + + ReviseCheckoutStatus + No + + + + + + + + The sales tax amount for the order. This field should be used if sales tax + was applied to the order. + + + + ReviseCheckoutStatus + No + + + + + + + + The amount of money paid for shipping. + + + + ReviseCheckoutStatus + No + + + + + + + + Not supported. + + + 20 + + ReviseCheckoutStatus + No + + + + + + + + This container is used to identify the electronic payment (other than Paypal) of an order. + + + + ReviseCheckoutStatus + No + + + + + + + + Not supported. + + + + ReviseCheckoutStatus + No + + + + + + + + This dollar value indicates the money due from the buyer upon delivery of the item. + <br><br> + This field should only be specified in the <b>ReviseCheckoutStatus</b> + request if 'COD' (cash-on-delivery) was the payment method selected by the buyer + and it is included as the <b>PaymentMethodUsed</b> value in the same + request. + + + + ReviseCheckoutStatus + No + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. For a single line item order, the + <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field to revise the + checkout status of the order. + <br><br> + Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line + item order, or the <b>OrderID</b> is used to identify a single or multiple line + item (Combined Invoice) order, the <b>OrderLineItemID</b> must be specified. + For a multiple line item (Combined Invoice) order, <b>OrderID</b> should be + used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are + ignored if present in the same request. + + + 100 + + ReviseCheckoutStatus + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + + Indicates success or failure of the attempt to revise the listing's checkout status. + + + + + + + + + + + + Enables a seller to change the properties of a currently active + fixed-price listing (including multi-variation listings). + + + AddFixedPriceItem, RelistFixedPriceItem, ReviseItem + + Revising Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-Revising.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenRevisingandRelis + + + + + + + + + + Child elements hold the values for item details that you want to change. + The Item.ItemID must always be set to the ID of the listing being changed. + Only specify Item fields for the details that are changing. Unless + otherwise specified in the field descriptions below, the listing retains + its existing values for fields that you don't pass in the + ReviseFixedPriceItem request. Use DeletedField to remove a field from the + listing. + + + + ReviseFixedPriceItem + Yes + + + + + + + + Specifies the name of a field to delete from a listing. The request can + contain zero, one, or many instances of DeletedField (one for each field + to be deleted). See the relevant field descriptions to determine when to + use DeletedField (and potential consequences). + <br><br> + You cannot delete required fields from a listing. + <br><br> + Some fields are optional when you first list an item (e.g., + SecondaryCategory), but once they are set they cannot be deleted when you + revise an item. Some optional fields cannot be deleted if the item has + bids and/or ends within 12 hours. Some optional fields cannot be deleted + if other fields depend on them. See the eBay Trading API guide for rules + on removing values when revising items. + <br><br> + Some data (such as Variation nodes within Variations) can't be deleted by + using DeletedFields. See the relevant field descriptions for how to delete + such data. + <br><br> + DeletedField accepts the following path names, which delete the + corresponding nodes: + <br><br> + Item.ApplicationData<br> + Item.AttributeSetArray<br> + Item.ConditionID<br> + Item.ItemSpecifics<br> + Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> + Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> + Item.ListingDesigner.LayoutID<br> + Item.ListingDesigner.ThemeID<br> + Item.ListingEnhancement[Value]<br> + Item.PayPalEmailAddress<br> + Item.PictureDetails.GalleryURL<br> + Item.PictureDetails.PictureURL<br> + Item.PostalCode<br> + Item.ProductListingDetails<br> + Item.SellerContactDetails<br> + Item.SellerContactDetails.CompanyName<br> + Item.SellerContactDetails.County<br> + Item.SellerContactDetails.InternationalStreet<br> + Item.SellerContactDetails.Phone2AreaOrCityCode<br> + Item.SellerContactDetails.Phone2CountryCode<br> + Item.SellerContactDetails.Phone2CountryPrefix<br> + Item.SellerContactDetails.Phone2LocalNumber<br> + Item.SellerContactDetails.PhoneAreaOrCityCode<br> + Item.SellerContactDetails.PhoneCountryCode<br> + Item.SellerContactDetails.PhoneCountryPrefix<br> + Item.SellerContactDetails.PhoneLocalNumber<br> + Item.SellerContactDetails.Street<br> + Item.SellerContactDetails.Street2<br> + Item.ShippingDetails.PaymentInstructions<br> + Item.ShippingServiceCostOverrideList<br> + Item.SKU (unless InventoryTrackingMethod is SKU)<br> + Item.SubTitle + <br><br> + These values are case-sensitive. Use values that match the case of the + schema element names (Item.PictureDetails.GalleryURL) or make the initial + letter of each field name lowercase (item.pictureDetails.galleryURL). + However, do not change the case of letters in the middle of a field name. + For example, item.picturedetails.galleryUrl is not allowed. + <br><br> + To delete a listing enhancement like BoldTitle, specify the value you are + deleting in square brackets ("[ ]"); for example, + Item.ListingEnhancement[BoldTitle]. + + + + ReviseFixedPriceItem + Conditionally + + + + + + + + + + + + + + Returns the Item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the revised listing (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Item ID that uniquely identifies the item listing that was revised. + Provided for confirmation purposes. The value returned should be the + same as the item ID specified in the ItemID property of the Item object + specified as input for the call. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + ReviseFixedPriceItem + Always + + + + + + + + Item-level SKU for the listing, if the seller specified + Item.SKU for the listing. Variation SKUs are not returned + (see GetItem instead). + + + + ReviseFixedPriceItem + Conditionally + + + + + + + + Starting date and time for the listing. + + + + ReviseFixedPriceItem + Always + + + + + + + + Date and time when the new listing ends. This equals the starting time + plus the listing duration. + + + + ReviseFixedPriceItem + Always + + + + + + + + Child elements contain the estimated listing fees for the revised item + listing. The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. Revising an item does not itself + incur a fee. However, certain item properties are fee-based and result + in the return of fees in the call's response. + + + + ReviseFixedPriceItem + Always + + + eBay.com Fees + http://pages.ebay.com/help/sell/fees.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Final Value Fees + http://pages.ebay.com/help/sell/fvf.html + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + ReviseFixedPriceItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + ReviseFixedPriceItem + Conditionally + + + + + + + + The nature of the discount, if a discount applied. + + + + ReviseFixedPriceItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + ReviseFixedPriceItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>ReviseFixedPriceItem</b> request, and if + at least one listing recommendation exists for the listing about to be revised. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item again based on eBay's listing + recommendation(s). + + + + ReviseFixedPriceItem + Conditionally + + + + + + + + + + + + + + Enables a seller to change the price and quantity of a currently- + active, fixed-price listing. Using ReviseInventoryStatus to modify + data qualifies as revising the listing. + <br><br> + Inputs are the item IDs or SKUs of the listings being revised, + and the price and quantity that are + being changed for each revision. Only applicable to fixed-price listings.<br> + <br><br> + Changing the price or quantity of a currently- + active, fixed-price listing does not reset the Best Match performance score. + For Best Match information related to multi-variation listings, see the Best + Match information at the following topic: + <a href="http://pages.ebay.com/sell/variation/">Multi-quantity Fixed Price + listings with variations</a>.<br> + <br><br> + As with all listing calls, the site you specify in the request URL + (for SOAP) or the X-EBAY-API-SITEID HTTP header (for XML) + should match the original listing's <b>Item.Site</b> value. + In particular, this is a best practice when you submit new and + revised listings.<br> + <br><b> + For Large Merchant Services users:</b> When you use ReviseInventoryStatus within a Merchant Data file, + it must be enclosed within two BulkDataExchangeRequest tags. + A namespace is returned in the BulkDataExchangeResponseType + (top level) of the response. The BulkDataExchange tags are not shown in the call input/output descriptions. + + + + Enables a seller to change the price and quantity of currently active fixed-price items. + + + AddItems, GetSellerList, ReviseItem, RelistItem + + + Standard Data for All Calls + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-StandardCallData.html#SpecifyingtheTargetSite + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenRevisingandRelis + + + + + + + + + + Contains the updated quantity and/or price of a listing + being revised. You should not modify the same listing twice + (by using a duplicate ItemID or SKU) in the same request; + otherwise, you may get an error or unexpected results. + (For example, you should not use one InventoryStatus node to + update the quantity and another InventoryStatus node to update + the price of the same item.) You can pass up to 4 InventoryStatus nodes in a single request. + + + + ReviseInventoryStatus + Yes + 4 + + + + + + + + + + + + + + + Returns the Item ID or SKU with changed Price and Quantity for the revised listing. + + + + + + + + + Confirms the quantity and price associated with a listing + or variation that was revised. + + + + StartTime, EndTime + ReviseInventoryStatus + Always + 4 + + + + + + + + Child elements contain the estimated listing fees for a + listing that was revised. Use the ItemID to correlate the + Fees data with the InventoryStatus data in the response. + The fees do not include the Final Value Fee (FVF), + which can't be determined until the listing has sales.<br> + <br> + If you revise a variation in a multi-variation listing, + the fees are for the entire listing. The insertion fee and + listing fee are affected by the highest priced variation + in the listing (which is not necessarily the variation that + you passed in the request).<br> + <br> + Also note that the call returns only one Fees node per listing. + For example, if you revise 4 variations from the same + multi-variation listing, the response includes 4 + InventoryStatus nodes and 1 Fees node. + + + + ReviseInventoryStatus + Always + + + eBay.com Fees + http://pages.ebay.com/help/sell/fees.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Final Value Fees + http://pages.ebay.com/help/sell/fvf.html + + + + + + + + + + + + + + Enables a seller to change the properties of a currently active listing.&nbsp;<b>Also for Half.com</b>. + <br> + <br> + After one item in a multi-quantity fixed-price listing has been sold, you can not + the values in the Title, Primary Category, Secondary Category, Listing Duration, + and Listing Type fields for that listing. However, all other fields in the + multi-quantity, fixed-price listing are editable. + <br> + <br> + Inputs are the Item ID of the listing you are revising, and the field or fields + that you are updating. + + + + AddItem, AddToItemDescription, GetItem, GetSellerList, + RelistItem, ReviseFixedPriceItem, GetCategories, GetCategoryMappings + + + Revising Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-Revising.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenListingItems + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#ConsideringBestMatchWhenRevisingandRelis + + + + + + + + + + Child elements hold the values for properties that are changing. The + Item.ItemID property must always be set to the ID of the item listing being + changed. Set values in the Item object only for those properties that are + changing. Use DeletedField to remove a property. + <br><br> + Applicable to Half.com. + + + + ReviseItem + Yes + + + + + + + + Specifies the name of a field to delete from a listing. See the eBay + Trading API guide for rules on deleting values when revising items. Also + see the relevant field descriptions to determine when to use DeletedField + (and potential consequences). The request can contain zero, one, or many + instances of DeletedField (one for each field to be deleted). + <br><br> + You cannot delete required fields from a listing. + <br><br> + Some fields are optional when you first list an item (e.g., + SecondaryCategory), but once they are set they cannot be deleted when you + revise an item. Some optional fields cannot be deleted from auction + listings if the item has bids and/or ends within 12 hours. Some optional + fields cannot be deleted if other fields depend on them. + <br><br> + Some data (such as Variation nodes within Variations) can't be deleted by + using DeletedFields. See the relevant field descriptions for how to delete + such data. See the eBay Features Guide for rules on removing values + when revising items. Also see the relevant field descriptions for details + on when to use DeletedField (and potential consequences). + <br><br> + DeletedField accepts the following path names, which delete the + corresponding nodes: + <br><br> + Item.ApplicationData<br> + Item.AttributeSetArray<br> + Item.BuyItNowPrice<br> + Item.ConditionID<br> + Item.ExtendedSellerContactDetails<br> + Item.ClassifiedAdContactByEmailEnabled<br> + Item.ItemSpecifics<br> + Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> + Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> + Item.ListingDesigner.LayoutID<br> + Item.ListingDesigner.ThemeID<br> + Item.ListingDetails.MinimumBestOfferMessage<br> + Item.ListingDetails.MinimumBestOfferPrice<br> + Item.ListingEnhancement[Value]<br> + Item.PayPalEmailAddress<br> + Item.PictureDetails.GalleryURL<br> + Item.PictureDetails.PictureURL<br> + Item.PostalCode<br> + Item.ProductListingDetails<br> + Item.SellerContactDetails<br> + Item.SellerContactDetails.CompanyName<br> + Item.SellerContactDetails.County<br> + Item.SellerContactDetails.InternationalStreet<br> + Item.SellerContactDetails.Phone2AreaOrCityCode<br> + Item.SellerContactDetails.Phone2CountryCode<br> + Item.SellerContactDetails.Phone2CountryPrefix<br> + Item.SellerContactDetails.Phone2LocalNumber<br> + Item.SellerContactDetails.PhoneAreaOrCityCode<br> + Item.SellerContactDetails.PhoneCountryCode<br> + Item.SellerContactDetails.PhoneCountryPrefix<br> + Item.SellerContactDetails.PhoneLocalNumber<br> + Item.SellerContactDetails.Street<br> + Item.SellerContactDetails.Street2<br> + Item.ShippingDetails.PaymentInstructions<br> + Item.ShippingServiceCostOverrideList<br> + Item.SKU (unless InventoryTrackingMethod is SKU)<br> + Item.SubTitle + <br><br> + These values are case-sensitive. Use values that match the case of the + schema element names (Item.PictureDetails.GalleryURL) or make the initial + letter of each field name lowercase (item.pictureDetails.galleryURL). + However, do not change the case of letters in the middle of a field name. + For example, item.picturedetails.galleryUrl is not allowed. + <br><br> + To delete a listing enhancement like BoldTitle, specify the value you are + deleting in square brackets ("[ ]"); for example, + Item.ListingEnhancement[BoldTitle]. + + + + ReviseItem + Conditionally + + + + + + + + + When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated + listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. + This call is similar to VerifyAddItem in revise mode. + + + + ReviseItem + Conditionally + + + + + + + + + + + + + + Returns the Item ID, SKU (if any), listing recommendations (if applicable), the + estimated fees for the revised listing (except the Final Value Fee, which isn't calculated + until the item has sold), the start and end times of the listing, and other details. + + + + + + + + + Item ID that uniquely identifies the item listing that was revised. + Provided for confirmation purposes. The value returned should be the + same as the item ID specified in the ItemID property of the Item object + specified as input for the call. + Also applicable to Half.com. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + ReviseItem + Always + + + + + + + + Starting date and time for the revised listing. + Also returned for Half.com (for Half.com, the start time is + always the time the item was originally listed). + + + + ReviseItem + Always + + + + + + + + Date and time when the new listing ends. This is the starting time + plus the listing duration. + Also returned for Half.com, but for Half.com the actual end time is GTC + (not the end time returned in the response). + + + + ReviseItem + Always + + + + + + + + Child elements contain the estimated listing fees for the revised item + listing. The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. Revising an item does not itself + incur a fee. However, certain item properties are fee-based and result + in the return of fees in the call's response. + Not applicable to Half.com. + + + + ReviseItem + Always + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + Not applicable to Half.com. + + + 10 + + ReviseItem + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + Not applicable to Half.com. + + + 10 + + ReviseItem + Conditionally + + + + + + + + Supporting VerifyOnly for ReviseItem call as part of project 24083 (API - Critical enhancements). + When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated + listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. + This call is similar to VerifyAddItem in revise mode. + + + + ReviseItem + Conditionally + + + + + + + + The nature of the discount, if a discount applied. + + + + ReviseItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + ReviseItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>ReviseItem</b> request, and if + at least one listing recommendation exists for the listing about to be revised. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the item again based on eBay's listing + recommendation(s). + + + + ReviseItem + Conditionally + + + + + + + + + + + + + + Sets the read state for messages, sets the flagged state of messages, + and moves messages into and out of folders. + + + + AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMessagePreferences, + GetMemberMessages, GetMyMessages, ReviseMyMessagesFolders + + + + + + + + + + Contains a list of up to 10 MessageID values. + <br><br> + MessageIDs must be included in + the request. Messages in the Sent box cannot be moved, + marked as Read, or Flagged. + + + + ReviseMyMessages + Conditionally + + + + + + + + This field will be deprecated in an upcoming release. + This field formerly contained a list of up to 10 AlertID values. + <br><br> + Alerts cannot be flagged. Alerts cannot be + moved into a new folder until they have been resolved. + <br><br> + Resolve alerts by marking Read (if no action is + required), or by using ActionURL (if action is + required). + + + + + + + + + + + Changes the read states of all + messages specified in a request. + At least one of the following + must be specified in the + request: Read, Flagged, or FolderID. + Messages in the Sent box cannot be moved, + marked as Read, or Flagged. + <br><br> + Note that messages retrieved + with the API are not automatically marked Read, + and must be marked Read with this call. + + + + ReviseMyMessages + Conditionally + + + + + + + + Changes the flagged states of all messages specified in + a request by their MessageID values. At least one of + Read, Flagged, or FolderID must be specified in the + request. Messages in the Sent box cannot be moved, + marked as Read, or Flagged. + + + + ReviseMyMessages + Conditionally + + + + + + + + An ID that uniquely identifies the My Messages folder to + move messages into. At least one of Read, + Flagged, or FolderID must be specified in the request. + <br><br> + Messages + in the Sent box cannot be moved, marked as Read, or + Flagged. + + + + ReviseMyMessages + Conditionally + + + + + + + + + + + + + + The response to ReviseMyMessagesRequestType. If the request was successful, + ReviseMyMessages returns nothing. + + + + + + + + + + + + Renames, removes, or restores the specified My Messages folders for + a given user. + + + + AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMessagePreferences, + GetMemberMessages, GetMyMessages, ReviseMyMessages + + + + + + + + + + Indicates the type of operation to perform on a + specified My Messages folder. Operations include creating, + renaming, removing, and restoring folders. Operations + cannot be performed on the Inbox and Sent folders. + + + + ReviseMyMessagesFolders + Yes + + + + + + + + An ID that uniquely identifies the My Messages + folder to perform the operation on. This value is set by + eBay and cannot be changed. Retrieve FolderIDs + by calling GetMyMessages with a DetailLevel of + ReturnSummary. Inbox is FolderID = 0, and Sent is + FolderID = 1. + + + + ReviseMyMessagesFolders + Yes + + + + + + + + The name of a specified My Messages folder. Depending + on the specified Operation, the value is an existing + folder name or a new folder name. Retrieve existing + FolderNames by calling GetMyMessages with a DetailLevel + of ReturnSummary. Inbox is FolderID = 0, and Sent is + FolderID = 1. + + + + ReviseMyMessagesFolders + Conditionally + + + + + + + + + + + + + + + The response to ReviseMyMessagesFoldersRequestType. If the request was successful, + ReviseMyMessagesFolders returns nothing. + + + + + + + + + + + Renames a Selling Manager inventory folder. + This call is subject to change without notice; the deprecation process is + inapplicable to this call. + + + + Revises the name of a Selling Manager inventory folder. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Identifier of the folder to be modified. Valid inputs are folder ID, + folder name, and comments. + + + + ReviseSellingManagerInventoryFolder + Yes + + + + + + + + + + + + + + Returns the status of a revise folder operation. + + + + + + + + + Contains information about the folder that has been renamed. + + + + ReviseSellingManagerInventoryFolder + Always + + + + + + + + + + + + + + Revises a Selling Manager product. + <br><br> + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The details of the product that is being revised. + + + + ReviseSellingManagerProduct + Yes + + + + + + + + The details of the folder for this product. + + + + ReviseSellingManagerProduct + Conditionally + + + + + + + + Specifies the name of a field to remove from a Selling Manager product. + The request can contain zero, one, or many instances of DeletedField (one for each field to be removed). + DeletedField accepts the following path names, which remove the corresponding fields:<br><br> + SellingManagerProductDetails.CustomLabel<br> + SellingManagerProductDetails.QuantityAvailable<br> + SellingManagerProductDetails.UnitCost<br> + These values are case-sensitive. Use values that match the case of the schema element names. + + + + ReviseSellingManagerProduct + Conditionally + + + + + + + + Specifies an eBay category associated with the product, + defines Item Specifics that are relevant to the product, + and defines variations available for the product + (which may be used to create multivariation listings). + + + + ReviseSellingManagerProduct + Yes + + + + + + + + + + + + + + Response for revising a Selling Manager product. + + + + + + + + + The details of the product. + + + + ReviseSellingManagerProduct + Always + + + + + + + + + + + + + + + Request type containing the input fields for the <b>ReviseSellingManagerSaleRecord</b> + call. The standard Trading API deprecation process is not applicable to this + call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be + paired up with a corresponding <b>TransactionID</b> and used as an input filter + for <b>ReviseSellingManagerSaleRecord</b>. The <b>ItemID</b>/<b>TransactionID</b> pair + corresponds to a Selling Manager <b>SaleRecordID</b>, which can be retrieved + with the <b>GetSellingManagerSaleRecord</b> call. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + (Combined Invoice) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item (Combined Invoice) order, <b>OrderID</b> + should be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + + + + ReviseSellingManagerSaleRecord + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Unique identifier for an eBay order line item (transaction). An order + line item is created once there is a commitment from a buyer to purchase + an item. Since an auction listing can only have one order line item + during the duration of the listing, the <b>TransactionID</b> for + auction listings is always 0. Along with its corresponding <b>ItemID</b>, a + <b>TransactionID</b> is used and referenced during an order checkout flow and + after checkout has been completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be + used as an input filter for <b>ReviseSellingManagerSaleRecord</b>. The + <b>ItemID</b>/<b>TransactionID</b> pair corresponds to a Selling Manager <b>SaleRecordID</b>, + which can be retrieved with the <b>GetSellingManagerSaleRecord</b> call. + <br><br> + Unless an <b>OrderLineItemID</b> is used to identify a single line item order, + or the <b>OrderID</b> is used to identify a single or multiple line item + (Combined Invoice) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be + specified. For a multiple line item (Combined Invoice) order, <b>OrderID</b> + must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the + <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. + + + + ReviseSellingManagerSaleRecord + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + A unique identifier that identifies a single line item or multiple line + item (Combined Invoice) order. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b> value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order through + the eBay site. A Combined Invoice order can also be created by the + seller through the <b>AddOrder</b> call. The <b>OrderID</b> can be used as an input + filter for <b>ReviseSellingManagerSaleRecord</b>. The <b>OrderID</b> + is linked to a Selling Manager <b>SaleRecordID</b>, and can be retrieved + with the <b>GetSellingManagerSaleRecord</b> call. + <br><br> + <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if + these fields are also specified in the same request. + + + + ReviseSellingManagerSaleRecord + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Container consisting of order costs, shipping details, order status, and + other information. The changes made under this container will update the + order in Selling Manager. + + + + ReviseSellingManagerSaleRecord + Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. For a single line item order, the + <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field to revise the + order in Selling Manager. + <br><br> + Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line + item order, or the <b>OrderID</b> is used to identify a single or multiple line + item (Combined Invoice) order, the <b>OrderLineItemID</b> must be specified. + For a multiple line item (Combined Invoice) order, <b>OrderID</b> should be + used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are + ignored if present in the same request. + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + ReviseSellingManagerSaleRecord + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + + Response to a ReviseSellingManagerSaleRecord call. + + + + + + + + + + + + Revises a Selling Manager template. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the sale template. You can obtain a + SaleTemplateID by calling GetSellingManagerInventory or AddSellingManagerTemplate. + + + + ReviseSellingManagerTemplate + Yes + + + + + + + + Reserved for future use. + + + + + + + The name of the sale template. + + + + ReviseSellingManagerTemplate + No + + + + + + + + Required. In Item.ItemID, specify the same value as the + value you specified in SaleTemplateID. + Other child elements hold the values for properties that are being changed. + Set values in the Item object only for those properties that are + changing. Use DeletedField to remove a property. + + + + ReviseSellingManagerTemplate + Yes + + + + + + + + Specifies the name of a field to remove from a template. + See the eBay Features Guide for rules on removing values when revising items. + Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). + The request can contain zero, one, or many instances of DeletedField (one for each field to be removed). + DeletedField accepts the following path names, which remove the corresponding fields: + <br><br> + Item.ApplicationData<br> + Item.AttributeSetArray<br> + Item.ConditionID<br> + Item.ItemSpecifics<br> + Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> + Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> + Item.ListingDesigner.LayoutID<br> + Item.ListingDesigner.ThemeID<br> + Item.ListingEnhancement[Value]<br> + Item.PayPalEmailAddress<br> + Item.PictureDetails.GalleryURL<br> + Item.PictureDetails.PictureURL<br> + Item.PostalCode<br> + Item.ProductListingDetails<br> + item.ShippingDetails.PaymentInstructions<br> + Item.ShippingServiceCostOverrideList<br> + item.SKU<br> + Item.SubTitle<br><br> + These values are case-sensitive. Use values that match the case of the schema element names + (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). + However, do not change the case of letters in the middle of a field name (e.g., item.picturedetails.galleryUrl is not allowed). + <br><br> + Depending on how you have configured your pictures, you cannot necessarily delete + both GalleryURL and PictureURL from an existing listing. + If GalleryType was already set for the item you are revising, you cannot remove it. + This means you still need to include either a first picture + or a gallery URL in your revised listing. + + + + ReviseSellingManagerTemplate + Conditionally + + + + + + + + Use this field to verify the template instead of revising it. + + + + ReviseSellingManagerTemplate + No + + + + + + + + + + + + + + Returns the template ID and the estimated fees for the revised listing. + + + + + + + + + This sale template ID uniquely identifies the template that was revised + in the request. This sale template ID should match the + template ID specified in the request. + specified for the call. + + + + ReviseSellingManagerTemplate + Always + + + + + + + + Child elements contain the estimated listing fees for the revised item + listing. The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. Revising an item does not itself + incur a fee. However, certain item properties are fee-based and result + in the return of fees in the call's response. + Not applicable to Half.com. + + + + ReviseSellingManagerTemplate + Always + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + Not applicable to Half.com. + + + + ReviseSellingManagerTemplate + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + Not applicable to Half.com. + + + + ReviseSellingManagerTemplate + Conditionally + + + + + + + + Instead of revising, only verifies the template. + + + + ReviseSellingManagerTemplate + Always + + + + + + + + The name of the sale template. + + + + ReviseSellingManagerTemplate + Always + + + + + + + + The details of the product that this template belongs to. + + + + ReviseSellingManagerTemplate + Always + + + + + + + + + + + + + + Revokes a token before it would otherwise expire. + + + FetchToken, GetSessionID, GetTokenStatus + + + + + + + + + Cancels notification subscriptions for the user/application if set to true. Default value is false. + + + + RevokeToken + No + + + + + + + + + + + + + + Response when an application has voluntarily revoked a user token. + + + + + + + + + + + + + Creates a Selling Manager listing template that is similar to an item. + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + ItemID which should be created as a template and saved to inventory. + + + + SaveItemToSellingManagerTemplate + Yes + + + + + + + + Associates the new template with a product. + + + + SaveItemToSellingManagerTemplate + Yes + + + + + + + + Name associated with the template. If no name is submitted, the template will be named automatically. + + + + SaveItemToSellingManagerTemplate + Yes + + + + + + + + + + + + + + Returns the status of save to template operation. + + + + + + + + + Template ID that is newly created. + + + + SaveItemToSellingManagerTemplate + Always + + + + + + + + + + + + + + Enables a seller to "reverse" an Unpaid Item dispute that has been closed, for + example, if buyer and seller reach an agreement. The seller's Final Value Fee + credit and the buyer's strike are both reversed, if applicable. + The dispute might have resulted + in a strike to the buyer and a Final Value Fee credit to the seller. A buyer and + seller sometimes come to agreement after a dispute has been closed. In particular, + the seller might discover that the buyer actually paid, or the buyer might agree + to pay the seller's fees in exchange for having the strike removed. + <br><br> + A dispute can only be reversed if it was closed with DisputeActivity set to + SellerEndCommunication, CameToAgreementNeedFVFCredit, or + MutualAgreementOrNoBuyerResponse. + + + + Enables a seller to "reverse" an Unpaid Item dispute that has been + closed, for example, if buyer and seller reach an agreement. + The seller's Final Value Fee credit and the buyer's strike are both reversed. + if applicable. + + + AddDispute, AddDisputeResponse, GetDispute, GetUserDisputes + + + Reversing a Closed Unpaid Item Dispute + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-DisputesReversing.html + + + Unpaid Item Disputes + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/UPI-Disputes.html + + + + + + + + + + The unique identifier of the dispute that was returned when the dispute was created. + The dispute must be an Unpaid Item dispute that the seller opened. + + + + SellerReverseDispute + Yes + + + + + + + + The reason the dispute is being reversed. + + + + SellerReverseDispute + Yes + + + + + + + + + + + + + + Returned after calling SellerReverseDisputeRequest. Contains the status + of the call and any errors or warnings. + + + + + + + + + + + + Enables a seller to send an order invoice to a buyer. Where applicable, updates to shipping, payment methods, and sales tax made in this request are applied to the specified order as a whole and to the individual order line items whose data are stored in individual <b>Transaction</b> objects. + + + Enables a seller to send an order invoice to a buyer. + AddItem, GetItemTransactions, GetSellerTransactions + + + + + + + + + Unique identifier for an eBay item listing. Unless <b>OrderID</b> or + <b>OrderLineItemID</b> is provided in the request, the <b>ItemID</b> (or <b>SKU</b>) is + required and must be paired with the corresponding <b>TransactionID</b> to + identify a single line item order. For a multiple line item (Combined Invoice) order, <b>OrderID</b> should be used. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + SendInvoice + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Unique identifier for an eBay order line item (transaction). An order + line item is created once there is a commitment from a buyer to purchase + an item. Since an auction listing can only have one order line item + during the duration of the listing, the <b>TransactionID</b> for + auction listings is always 0. Unless <b>OrderID</b> or <b>OrderLineItemID</b> is + provided in the request, the <b>TransactionID</b> is required and must be + paired with the corresponding <b>ItemID</b> to identify a single line item + order. For a multiple line item (Combined Invoice) order, <b>OrderID</b> should + be used. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + SendInvoice + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + A unique identifier that identifies a single line item or multiple line + item (Combined Invoice) orders. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b> value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order. A + Combined Invoice order can also be created by the seller through the + <b>AddOrder</b> call. + <br><br> + Unless the <b>ItemID</b> (or SKU) and corresponding <b>TransactionID</b>, or the + <b>OrderLineItemID</b> is provided in the request to identify a single line + item order, the <b>OrderID</b> must be specified. If <b>OrderID</b> is specified, + <b>OrderLineItemID</b>, <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present + in the same request. + + + + SendInvoice + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + If the buyer has an International shipping address, use this container + to offer up to three International shipping services. If International + shipping services are offered, (domestic) <b>ShippingServiceOptions</b> should + not be included in the request. + <br> + + + + SendInvoice + No + + + + + + + + If the buyer has a domestic shipping address, use this container + to offer up to three domestic shipping services. If domestic + shipping services are offered, <b>InternationalShippingServiceOptions</b> should + not be included in the request. + <br> + + + + SendInvoice + No + + + + + + + + Container consisting of sales tax details. The amount of sales tax to + add to the price of an order is dependent on the sales tax rate in the + buyer's state and whether sales tax is being applied to the cost of the + order only or the cost of the order plus shipping. + + + + SendInvoice + No + + + + + + + + Specifies whether an insurance fee is required. An <b>InsuranceOption</b> value of + <b>IncludedInShippingHandling</b> cannot be used if the item will use calculated + shipping. Some shipping carriers automatically include shipping insurance + for qualifying items.<br> + + + + SendInvoice + NotOfferedOnSite + No + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + Insurance cost, as set by seller, if ShippingType = 1. + Specify if <b>InsuranceOption</b> is optional or required. Must + be greater than zero value if a value of Optional or Required is passed in + <b>InsuranceOption</b>. Value specified should be the total cost of insuring the + item.<br> + + + 0.0 + + SendInvoice + No + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + + This optional field allows a US or German seller to add specific payment + methods that were not in the original item listing. The only valid values + for this field are 'PayPal' for a US listing, or + 'MoneyXferAcceptedInCheckout' (CIP+) for a DE listing. + + + + SendInvoice + No + + + + + + + + If the <b>PaymentMethods</b> field is used and set to PayPal, the seller + provides his/her PayPal email address in this field. + + + + SendInvoice + No + + + + + + + + This field allows the seller to provide a message or instructions + regarding checkout/payment or the return policy. + + + 500 + + SendInvoice + No + + + + + + + + Flag indicating whether or not the seller wishes to receive an email copy of + the invoice sent to the buyer. + + + true + + SendInvoice + No + + + + + + + + This dollar value indicates the money due from the buyer upon delivery of the item. + <br><br> + This field should only be specified in the <b>SendInvoice</b> request if 'COD' + (cash-on-delivery) was the payment method selected by the buyer and it is included + as the <b>PaymentMethods</b> value in the same request. + + + + SendInvoice + No + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp + + + + + + + + The seller's unique identifier for an item that is being tracked by this + SKU. If <b>OrderID</b> or <b>OrderLineItemID</b> are not provided, both <b>SKU</b> (or + <b>ItemID</b>) and corresponding <b>TransactionID</b> must be provided to uniquely + identify a single line item order. For a multiple line item (Combined Invoice) order, <b>OrderID</b> must be used. + <br> + <br> + This field can only be used if the <b>Item.InventoryTrackingMethod</b> field + (set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to + SKU. + + + 50 + + SendInvoice + Conditionally + + + + + + + + A unique identifier for an eBay order line item. This field is created + as soon as there is a commitment to buy from the seller, and its value + is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a + hyphen in between these two IDs. + <br> + <br> + Unless the <b>ItemID</b> (or <b>SKU</b>) and corresponding <b>TransactionID</b> is used to + identify a single line item order, or the <b>OrderID</b> is used to identify a + single or multiple line item (Combined Invoice) order, the + <b>OrderLineItemID</b> must be specified. For a multiple line item (Combined Invoice) order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, + <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present in the same + request. + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + SendInvoice + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This field allows the seller to adjust the total cost of the order to account + for an extra charge or to pass down a discount to the buyer. + <br><br> + The currency used in this field must be the same currency of the listing site. + A positive value in this field indicates that the amount is an extra charge + being paid to the seller by the buyer, and a negative value indicates that the + amount is a discount given to the buyer by the seller. + + + + SendInvoice + Conditionally + + + + + + + + + + + + + + Returns the status of calling SendInvoice. + + + + + + + + + + + + Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their + Ask a Question page, or to reset any custom subjects to their default values. + + + GetMessagePreferences + + + + + + + + + Contains custom ASQ subjects or a flag to reset those + subjects to their default values. + + + + SetMessagePreferences + No + + + + + + + + + + + + + + Returns the success or failure of the + SetMessagePreferencesRequest, and any applicable errors. + + + + + + + + + + + + + + Manages notification and alert preferences for applications and users. + + + GetNotificationPreferences, GetNotificationsUsage + + Working with Platform Notifications + http://developer.ebay.com/DevZone/guides/ebayfeatures/Notifications/Notifications.html + + + + + + + + + + Specifies application-level event preferences that have been enabled, + including the URL to which notifications should be delivered and whether + notifications should be enabled or disabled (although the + UserDeliveryPreferenceArray input property specifies specific + notification subscriptions). + + + + SetNotificationPreferences + No + + + + + + + + Specifies events and whether or not they are enabled. + + + + SetNotificationPreferences + No + + + + + + + + Specifies user data for notification settings, such as mobile phone number. + + + + SetNotificationPreferences + No + + + + + + + + Characteristics or details of an event such as type, name and value. + Currently can only be set for wireless applications. + + + + SetNotificationPreferences + No + + + + + + + + Specifies up to 25 ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName + to associate with a user token sent in a SetNotificationPreferences request. To + specify multiple DeliveryURLNames, create separate instances of + ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName, and then enable + up to 25 DeliveryURLNames by including them in comma-separated format in this field. + + + + SetNotificationPreferences + No + + + + + + + + + + + + + + (out) Returns the success or failure of a SetNotificationPreferences request. + + + + + + + + + + + + + + + Creates, updates, or deletes Picture Manager account settings, folders, or pictures. + + + 667 + NoOp + 803 + + Creates, updates, or deletes Picture Manager account settings, folders, or pictures. + This call will soon be deprecated. + + GetPictureManagerDetails, GetPictureManagerOptions + + + + + + + + + Specifies the setting or folder to create, update, or delete, or the + picture to update. You cannot upload or delete pictures using + SetPictureManagerDetails; you must use the eBay site. + + + 667 + NoOp + 803 + + SetPictureManagerDetails + Yes + + + + + + + + Specifies the action to take on the setting, folder, or picture. + The values Add and Delete apply only to folders. + + + 667 + NoOp + 803 + + SetPictureManagerDetails + Yes + + + + + + + + + + + + + + Returns the status of an action on a setting, folder, or picture in a Picture Manager account. + + + 667 + NoOp + 803 + + + + + + + + + + + + Creates or modifies a promotional sale. Promotional sales enable sellers + to apply discounts and/or free shipping across many listings. + + + + Creates or modifies a promotional sale. Promotional sales enable sellers + to apply discounts and/or free shipping across many listings. + + SetPromotionalSaleListings, GetPromotionalSaleDetails + + Putting Store Items on Sale + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + The seller must include this field and set it to 'Add' to create a new + promotional sale, or set it to 'Update' to modify an existing promotional sale, + or set it to 'Delete' to delete a promotional sale. + + + + SetPromotionalSale + Yes + + + + + + + + This container must be included in each <b>SetPromotionalSale</b> call. + The fields of this container that will be used will depend on whether the seller is + adding a new promotional sale, updating an existing promotional sale, or deleting an + existing promotional sale. + + + + SetPromotionalSale + Yes + + + + + + + + + + + + + + Contains the ID and status of a promotional sale. + The Promotional Price Display feature enables sellers + to apply discounts and/or free shipping across many listings. + + + + + + + + + Contains the status of a promotional sale. + + + + SetPromotionalSale + Always + + + + + + + + Contains the ID of a promotional sale. + + + + SetPromotionalSale + Always + + + + + + + + + + + + + + Enables the seller to change the item listings that are affected by a promotional sale. + + + SetPromotionalSale, GetPromotionalSaleDetails + + Putting Store Items on Sale + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + The unique identifier of the seller's promotional sale. Based on the <b>Action</b> + value, listings will either be added to or removed from the promotional sale. + + + + SetPromotionalSaleListings + Yes + + + + + + + + This required field determines whether you are adding (specify 'Add') or + removing (specify 'Delete) one or more listings from the promotional sale + identified by the <b>PromotionalSaleID</b> value in the request. + <br><br> + If you specify 'Delete', you must include one or more <b>ItemID</b> + values under the <b>PromotionalSaleItemIDArray</b> container, and + you cannot use the other filter options in the request. If you specify 'Add', + you can add one or more listings using any of the filtering options in the + request. Active auction listings that have one or more bids cannot be added to + or removed from a promotional sale. + + + + SetPromotionalSaleListings + Add, Delete + Yes + + + + + + + + Container consisting of one or more <b>ItemID</b> values. Based on + the <b>Action</b> value, the listings identified by these + <b>ItemID</b> values are either added to or removed from the + promotional sale. + <br><br> + This container is required if listings are being removed (<b>Action</b>='Delete') + from the promotional sale. + + + + SetPromotionalSaleListings + Conditionally + + + + + + + + If a <b>StoreCategoryID</b> value is included in the call request, + all active items in this store category are added to the promotional sale. This + field cannot be used if the <b>Action</b> field is set to 'Delete'. + + + + SetPromotionalSaleListings + No + + + + + + + + If a <b>CategoryID</b> value is included in the call request, + all active items in this eBay category are added to the promotional sale. This + field cannot be used if the <b>Action</b> field is set to 'Delete'. + + + + SetPromotionalSaleListings + No + + + + + + + + If this field is included and set to 'true' in the call request, all fixed-price + listings are added to the promotional sale. This field cannot be used if the + <b>Action</b> field is set to 'Delete'. + + + + SetPromotionalSaleListings + No + + + + + + + + If this field is included and set to 'true' in the call request, all store inventory + items are added to the promotional sale. This field cannot be used if the + <b>Action</b> field is set to 'Delete'. + + + + SetPromotionalSaleListings + No + + + + + + + + If this field is included and set to 'true' in the call request, all auction + listings are added to the promotional sale. This field cannot be used if the + <b>Action</b> field is set to 'Delete'. + + + + SetPromotionalSaleListings + No + + + + + + + + + + + + + + Contains the status of a promotional sale. + + + + + + + + + Contains the status of a promotional sale. + + + + SetPromotionalSaleListings + Always + + + + + + + + + + + + + + Enables Selling Manager subscribers to store standard feedback comments that can + be left for their buyers. Selling Manager Pro subscribers can also specify what + events, if any, will trigger an automated feedback to buyers. + + + + Enables Selling Manager and Selling Manager Pro subscribers to store feedback + comments for buyers and set automated feedback preferences (Selling Manager Pro + subscribers only). + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + Leaving and Retrieving Feedback + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + + + + + + + + Specifies the event that will trigger automated feedback to the buyer. + Applies to Selling Manager Pro subscribers only. + + + + SetSellingManagerFeedbackOptions + No + + + + + + + + Contains a set of comments from which one can be selected to leave + feedback for a buyer. If automated feedback is used, a comment is + selected from the set randomly. Automated feedback applies to Selling + Manager Pro subscribers only. Stored comments cannot be replaced or + edited individually. Submitting a stored comments array replaces all + existing stored comments. + <br> + + + + SetSellingManagerFeedbackOptions + No + + + + + + + + + + + + + + Provides confirmation that feedback comments and (optionally) automated feedback + preferences were added successfully. + + + + + + + + + + + + + + Revises, or adds to, the set of Selling Manager automation + rules associated with an item. + <br> + <br> + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + <br> + <br> + Using this call, you can add an autolist rule. + You also can add a second chance offer + rule (restricted to auction items and auction templates). + Note that autorelist rules can only be set on templates. + An autorelist rule for an item is inherited from a template. + <br> + <br> + This call also enables you to specify particular information about automation + rules. + <br> + <br> + If a node is not passed in the call, the setting for the corresponding + automation rule remains unchanged. + <br> + <br> + Although this call can revise (overwrite) an existing rule, + this call cannot delete an automation rule. + (Instead, use DeleteSellingManagerItemAutomationRule.) + + + + Revises or adds to the set of + Selling Manager automation rules associated with a specific item. + + AddSellingManagerTemplate,GetSellingManagerTemplates + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The item ID whose automation rules you want to change. + + + + SetSellingManagerItemAutomationRule + Yes + + + + + + + + The information for the automated relisting rule to be associated with the item. + + + + SetSellingManagerItemAutomationRule + No + + + + + + + + The information for the automated second chance offer rule to be associated with the item. + + + + SetSellingManagerItemAutomationRule + No + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified item. + + + + + + + + + Contains the automated listing rule associated with this item. + + + + SetSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains the automated relisting rule associated with this item. + + + + SetSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains the automated second chance offer rule associated with this item. + + + + SetSellingManagerItemAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rules (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + SetSellingManagerItemAutomationRule + Conditionally + + + + + + + + + + + + + + + Revises, or adds to, the Selling Manager automation + rules associated with a template. + <br> + <br> + This call is subject to change without notice; the + deprecation process is inapplicable to this call. + <br> + <br> + Using this call, you can add either an autorelist rule or + an autolist rule, but not both. + You also can add a second chance + offer rule (restricted to auction items and auction templates). + <br> + <br> + This call also enables you to specify particular information about automation + rules. + <br> + <br> + If a node is not passed in the call, the setting for the corresponding + automation rule remains unchanged. + <br> + <br> + Although this call can revise (overwrite) an existing rule, + this call cannot delete an automation rule. + (Instead, use DeleteSellingManagerTemplateAutomationRule.) + + + + Revises or adds to the + Selling Manager automation rules associated with a specific template. + + AddSellingManagerTemplate,GetSellingManagerTemplates,GetSellingManagerTemplateAutomationRule,DeleteSellingManagerTemplateAutomationRule + + Using Selling Manager Calls in the Trading API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listings-SellingManager.html + + + Selling Manager page on the eBay Site + http://pages.ebay.com/selling_manager/ + + + Selling Manager Pro page on the eBay Site + http://pages.ebay.com/selling_manager_pro + + + + + + + + + + The ID of the Selling Manager template whose automation rules + you want to change. You can obtain a SaleTemplateID by calling + GetSellingManagerInventory. + + + + SetSellingManagerTemplateAutomationRule + Yes + + + + + + + + The information for the automated listing rule to be associated with the template. + + + + SetSellingManagerTemplateAutomationRule + No + + + + + + + + The information for the automated relisting rule to be associated with the template. + + + + SetSellingManagerTemplateAutomationRule + No + + + + + + + + The information for the automated second chance offer rule to be associated with the template. + + + + SetSellingManagerTemplateAutomationRule + No + + + + + + + + + + + + + + Contains the set of automation rules associated with the specified template. + + + + + + + + + Contains the automated listing rule associated with this template. + + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains the automated relisting rule associated with this template. + + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains the automated second chance offer rule associated with this template. + + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Contains fees that may be incurred when items are listed using the + automation rules (e.g., a scheduled listing fee). Use of an automation rule + does not in itself have a fee, but use can result in a fee. + + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + + + Enables a seller to define shipping cost discount profiles for things such as combined + payments for shipping and handling costs. + + + + AddItem, GetItem, GetShippingDiscountProfiles, RelistItem, ReviseItem, VerifyAddItem + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + + + The three-digit code of the currency to be used for shipping cost discounts and + insurance for Combined Invoice orders. A discount profile can only be associated + with a listing if the <b>CurrencyID</b> value of the profile matches the + <b>Item.Currency</b> value specified in a listing. + <br><br> + Required if the user creates flat rate shipping discount profiles, a promotional + discount, a packaging/handling cost profile based on a variable + discount rule, or if the user defines shipping insurance range/fee pairs. + <br><br> + Note: There is a currencyID attribute on many elements of SetShippingDiscountProfiles. + To avoid an error, be sure to use the same <b>CurrencyID</b> value + in each occurrence within the same request. + + + + SetShippingDiscountProfiles + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This field is used to specify the number of days after the sale of an + item in which the buyer or seller can combine multiple and mutual order + line items into one Combined Invoice order. In a Combined Invoice order, + the buyer makes one payment for all order line items, hence only unpaid + order line items can be combined into a Combined Invoice order. + + + + SetShippingDiscountProfiles + Yes + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Indicates what action to take on the specified flat shipping discount, + calculated shipping discount or promotional discount. + If the action is Delete and if a flat rate or calculated shipping discount + profile is specified, the discount profile identified by + DiscountProfile.DiscountProfileID is deleted + (see DiscountProfile.MappedDiscountProfileID for related details). + + + + SetShippingDiscountProfiles + Yes + + + + + + + + Details of a shipping cost discount profile for flat rate shipping. + If this is provided, CalculatedShippingDiscount and PromotionalShippingDiscountDetails + should be omitted. + + + + SetShippingDiscountProfiles + No + + + + + + + + Details of a shipping cost discount profile for calculated shipping. + If this is provided, FlatShippingDiscount and PromotionalShippingDiscountDetails + should be omitted. + + + + SetShippingDiscountProfiles + No + + + + + + + + This container is used by the seller to specify/modify packaging and handling discounts that are applied + for Combined Invoice orders. + + + + SetShippingDiscountProfiles + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + The data for the promotional shipping discount. + If this is provided, FlatShippingDiscount and CalculatedShippingDiscount + should be omitted. + + + + SetShippingDiscountProfiles + No + + + + + + + + Information establishing what fee to apply for domestic shipping insurance + for Combined Invoice depending on which range the order item-total price + falls into. + + + + SetShippingDiscountProfiles + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + Information establishing what fee to apply for international shipping + insurance for Combined Invoice depending on which range the order item-total + price falls into. + + + + SetShippingDiscountProfiles + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + + + + The response to a call of SetShippingDiscountProfiles. + + + + + + + + + + + + + Sets the configuration of the eBay store owned by the caller. + + + + GetStoreOptions, GetStore, GetStoreCustomPage, SetStoreCustomPage, + SetStoreCategories, GetStoreCategoryUpdateStatus + + + Editing the Store Settings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + Specifies the Store configuration that is being set for the user. + + + + SetStore + Yes + + + + + + + + + + + + + + Returned after calling SetStoreRequest. This serves as confirmation that + the Store configuration was successfully submitted. + + + + + + + + + + + + + Changes the category structure of an eBay store. + + + GetStore, GetStoreCategoryUpdateStatus, SetStore + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + Specifies the type of action (Add, Move, Delete, or Rename) to carry out + for the specified categories. + + + + SetStoreCategories + Yes + + + + + + + + Items can only be contained within child categories. A parent category + cannot contain items. If adding, moving, or deleting categories displaces + items, you must specify a destination child category under which the + displaced items will be moved. The destination category must have no + child categories. + + + + SetStoreCategories + Conditionally + + + + + + + + When adding or moving store categories, specifies the category under + which the listed categories will be located. To add or move categories to + the top level, set the value to -999. + + + + SetStoreCategories + Conditionally + + + + + + + + Specifies the store categories on which to act. + + + + SetStoreCategories + Yes + + + + + + + + + + + + + + Returns the status of the processing progress for changes to the category + structure for a store. + + + + + + + + + The task ID associated with the category structure change request. For a + simple change, the SetStoreCategories call is processed synchronously. + That is, simple changes are made immediately and then the response is + returned. For synchronous processing, the task ID in the response is 0. + If the category structure changes affect many listings, the changes will + be processed asynchronously and the task ID will be a positive number. + Use the non-zero task ID with GetStoreCategoryUpdateStatus to monitor + the status of asynchronously processed changes. + + + + SetStoreCategories + Always + + + + + + + + When a category structure change is processed synchronously, the status + is returned as Complete or Failed. For asynchronously processed changes, + the status is reported as Pending. Use GetStoreCategoryUpdateStatus to + monitor the status of asynchronously processed changes. + + + + SetStoreCategories + Always + + + + + + + + + Contains data for store categories that you have created. + + + + SetStoreCategories + Always + + + + + + + + + + + + + + Creates or updates a custom page on a user's eBay Store. + + + GetStoreOptions, GetStore, SetStore, GetStoreCustomPage + + Managing Custom Pages + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + The custom page being submitted. + + + + SetStoreCustomPage + Yes + + + + + + + + + + + + + + Returned after calling SetStoreCustomPageRequest. This serves as + confirmation that the custom page was successfully submitted. + + + + + + + + + The custom page that was submitted. + + + + SetStoreCustomPage + Always + + + + + + + + + + + + + + Sets the preferences for a user's eBay Store. + + + GetStore, GetStorePreferences, SetStore + + Managing eBay Stores + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayStore.html + + + + + + + + + + Specifies the store preferences. + + + + SetStorePreferences + No + + + + + + + + + + + + + + Returned after calling SetStorePreferencesRequest. This serves as confirmation that + the Store preferences were successfully submitted. + + + + + + + + + + + + Sets the tax table for a seller on a given site. + + + GetTaxTable + + Enabling Multi-jurisdiction Sales Tax + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-SalesTax.html + + + Managing User Preferences + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html#SettingUserPreferences + + + Enabling Multi-jurisdiction Sales Tax + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-SalesTax.html + + + + + + + + + + A container of tax jurisdiction information unique to a user/site combination. + + + + SetTaxTable + Yes + + + + + + + + + + + + + + Response to SetTaxTableRequest. + + + + + + + + + + + + + Enables users to add, replace, and delete My eBay notes for + items that are being tracked in the My eBay All Selling and + All Buying areas. + + + + + + + + + + + ID of the item to which the My eBay note will be + attached. Notes can only be added to items that are + currently being tracked in My eBay. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + SetUserNotes + Conditionally + + + + + + + + The seller must include this field and set it to 'AddOrUpdate' to add a new + user note or update an existing user note, or set it to 'Delete' to delete a + an existing user note. + + + + SetUserNotes + Yes + + + + + + + + Text of the note. Maximum 250 characters. Required only + if the Action is <b>AddOrUpdate</b>. This note text will + completely replace any existing My eBay note for the + specified item. + + + 250 + + SetUserNotes + Conditionally + + + + + + + + Unique identifier for the order line item (transaction) to which the My + eBay note will be attached. Notes can only be added to order line items + that are currently being tracked in My eBay. Buyers can + view user notes made on order line items in the + <b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and + sellers can view user notes made on order line items in + the <b>PrivateNotes</b> field of the <b>SoldList</b> and <b>DeletedFromSoldList</b> + containers in <b>GetMyeBaySellinging</b>. + + + + SetUserNotes + No + + + + + + + + Container consisting of name-value pairs that identify (match) one + variation within a fixed-price, multi-variation listing. The specified + name-value pair(s) must exist in the listing specified by either the + <b>ItemID</b> or <b>SKU</b> values specified in the request. If a specific order line + item is targeted in the request with an + <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any specified + <b>VariationSpecifics</b> container is ignored by the call. + + + + SetUserNotes + No + + + + + + + + SKU value of the item variation to which the My eBay note will be + attached. Notes can only be added to items that are currently being + tracked in My eBay. A SKU (stock keeping unit) value is defined by and + used by the seller to identify a variation within a fixed-price, multi- + variation listing. The SKU value is assigned to a variation of an item + through the <b>Variations.Variation.SKU</b> element. + <br> + <br> + This field can only be used if the <b>Item.InventoryTrackingMethod</b> field + (set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to + SKU. + <br> + <br> + If a specific order line item is targeted in the request + with an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any + specified <b>SKU</b> is ignored by the call. + + + + SetUserNotes + No + + + + + + + + A unique identifier for an eBay order line item. This field is created as + soon as there is a commitment to buy from the seller, and its value is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. <b>OrderLineItemID</b> can be used in the input instead of + an <b>ItemID</b>/<b>TransactionID</b> pair to identify an order line item. + <br> + <br> + Notes can only be added to order line items that are currently being + tracked in My eBay. Buyers can view user notes made on order line items in + the <b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and + sellers can view user notes made on order line items in the <b>PrivateNotes</b> + field of the <b>SoldList</b> and <b>DeletedFromSoldList</b> containers in + <b>GetMyeBaySellinging</b>. + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + SetUserNotes + Conditionally + + + + + + + + + + + + + + Returns the status of the call. + + + + + + + + + + + + Sets the authenticated user's preferences. + + + GetUserPreferences + + Managing User Preferences + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + + + + + + + + Container consisting of the seller's preference for receiving contact + information for unsuccessful bidders. This preference is only applicable for + auction listings. + + + + SetUserPreferences + No + + + + + + + + Container consisting of the seller's preference for allowing Combined Invoice + orders for the same seller and buyer. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Calculated and flat-rate shipping preferences are no longer set using this + call. Instead, use the <b>SetShippingDiscountProfiles</b> call to + set the shipping discounts for Combined Invoice orders. + </span> + <br> + <span class="tablenote"><strong>Note:</strong> + A seller's combined payment preferences can take up to 7 days to + have any affect on eBay. + </span> + + + + SetUserPreferences + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This container should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. This container will be removed from the + Trading WSDL and API Call Reference docs in a future release. + <br><br> + Container consisting of the seller's cross-promotion preferences. These + preferences are only applicable for eBay Store owners. One or more + preferences may be set or modified under this field. + + + + SetUserPreferences + No + + + + + + + + Container consisting of the seller's payment preferences. One or more + preferences may be set or modified under this field. Payment preferences + specified in a <b>SetUserPreferences</b> call override the settings + in My eBay payment preferences. + + + + SetUserPreferences + No + + + + + + + + Container consisting of the seller's preferences for displaying items on a + buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. One + or more preferences may be set or modified under this field. + + + + SetUserPreferences + No + + + + + + + + Container consisting of the seller's preferences for the end-of-auction + email sent to the winning bidder. These preferences allow the seller to + customize the Email that is sent to buyer at the end of the auction. One or + more preferences may be set or modified under this field. These preferences + are only applicable for auction listings. + + + + SetUserPreferences + No + + + + + + + + Flag that controls whether the shipment's tracking number is sent by Email + from the seller to the buyer. + + + false + + SetUserPreferences + No + + + + + + + + Flag that controls whether the buyer is required to provide a shipping phone + number upon checkout. Some shipping carriers require the receiver's phone + number. + + + false + + SetUserPreferences + No + + + + + + + + Container consisting of a seller's Unpaid Item Assistant preferences. The + Unpaid Item Assistant automatically opens an Unpaid Item dispute on the + behalf of the seller. One or more preferences may be set or modified under + this field. + + + + SetUserPreferences + No + + + http://pages.ebay.com/sell/UPI/upiassistant/index.html + Unpaid Item Assistant + + + http://pages.ebay.com/sell/UPI/standardprocess/index.html + Understanding the New Unpaid Item Process + + + + + + + + Container consisting of a seller's preference for sending a purchase + reminder email to buyers. + + + + SetUserPreferences + No + + + + + + + + A flag used to disable the use of a third-party application to handle the + checkout flow for a seller. If set to true, Third-Party Checkout is disabled + and any checkout flow initiated on the seller's application is redirected to + the eBay checkout flow. + + + false + + SetUserPreferences + No + + + + + + + + Contains information about a seller's order cut off time preferences for same day shipping. If the seller specifies a value of <code>0</code> in <strong>Item.DispatchTimeMax</strong> to offer same day handling when listing an item, the seller's shipping time commitment depends on the order cut off time set for the listing site, as indicated by <strong>DispatchCutoffTimePreference.CutoffTime</strong>. + + + + SetUserPreferences + No + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + details about dispatch cut off times + + + + + + + + If this flag is included and set to <code>true</code>, the seller's new listings will enable the Global Shipping Program by default. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This field is ignored for sellers who are not opted in to the Global Shipping Program (when GetUserPreferences returns <strong>OfferGlobalShippingProgramPreference</strong> with a value of <code>false</code>). + </span> + + + false + + SetUserPreferences + No + + + + + + + + If this flag is included and set to <code>true</code>, and the seller specifies an international shipping service to a particular country for a given listing, the specified service will take precedence and be the listing's default international shipping option for buyers in that country, rather than the Global Shipping Program. The Global Shipping Program will still be the listing's default option for shipping to any Global Shipping-eligible country for which the seller does <em>not</em> specify an international shipping service. + <br/><br/> + If this flag is set to <code>false</code>, the Global Shipping Program will be each Global Shipping-eligible listing's default option for shipping to any Global Shipping-eligible country, regardless of any international shipping service that the seller specifies for the listing. + + + false + + SetUserPreferences + No + + + + + + + + When this flag is set to 'true', it enable the Out-of-Stock feature. A seller would use + this feature to keep Fixed-Price GTC (Good 'Til Canceled) listings + alive even when the "quantity available" value goes to 0 (zero). This is useful when waiting + for additional stock and eliminates the need to end the listing + and then recreating it when stock arrives. + <br/><br/> + While the "quantity available" value is 0, the listing would be hidden from eBay search and + if that item was specifically searched for with <b>GetItem</b> + (or related call), the element <b>HideFromSearch</b> would be returned as 'true' and + <b>ReasonHideFromSearch</b> would be returned as 'OutOfStock'. + <br/><br/> + When stock is available, the seller can use the <b>Revise</b> calls to update the inventory of the item + (through the <b>Item.Quantity</b> or <b>Item.Variations.Variation.Quantity</b> + fields) and the listing would appear again. + <br/><br/> + You can return the value of this flag using the <a href="GetUserPreferences.html#Request.ShowOutOfStockControlPreference">GetUserPreferences</a> call and setting the <b>ShowOutOfStockControlPreference</b> field to 'true'. + <br/><br/> + <span class="tablenote"><b>IMPORTANT: </b> + When a listing using the Out-of-Stock feature has zero quantity, the seller has 90 days to add inventory without incurring a listing fee. Fees are changed at the end of each the billing cycle but are then refunded if the item is out-of-stock for an entire billing period. See <a href="../../../../guides/ebayfeatures/Development/Listings-UseOutOfStock.html#FeesForaListingWithZeroQuantity">Fees For a Listing With Zero Quantity</a> for details. + </span> + + + false + + Using the Out-of-Stock Feature for more details + ../../../../guides/ebayfeatures/Development/Listings-UseOutOfStock.html + + + SetUserPreferences + No + + + + + + + + + + + + + + Returned after a call to <b>SetUserPreferences</b> to indicate that the call succeeded. + + + + + + + + + + + + + Uploads a picture to the eBay Picture Service and returns a URL for the picture. + + You will use this URL when creating the listing using one of the <b>AddItem</b> calls. + + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Working with Pictures in an Item Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InListing.html#AssociatingPictureswithanItem + + + Including Pictures in the Search Results Gallery + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InResults.html + + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#DefiningPicturesforVariations + + + + + + + + + + A name you provide for the picture. + Returned as <b>SiteHostedPictureDetails.PictureName</b> in the call response. + + + + UploadSiteHostedPictures + No + + + + + + + + The picture system version. Only version 2 is valid. + Available to support future changes in the picture system version. + + + + 2 + UploadSiteHostedPictures + No + + + + + + + + The image sizes that will be generated. + <br/><br/> + <span class="tablenote"><b>IMPORTANT: </b> + To get the standard website image sizing with Zoom, set this field to <b>Supersize</b>. + </span> + + + + Standard + Large + UploadSiteHostedPictures + No + + + + + + + + An optional reference ID to the binary attachment. + The <b>PictureData</b> field does not contain the binary attachment. + The binary attachment is image data, + including the headers, from a JPG, GIF, PNG, BMP, or TIF format image file. + The binary attachment must be sent as a MIME attachment, + in your POST request, after the XML input. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This field is not applicable for eBay Large Merchant Services. Use the + <b>ExternalPictureURL</b> field instead. + </span> + + + + UploadSiteHostedPictures + No + + + + + + + + Determines if the uploaded picture is to replace all the pictures or to be added to the pictures currently available to a seller on the eBay site. The picture is available to the seller on the My Picture Uploads tab within the Sell Your Item (SYI) pages. + <br/><br/> + The picture you upload (and its URL) is stored for a period of time on the eBay site. If, within that time, the picture is associated with an item, then the picture persists on the eBay site for the same time length as other pictures uploaded using the <b>UploadSiteHostedPictures</b> call. + <br/><br/> + To view the expiration date of the picture, use + <b>UploadSiteHostedPictures.SiteHostedPictureDetails.UseByDate</b>. The date returned is relative to the current date. + + + 25 + + UploadSiteHostedPictures + No + + + + + + + + + The URL for the picture you want to upload. + You can include only one <b>ExternalPictureURL</b> field per call. + <br><br> + The eBay server uses the information in this field to retrieve a picture from a URL on an external web server. Once retrieved, the picture will be copied to eBay Picture Services (EPS) and retained for 90 days, plus the length of your listing duration. + <br/><br/> + <span class="tablenote"><b>Note: </b> + The <b>ExternalPictureURL</b> field is required when using eBay Large Merchant Services. + </span> + + + 1024 + + UploadSiteHostedPictures + Conditionally + 1 + + + + + + + + The type of watermark to apply to the uploaded picture. + <br/><br/> + <span class="tablenote"><b>Note: </b> + Watermarks are applied only to pictures that are greater than an eBay Picture Service configured size. + </span> + + + + UploadSiteHostedPictures + No + + + + + + + + The number of days to extend the expiration date for the specified image, after a listing has ended. This call is restricted to applications that have been granted permission to use it by eBay Developer Technical Support. + <br><br> + This field is not needed for active listings - it is meant to be used only + when a picture needs to be hosted longer than the normal listing duration. + + + 1 + 30 + + UploadSiteHostedPictures + No + + + + + + + + + + + + + + Contains information about a picture upload (i.e., information about a picture + upload containing a binary attachment of an image). + + + + + + + + + The picture system version that was used to upload pictures. + Only version 2 is valid. + + + + UploadSiteHostedPictures + Always + + + + + + + + The information about an <b>UploadSiteHostedPictures</b> upload, + including the URL of the uploaded picture. + + + + UploadSiteHostedPictures + Always + + + + + + + + + + + + + + Validates the user response to a <b class="con">GetChallengeToken</b> + botblock challenge. + + + + Validates the user response to a GetChallengeToken botblock challenge. + + GetChallengeToken + + + + + + + + + Botblock token that was returned by GetChallengeToken. + + + + ValidateChallengeInput + Yes + + + + + + + + User response to a botblock challenge. + + + + ValidateChallengeInput + Yes + + + + + + + + Whether the challenge token should remain valid for up to two minutes. + + + false + + ValidateChallengeInput + No + + + + + + + + + + + + + + Validate the user response to botblock challenge. + + + + + + + + + Indicates whether the token is valid. + + + + ValidateChallengeInput + Always + + + + + + + + + + + + + + Requests to enable a test user to sell items in the Sandbox environment. + + + GetUser + + + + + + + + + Value for the feedback score of a user. If no value is passed in the request, + or if the value is zero, the feedback score is unchanged. This element is not intended + for regularly testing feedback because the feedback value can change after the request. + + + + ValidateTestUserRegistration + No + + 0 + 1000 + + + + + + + Value for the date and time that a user's registration begins. + + + + ValidateTestUserRegistration + No + + + + + + + + Indicates if a user subscribes to Seller's Assistant. You cannot + request to subscribe a user to both Seller's Assistant and + Seller's Assistant Pro. You cannot request to unsubscribe a user. + + + + ValidateTestUserRegistration + No + + + + + + + + Indicates if a user subscribes to Seller's Assistant Pro. You cannot + request to subscribe a user to both Seller's Assistant and + Seller's Assistant Pro. You cannot request to unsubscribe a user. + + + + ValidateTestUserRegistration + No + + + + + + + + Indicates if a user subscribes to Selling Manager. You cannot + request to subscribe a user to both Selling Manager and + Selling Manager Pro. You cannot request to unsubscribe a user. + + + + ValidateTestUserRegistration + No + + + + + + + + Indicates if a user subscribes to Selling Manager Pro. You cannot + request to subscribe a user to both Selling Manager and + Selling Manager Pro. You cannot request to unsubscribe a user. + + + + ValidateTestUserRegistration + No + + + + + + + + + + + + + + Returned after calling ValidateTestUserRegistrationRequest; confirms a successful + call. + + + + + + + + + + + + + Reports items that allegedly infringe your copyright, trademark, or other + intellectual property rights. You can report one or more items at a time with this + call. You must be a member of the Verified Rights Owner (VeRO) Program to use this + call. + + + + Reports items that allegedly infringe your copyright, trademark, or other + intellectual property rights. You must be a member of the Verified Rights Owner + (VeRO) Program to use this call. + + + GetVeROReasonCodeDetails, GetVeROReportStatus + + + + + + + + + + User ID of the VeRO member reporting the items. + + + + VeROReportItems + Yes + + + + + + + + Container (packet) for items being reported. You can report the same item + more than once in a packet if a different reason code is used each time. + + + + VeROReportItems + No + + + + + + + + + + + + + + Contains a packet ID and status for the items reported by the VeRO Program member. + + + + + + + + + A unique packet identifier for the items reported. + + + + + + VeROReportItems + Conditionally + + + + + + + + The processing status of the packet. + + + + VeROReportItems + Conditionally + + + + + + + + + + + + + + Enables a seller to test the definition of a new fixed-price listing by + submitting the definition to eBay without creating a actual listing. + + + AddFixedPriceItem, VerifyAddItem + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + + + + + + + + Root container holding all values that define a new + fixed-price listing. + + + + VerifyAddFixedPriceItem + Yes + + + + + + + + + + + + + + Returns the listing recommendations (if applicable), the + estimated fees for the proposed new listing (except the Final Value Fee, which isn't calculated + until the item has sold), and other details. + + + + + + + + + Represents the item ID for the new fixed-price listing. VerifyAddFixedPriceItem does not + actually list an item, so 0 is returned instead of a normal item ID. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + VerifyAddFixedPriceItem + Always + + + + + + + + Item-level SKU for the new listing, if the seller specified + tem.SKU in the request. Variation SKUs are not returned + (see GetItem instead). + + + + AddFixedPriceItem + Conditionally + + + + + + + + Child elements contain the estimated listing fees for the new item listing. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + + + + VerifyAddFixedPriceItem + Always + + + + + + + + Indicates whether the item would be listed on eBay Express. + See ExpressItemRequirements for hints about why this + value is true or false for a given item. + + + + + + + + + + + + Contains details about why an item does or doesn't + qualify as an eBay Express listing. Only returned when + IncludeExpressRequirements is true the request.<br> + <br> + The item requirements are assessed in this order:<br> + - SellerExpressEligible<br> + - ExpressOptOut<br> + - ExpressApproved<br> + - All other settings + + + + + + + + + + + + ID of the primary category in which the item would be listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + VerifyAddFixedPriceItem + Conditionally + + + + + + + + ID of the secondary category in which the item would be listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + VerifyAddFixedPriceItem + Conditionally + + + + + + + + The nature of the discount, if a discount would have applied + had this actually been listed at this time. + + + + VerifyAddFixedPriceItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>VerifyAddFixedPriceItem</b> request, and if + at least one listing recommendation exists for the listing about to be listed. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the listing based on eBay's listing + recommendation(s) before actually creating the listing through an + <b>AddFixedPriceItem</b> call. + + + + VerifyAddFixedPriceItem + Conditionally + + + + + + + + + + + + + + Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.&nbsp;<b>Also for Half.com</b>. + <br><br> + Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the + recoupment terms before adding or verifying items. This agreement allows eBay to reimburse + a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and + the agreement is located <a href="https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement">here</a>. + The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response. + + + AddItem, VerifyAddFixedPriceItem + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + + + + + + + + Root container holding all values that define a new + listing. + + + + VerifyAddItem + Yes + + + + + + + + Indicates if the response should include detailed data relating to + whether an item would qualify as an Express listing. For + information about the Express-related data that can be returned + when IncludeExpressRequirements is set to true, + see the response of VerifyAddItem and see the + eBay Features Guide. + + + + + + + + + + <b>Deprecated.</b> Recommended usage for eBay.com listings is to use <b>Item.ExternalProductID</b>. + + + + + + + + + + + + + + + + Returns the listing recommendations (if applicable), the estimated fees for the + proposed new listing (except the Final Value Fee, which isn't calculated until the item + has sold), and other details. + + + + + + + + + Represents the item ID for the new listing. VerifyAddItem does not + actually list an item, so 0 is returned instead of a normal item ID. + <br><br> + <span class="tablenote"><b>Note:</b> + Although we represent item IDs as strings in the schema, we recommend you store + them as 64-bit signed integers. If you choose to store item IDs as strings, + allocate at least 19 characters (assuming decimal digits are used) to hold them. + eBay will increase the size of IDs over time. Your code should be prepared to + handle IDs of up to 19 digits. For more information about item IDs, see + <a href= + "https://ebaydts.com/eBayKBDetails?KBid=468"> + Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. + </span> + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + VerifyAddItem + Always + + + + + + + + Child Fee containers provide the listing feature names, fees, and possible discounts + for the new item listing. The fees do not include the Final Value Fee (FVF), which + cannot be determined until an item is sold. + <br /> + <br /> + There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will + be realized when the seller uses AddItem to list the same item. This is the result + of the timing of certain promotions. + + + + VerifyAddItem + Always + + + + + + + + Indicates whether the item would be listed on eBay Express. + See ExpressItemRequirements for hints about why this + value is true or false for a given item. + + + + + + + + + + + Contains details about why an item does or doesn't + qualify as an eBay Express listing. Only returned when + IncludeExpressRequirements is true the request. + <br> + <br> + The item requirements are assessed in this order:<br> + - SellerExpressEligible<br> + - ExpressOptOut<br> + - ExpressApproved<br> + - All other settings + + + + + + + + + + + + ID of the primary category in which the item would be listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + + + 10 + + VerifyAddItem + Conditionally + + + + + + + + ID of the secondary category in which the item would be listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + + + 10 + + VerifyAddItem + Conditionally + + + + + + + + The nature of the discount, if a discount would have applied + had this actually been listed at this time. + + + + VerifyAddItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + VerifyAddItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>VerifyAddItem</b> request, and if + at least one listing recommendation exists for the listing about to be listed. If + one or more listing recommendations are returned, it will be at the seller's + discretion about whether to revise the listing based on eBay's listing + recommendation(s) before actually creating the listing through an + <b>AddItem</b> call. + + + + VerifyAddItem + Conditionally + + + + + + + + + + + + + + Simulates the creation of a new Second Chance Offer + listing of an item without actually creating a listing. + + + GetAllBidders, AddSecondChanceItem + + Making Second Chance Offers for Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-SecondChanceOffers.html + + + + + + + + + + Specifies the bidder from the original, ended listing to whom the seller + is extending the second chance offer. Specify only one + RecipientBidderUserID per call. If multiple users are specified (each in a + RecipientBidderUserID node), only the last one specified receives the + offer. + + + + VerifyAddSecondChanceItem + Yes + + + + + + + + Specifies the amount the offer recipient must pay to purchase the item + from the second chance offer listing. Use only when the original item was + an eBay Motors (or in some categories on U.S. and international sites for + high-priced items, such as items in many U.S. and Canada Business and + Industrial categories) and it ended unsold because the reserve price was + not met. Call fails with an error for any other item conditions. + + + + VerifyAddSecondChanceItem + No + + + + + + + + Specifies the length of time the second chance offer listing will be + active. The recipient bidder has that much time to purchase the item or + the listing expires. + + + + VerifyAddSecondChanceItem + Yes + + + + + + + + Specifies the item ID for the original, ended listing from which the + second chance offer item comes. A new ItemID is returned for the second + chance offer item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + VerifyAddSecondChanceItem + Yes + + + + + + + + Message content. Cannot contain HTML, asterisks, or quotes. This content + is included in the second chance offer email sent to the recipient, which + can be retrieved with GetMyMessages. + + + 1000 + + VerifyAddSecondChanceItem + No + + + + + + + + + + + + + + + VerifyAddSecondChanceItem request to emulate creation of a new Second Chance Offer for an item to one of + that item's bidders. + + + + + + + + + Indicates the date and time when the new + second chance offer listing became active and + the recipient user could purchase the item. + + + + VerifyAddSecondChanceItem + Always + + + + + + + + Indicates the date and time when the second + chance offer listing expires, at which time + the listing ends (if the recipient user does + not purchase the item first). + + + + VerifyAddSecondChanceItem + Always + + + + + + + + + + + + + + This call is used to verify that the data you plan to pass into a <b>RelistItem</b> call will produce the results that you are expecting, including a successful call with no errors. + + + RelistItem + + + + + + + + + Child elements hold the values for item properties that change for the + relisted item. Item is a required input. At a minimum, the Item.ItemID + property must be set to the ID of the listing being relisted (a + listing that ended in the past 90 days). By default, the new listing's + Item object properties are the same as those of the original (ended) + listing. By setting a new value in the Item object, the new listing + uses the new value rather than the corresponding value from the old + listing. + + + + VerifyRelistItem + Yes + + + + + + + + Specifies the name of the field to delete from a listing. See the eBay Features Guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use <b>DeletedField</b> (and potential consequences). + The request can contain zero, one, or many instances of <b>DeletedField</b> (one for each field to be deleted). + <br><br> + Case-sensitivity must be taken into account when using a <b>DeletedField</b> tag to delete a field. The value passed into a <b>DeletedField</b> tag must either match the case of the schema element names in the full field path (Item.PictureDetails.GalleryURL), or the initial letter of each schema element name in the full field path must be lowercase (item.pictureDetails.galleryURL). + Do not change the case of letters in the middle of a field name. + For example, item.picturedetails.galleryUrl is not allowed.<br><br> + To delete a listing enhancement like 'BoldTitle', specify the value you are deleting; + for example, Item.ListingEnhancement[BoldTitle]. + + + + VerifyRelistItem + Conditionally + + + + + + + + + + + + + + Returns the listing recommendations (if applicable), the estimated fees for the + proposed new listing (except the Final Value Fee, which isn't calculated until the item + has sold), and other details. + + + + + + + + + Unique item ID for the new listing. As VerifyRelistItem does not + actually relist an item, returns 0 instead of a normal item ID. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + VerifyRelistItem + Always + + + + + + + + Child elements contain the estimated listing fees for the new item + listing. The fees do not include the Final Value Fee (FVF), which cannot + be determined until an item is sold. + + + + VerifyRelistItem + Always + + + + + + + + Date and time the new listing became active on the eBay site. + + + + VerifyRelistItem + Always + + + + + + + + Date and time when the new listing ends. This is the starting time plus + the listing duration. + + + + VerifyRelistItem + Always + + + + + + + + The nature of the discount, if a discount would have applied + had this actually been listed at this time. + + + + VerifyRelistItem + Conditionally + + + + + + + + Provides a list of products recommended by eBay which match the item information + provided by the seller. + Not applicable to Half.com. + + + + VerifyRelistItem + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the + <b>IncludeRecommendations</b> flag was included and set to 'true' + in the <b>VerifyRelistItem</b> request, and if at least one listing + recommendation exists for the item about to be relisted. If one or more listing + recommendations are returned, it will be at the seller's discretion about + whether to revise the item based on eBay's listing recommendation(s) before + actually relisting the item through a <b>RelistItem</b> call. + + + + VerifyRelistItem + Conditionally + + + + + + + + + + + + + + + Base type definition of the request payload, which can carry any type of payload + content plus optional versioning information and detail level requirements. All + concrete request types (e.g., AddItemRequestType) are derived from the abstract + request type. The naming convention we use for the concrete type names is the name + of the service (the verb or call name) followed by "RequestType": + VerbNameRequestType + + + + + + + Detail levels are instructions that define standard subsets of + data to return for particular data components (e.g., each + Item, Transaction, or User) within the response payload. + For example, a particular detail level might cause the + response to include buyer-related data in every result + (e.g., for every Item), but no seller-related data. + Specifying a detail level is like using a + predefined attribute list in the SELECT clause of an SQL query. + Use the DetailLevel element to specify the required detail level + that the client application needs pertaining to the data components + that are applicable to the request.<br> + <br> + The <b>DetailLevelCodeType</b> defines the + global list of available detail levels for all request types. + Most request types support certain detail + levels or none at all. If you pass a detail level that exists + in the schema but that isn't valid for a particular request, + eBay ignores it processes the request without it. + For each request type, see the detail level tables in the + Input/Output Reference to determine which detail levels are + applicable and which elements are returned for each applicable + detail level. <br> + <br>Note that <b>DetailLevel</b> is required input for + <b>GetMyMessages</b>. <br> + <br> + With <b>GetSellerList</b> and other calls that retrieve large data sets, + please avoid using 'ReturnAll' when possible. For example, if you use + <b>GetSellerList</b>, use <b>GranularityLevel</b> instead, or use <b>GetSellerEvents</b>. If you do use 'ReturnAll' with + <b>GetSellerList</b>, use a small <b>Pagination.EntriesPerPage</b> value and a narrow + <b>EndTimeFrom</b>/<b>EndTimeTo</b> date range for better performance. + + + Yes + + GetMyMessages + + ReturnSummary, ReturnHeaders, ReturnMessages + Yes + + + GetAdFormatLeads + GetBestOffers + GetCategories + GetCategory2CS + GetCategoryMappings + GetFeedback + GetOrders + GetSellerEvents + GetTaxTable + ReturnAll, none + No + + + GetCategoryFeatures + GetMyeBayBuying + GetMyeBaySelling + GetUser + GetUserDisputes + ReturnAll, ReturnSummary, none + No + + + GetItemTransactions + GetSellerList + GetSellerTransactions + GetOrderTransactions + ItemReturnDescription, ReturnAll, none + No + + + GetSellingManagerTemplates + GetItem + ItemReturnAttributes, ItemReturnDescription, ReturnAll, none + No + + + + + + + + Use ErrorLanguage to return error strings for the call in a different language + from the language commonly associated with the site that the requesting user + is registered with. Specify the standard RFC 3066 language identification tag + (e.g., en_US). + <br><br> + <table border="0"> + <tr> + <th>ID</th> + <th>Country</th> + </tr> + <tr> + <td>en_AU</td> + <td>Australia</td> + </tr> + <tr> + <td>de_AT</td> + <td>Austria</td> + </tr> + <tr> + <td>nl_BE</td> + <td>Belgium (Dutch)</td> + </tr> + <tr> + <td>fr_BE</td> + <td>Belgium (French)</td> + </tr> + <tr> + <td>en_CA</td> + <td>Canada</td> + </tr> + <tr> + <td>fr_CA</td> + <td>Canada (French)</td> + </tr> + <tr> + <td>zh_CN</td> + <td>China</td> + </tr> + <tr> + <td>fr_FR</td> + <td>France</td> + </tr> + <tr> + <td>de_DE</td> + <td>Germany</td> + </tr> + <tr> + <td>zh_HK</td> + <td>Hong Kong</td> + </tr> + <tr> + <td>en_IN</td> + <td>India</td> + </tr> + <tr> + <td>en_IE</td> + <td>Ireland</td> + </tr> + <tr> + <td>it_IT</td> + <td>Italy</td> + </tr> + <tr> + <td>nl_NL</td> + <td>Netherlands</td> + </tr> + <tr> + <td>en_SG</td> + <td>Singapore</td> + </tr> + <tr> + <td>es_ES</td> + <td>Spain</td> + </tr> + <tr> + <td>de_CH</td> + <td>Switzerland</td> + </tr> + <tr> + <td>en_GB</td> + <td>United Kingdom</td> + </tr> + <tr> + <td>en_US</td> + <td> United States</td> + </tr> + </table> + + + + + No + + + http://www.ietf.org/rfc/rfc3066.txt + Tags for the Identification of Languages + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. If you pass in a + <b>MessageID</b> in a request, the same value will be returned in the + <b>CorrelationID</b> field in the response. Pairing these values can + help you track and confirm that a response is returned for every request and to + match specific responses to specific requests. + If you do not pass a <b>MessageID</b> value in the request, + <b>CorrelationID</b> is not returned.<br> + <br> + <span class="tablenote"><b>Note:</b> + <b>GetCategories</b> is designed to retrieve very large sets of metadata + that change once a day or less often. To improve performance, these calls return + cached responses when you request all available data (with no filters). When this + occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields + aren't applicable. However, if you specify an input filter to reduce the amount of + data returned, the calls retrieve the latest data (not cached). When this occurs, + <b>MessageID</b> and <b>CorrelationID</b> are applicable. + </span> + + + + + No + + + + + + + + The version number of the API code that you are + programming against (e.g., 859). + The version you specify for a call has these basic effects:<br> + - It indicates the version of the code lists and other + data that eBay should use to process your request.<br> + - It indicates the schema version you are using.<br> + You need to use a version that is greater than or equal to the + lowest supported version.<br> + <br> + <b>For the SOAP API:</b> If you are using the SOAP API, + this field is required. Specify the version of the WSDL your + application is using.<br> + <br> + <b>For the XML API:</b> If you are using the XML API, + this field has no effect. Instead, specify the version in the + X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. + (If you specify <b>Version</b> in the body of an XML API request and it + is different from the value in the HTTP header, eBay returns an + informational warning that the value in the HTTP header was used + instead.) + + + + + Conditionally + + + Routing the Request (Gateway URLs) + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-RoutingRequest.html#HTTPHeaders + + + eBay Schema Versioning Strategy + ../../HowTo/eBayWS/eBaySchemaVersioning.html + + + Lowest Supported Version + ../../HowTo/eBayWS/eBaySchemaVersioning.html#VersionSupportSchedule + + + + + + + + The public IP address of the machine from which the request is sent. + Your application captures that IP address and includes it in + a call request. eBay evaluates requests for safety (also see + the <b>BotBlock</b> container + in the request and response of this call). + + + + PlaceOffer + Yes + + + + + + + + Error tolerance level for the call. This is a preference + that specifies how eBay should handle requests that contain + invalid data or that could partially fail. This gives you some control + over whether eBay returns warnings or blocking errors + and how eBay processes the invalid data.<br> + <br> + This field is only applicable to AddItem and related calls, + and only when the listing includes ProductListingDetails. + + + + AddItem + AddItems + AddLiveAuctionItem + RelistItem + ReviseItem + ReviseLiveAuctionItem + VerifyAddItem + BestEffort + No + + Pre-filling Item Specifics with Product Details + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/ItemSpecifics-CatalogDetails.html#ProductIDErrorHandling + + + + CompleteSale + BestEffort, FailOnError + FailOnError + No + + + + + + + + A unique identifier for a particular call. If the same <b>InvocationID</b> is passed + in after it has been passed in once on a call that succeeded for a particular + application and user, then an error will be returned. The identifier can + only contain digits from 0-9 and letters from A-F. The + identifier must be 32 characters long. For example, + 1FB02B2-9D27-3acb-ABA2-9D539C374228. + + + 32 + + AddOrder + AddToItemDescription + PlaceOffer + ReviseCheckoutStatus + ReviseItem + No + + + + + + + + You can use the <b>OutputSelector</b> field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the <b>OutputSelector</b> field, the output data will only include the fields you specified in the request. For example, if you are using <b>GetItem</b> and you only want to retrieve the URL of the View Item page (emitted in <b>ViewItemURL</b> field) and the item's Buy It Now price (emitted in <b>BuyItNowPrice</b> field), you would include two separate <b>OutputSelector</b> fields and set the value for each one as 'ViewItemURL' and 'BuyItNowPrice' as in the following example: + <br> + <br> + <pre> + ...<br> + <code>&lt;OutputSelector&gt;ViewItemURL&lt;/OutputSelector&gt;<br> + &lt;OutputSelector&gt;BuyItNowPrice&lt;/OutputSelector&gt; + </code><br> + ... + </pre> + + + + GetAccount + GetAdFormatLeads + GetAllBidders + GetBestOffers + GetBidderList + GetCategories + GetCategoryFeatures + GetCategoryListings + GetCrossPromotions + GetFeedback + GetHighBidders + GetItem + GetItemsAwaitingFeedback + GetItemShipping + GetItemTransactions + GetMemberMessages + GetMyeBayBuying + GetMyeBaySelling + GetMyMessages + GetNotificationPreferences + GetOrders + GetOrderTransactions + GetProducts + GetSearchResults + GetSellerEvents + GetSellerList + GetSellerPayments + GetSellerTransactions + No + + + Selecting Fields to Retrieve + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-SelectingFields.html + + + + + + + + Controls whether or not to return warnings when the application passes + unrecognized or deprecated elements in a request.<br> + <br> + An unrecognized element is one that is not defined in any supported + version of the schema. Schema element names are case-sensitive, + so using <b>WarningLevel</b> can also help you remove any potential hidden + bugs within your application due to incorrect case or spelling in + field names before you put your application into the + Production environment.<br> + <br> + <b>WarningLevel</b> only validates elements; it doesn't validate + XML attributes. It also doesn't control warnings related to + user-entered strings or numbers, or warnings for + logical errors.<br> + <br> + We recommend that you only use this during development and debugging. + Do not use this in requests performed in the Production environment. + + + + + No + + + https://ebaydts.com/eBayKBDetails?KBid=499 + Warning Level + + + + + + + + Container for a token and for user input. + + + + PlaceOffer + Conditionally + + + + + + + + + + + + Base type definition of a response payload that can carry any + type of payload content with following optional elements:<br> + - timestamp of response message<br> + - application-level acknowledgement<br> + - application-level (business-level) errors and warnings + + + + + + + This value represents the date and time when eBay processed the + request. The time zone of this value is GMT and the format is the + ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the <b>Time + Values</b> section in the eBay Features Guide for information about this + time format and converting to and from the GMT time zone. <br> + <br> + <span class="tablenote"><b>Note:</b> + <b>GetCategories</b> and other Trading API calls are designed to retrieve very large sets + of metadata that change once a day or less often. To improve performance, these + calls return cached responses when you request all available data (with no + filters). When this occurs, this time value reflects the time the cached response + was created. Thus, this value is not necessarily when the request was processed. + However, if you specify an input filter to reduce the amount of data returned, the + calls retrieve the latest data (not cached). When this occurs, this time value does + reflect when the request was processed.</span> + + + + OrderAck, SetShipmentTrackingInfo, SoldReport + Always + + + + + + + + A token representing the application-level acknowledgement code that indicates + the response status (e.g., success). The <b>AckCodeType</b> list specifies + the possible values for the <b>Ack</b> field. + + + + CompleteSale, GetPopularKeywords, SoldReport + PartialFailure + Always + + + CompleteSale + GetPopularKeywords + Always + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. If you pass in a + <b>MessageID</b> in a request, the same value will be returned in the + <b>CorrelationID</b> field in the response. Pairing these values can + help you track and confirm that a response is returned for every request and to + match specific responses to specific requests. + If you do not pass a <b>MessageID</b> value in the request, + <b>CorrelationID</b> is not returned.<br> + <br> + <span class="tablenote"><b>Note:</b> + <b>GetCategories</b> is designed to retrieve very large sets of metadata + that change once a day or less often. To improve performance, these calls return + cached responses when you request all available data (with no filters). When this + occurs, the <b>MessageID</b> and <b>CorrelationID</b> fields + aren't applicable. However, if you specify an input filter to reduce the amount of + data returned, the calls retrieve the latest data (not cached). When this occurs, + <b>MessageID</b> and <b>CorrelationID</b> are applicable. + </span> + + + + OrderAck, SetShipmentTrackingInfo, SoldReport + Conditionally + + + + + + + + A list of application-level errors (if any) that occurred when eBay + processed the request. + + + + SoldReport + Conditionally + + + Error Handling + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-ErrorHandling.html + + + + + + + + Supplemental information from eBay, if applicable. May elaborate on + errors (such as how a listing violates eBay policies) or provide + useful hints that may help a seller increase sales. This data can + accompany the call's normal data result set or a result set that + contains only errors. <br> + <br> + Applications must recognize when the <b>Message</b> field is returned and + provide a means to display the listing hints and error message + explanations to the user. <br> + <br> + The string can return HTML, including TABLE, IMG, and HREF elements. + In this case, an HTML-based application should be able to include + the HTML as-is in the HTML page that displays the results. + A non-HTML application would need to parse the HTML + and convert the table elements and image references into UI elements + particular to the programming language used. + As usual for string data types, the HTML markup elements are escaped + with character entity references + (e.g.,&lt;table&gt;&lt;tr&gt;...). + + + + AddFixedPriceItem + AddItem + AddItems + AddToItemDescription + EndItem + PlaceOffer + RelistFixedPriceItem + RelistItem + RespondToWantItNowPost + ReviseFixedPriceItem + ReviseItem + VerifyAddFixedPriceItem + VerifyAddItem + Conditionally + + + Standard Data for All Calls + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-StandardCallData.html#Message + + + + + + + + The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the <b>Standard Data for All Calls</b> section in the eBay Features Guide for information on using the response version when troubleshooting <b>CustomCode</b> values that appear in the response. + + + + OrderAck, SetShipmentTrackingInfo, SoldReport + Always + + + + + + + + This refers to the specific software build that eBay used when processing the request + and generating the response. This includes the version number plus additional + information. eBay Developer Support may request the build information + when helping you resolve technical issues. + + + + OrderAck, SetShipmentTrackingInfo, SoldReport + Always + + + + + + + + Event name of the notification. Only returned by Platform Notifications. + + + + + + + Information that explains a failure due to a duplicate <b>InvocationID</b> being + passed in. + + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddOrder + AddSecondChanceItem + AddToItemDescription + PlaceOffer + RelistFixedPriceItem + RelistItem + ReviseCheckoutStatus + ReviseFixedPriceItem + ReviseItem + Conditionally + + + + + + + + Recipient user ID of the notification. Only returned by Platform Notifications. + + + + + + + Unique Identifier of Recipient user ID of the notification. Only returned by + Platform Notifications (not for regular API call responses). + + + + + + + A Base64-encoded MD5 hash that allows the recipient of a Platform + Notification to verify this is a valid Platform Notification sent by + eBay. + + + + + + + Expiration date of the user's authentication token. Only returned + within the 7-day period prior to a token's expiration. To ensure + that user authentication tokens are secure and to help avoid a + user's token being compromised, tokens have a limited life span. A + token is only valid for a period of time (set by eBay). After this + amount of time has passed, the token expires and must be replaced + with a new token. + + + + FetchToken, OrderAck, SetShipmentTrackingInfo, GetSessionID, SoldReport + Conditionally + + + + + + + + Container of token, image URL and audio URL. + + + + PlaceOffer + Conditionally + + + + + + + + An application subscribing to notifications can include an XML-compliant + string, not to exceed 256 characters, which will be returned. The string can + identify a particular user. Any sensitive information should be passed with due + caution. + <br><br> + To subscribe to and receive eBay Buyer Protection notifications, this field is + required, and you must pass in 'eBP notification' as a string. + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + This code identifies the acknowledgement code types that + eBay could use to communicate the status of processing a + (request) message to an application. This code would be used + as part of a response message that contains an + application-level acknowledgement element. + + + + + + + (out) Request processing succeeded + + + + + + + (out) Request processing failed + + + + + + + (out) Request processing completed with warning information + being included in the response message + + + + + + + (out) Request processing completed with some failures. + See the Errors data to determine which portions of the request failed. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container of token and user reply. + + + + + + + An encrypted token that eBay generates and that applications + need to pass as input to subsequent calls. One use of this might + be to block users from the site due to multiple call requests. + + + + PlaceOffer + Conditionally + + + + + + + + The user's response to being asked to type the message + in the botblock challenge image (that is, the image + corresponding to BotBlockUrl that has been returned in a previous call). + + + + PlaceOffer + Conditionally + + + + + + + + + + + + Container of token and image URL and Audio URL. + + + + + + + An encrypted token generated by eBay when the botblock + mechanism is triggered. This token is mapped to BotBlockUrl + and BotBlockAudioUrl. + + + + PlaceOffer + Conditionally + + + + + + + + The URL of the image that your application should display to + the user for a botblock challenge. + + + + PlaceOffer + Conditionally + + + + + + + + The URL of the audio-clip that your application should provide for sight-impaired users. + The BotBlockAudioUrl audio-clip corresponds to the BotBlockUrl image. + + + + PlaceOffer + Conditionally + + + + + + + + + + + + Identifies payment methods used by a buyer to pay a + seller. On item listings, identifies one of the payment methods + seller will accept for the item. Available payment methods can + differ by site and item. Payment methods are not applicable to eBay + Real Estate ad format listings. + + + StandardPayment, QIWI + + + + + + + No payment method specified. + For example, no payment methods would be specified for Ad format listings. + + + + + + + Money order/cashiers check. + Not applicable to US/CA eBay Motors listings. + + + + + + + American Express. + Not applicable to US/CA eBay Motors listings. + + + + + + + Payment instructions are contained in the item's description. + + + + + + + Credit card. + Not applicable to Real Estate or US/CA eBay Motors listings. + + + + + + + Personal check. + + + + + + + Cash on delivery. + This payment method is obsolete (ignored) for the US, US eBay Motors, UK, and Canada sites. + See "Field Differences for eBay Sites" in the eBay Web Services Guide for a list of sites + that accept COD as a payment method. Not applicable to Real Estate listings. + When revising an item (on sites that still support COD), you can add or change its value. + + + + + + + Visa/Mastercard. These qualify as safe payment methods. + Not applicable to US/CA eBay Motors listings. + + + + + + + PaisaPay (for India site only). This qualifies as a safe payment method and is required for all categories on the IN site. + + + + + + + Other forms of payment. Some custom methods are accepted by seller + as the payment method in the transaction. + Not applicable to US/CA eBay Motors listings + (see PaymentSeeDescription instead). + + + + + + + PayPal is accepted as a payment method. This qualifies as a safe payment method. If true in listing + requests, Item.PayPalEmailAddress must also be specified.<br> + <br> + If you don't pass PayPal in the listing request but the seller's eBay + preferences are set to accept PayPal on all listings, + eBay will add PayPal as a payment method for you in most cases, + and we may return a warning. <br> + <br> + PayPal must be accepted when the seller requires immediate payment + (Item.AutoPay) or offers other PayPal-based features, such as a + finance offer (Item.FinanceOfferID). + PayPal must be accepted for charity listings. + PayPal must be accepted for event ticket listings when the venue is in + New York state or Illinois, so that eBay can offer buyer protection + (per state law). (For some applications, it may be + simplest to use errors returned from VerifyAddItem to flag the PayPal + requirement for New York and Illinois ticket listings.) + PayPal must be accepted for US eBay Motors listings that require a deposit (and it will not be set automatically based on the + seller's preferences). Conversely, if PayPal is specified for US eBay Motors listings, deposit attributes must be specified.<br> + + + + + + + Discover card. + Not applicable to US/CA eBay Motors listings. + + + + + + + Payment on delivery. + Not applicable to Real Estate or US/CA eBay Motors listings. + + + + + + + Direct transfer of money. + Not applicable to US/CA eBay Motors listings. + + + + + + + If the seller has bank account information on file, and + MoneyXferAcceptedInCheckout = true, then the bank account information will + be displayed in Checkout. Applicable only to certain global eBay sites. See + the "International Differences Overview" in the eBay Web Services Guide. + + + + + + + All other online payments. + Not applicable to US/CA eBay Motors listings. + + + + + + + Reserved for future use. + + + + + + + Reserved for future use. + + + + + + + Reserved for future use. + + + + + + + Reserved for future use. + + + + + + + Reserved for internal or future use. + + + + + + + Loan check option (applicable only to the US eBay Motors site, + except in the Parts and Accessories category, and the eBay Canada site for motors). + + + + + + + Cash-in-person option. Applicable only to US and Canada eBay Motors vehicles, + (not the Parts and Accessories category). + + + + + + + Elektronisches Lastschriftverfahren (direct debit). + Only applicable to the Express Germany site, which has been shut down. + + + 579 + NoOp + + + + + + + + PaisaPayEscrow payment option. Applicable on selected categories on the India site only. + + + + + + + PaisaPayEscrowEMI (Equal Monthly Installments) Payment option. + Must be specified with PaisaPayEscrow. Applicable only to India site. + + + + + + + This payment method can be added only if + a seller has a payment gateway account. + You can use GetUser.User.SellerInfo.IntegratedMerchantCreditCardInfo + to determine if a seller has a payment gateway account. + If a seller successfully uses AddItem with IntegratedMerchantCreditCard, + then for the resulting item, + the IntegratedMerchantCreditCard value is a replacement + for a credit-card payment method such as VisaMC. + In such a case, the listing displays (to potential buyers) the credit cards that the + seller specified in the seller's preferences for their payment gateway account (in My eBay). + Additionally, a buyer's credit-card payment is integrated into eBay checkout. + + + + + + + The Moneybookers payment method. + For more information, see http://www.moneybookers.com/partners/us/ebay. + Only applicable to the US site (and + to the Parts and Accessories category of the US eBay Motors site). + + + + + + + The Paymate payment method. This payment method is only accepted on the eBay Australia site. For more information on setting up Paymate as an accepted payment method on the eBay Australia site, + see the <a href="http://www.paymate.com/cms/index.php/sellers/sell-on-ebay/selling-on-ebay" target="_blank">Sell with Paymate on eBay.com.au</a> help page. + + + + + + + The ProPay payment method. US site only. For more information, + see http://www.Propay.com/eBay. + + + + + + + PayOnPickup payment method. PayOnPickup is the same as CashOnPickup. + For listings on the eBay US site, the user interface refers to this feature as Pay on pickup. + In the user interface of your application, please refer to the feature as Pay on pickup so that + the name in your user interface corresponds to the name on the eBay US site. + + + + + + + This payment method can be added only if + a seller has a IMCC payment gateway account and Diners Club card is selected in credit card preference. + Currently Dines card is enabled for CyberSource Gateway sellers. + + + + + + + This value is no longer used. + + + + + + + This value indicates that a debit card can be used/was used to pay for the order. This payment method value must be passed in one of the <b>Item.PaymentMethods</b> fields if the seller is making the item available for eBay Now delivery. For eBay Now orders, the eBay Now valet accepts debit cards as a form of payment. This value is only applicable for eBay Now orders. + + + + + + + This value indicates that a credit card can be used/was used to pay for the order. This payment method value must be passed in one of the <b>Item.PaymentMethods</b> fields if the seller is making the item available for eBay Now delivery. For eBay Now orders, the eBay Now valet accepts credit cards as a form of payment. This value is only applicable for eBay Now orders. + + + + + + + This buyer payment method is only applicable for the Germany site and is associated with the rollout of Progressive Checkout and the Pay Upon Invoice feature. 'PayUponInvoice' is not a payment method that is offered to the buyer, but instead, eBay/PayPal makes the determination (based on several factors) during checkout whether the buyer is eligible for 'Pay Upon Invoice'. If the buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until an order invoice is sent by the seller. The seller must offer PayPal as a payment option or the 'Pay Upon Invoice' option will not be made available to the buyer under any circumstance. + <br><br> + Only select categories on the Germany site will support the 'Pay Upon Invoice' option, and orders going above the two-thousand dollar EURO mark will not be eligible for 'Pay Upon Invoice'. + <br><br> + Since the seller can not specify 'Pay Upon Invoice' as a payment method, this enumeration value cannot be passed into a <b>Item.PaymentMethods</b> field in an Add/Revise/Relist call. + + + + + + + This value indicates that QIWI can be used/was used by Russian buyers to pay for the order. This payment method value must be passed in one of the <b>Item.PaymentMethods</b> fields in an Add/Revise/Relist API call if the seller wants to make QIWI an available payment method for Russian buyers. QIWI works in conjunction with PayPal, so if 'QIWI' is set as an available payment method, 'PayPal' must be specified as well. This value can only be specified on the eBay US site, and it is only applicable for Russian buyers. + + + + + + + + + + Security header used for SOAP API calls. + + + + + + + + + + Authentication token representing the user who is making the + request. The user's token must be retrieved from eBay. To determine + a user's authentication token, see the Authentication and + Authorization information in the eBay Web Services guide. For calls + that list or retrieve item or transaction data, the user usually + needs to be the seller of the item in question or, in some cases, + the buyer. Similarly, calls that retrieve user or account data may + be restricted to the user whose data is being requested. The + documentation for each call includes information about such + restrictions. + + + 2000 + + FetchToken + Yes + + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + + + + + + Expiration date of the user's authentication token. Only returned + within the 7-day period prior to a token's expiration. To ensure + that user authentication tokens are secure and to help avoid a + user's token being compromised, tokens have a limited life span. A + token is only valid for a period of time (set by eBay). After this + amount of time has passed, the token expires and must be replaced + with a new token. + + + + GetSessionID,FetchToken + Conditionally + + + + + + + + Authentication information for the user on whose behalf the + application is making the request, and authorization information for + the application making the request. Only registered eBay users are + allowed to make API calls. To verify that a user is registered, your + application normally needs to pass a user-specific value called an + "authentication token" in the request. This is equivalent to signing + in on the eBay Web site. As API calls do not pass session + information, you need to pass the user's authentication token every + time you invoke a call on their behalf. All calls require an + authentication token, except the calls you use to retrieve a token + in the first place. For such calls, you use the eBay member's + username and password instead. + + + + FetchToken + Yes + + + + + + + + A Base64-encoded MD5 hash that allows the recipient of a Platform + Notification to verify this is a valid Platform Notification sent by + eBay. + + + + + + + + + + + Specifies standard subsets of data to return for each result + within the set of results in the response payload. If no + detail level is specified, a base set of data is returned. + The base set of data varies per call. + + + + + + + (in) Returns all available data. + With GetSellerList and other calls that retrieve large data sets, + please avoid using ReturnAll when possible. For example, if you use + GetSellerList, use a GranularityLevel or use the + GetSellerEvents call instead. If you use ReturnAll with GetSellerList, + use a small EntriesPerPage value and a short + EndTimeFrom/EndTimeTo range for better performance. + + + + + + + (in) Returns Description, plus the + ListingDesigner node and some additional information if applicable + + + + + + + (in) For GetItem, returns Item Specifics and + Pre-filled Item Information, if any. + For GetSearchResults, only returns Item Specifics (if any) that + are applicable to search results, and only under certain conditions. + See the description of Item.AttributeSetArray for details about + the effects for applicable calls. Also see the description of + Item.ProductListingDetails for GetItem. + + + + + + + (in) For the GetSearchResults call, returns the primary category and, if applicable, the secondary category + + + + + + + (in) Returns the summary data. + For GetMyMessages, this detail level returns the same data + whether or not you include MessageIDs or AlertIDs in the + request. Returns up to 10 FolderID and FolderName values. + Currently, this detail level is the only way to retrieve + FolderID and FolderName values. See "GetMyMessages" in the + eBay Web Services Guide for a code sample that demonstrates + this. + + + + + + + (in) Returns message headers. + For GetMyMessages, if you include MessageIDs or AlertIDs in + the request, this detail level returns header information, + without body text, for the specified message ID or alert ID + values. If you include a FolderID, header information is + returned only for the messages and alerts in the specified + folder. + If you do not include MessageIDs or AlertIDs, this detail + level returns header information for Alerts and Messages as follows: + - If all the Alerts have been read, they are sorted in date order, + with the most recent first. + - If one of the Alerts has not been read, the Read Alerts come first, + sorted most recent first, followed by the Unread Alert(s). + - All messages in ascending order by date received with the + oldest messages first. + Note that even when restricted by this detail level to + return only header information, GetMyMessages may return a + high volume of data. + + + + + + + (in) Returns full message information. + For GetMyMessages, if you include MessageIDs or AlertIDs in + the request, this detail level returns message information + for the specified message ID or alert ID values. If you + include a FolderID, message information is returned only for + the messages and alerts in the specified folder. + + + + + + + + + + Defines the action taken on a dispute with AddDisputeResponse. The value + you can use at a given time depends on the current value of DisputeState + (see the Developer Guide for more information). Some values are for + Unpaid Item disputes and some are for Item Not Received disputes. + + + + + + + (in) The seller wants to add a response to the dispute. For Unpaid + Item disputes. The seller is limited to 25 responses. + + + + + + + (in) The buyer has paid or the seller otherwise does not need to + pursue the dispute any longer. For Unpaid Item disputes. + + + + + + + (in) The seller has made an agreement with the buyer and requires a + credit for a Final Value Fee already paid. For Unpaid Item disputes. + + + + + + + (in) The seller wants to end communication or stop waiting for the + buyer. For Unpaid Item disputes. + + + + + + + (in) The seller wants to end communication or stop waiting for the + buyer. Mutual agreement has been reached or the buyer has not + responded within four days. For Unpaid Item disputes. + + + + + + + (in) The seller offers a full refund if the buyer did not receive + the item or a partial refund if the item is significantly not as + described. For Item Not Received or Significantly Not As Described + disputes. Can be used when DisputeState is:<br> + NotReceivedNoSellerResponse<br> + NotAsDescribedNoSellerResponse<br> + NotReceivedMutualCommunication<br> + NotAsDescribedMutualCommunication + + + + + + + (in) The seller has shipped the item or a replacement and provides + shipping information. For Item Not Received and Significantly Not As + Described disputes. Can be used when DisputeState is:<br> + NotReceivedNoSellerResponse<br> NotReceivedMutualCommunication + + + + + + + (in) The seller communicates with the buyer, offering a response or + comment. The seller is limited to 25 responses. + For Item Not Received and Significantly Not As Described + disputes. Can be used when DisputeState is:<br> + NotReceivedNoSellerResponse<br> + NotAsDescribedNoSellerResponse<br> + NotReceivedMutualCommunication<br> + NotAsDescribedMutualCommunication + + + + + + + (in) The buyer has not received an expected full or partial refund from the + seller in an Item Not Received or Significantly Not As Described buyer + dispute. This value can be used when DisputeState is:<br> + NotReceivedNoSellerResponse <br> + NotReceivedMutualCommunication <br> + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates whether the seller is eligible for a Final Value Fee credit if the + dispute is resolved by the buyer and seller, or if eBay customer support makes a + decision on the dispute in the seller's favor. Note that even if the item is + eligible for a Final Value Fee credit, the credit is not guaranteed in any way. + + + + + + + (out) The seller is not currently eligible for a Final Value Fee credit. + + + + + + + (out) The seller is eligible for a Final Value Fee credit. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Enumerated type that contains the explanations for a buyer or seller opening a case + against one another. These values are specified in the <b>DisputeExplanation</b> + field of <b>AddDispute</b>, and are returned in the + <b>GetUserDisputes</b> and <b>GetDispute</b> calls. The + <b>DisputeReason</b> value will dictate what + <b>DisputeExplanation</b> values that can be used/returned. + + + BuyerNoLongerRegistered + + + + + + + This value indicates that the buyer has not paid for the order line item, and has + not responded to the seller regarding payment. This value is allowed when the + <b>DisputeReason</b> value is <b>BuyerHasNotPaid</b>. + + + + + + + This value indicates that the buyer has not paid for the order line item, and + according to the seller, has refused to pay for the order line item. This value is + allowed when the <b>DisputeReason</b> value is + <b>BuyerHasNotPaid</b>. + + + + + + + This value indicates that the buyer has not paid for the order line item, and + is not cleared by eBay to pay. This value is allowed when the + <b>DisputeReason</b> value is + <b>BuyerHasNotPaid</b>. + + + + + + + This value indicates that the buyer has returned the item, and seller has agreed to + cancel the order and issue a refund to the buyer. This value is allowed when the + <b>DisputeReason</b> value is <b>TransactionMutuallyCanceled</b>. + + + + + + + This value indicates that the buyer and seller were unable to resolve a disagreement + over terms, and the seller is willing to cancel the order line item. This value is allowed when the + <b>DisputeReason</b> value is <b>TransactionMutuallyCanceled</b>. + + + + + + + This value indicates that the buyer no longer wants the item (buyer remorse), and + the seller is willing to cancel the order line item. This value is allowed when the + <b>DisputeReason</b> value is + <b>TransactionMutuallyCanceled</b>. + + + + + + + This value indicates that the buyer made a mistake by purchasing the item, and + the seller is willing to cancel the order line item. This value is allowed when the + <b>DisputeReason</b> value is + <b>TransactionMutuallyCanceled</b>. + + + + + + + This value is deprecated, and should not be used. + + + + + + + This value indicates that the buyer is requesting shipment of the item to an + unconfirmed (not on file with eBay) address. This value is allowed when the + <b>DisputeReason</b> value is <b>BuyerHasNotPaid</b> or + <b>TransactionMutuallyCanceled</b>. + + + + + + + This value is deprecated, and should not be used. + + + + + + + This value is deprecated, and should not be used. + + + + + + + This value can be used when no other explanation in <b> + DisputeExplanationCodeType</b> is appropriate for the situation. This value is + allowed when the <b>DisputeReason</b> value is + <b>BuyerHasNotPaid</b> or + <b>TransactionMutuallyCanceled</b>. + + + + + + + This value can be used when no other explanation in + <b>DisputeExplanationCodeType</b> is appropriate for the situation. This + value is allowed when the <b>DisputeReason</b> value is + <b>ItemNotReceived</b> or <b>SignificantlyNotAsDescribed</b>. + This value cannot be used in <b>AddDispute</b>. + + + + + + + This value indicates that the Unpaid Item case was opened by eBay through the Unpaid + Item Assistance mechanism. This value cannot be used in + <b>AddDispute</b>. + + + + + + + This value indicates that the buyer has not paid the seller for the order line item, + or has paid the seller but the payment has not cleared. This value is allowed when + the <b>DisputeReason</b> value is <b>BuyerHasNotPaid</b>. + + + + + + + This value indicates that the buyer is requesting shipment of the item to a country + that is on the seller's ship-to exclusion list. This value is allowed when the + <b>DisputeReason</b> value is <b>BuyerHasNotPaid</b> or + <b>TransactionMutuallyCanceled</b>. + + + + + + + This value indicates that the buyer has not paid for the order line item. This value + is allowed when the <b>DisputeReason</b> value is + <b>BuyerHasNotPaid</b>. + + + + + + + This value indicates that the Unpaid Item case was opened by eBay through the Unpaid + Item Assistance mechanism, and then was subsequently converted to a manual dispute, + either by the seller or by eBay. This value cannot be used in + <b>AddDispute</b>. + + + + + + + This value indicates that the seller ran out of stock on the item, cannot fulfill + the order, and has to cancel the order line item. This value is allowed when the + <b>DisputeReason</b> value is + <b>TransactionMutuallyCanceled</b>. + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + The number of disputes that match a given filter. + + + + + + + A filter used to reduce the number of disputes returned. The filter uses criteria + such as whether the dispute is awaiting a response, is closed, or is eligible for + credit. Both Unpaid Item and Item Not Received disputes can be returned for the + same filter value. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + The number of disputes that match the filter. + In the GetUserDisputes response, not returned for the filter type + that was used in the request. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + + + + + Enumeration type that specifies the dispute filters that can be used in the + DisputeFilterType field of the GetUserDisputes call. Note that eBay Buyer + Protection cases are not returned with the GetUserDisputes call, regardless of + the filter that is used. + + + + + + + If used, this filter returns all open and closed disputes that involve the caller as a buyer + or seller. + + + + + + + If used, this filter returns all open disputes that involve the caller as a buyer + or seller and are awaiting a response from the caller. This is the default DisputeFilterType value. In other words, if no DisputeFilterType is specified in the request, only those disputes where the caller's response is due are returned. + + + + + + + If used, this filter returns all open disputes that involve the caller as a buyer or seller and + are awaiting a response from the other party. + + + + + + + If used, this filter returns all closed disputes that involve the caller as a buyer + or seller. + + + + + + + If used, this filter returns all disputes that involve the caller as a buyer + or seller and are eligible for a Final Value Fee credit, regardless of + whether or not the credit has been granted. + + + + + + + If used, this filter returns all open and closed Unpaid Item disputes that + involve the caller as a buyer or seller. + + + + + + + If used, this filter returns all open and closed Item Not Received disputes + that involve the caller as a buyer or seller. + + + + + + + Reserved for future use. + + + + + + + + + + An identifier of a dispute. + + + + + + + + + Defines who added a message to a dispute. Used for both Unpaid Item + and Item Not Received disputes. + + + + + + + (out) The buyer of the item under dispute. + + + + + + + (out) The seller of the item under dispute. + + + + + + + (out) eBay, either an administrator or the site itself. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains a message posted to a dispute. The message can be posted + by the buyer, the seller, or an eBay representative. + + + + + + + An ID that uniquely identifies the message. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + The party who posted the message: the buyer, the seller, + or an eBay representative. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + The date and time the message was created, in GMT. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + The text of the message. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + + + + + Enumerated type that contains the top-level reasons for a buyer or seller to create a + case against one another. These values are specified in the + <b>DisputeReason</b> field of <b>AddDispute</b>, and are returned + in the <b>GetUserDisputes</b> and <b>GetDispute</b> calls. + The <b>DisputeReason</b> value will dictate what + <b>DisputeExplanation</b> values that can be used/returned. + + + + + + + The seller has opened a case against the buyer because the buyer has not paid for + the order line item. A seller can open an Unpaid Item case as early as two days after + the end of the auction listing. An exception to this rule occurs when the seller + allows combined payment orders. If the seller does allow the buyer to combine orders + and make one payment for those orders, the seller would not be able to open an Unpaid + Item case until after the time period to combine orders expires. + <br> + + + + + + + With the mutual consent of the buyer, the seller is canceling the order line item. + + + + + + + The buyer has opened a case against the seller because the item has not been + received by the buyer. A buyer can open an Item Not Received case after the + Estimated Delivery Date of the item has passed, or 7 days after payment if the + Estimated Delivery Date wasn't given by the seller. This value cannot be used in + <b>AddDispute</b>. + + + + + + + The buyer has opened a case against the seller because the item was received but + does not match the item description in the listing. A buyer can open an Item + Significantly Not As Described case immediately after receiving the item. This value + cannot be used in <b>AddDispute</b>. + + + + + + + The item was returned but no refund was given. This value cannot be used in + <b>AddDispute</b>. + + + + + + + Item was returned and seller was not paid. This value cannot be used in + <b>AddDispute</b>. + + + + + + + Reserved for future or internal use. + + + + + + + + + + Describes the type of dispute, either Unpaid Item or Item Not Received. + + + + + + + (out) An Unpaid Item dispute. + + + + + + + (out) An Item Not Received dispute. + + + + + + + One type come from Half.com. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the reason a dispute was resolved. + + + + + + + The dispute was not resolved. + + + + + + + The buyer provided proof of payment in feedback. + + + + + + + The buyer or seller had a technical problem with a computer. + + + + + + + The buyer and seller have not made contact. + + + + + + + The buyer or seller had a family emergency. + + + + + + + The buyer provided proof of payment in feedback. + + + + + + + The dispute was the buyer's first infraction. + + + + + + + The buyer and seller came to agreement. + + + + + + + The buyer returned the item. + + + + + + + The buyer reimbursed the seller's auction fees. + + + + + + + The seller received payment. + + + + + + + Some other resolution occurred. + + + + + + + After eBay approved payment of the claim, the claim was paid. + + + + + + + Reserved for future use. + + + + + + + + + + Specifies the action taken by eBay as a result of the dispute resolution. + + + + + + + The buyer received an Unpaid Item Strike. + + + + + + + The buyer is suspended and unable to use the eBay site. + + + + + + + The buyer is restricted and unable to bid or purchase items. + + + + + + + The seller received a Final Value Fee credit. + + + + + + + The seller's listing fee was credited. + + + + + + + The buyer's Unpaid Item Strike was appealed. + + + + + + + The restriction on the buyer was lifted. + + + + + + + The restriction on the buyer was lifted. + + + + + + + The seller's Final Value Fee credit was reversed. + + + + + + + The seller's listing fee was reversed. + + + + + + + The buyer is given a ticket. + + + + + + + The seller did not receive a Final Value Fee credit. + + + + + + + The buyer did not received the item, and the buyer filed a claim. + + + + + + + + Reserved for future use. + + + + + + + + Reserved for future use. + + + + + + + + Reserved for future use. + + + + + + + + Reserved for future use. + + + + + + + + Reserved for future use. + + + + + + + Credit amount for feature fees. + + + + + + + Amount not returned or credited for feature fees. Item price. + + + + + + + Amount reversed on credit card for feature fees. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains all information about a dispute resolution. A dispute + can have a resolution even if the seller does not receive payment. + The resolution can have various results, including a Final Value Fee credit to + the seller or a strike to the buyer. + + + + + + + The action resulting from the resolution, affecting either + the buyer or the seller. + + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + CSGetDisputeSummary + Always + + + + + + + + The reason for the resolution. The DisputeResolutionReason + results in the action described by the DisputeResolutionRecordType. + + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + CSGetDisputeSummary + Always + + + + + + + + The date and time the dispute was resolved, in GMT. + + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + CSGetDisputeSummary + Always + + + + + + + + + + + + Specifies how a list of returned disputes should be sorted. + + + + + + + (in) Sort by the time the dispute was created, in descending order. + + + + + + + (in) Sort by the time the dispute was created, in ascending order. + + + + + + + (in) Sort by the time the dispute was created, in descending order. + + + + + + + (in) Sort by the dispute status, in ascending order. + + + + + + + (in) Sort by the dispute status, in descending order. + + + + + + + (in) Sort by whether the dispute is eligible for + Final Value Fee credit, in ascending + order. Ineligible disputes are listed before eligible disputes. + + + + + + + (in) Sort by whether the dispute is eligible for + Final Value Fee credit, in descending + order. Eligible disputes are listed before ineligible disputes. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the current state of the dispute, which determines the values + that are valid for DisputeActivity. DisputeState is an internal value + returned in the response. A value can apply to an Unpaid Item or Item + Not Received dispute. A dispute filed when an item is significantly not + as described in the product listing is a variation of an Item Not + Received dispute. + + + + + + + The dispute is locked and cannot be updated. For any type of + dispute. No values of DisputeActivity are valid. + + + + + + + The dispute is closed. In some cases, it can be reversed with + SellerReverseDispute. For any type of dispute. No values of + DisputeActivity are valid. + + + + + + + eBay sent the buyer an Unpaid Item Reminder with a Pay Now + option. Waiting for the buyer's first response. It is within the 7-day + grace period. For Unpaid Item Disputes. DisputeActivity can be + SellerAddInformation or SellerCompletedTransaction. + + + + + + + eBay sent the buyer an Unpaid Item Reminder with no Pay Now + option. Waiting for the buyer's first response. It is within the 7-day + grace period. For Unpaid Item Disputes. DisputeActivity can be + SellerAddInformation or SellerCompletedTransaction. + + + + + + + eBay sent the buyer an Unpaid Item Reminder with a Pay Now + option. Waiting for the buyer's first response. The 7-day grace + period has expired. For Unpaid Item Disputes. DisputeActivity can be + SellerAddInformation, SellerCompletedTransaction, or + SellerEndCommunication. + + + + + + + eBay sent the buyer an Unpaid Item Reminder with no Pay Now + option. Waiting for the buyer's first response. The 7-day grace + period has expired. For Unpaid Item Disputes. DisputeActivity can be + SellerAddInformation, SellerCompletedTransaction, or + SellerEndCommunication. + + + + + + + The buyer and seller have communicated, and eBay offered the buyer + a Pay Now option. For Unpaid Item Disputes. DisputeActivity + can be SellerAddInformation, SellerCompletedTransaction, + SellerEndCommunication, or CameToAgreementNeedFVFCredit. + + + + + + + The buyer and seller have communicated. eBay did not offer + the buyer a Pay Now option. For Unpaid Item Disputes. DisputeActivity can + be SellerAddInformation, SellerCompletedTransaction, + SellerEndCommunication, or CameToAgreementNeedFVFCredit. + + + + + + + The dispute is pending resolution. A dispute cannot be closed + when it is in this state. For Unpaid Item Disputes. + No values of DisputeActivity are valid. + + + + + + + The buyer and seller have agreed within the grace period not + to complete the transaction. For Unpaid Item Disputes. + DisputeActivity can be SellerAddInformation. + + + + + + + The buyer and seller have agreed not to complete the + transaction, after the grace period. For Unpaid Item Disputes. + DisputeActivity can be SellerAddInformation, + SellerCompletedTransaction, or SellerEndCommunication. + + + + + + + The buyer filed an Item Not Received dispute, and the seller + has not responded. For Item Not Received disputes. DisputeActivity + can be SellerOffersRefund, SellerShippedItem, or SellerComment. + + + + + + + The buyer filed an Item Not Received dispute for an item + significantly not as described, and the seller has not responded. + DisputeActivity can be SellerOffersRefund or SellerComment. + + + + + + + The buyer filed an Item Not Received dispute and is + communicating with the seller. DisputeActivity can be + SellerOffersRefund, SellerShippedItem, or SellerComment. + + + + + + + The buyer filed an Item Not Received dispute for an item + significantly not as described and is communicating with the seller. + DisputeActivity can be SellerOffersRefund. + + + + + + + The seller says mutual agreement has been reached and is + waiting for the buyer to confirm, or the buyer is returning the item + to the seller. DisputeActivity can be SellerAddInformation. + For Unpaid Item Disputes. + + + + + + + The claim was assigned to an adjuster. + + + + + + + The buyer was contacted by eBay and asked to submit paperwork to + support the claim. + + + + + + + The buyer did not respond to verification or was missing paperwork. + + + + + + + The buyer is not eligible for reimbursement. + + + + + + + Paperwork was received from the buyer and the claim is being investigated. + + + + + + + The buyer's claim was approved for reimbursement and was + sent to accounts payable for payment. + + + + + + + The buyer was reimbursed. + + + + + + + The issue has been resolved: the seller sent the item or a refund. + + + + + + + A claim was submitted (via Web). + + + + + + + The unpaid item dispute is open. + + + + + + + An unpaid item dispute filed by the Unpaid Item Assistance mechanism was + disabled by eBay (for example, eBay detected that payment was initiated + and the seller needs to manually handle this dispute). + + + + + + + An unpaid item dispute filed by the Unpaid Item Assistance mechanism was + disabled by the seller (e.g. the buyer and seller have communicated + about payment and the seller wishes to extend the time for payment + and not let the automatic process close the dispute 4 days after the + dispute was automatically opened). + + + + + + + Reserved for internal or future use. + + + + + + + + + + Describes the status of the dispute, which supplements the DisputeState. + Some values apply to Unpaid Item disputes and some to Item Not Received disputes. + Disputes can be sorted by DisputeStatus. Ascending order is:<br> + 1 - WaitingForSellerResponse<br> + 2 - WaitingForBuyerResponse<br> + 3 - ClosedFVFCreditStrike<br> + 4 - ClosedNoFVFCreditStrike<br> + 5 - ClosedFVFCreditNoStrike<br> + 6 - ClosedNoFVFCreditNoStrike<br> + 7 - Closed<br> + 8 - StrikeAppealedAfterClosing<br> + 9 - FVFCreditReversedAfterClosing<br> + 10 - StrikeAppealedAndFVFCreditReversed<br> + Descending order is the reverse. + + + + + + + The dispute is closed. For Item Not Received disputes. + + + + + + + The dispute is waiting for the seller's response. For both + Unpaid Item and Item Not Received disputes. + + + + + + + The dispute is waiting for the buyer's response. For both + Unpaid Item and Item Not Received disputes. + + + + + + + The dispute is closed, the seller received + a Final Value Fee credit, and the buyer received a strike. + For Unpaid Item disputes. + + + + + + + The dispute is closed, the seller did not receive + a Final Value Fee credit, and the buyer received a strike. + For Unpaid Item disputes. + + + + + + + The dispute is closed, the seller received a + Final Value Fee credit, and the buyer did not receive a strike. + For Unpaid Item disputes. + + + + + + + The dispute is closed, the seller did not receive + a Final Value Fee credit, and the buyer did not receive a strike. + For Unpaid Item disputes. + + + + + + + The buyer's strike was appealed after the dispute was closed. + For Unpaid Item disputes. + + + + + + + The seller's Final Value Fee credit was reversed after the + dispute was closed. For Unpaid Item disputes. + + + + + + + Both the seller's Final Value Fee credit and the buyer's strike + were reversed after the dispute was closed. For Unpaid Item disputes. + + + + + + + Claim assigned to an adjuster. Also maps for filed claim in Half.com + + + + + + + Buyer contacted and asked to submit paperwork + + + + + + + Buyer did not respond to verification or missing some paperwork. Also maps for + filed claim in Half.com + + + + + + + Not eligible for reimbursement + + + + + + + Paperwork received, claim being investigated. Also maps for filed claim in + Half.com + + + + + + + Claim approved for reimbursement; sent to accounts payable for payment + + + + + + + Reimbursement completed + + + + + + + Issue resolved: seller sent Item or Refund + + + + + + + Claim Submitted via Web flow + + + + + + + Unpaid Item dispute opened + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains properties that provide information on duplicate uses of InvocationIDs. + + + + + + + The duplicate InvocationID. + + + + AddItem + AddItems + AddLiveAuctionItem + AddOrder + AddSecondChanceItem + AddToItemDescription + PlaceOffer + RelistItem + ReviseLiveAuctionItem + ReviseCheckoutStatus + ReviseItem + Conditionally + + + + + + + + The status of the previous call that used the InvocationID. + + + + AddItem + AddItems + AddLiveAuctionItem + AddOrder + AddSecondChanceItem + AddToItemDescription + PlaceOffer + RelistItem + ReviseCheckoutStatus + ReviseItem + ReviseLiveAuctionItem + Conditionally + + + + + + + + The id that identifies the business item the previous API invocation + created. For example, the ItemID of the item created by an AddItem call. + + + + AddItem + AddItems + AddLiveAuctionItem + AddOrder + AddSecondChanceItem + AddToItemDescription + PlaceOffer + RelistItem + ReviseCheckoutStatus + ReviseItem + ReviseLiveAuctionItem + Conditionally + + + + + + + + + + + + + + + + + + An error has occurred either as a result of a problem in the sending + application or because the application's end-user has attempted to submit + invalid data (or missing data). In these cases, do not retry the request. The + problem must be corrected before the request can be made again. If the problem + is due to something in the application (such as a missing required field), the + application must be changed. If the problem is a result of end-user data, the + application must alert the end-user to the problem and provide the means for + the end-user to correct the data. Once the problem in the application or data + is resolved, resend the request to eBay with the corrected data. + + + + + + + Indicates that an error has occurred on the eBay system side, such as a + database or server down. An application can retry the request as-is a + reasonable number of times (eBay recommends twice). If the error persists, + contact Developer Technical Support. Once the problem has been resolved, the + request may be resent in its original form. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Preferences that specify how eBay should handle certain requests that contain + invalid data or that could partially fail. These preferences give you some control + over whether eBay returns warnings or errors in response to invalid data and how + eBay handles listing requests when such data is passed in. For example, these + preferences are applicable to AddItem and related calls when Item Specifics are + specified, and to CompleteSale. See the eBay Web Services Guide + for details about these preferences and their effects. + + + + + + + (in) Apply validation rules that were in effect prior to the time + the call started supporting ErrorHandling. + + + + + + + (in) Drop the invalid data, continue processing the request with the + valid data. If dropping the invalid data leaves the request in a + state where required data is missing, reject the request.<br> + <br> + If BestEffort is specified for CompleteSale, the Ack field in the + response could return PartialFailure if one change fails but + another succeeds. For example, if the seller attempts to + leave feedback twice for the same order line item, the feedback changes + would fail but any paid or shipped status changes would succeed. + + + + + + + (in) If any attribute data is invalid, drop the entire attribute set and + proceed with listing the item. If the category has required attributes + and the attribute set is dropped, reject the listing. + + + + + + + (in) If any data is invalid, reject the request. + + + + + + + + + + A variable that contains specific information about the context of this error. + For example, if you pass in an attribute set ID that does not match + the specified category, the attribute set ID might be returned as an error parameter. + Use error parameters to flag fields that users need to correct. + Also use error parameters to distinguish between errors when multiple + errors are returned. + + + + + + + The value of the variable (e.g., the attribute set ID) + + + + + Conditionally + + + + + + + + + + The index of the parameter in the list of parameter types returned + within the error type. + + + + + Conditionally + + + + + + + + + + These are request errors (as opposed to system errors) that occur due to problems + with business-level data (e.g., an invalid combination of arguments) that + the application passed in. + + + + + + + A brief description of the condition that raised the error. + + + + + Conditionally + + + + + + + + A more detailed description of the condition that raised the error. + + + + + Conditionally + + + + + + + + A unique code that identifies the particular error condition that occurred. + Your application can use error codes as identifiers + in your customized error-handling algorithms. See the "Errors by Number" document. + + + other + + + Conditionally + + + + + + + + Indicates whether the error message text is intended to be displayed to an end user + or intended only to be parsed by the application. If true or not present (the default), + the message text is intended for the end user. If false, the message text is intended for + the application, and the application should translate the error into a more appropriate message. + Only applicable to Item Specifics errors and warnings returned from listing requests. + + + + AddItem + AddItems + AddLiveAuctionItem + RelistItem + ReviseItem + ReviseLiveAuctionItem + VerifyAddItem + Conditionally + + + + + + + + Indicates whether the error is a severe error (causing the request to fail) + or an informational error (a warning) that should be communicated to the user. + + + + + Conditionally + + + + + + + + This optional element carries a list of context-specific + error variables that indicate details about the error condition. + These are useful when multiple instances of ErrorType are returned. + + + + + Conditionally + + + + + + + + API errors are divided between two classes: system errors and request errors. + + + + + Conditionally + + + + + + + + + + + + SOAP faults are used to indicate that an infrastructure error has occurred, + such as a problem on eBay's side with database or server going down, or a + problem with the client or server-side SOAP framework. + + + + + + + + + + + Error code can be used by a receiving application to debug a SOAP response + message that contains one or more SOAP fault details. + Each error code is uniquely defined for each fault scenario. + See the eBay documentation for more information. + Your application can use error codes as identifiers + in your customized error-handling algorithms. + + + + + + + Indicates whether the error is a severe error (causing the request to fail) + or an informational error (a warning). + + + + + + + Description of the condition that caused the SOAP fault. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Basic type for specifying measures and the system of measurement. + A decimal value (e.g., 10.25) is meaningful + as a measure when accompanied by a definition of the unit of measure (e.g., Pounds), + in which case the value specifies the quantity of that unit. + A MeasureType expresses both the value (a decimal) and, optionally, the unit and + the system of measurement. + Details such as shipping weights are specified as measure types. + + + + + + + + Unit of measure. This attribute is shared by various fields, + representing units such as lbs, oz, kg, g, in, cm. + <br><br> + For weight, English major/minor units are pounds and ounces, + and metric major/minor units are kilograms and grams. + For length, the English unit is inches, and metric unit is centimeters. + <br><br> + To get the full list of package dimension and weight measurement units + (and all alternative spellings and abbreviations) supported by your site, + call <b>GeteBayDetails</b>. + + + + AddItem + AddItems + No + + + GetItemShipping + GetSellerTransactions + GetShippingDiscountProfiles + Conditionally + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GeteBayDetails + GeteBayDetails.html + + + + + + + + + The system of measurement (e.g., English). + + + + AddItem + AddItems + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetShippingDiscountProfiles + Conditionally + + + + + + + + + + + + + + English system of measurement. + + + + + + + Metric system of measurement. + + + + + + + + + + Contains data for controlling pagination in API requests. + Pagination of returned data is required for some calls and not + needed in or not supported for some calls. See the documentation + for individual calls to determine whether pagination is supported, + required, or desirable. + + + + + + + This integer value is used to specify the maximum number of entries to return + in a single "page" of data. This value, along with the number of entries that + match the input criteria, will determine the total pages (see + PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the + maximum value is 200 and the default value is 25 entries per page. + <br><br> + For GetOrders, the maximum value is 100 and the default value is 25 orders per page. + <br><br> + For GetUserDisputes, this value is hard-coded at 200, and any pagination input is + ignored. + <br><br> + For GetProducts, the maximum value is 20, and any higher values are + ignored. + + + + GetAccount + GetCategoryListings + GetFeedback + GetItemsAwaitingFeedback + GetItemTransactions + GetLiveAuctionBidders + GetMyeBayBuying + GetMyeBaySelling + GetOrders + GetSellerTransactions + GetWantItNowSearchResults + GetLiveAuctionBidders + GetVeROReportStatus + GetSellingManagerInventory + GetSellingManagerSoldListings + GetMyMessages + GetMemberMessages + No + + + 1 + 200 + 25 + GetOrders + No + + + GetBestOffers + No + 20 + + + 1 + 50000 + 50 + GetProductSearchResults + GetProductFamilyMembers + No + + + 1 + 20 + GetProducts + No + + + 1 + 400 + GetSearchResults + No + + + 1 + 200 + 200 + GetSellerPayments + No + + + 200 + 200 + 200 + GetUserDisputes + No + + + GetSellerList + Yes + + + 100 + GetPopularKeywords + No + + + + + + + + Specifies the number of the page of data to return in the current call. + Default is 1 for most calls. For some calls, the default is 0. Specify a + positive value equal to or lower than the number of pages available (which you + determine by examining the results of your initial request). + See the documentation for other individual calls to determine the correct + default value. + + + + 1 + 1 + GetAccount + GetCategoryListings + GetFeedback + GetItemsAwaitingFeedback + GetItemTransactions + GetLiveAuctionBidders + GetMyeBayBuying + GetMyeBaySelling + GetOrders + GetSearchResults + GetSellerTransactions + GetWantItNowSearchResults + GetLiveAuctionBidders + GetVeROReportStatus + GetSellingManagerInventory + GetSellingManagerSoldListings + GetBestOffers + GetMyMessages + GetMemberMessages + No + + + GetUserDisputes + Yes + + + 0 + 2147483647 + 0 + GetProductSearchResults + GetProductFamilyMembers + No + + + GetSellerList + Yes + + + 1 + 2147483647 + 1 + GetSellerPayments + No + + + 1 + 2000 + 1 + GetProducts + No + + + 1 + GetPopularKeywords + No + + + + + + + + + + + + Basic type for specifying quantities. + + + + + + + + + + + + +SeverityCodeType - Type declaration to be used by other schema. +This code identifies the severity of an API error. A code indicates +whether there is an API-level error or warning that needs to be +communicated to the client. + + + + + + + The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. + <br/><br/> + When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. + + + + + + + The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. + <br/><br/> + If the source of the problem is within the application (such as a missing required element), change the application before you retry the request. + <ul> + <li>If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay. + </li> + <li>If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. + </li> + </ul> + <br/><br/> + See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-UsingLiveData.html#CompatibleApplicationCheck">Compatible Application Check</a> section of the + eBay Features Guide for more information. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Specifies a universally unique identifier for an item. This is used to ensure that you only + list a particular item once, particularly if you are listing many items at once. + The identifier can contain only digits + from 0-9 and letters from A-F. The identifier must be 32 characters long. For + example, 9CEBD9A6825644EC8D06C436D6CF494B. + + + + Item.Site in AddItem + AddItem.html#Request.Item.UUID + + + + + + + + + + + + + + + + + + + The application ID that is unique to each application you (or your company) + has registered with the eBay Developers Program. If you are executing a call + in the Sandbox, this is the "AppId" value that eBay issued to you when you + received your Sandbox keys. If you are executing a call in Production, this is + the "AppId" value that eBay issued to you when you received your Production + keys. + + + + FetchToken + Yes + + + + + + + + The unique developer ID that the eBay Developers Program issued to you (or + your company). If you are executing a call in the Sandbox, this is the "DevId" + value that eBay issued to you when you received your Sandbox keys. Typically, + you receive your Sandbox keys when you register as a new developer. If you are + executing a call in Production, this is the "DevId" value that eBay issued to + you when you received your Production keys. Typically, you receive your + Production keys when you certify an application. + + + + FetchToken + Yes + + + + + + + + Authentication certificate that authenticates the application when making API + calls. If you are executing a call in the Sandbox, this is the "CertId" value + that eBay issued to you when you received your Sandbox keys. If you are + executing a call in Production, this is the "CertId" value that eBay issued to + you when you received your Production keys. This is unrelated to auth tokens. + + + + FetchToken + Yes + + + + + + + + eBay user ID (i.e., eBay.com Web site login name) for the user the application + is retrieving a token for. This is typically the application's end-user (not + the developer). + + + 64 + + FetchToken + Yes + + + + + + + + Password for the user specified in Username. + + + + + + + + + + + + + + + + + Do not return warnings when the application passes + unrecognized or deprecated elements in a request. + This is the default value if WarningLevel is not specified. + + + + + + + Return warnings when the application passes + unrecognized or deprecated elements in a request. + + + + + + + + + + + + + + + + + + + eBay user ID (i.e., eBay.com Web site login name) for the user the application + is retrieving a token for. This is typically the application's end-user (not + the developer). + + + 64 + + FetchToken + Yes + + + + + + + + Password for the user specified in Username. + + + + + + + Authentication token representing the user who is making the request. The + user's token must be retrieved from eBay. To determine a user's authentication + token, see the Authentication and Authorization information in the eBay Web + Services guide. For calls that list or retrieve item or transaction data, the + user usually needs to be the seller of the item in question or, in some cases, + the buyer. Similarly, calls that retrieve user or account data may be + restricted to the user whose data is being requested. The documentation for + each call includes information about such restrictions. + + + 2000 + + FetchToken + Yes + + + Getting Tokens + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens.html + + + + + + + + + + + + + + Enables a seller to add custom Ask Seller a Question (ASQ) + subjects to display on the seller's Ask a Question page, or reset + the custom subjects to the default values. + + + + + + + Used to reset custom subjects to their default values. For + SetMessagePreferences, either ResetDefaultSubjects or Subject + is required in the request, but not both. + + + + SetMessagePreferences + Conditionally + + + + + + + + Contains the ASQ subjects to display on the seller's + Ask a Question page, with one subject per Subject node up to a + maximum of nine. The tenth subject, "General question about + this item," cannot be edited. An error will be returned if subjects are duplicated. + <br><br> + For SetMessagePreferences, either ResetDefaultSubjects or + Subject is required in the request, but not both. Subjects are + displayed on the ASQ drop-down list in same order as the + request. + <br><br> + Note that the default ASQ subjects will display in the site's + language if retrieved from a site other than the seller's own. + For example, if a US seller sells on the DE and the FR + sites, the default subjects will display in German and French + respectively. However, if the seller adds custom questions, + all questions will display only in the seller's language. In + the example case, FR and DE buyers would see custom subjects + in English only. Use ResetDefaultSubjects to restore the + default subjects and the default language display behavior. + + + 60 + + GetMessagePreferences + Conditionally + + + SetMessagePreferences + Conditionally + + + + + + + + + + + + Enumerated type that defines the possible values that can be returned in the <b>RuleCurrentStatus</b> output field of the <b>GetApiAccessRules</b> call. The <b>RuleCurrentStatus</b> is only returned if the daily, hourly, or periodic call limit for the corresponding API call has been exceeded, or if a call limit does not apply to the API call. + + + + + + + This value indicates that usage limits do not apply to the corresponding API call. + + + + + + + This value indicates that your application has exceeded its hourly hard call limit for the corresponding API call. + + + + + + + This value indicates that your application has exceeded its daily hard call limit for the corresponding API call. + + + + + + + This value indicates that your application has exceeded its periodic hard call limit for the corresponding API call. The period is defined in the <b>ApiAccessRule.Period</b> field and can be a calendar month or a specific number of days. + + + + + + + This value indicates that your application has exceeded its hourly soft call limit for the corresponding API call. + + + + + + + This value indicates that your application has exceeded its daily soft call limit for the corresponding API call. + + + + + + + This value indicates that your application has exceeded its periodic soft call limit for the corresponding API call. The period is defined in the <b>ApiAccessRule.Period</b> field and can be a calendar month or a specific number of days. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines values that describe an application's current status + with respect to an API access rule. The rules specify daily, + hourly, and periodic usage limits for various eBay Web Services calls. + + + + + + + The rule is turned off, and no rule validation + was performed. + + + + + + + The rule is turned on, and rule validation was + performed. + + + + + + + The application is blocked from making + requests to the call named in this rule. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Enumerated type that defines the debit and credit transactions that occur on an eBay user's account. These values are returned in the <b>AccountEntry.AccountDetailsEntryType</b> output field of the <b>GetAccount</b> call. + + + + + + + The reason for the charge is unknown. + + + + + + + The fee for listing an item for sale on eBay. + + + + + + + The fee for a listing title in boldface font. + + + + + + + The fee for adding an optional feature to a listing, + such as a reserve fee or a listing upgrade fee. + + + + + + + (out) + + + + + + + The fee charged when a listed item sells. The fee + is a percentage of the final sale price. + + + + + + + A payment by check made by a seller to eBay. + + + + + + + A payment by credit card made by a seller to eBay. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + A refund made by eBay to the seller's credit card. + + + + + + + A refund made by eBay to the seller by check. + + + + + + + A finance charge made to the seller's account, for example, + the monthly finance charge added to an account whose balance has not been + paid. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + A credit made by eBay for a duplicate listing. + + + + + + + A fee charged by eBay for a partial sale. + + + + + + + A reversal of an electronic transfer payment. + + + + + + + A one-time payment to the account made by + credit card. + + + + + + + A fee charged by eBay for a returned check. + + + + + + + A fee charged by eBay when a check must be redeposited + to collect funds. + + + + + + + A cash payment made on the seller's account. + + + + + + + A credit issued by eBay for an insertion fee. + If a listed item does not sell or results in an + Unpaid Item (UPI) dispute, the seller can relist + the item. If the item sells the second time, eBay + credits the insertion fee. + + + + + + + A credit issued by eBay for the Bold listing fee. + + + + + + + A credit issued by eBay for the Featured listing fee. + + + + + + + (out) + + + + + + + A credit issued by eBay for the Final Value Fee. + Issued as a result of an Unpaid Item dispute, under + some circumstances. + + + + + + + A fee charged by eBay when the seller's check does not clear + due to insufficient funds. + + + + + + + A fee charged by eBay when the seller's check does not clear + because the account has been closed. + + + + + + + (out) + + + + + + + A payment made to the account by money order. + + + + + + + An automatic monthly charge of the seller's invoice + amount made by eBay to a credit card the seller has placed + on file. + + + + + + + A one-time payment made by a credit card + that is not on file with eBay for automatic monthly + payments. + + + + + + + (out) + + + + + + + (out) + + + + + + + A transfer from another account to this account, + resulting in a credit to this account. + + + + + + + A transfer from this account to another account, + resulting in a debit to this account. + + + + + + + A credit balance for an account's invoice period, + meaning that the seller should not pay. + + + + + + + An all-purpose code for debits that are manually applied to auctions, + for example, when the credit cannot be applied to an item number + + + + + + + An all-purpose code for credits that are manually applied to auctions, + for example, when the credit cannot be applied to an item number + + + + + + + (out) + + + + + + + A note that the credit card is not + on file at the customer's request. + + + + + + + A credit issued by eBay for an insertion + fee when an item is relisted. + + + + + + + (out) + + + + + + + A fee charged by eBay for adding a gift icon to + a listing. The gift icon highlights the item as a good + gift and might offer gift services, such as wrapping + or shipping. + + + + + + + A credit issued by eBay for the gift item + fee. + + + + + + + A fee charged by eBay for listing an item + in the Picture Gallery. A buyer sees a picture of + the item when browsing a category, before moving to + the item's listing page. + + + + + + + A fee charged by eBay for listing an item + in the Featured section at the top of the Picture Gallery + page. + + + + + + + A credit issued by eBay for the Gallery fee + charged when the item was listed. + + + + + + + A credit issued by eBay for the Featured Gallery + fee charged when the item was listed. + + + + + + + (out) + + + + + + + A credit issued by eBay when listings are not available + due to system downtime. The downtime can be a title search + outage or a hard outage. See the online help for details. + + + + + + + (out) + + + + + + + (out) + + + + + + + A fee charged by eBay when an item is listed with + a reserve price. The fee is credited when the auction + completes successfully. + + + + + + + A credit issued by eBay for a reserve price auction + when the auction completes successfully. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + A credit issued by eBay to a Store owner + who has promoted items outside of eBay. + + + + + + + (out) + + + + + + + A switch from one billing currency to another. + The billing currency can be USD, EUR, CAD, GBP, AUD, + JPY, or TWD. + + + + + + + A payment made to the account by gift certificate. + + + + + + + A payment made to the account by wire transfer. + + + + + + + (out) + + + + + + + A one-time payment made to the account by electronic + transfer. + + + + + + + A credit (addition) made by eBay to the seller's account + when a payment needs to be adjusted. + + + + + + + A debit (deduction) made by eBay to the seller's account + when a payment needs to be adjusted. + + + + + + + (out) + + + + + + + (out) + + + + + + + A writeoff of the account charge by eBay + because the seller has declared bankruptcy. + + + + + + + (out) + + + + + + + A writeoff of the account charge by eBay + because the seller is deceased. + + + + + + + (out) + + + + + + + (out) + + + + + + + A reversal of a finance charge, made by eBay. + The finance charge is added if the seller does not pay + the monthly account balance on time. + + + + + + + A reversal of a Final Value Fee credit, resulting + in the fee being charged to the seller. The Final Value + Fee can be credited as a result of an Unpaid Item Dispute. + If the buyer later pays, the seller can request a reversal. + + + + + + + A fee charged for currency conversion. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + A monthly payment made by automatic direct debit to the + seller's checking account, when the account information + is on file. + + + + + + + A one-time payment made by direct debit to the seller's + checking account, when the account information is not on file, + but is provided for this payment. + + + + + + + A payment made by direct debit from the seller's + checking account when the seller has requested automatic + monthly invoice payments. + + + + + + + A reversal of a payment made by direct debit + from the seller's checking account. + + + + + + + A reversal of a payment made by direct debit + from a seller's checking account when an item is returned + by the buyer. + + + + + + + A fee charged by eBay for adding a colored band to + emphasize a listing. + + + + + + + A credit issued by eBay for a highlight fee on an + item's listing. + + + + + + + (out) + + + + + + + A fee charged for a 30-day real estate + listing. + + + + + + + A credit for a 30-day real estate listing. + + + + + + + (out) + + + + + + + (out) + + + + + + + A fee charged to sellers who do not provide a credit card + or checking account number to verify identify. + + + + + + + A credit granted for an EquifaxRealtimeFee. + + + + + + + (out) + + + + + + + (out) + + + + + + + Two accounts with the same owner but different user IDs + have been merged into one. + + + + + + + (out) + + + + + + + (out) + + + + + + + The option to send the seller paper invoices + has been turned on. + + + + + + + The option to send the seller paper invoices + has been turned off. + + + + + + + (out) + + + + + + + An automatic reversal of a Final Value Fee + credit. + + + + + + + A credit granted by eBay when a title search + outage of one hour or longer occurs on the site. + + + + + + + A fee charged for listing a lot (one or more items) in a + Live Auction catalog. + + + + + + + A fee charged for listing an extra item in a Live Auction. + + + + + + + (out) + + + + + + + A credit for listing an item in a Live Auction catalog. + + + + + + + A Final Value Fee charged by eBay when a lot listed + on a Live Auction is sold. + + + + + + + A refund of a Final Value Fee that was charged + when a Live Auction lot was sold. + + + + + + + A fee paid by the buyer to the auction house for + a purchase in a Live Auction. + + + + + + + A refund of the fee paid by a buyer to the auction + house for a purchase in a Live Auction. + + + + + + + A fee charged for audio or video services provided + during the sale of lots at a Live Auction. + + + + + + + A refund for audio or video services provided at + a Live Auction. + + + + + + + A fee charged for a panoramic 360-degree photo + in a listing. + + + + + + + A fee charged for a slide show of panoramic 360-degree + photos. + + + + + + + A credit granted to reverse an IPIX photo fee. + + + + + + + A credit granted to reverse an IPIX slideshow fee. + + + + + + + A fee charged for listing an item for 10 days, + rather than one, three, five, or seven days. + + + + + + + A credit granted to reverse a 10-day auction + fee. + + + + + + + (out) + + + + + + + (out) + + + + + + + A fee charged for a subscription to Auction Assistant Basic. + + + + + + + A fee charged for a subscription to Auction Assistant Pro. + + + + + + + A credit granted for a subscription fee charged for Auction Assistant Basic. + + + + + + + A credit granted for a subscription fee charged for Auction Assistant Pro. + + + + + + + A fee charged by eBay for a supersized picture + in a listing. + + + + + + + A credit issued by eBay for a supersized picture. + + + + + + + A fee charged by eBay for the Picture Pack feature. + The fee differs according to the number of pictures you + use. See the online help for details. + + + + + + + A partial credit issued by eBay for the Picture Pack fee. + + + + + + + A full credit issued by eBay for the Picture Pack fee. + + + + + + + A monthly subscription fee charged for an eBay Store. + The fee can be Basic, Featured, or Anchor. + + + + + + + A credit issued by eBay for the monthly fee charged + for an eBay store. + + + + + + + The fee charged by eBay for listing a Fixed Price item. + + + + + + + A credit issued by eBay for listing a Fixed Price item. + + + + + + + The Final Value Fee credit charged by eBay when + a fixed price item sells. + + + + + + + A credit issued by eBay for the Final Value Fee + for a fixed price item. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + The fee charged by eBay for creating a Fixed Price + listing with a 10-day duration. Fixed Price listings + of 1, 3, 5, and 7 days are not charged this fee. + + + + + + + A credit issued by eBay for a Fixed Price listing + with a 10-day duration. + + + + + + + A fee charged by eBay for listing a Buy It Now item. + + + + + + + A credit issued by eBay for the fee charged for a + Buy It Now listing. + + + + + + + A fee for scheduling a listing to start at some + later time, up to 3 weeks after the listing is created. + + + + + + + A credit made by eBay for the fee charged for + scheduling a listing to start after the listing is created. + + + + + + + The monthly subscription fee charged for + Selling Manager Basic. The monthly charge is billed + in advance. + + + + + + + The monthly subscription fee charged for + Selling Manager Pro. The monthly charge is billed + in advance. + + + + + + + A one-time credit for a free one-month + trial of Selling Manager Basic. + + + + + + + A one-time credit for a free one-month + trial of Selling Manager Pro. + + + + + + + The fee charged for a Good-Til-Cancelled + listing in an eBay Store. The charge is made once + each 30 days, until the listing ends. + + + + + + + A credit for the fee charged for a Good-Til-Cancelled + listing in an eBay Store. + + + + + + + The fee charged for using a Listing Designer theme and layout + template for a listing. The fee is displayed to the seller during + the listing process. + + + + + + + A credit issued by eBay for a Listing Designer fee. + + + + + + + The fee charged for listing an auction item + for 10 days. + + + + + + + A credit for the fee charged for listing an + auction item for 10 days. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + An addition to the seller's eBay + Anything Points account. Each point is + equivalent to $0.01. + + + + + + + A reduction to the seller's eBay + Anything Points account. Each point is + equivalent to $0.01. + + + + + + + An automatic payment of seller fees + from the seller's eBay Anything Points account. + + + + + + + A one-time payment of seller fees from + the seller's eBay Anything Points account. + + + + + + + A reversal of a seller fee payment made + from the seller's eBay Anything Points account. + + + + + + + A cash payment made from the seller's eBay + Anything Points account and credited to the seller's + account. + + + + + + + A credit (return) to your account of Value-Added Tax + previously paid. + + + + + + + A debit to your account for a Value-Added Tax charge. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + Used for Store Inventory listings, which are no longer supported on any eBay site. + + + + + + + A credit for a StoresSuccessfulListingFee. + + + + + + + (out) + + + + + + + A credit posted to a seller's account + for sale of Stores Inventory items by buyers + referred to the seller's Store by printed materials + and emails outside eBay. + + + + + + + The fee charged for adding a subtitle + to a listing. The subtitle adds information + to the title. + + + + + + + A credit of the fee charged for adding a + subtitle to a listing. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + The monthly fee charged for subscribing to + Picture Manager. The fee varies according to + the level of subscription. + + + + + + + A credit granted for a Picture Manager subscription + fee. + + + + + + + A fee charged for a basic subscription to Seller Reports. + + + + + + + A credit granted for a basic subscription to Seller Reports. + + + + + + + A fee charged for a subscription to Seller Reports Plus. + + + + + + + A credit granted for a subscription to Seller Reports Plus. + + + + + + + (out) + + + + + + + (out) + + + + + + + (out) + + + + + + + The fee for adding a border that outlines a listing with a frame. + + + + + + + A credit for the border fee charged for a listing. + + + + + + + A fee charged to a seller for upgrading + a listing from eBay Germany's Car, Motorcycle, + and Special Vehicle categories so that it is also + searchable on the mobile.de classifieds site. + + + + + + + A monthly subscription fee charged for + Sales Reports Plus. + + + + + + + A credit granted for a Sales Reports Plus + monthly subscription fee. + + + + + + + A credit granted for upgrading a listing + to make it searchable on the mobile.de platform. + + + + + + + A fee charged to owners of eBay Stores + who have a sent a marketing email to buyers, + for the number of email recipients over + the Store's monthly free allocation. The + monthly allocation varies according to the type + of Store. + + + + + + + A credit granted for an email marketing fee. + + + + + + + A fee charged for the Picture Show + service, which lets buyers browse or see a slide + show of 2 or more pictures at the top of the + item page. + + + + + + + A credit granted for a Picture Show fee. + + + + + + + A fee charged for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). + + + + + + + A credit granted by eBay for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). + + + + + + + A fee charged by eBay for the BasicUpgradePackBundle feature pack. + No longer applicable to any sites (but formerly applicable to the + Australia site, site ID 15). + + + + + + + A credit granted by eBay for the BasicUpgradePackBundle feature pack. + No longer applicable to any sites (but formerly applicable to the + Australia site, site ID 15). + + + + + + + A fee charged by eBay for the ValuePackBundle feature pack. + + + + + + + A credit granted by eBay for the ValuePackBundle feature pack. + + + + + + + A fee charged by eBay for the ProPackPlusBundle feature pack. + + + + + + + A credit granted by eBay for the ProPackPlusBundle feature pack. + + + + + + + The final entry in an account before it is closed + or merged with another account. + + + + + + + Reserved for future use. + + + + + + + A fee charged for extended listing duration. + + + + + + + A credit granted by eBay for extended listing duration. + + + + + + + The fee for an international listing. + + + + + + + A credit issued by eBay for an international listing. + + + + + + + A MarketPlace Research fee for expired subscriptions. + + + + + + + A MarketPlace Research credit for expired subscriptions. + + + + + + + A MarketPlace Research basic subscription fee. + + + + + + + A MarketPlace Research basic subscription credit. + + + + + + + A MarketPlace Research pro subscription fee. + + + + + + + Basic bundle fee. + + + + + + + Basic bundle fee credit. + + + + + + + A MarketPlace Research pro subscription fee credit. + + + + + + + A Vehicle Local subscription fee. + + + + + + + A Vehicle Local subscription fee credit. + + + + + + + A Vehicle Local insertion fee. + + + + + + + A Vehicle Local insertion fee credit. + + + + + + + A Vehicle Local final value fee. + + + + + + + A Vehicle Local final value fee credit. + + + + + + + A Vehicle Local GTC fee. + + + + + + + A Vehicle Local GTC fee credit. + + + + + + + eBay Motors Pro fee. Applies to eBay Motors Pro registered dealer + applications only. + + + + + + + eBay Motors Pro fee credit. Applies to eBay Motors Pro registered + dealer applications only. + + + + + + + eBay Motors Pro feature fee. Applies to eBay Motors Pro registered + dealer applications only. + + + + + + + eBay Motors Pro feature fee credit. Applies to eBay Motors Pro + registered dealer applications only. + + + + + + + A fee charged by eBay for listing an item with the + Gallery Plus feature enabled. This feature cannot be removed + with ReviseItem or RelistItem. However, if the feature is + upgraded, for example, to Gallery Featured, the fee for + Gallery Plus is refunded and a fee for Gallery Feature is + charged instead. + + + + + + + A credit issued by eBay when refunding the fee for + enabling the Gallery Plus feature. A Gallery Plus credit may + be issued if, for example, a user upgrades their feature + with ReviseItem or RelistItem to Gallery Featured. In this + case, the original Gallery Plus fee is refunded and a + Gallery Featured fee is charged instead. + + + + + + + + + + + + + + + + + + + eBay ImmoPro Fee + + + + + + + Credit eBay ImmoPro Fee + + + + + + + eBay ImmoPro Feature Fee + + + + + + + Credit eBay ImmoPro Feature Fee + + + + + + + eBay Real Estate Pro Fee + + + + + + + Credit eBay Real Estate Pro Fee + + + + + + + eBay Real Estate Pro Feature Fee + + + + + + + Credit eBay Real Estate Pro Feature Fee + + + + + + + PowerSeller, PowerSeller shipping, Top-rated seller, + eBay Stores subscription, or other subscription discount against the + final value fee, insertion fee, subscription fee, late payment fee, + or other fee. See AccountEntry.Title for an explanation of the + discount and the percentage that was applied. + + + + + + + + Reserved for future use. + + + + + + + + Reserved for future use. + + + + + + + The fee charged for Return Shipping. + + + + + + + A credit issued by eBay against a Return Shipping charge. + Issued as a result of an Unpaid Item dispute, under + some circumstances. + + + + + + + The fee charged by eBay for the Global Shipping Program. + + + + + + + Credit issued by eBay for charged Global Shipping Program Fee + + + + + + + A fee charged to the seller's account if the seller ends an auction (with bids) + early. + + + + + + + A credit issued by eBay to the seller's account if a duplicate auction + listing is ended administratively by eBay. A seller is only eligible for this + credit if the auction listing had zero bids and was never surfaced in Search. + + + + + + + The fee charged to the seller for printing out and using a FedEx shipping + label from eBay. + + + + + + + A credit issued by eBay to reimburse the seller for a FedEx shipping label. In + some cases, this credit may be issued to the seller as a result of an Unpaid Item + case that the seller has won against a buyer. + + + + + + + This fee is charged to the seller's account if eBay is forced to refund the buyer + in a case where the buyer has used the eBay US Managed Returns process and return + shipped the item to the seller, but the seller has not issued a refund to the buyer + within seven business days after receiving the returned item. + <br/><br/> + This value is equal to the refund ("CreditReturnRefund") issued to the buyer. + + + + + + + A credit issued to the buyer's account by eBay in a case where the buyer has used the eBay US + Managed Returns process and return shipped the item to the seller, but the seller + has not issued a refund to the buyer within seven business days after receiving the + returned item. The buyer credit amounts to the total purchase price (plus any + shipping costs if the item was "not as described") minus the seller's restocking + fee if one was specified under the return policy of the listing. + <br/><br/> + eBay then charges this expense to the seller's account, and this charge is + attached to the "FeeReturnRefund" value. + + + + + + + (out) The fee charged for early termination of an eBay Stores subscription. + + + + + + + (out) A credit issued by eBay for early termination of an eBay Stores subscription. + + + + + + + (out) The fee charged for early termination of a National Vehicle subscription. + + + + + + + (out) A credit issued by eBay for early termination of a National Vehicle subscription. + + + + + + + (out) A monthly subscription fee charged for a National Vehicle subscription. + + + + + + + (out) A credit issued by eBay for the monthly fee charged for a National Vehicle subscription. + + + + + + + (out) The fee charged to the seller for printing out and using an AU Post shipping label from eBay. + + + + + + + (out) A credit issued by eBay to reimburse the seller for an AU Post shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer. + + + + + + + (out) The fee charged to the seller for printing out and using an APAC FedEx shipping label from eBay. + + + + + + + (out) A credit issued by eBay to reimburse the seller for an APAC FedEx shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer. + + + + + + + (out) The fee charged to the seller for printing out and using an APAC TNT shipping label from eBay. + + + + + + + (out) A credit issued by eBay to reimburse the seller for an APAC TNT shipping label. In some cases, this credit may be issued to the seller as a result of an Unpaid Item case that the seller has won against a buyer. + + + + + + + (out) The fee charged for eBay Buyer Protection reimbursement. + + + + + + + (out) A credit issued by eBay for eBay Buyer Protection reimbursement. + + + + + + + (out) The fee charged for the Promoted Listing feature. + + + + + + + (out) A credit issued by eBay for the Promoted Listing feature. + + + + + + + + + + Type defining the array of <b>AccountEntry</b> objects that are conditionally returned in the <b>GetAccount</b> response. + + + + + + + Container consisting of detailed information for each debit or credit transaction that occurs on an eBay user's account. + + + + GetAccount + Conditionally + + + + + + + + + + + + Enumerated type defining the possible values that can be used in the <b>AccountEntrySortType</b> field of the <b>GetAccount</b> request to sort account entries returned in the response. + + + + + + + This is the default value. With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in ascending order (oldest transaction to most recent transaction). This value will produce the same results as the <b>AccountEntryCreatedTimeAscending</b> value. + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in ascending order (oldest transaction to most recent transaction). This value will produce the same results as the <b>None</b> value. + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted by transaction date (see <b>AccountEntry.Date</b> field) in descending order (most recent transaction to oldest transaction). + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted by Item ID value (see <b>AccountEntry.ItemID</b> field) in ascending order (oldest eBay listing to most recent eBay listing). + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted by Item ID value (see <b>AccountEntry.ItemID</b> field) in descending order (most recent eBay listing to oldest eBay listing). + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted in alphabetical order according to each entry's <b>AccountEntry.Description</b> value. When account entries are sorted according to fee type, the secondary sort criterion is transaction date, and for account entries with identical fee types, the oldest account entries will appear first in the response. + + + + + + + With this value set, account entries in the <b>GetAccount</b> response are sorted in reverse alphabetical order according to each entry's <b>AccountEntry.Description</b> value. When account entries are sorted according to fee type, the secondary sort criterion is transaction date, and for account entries with identical fee types, the oldest account entries will appear first in the response. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>AccountEntry</b> container returned in the <b>GetAccount</b> response. Each <b>AccountEntry</b> container consists of detailed information for a single credit or debit transaction, or an administrative action which occurred on the eBay user's account. + + + + + + + This enumeration value indicates the type of transaction or administrative action that occurred on the eBay user's account. Possible values are defined in the <b>AccountDetailEntryCodeType</b> enumerated type. + + + + GetAccount + Conditionally + + + + + + + + The category of the monetary transaction or administrative action applied + to an eBay account. + + + + GetAccount + Conditionally + + + + + + + + This field is no longer returned. If the eBay user has an outstanding balance owed to eBay, the owed amount will be displayed in the <b>AccountSummary.CurrentBalance</b> field in the <b>GetAccount</b> response. + + + + GetAccount + Conditionally + + + + + + + + Timestamp indicating the date and time that the entry was posted to the account, in + GMT. + + + + GetAccount + Conditionally + + + + + + + + Gross fees that are assessed by eBay (net fees plus VAT, if any). + Returned even if VAT does not apply. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + If the account entry is associated with an eBay listing, this field + shows the eBay <b>ItemID</b> value. If there is no correlation between the account entry and one of the user's eBay listings, '0' is returned in this field. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetAccount + Conditionally + + + + + + + + Memo line for the account entry. It can be an empty string. + + + + GetAccount + Conditionally + + + + + + + + The rate used for the currency conversion for a transaction. + + + + GetAccount + Conditionally + + + + + + + + Net fees that are assessed by eBay, excluding additional surcharges and VAT + (if any). Returned even if VAT does not apply. The value is positive for + debits (user pays eBay) and negative for credits (eBay pays user). + + + + GetAccount + Conditionally + + + + + + + + This value is the unique identifier for the account entry. This value is created by eBay once the transaction occurs on the user's account. + + + + GetAccount + Conditionally + + + + + + + + The applicable rate that was used to calculate the VAT (Value-Added Tax) for the transaction. When the <b>VATPercent</b> is specified for a listing, the item's VAT information appears on the View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. VAT is only applicable to sellers located in a European Union (EU) country. If VAT does not apply to the account entry, this field is still returned but it's value will be '0'. + + + + GetAccount + Conditionally + + + + + + + + A description or comment about the monetary transaction or administrative action applied to an eBay user account. + + + + GetAccount + Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. This field is only returned if the account entry is associated with an order line item. + + + 100 + + GetAccount + Conditionally + + + + + + + + The unique identifier of an order line item. This field is only returned if the account entry is associated with an order line item. + + + 19 + + GetAccount + Conditionally + + + + + + + + This boolean field is returned as 'true' if the seller received a discount on the Final Value Fee for the order line item. Only Top-Rated sellers are eligible for this Final Value Fee discount. The Final Value Fee discount percentage varies by country. For more information on becoming a Top-Rated Seller in the US and the requirements for Top-Rated Plus listings, see the <a href="http://pages.ebay.com/help/sell/top-rated.html" target="_blank">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> eBay Customer Support topic. + + + + GetAccount + Conditionally + + + + + + + + + + + + Specifies a report format to be used to describe the seller's account. + + + + + + + (in) Contains the entries since the last invoice eBay sent to the seller. + If you use LastInvoice, then InvoiceDate, BeginDate and EndDate are ignored. + + + + + + + (in) Contains the entries for a specific invoice, identified + by the invoice month and year. If you use SpecifiedInvoice, then you + must also use InvoiceDate. If you use SpecifiedInvoice, then BeginDate and EndDate are ignored. + + + + + + + (in) Contains entries that were posted to the seller's account between two dates. + The period covered may cross the boundaries of formal invoices. + If you use BetweenSpecifiedDates, then you also must specify BeginDate and EndDate. + If you use BetweenSpecifiedDates, then InvoiceDate is ignored. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + State of an account of an eBay user. + + + + + + + (out) The account is active. + + + + + + + (out) The account has been created but is not yet active, + pending additional information or processing by eBay. + + + + + + + (out) The account is inactive. No new seller account entries + would be posted by eBay to the account. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Summary data for the requesting user's seller account as a whole. This includes a + balance for the account, any past due amount and date, and defining data for + additional accounts (if the user has changed country of residency while having an + active eBay account). + + + + + + + Indicates the current state of the account (such as active or inactive). + Possible values are enumerated in the AccountStateCodeType code list. + + + + GetAccount + Conditionally + + + + + + + + Specifies payment made since the previous invoice, but is + returned only if AccountHistorySelection is LastInvoice or Specified + Invoice. The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Specifies credits granted since the previous invoice, but + is only returned AccountHistorySelection is LastInvoice or Specified + Invoice. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Specifies fees incurred since the last invoice, including + tax if applicable. Returned only if AccountHistorySelection + is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Contains the data for one additional account. An AccountSummaryType object + may return zero, one, or multiple additional accounts. See the schema + documentation for AdditionalAccountType for details on additional accounts. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Amount past due, 0.00 if not past due. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + First four digits of the bank account the user associated with the seller + account (with remainder Xed-out). This may be an empty string depending + upon the payment type the user selected for the account (e.g., if no + debit-card specified). + + + 4 + + GetAccount + Conditionally + + + + + + + + Indicates the date and time BankAccountInfo was last modified, in GMT. + (Also see the Data Types appendix for more information on how GMT dates are + handled in SOAP.) This may be an empty string depending upon the payment + type the user selected for the account (e.g., if no debit-card specified). + + + + GetAccount + Conditionally + + + + + + + + Indicates the billing cycle in which eBay sends a billing invoice to the + user. A value of 0 (zero) indicates an invoice sent on the last day of the + month. A value of 15 indicates an invoice sent on the 15th day of the + month. + + + + GetAccount + Conditionally + + + + + + + + Expiration date for the credit card selected by the user as payment method + for the account, in GMT. (Also see the Data Types appendix for more + information on how GMT dates are handled in SOAP.) Empty string if no + credit card is on file or if the account is inactive - even if there is a + credit card on file. + + + + GetAccount + Conditionally + + + + + + + + Last four digits of the credit card the user selected as payment method for + the account. Empty string if no credit is on file. + + + + GetAccount + Conditionally + + + + + + + + Indicates the date and time credit card or credit card expiration date was + last modified, in GMT. (Also see the Data Types appendix for more + information on how GMT dates are handled in SOAP.) This may be an empty + string depending on the payment method the user selected for the account + (e.g., Empty string if no credit card is on file.) + + + + GetAccount + Conditionally + + + + + + + + This field shows the current balance for the user's account. This value can be '0.00', a positive amount (debit), or a negative amount (credit). + <br><br> + This field is only returned if the <b>ExcludeBalance</b> flag is included in the call request and set to 'false'. + + + + GetAccount + Conditionally + + + + + + + + (out) Email address for the user. You cannot retrieve an email address for any + user with whom you do not have a transactional relationship, regardless of + site. Email is only returned for applicable calls when you are retrieving your + own user data OR when you and the other user are in a transactional + relationship and the call is being executed within a certain amount of time + after the transaction is created. + + + + + + + Amount of last invoice. 0.00 if account not yet invoiced. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Date of last invoice sent by eBay to the user, in GMT. (Also see the Data + Types appendix for more information on how GMT dates are handled in SOAP.) + Empty string if this account has not been invoiced yet. + + + + GetAccount + Conditionally + + + + + + + + Amount of last payment posted, 0.00 if no payments posted. + The value is positive for debits and negative for credits. + + + + GetAccount + Conditionally + + + + + + + + Date of last payment by the user to eBay, in GMT. (Also see the Data Types + appendix for more information on how GMT dates are handled in SOAP.) Empty + string if no payments have been posted. + + + + GetAccount + Conditionally + + + + + + + + Indicates whether the account has past due amounts outstanding. A value of + true indicates that the account is past due. A value of false indicates the + account is current. + + + + GetAccount + Conditionally + + + + + + + + Indicates the method the user selected to pay eBay with for the account. + The values for PaymentMethod vary from one global eBay site to the next. + Payment methods are enumerated in the SellerPaymentMethodCodeType code + list. + + + + GetAccount + Conditionally + + + + + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + + + + + + + Description of the fee type. + + + + FeeSettlementReport + Conditionally + + + + + + + + List of transactions for a certain fee type. + + + + FeeSettlementReport + Conditionally + + + + + + + + + + + + Used to indicate whether the Ad Format feature is enabled for a category. + + + + + + + The Ad Format feature is disabled for the category. + + + + + + + The Ad Format feature is enabled for the category. + + + + + + + The category supports the Ad Format feature only. + + + + + + + The lead generation Classified Ad Format feature is enabled for the category. + + + + + + + The category supports the lead generation Classified Ad Format feature only. + + + + + + + The category supports the lead generation Motors Local Market feature only. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>AdFormatEnabled</b> field that is returned under the <b>FeatureDefinitions</b> container if 'AdFormatEnabled' is used as a <b>FeatureID</b> value in the request, or if no <b>FeatureID</b> values are used in the request. The field is returned as an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + Enumerated type that indicates to the owner of a classified ad whether or not an email correspondence from a prospective buyer has been answered. + + + + + + + This value will appear in the response if there is a new message from a prospective buyer that the seller has not yet responded to. + + + + + + + This value will appear in the response if the seller has already responded to the prospective buyer's message. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains prospective buyer contact information and other details associated with + a lead for an ad format listing. + + + + + + + Message sent from the prospective buyer to the seller. Same + content as in the AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body node (that is only displayed if IncludeMemberMessages = + true is included in the request). The advantage of + retrieving the MemberMessageExchange node, however, is that + you retrieve the entire exchange between the seller and the + lead. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Address information for the prospective buyer. + Not returned or returned self-closed if information is unavailable. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The time of day when the prospective buyer prefers to be contacted by the + seller. + Not returned if information is unavailable. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Email address for the prospective buyer. If the prospective buyer chooses to + hide his email address when contacting the seller, this element contains two + dashes (--) instead of an email address. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Date and time (in GMT) that the lead was submitted. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The unique identifier of the item listing. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The title of the item listing. + + + 55 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The eBay ID of the user who is interested in the seller's item. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Contains any mail message content shared between the seller and lead. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Status of the lead. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The pay-per-lead feature is no longer available, and this field is scheduled to + be removed from the WSDL. + + + + + + + + + + + Email address for the prospective buyer as entered in the lead form on the View + Item page. Provides a way for sellers to contact prospective buyers who choose not to + log in to eBay. This applies to only eBay Motors and eBay Motors categories. + + + 128 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Prospective buyer's time frame for purchasing a vehicle as entered in the + Lead form on View Item page for eBay Motors and eBay Motors categories. + Purchasing Time Frames include: + <ul> + <li> + within next 3 days + </li> + <li> + within a week + </li> + <li> + within a month + </li> + <li> + within three months + </li> + <li> + in more than three months + </li> + <li> + within an undecided time frame + </li> + </ul> + + + 255 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The year of the vehicle the prospective buyer would like to trade in. Entered on + the lead form on the View Item page. Applies to eBay Motors and Motors categories + only. + + + 32 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The make of the vehicle the prospective buyer would like to trade in. Entered on + the lead form on the View Item page. Applies to eBay Motors and Motors categories + only. + + + 128 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The model of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page.Applies to eBay Motors and Motors categories only. + + + 128 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Prospective buyer answer whether or not the prospective buyer would like + financing. Entered on the lead form on the View Item page. Applies to eBay Motors + and Motors categories only. Financing response meanings: 0= no response,1= yes, 2= + no. + + + 1 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field corresponds to a configurable question on the lead form in the View + Item web page. The corresponding question is site-specific. To determine the + question for a specific site, you must view the form in the web flow for the given + site. This field applies to Classified Ad format listings in Motors categories + only. + + + 1 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field corresponds to a configurable question on the lead form in the View + Item web page. The corresponding question is site-specific. To determine the + question for a specific site, you must view the form in the web flow for the given + site. This field applies to Classified Ad format listings in Motors categories + only. + + + 1 + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>AddItemRequestContainer</b> containers that are used in an <b>AddItems</b> call. An <b>AddItemRequestContainer</b> container is required for each item being created through an <b>AddItems</b> call. Each item being created through an <b>AddItems</b> call is identified through a unique <b>AddItemRequestContainer.MessageID</b> value that is defined by the seller. + + + + + + + Container holding all values that define a new listing. One <b>Item</b> + container is required for each <b>AddItemRequestContainer</b>. + + + + AddItems + Yes + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. With + <b>AddItems</b>, a unique <b>MessageID</b> value is required for + each <b>AddItemRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>AddItemResponseContainer</b> container is used to correlate each + item request container with its corresponding response container. The same <b>MessageID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + + + + AddItems + Yes + + + + + + + + + + + + This container has all of the resulting information from an <b>AddItems</b> call. There will be one container per container specified in the request. + + Type defining the <b>AddItemResponseContainer</b> containers that are returned in an <b>AddItems</b> call. An <b>AddItemResponseContainer</b> container is returned for each item created through an <b>AddItems</b> call. Each item being created through an <b>AddItems</b> call is identified through a unique <b>AddItemRequestContainer.MessageID</b> value that is defined by the seller. To match up the <b>AddItemResponseContainer</b> to the <b>AddItemRequestContainer</b>, look for a <b>AddItemResponseContainer.CorrelationID</b> value that matches the <b>AddItemRequestContainer.MessageID</b> value in the request. + + + + + + + Unique item ID for the new listing. + Also applicable to Half.com. + <br><br> + <span class="tablenote"><b>Note:</b> Although we + represent item IDs as strings in the schema, we recommend you store them + as 64-bit signed integers. If you choose to store item IDs as strings, + allocate at least 19 characters (assuming decimal digits are used) to hold + them. eBay will increase the size of IDs over time. Your code should be + prepared to handle IDs of up to 19 digits. For more information about item + IDs, see <a + href="https://ebaydts.com/eBayKBDetails?KBid=468">Common + FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge + Base.</span> + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddItem + AddItems + Always + + + + + + + + Starting date and time for the new listing. + Also returned for Half.com (for Half.com, the start time is always the time the item was listed). + + + + AddItem + AddItems + Always + + + + + + + + Date and time when the new listing ends. This is the starting time + plus the listing duration. + Also returned for Half.com, but for Half.com the actual end time is GTC + (not the end time returned in the response). + + + + AddItem + AddItems + Always + + + + + + + + Child elements contain the estimated listing fees for the new item listing. + The fees do not include the Final Value Fee (FVF), which cannot be determined + until an item is sold. + Also returned for Half.com, but the values are not applicable to Half.com listings. + + + + AddItem + AddItems + Always + + + Final Value Fees and Credits + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + Fees per Site + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + Using Feature Packs to Save on Upgrade Fees + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Desc-FeaturePacks.html + + + + + + + + ID of the primary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. + If the primary category has not changed or it has expired with no replacement, + CategoryID does not return a value. + Not applicable to Half.com. + + + 10 + + AddItem + AddItems + Conditionally + + + + + + + + ID of the secondary category in which the item was listed. + Only returned if you set Item.CategoryMappingAllowed to true in the request + and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. + If the secondary category has not changed or it has expired with no replacement, + Category2ID does not return a value. + Not applicable to Half.com. + + + 10 + + AddItem + AddItems + Conditionally + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. With + <b>AddItems</b>, a unique <b>MessageID</b> value is required for + each <b>AddItemRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>AddItemResponseContainer</b> container is used to correlate each + item request container with its corresponding response container. The same <b>MessageID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + + + + AddItems + Always + + + + + + + + A list of application-level errors or warnings (if any) that were raised + when eBay processed the request. <br> + <br> + Application-level errors occur due to + problems with business-level data on the client side or on the eBay + server side. For example, an error would occur if the request contains + an invalid combination of fields, or it is missing a required field, + or the value of the field is not recognized. An error could also occur + if eBay encountered a problem in our internal business logic while + processing the request.<br> + <br> + Only returned if there were warnings or errors. + + + + + Conditionally + + + + + + + + Supplemental information from eBay, if applicable. May elaborate on errors or + provide useful hints for the seller. This data can accompany the call's normal + data result set or a result set that contains only errors. The string can + return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML- + based application should be able to include the HTML as-is in the HTML page + that displays the results. A non-HTML application would need to parse the HTML + and convert the table elements and image references into UI elements + particular to the programming language used. Because this data is returned as + a string, the HTML markup elements are escaped with character entity + references (e.g.,&lt;table&gt;&lt;tr&gt;...). + + + + AddItems + Conditionally + + + + + + + + The nature of the discount, if a discount applied. + + + + AddItem + AddItems + Conditionally + + + + + + + + Container consisting of one or more <b>Recommendation</b> containers. Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. + <br><br> + This container is only returned if the <b>IncludeRecommendations</b> + flag was included and set to 'true' in the <b>AddItems</b> request, and if + at least one listing recommendation exists for the newly created listing. If + one or more listing recommendations are returned for one or more of the newly + created listings, it will be at the seller's discretion about whether to revise the + item(s) based on eBay's listing recommendation(s). + + + + AddItems + Conditionally + + + + + + + + + + + + + Holds the content of the request. + + + + + + + A <b>CorrelationID</b> value is required for + each <b>AddMemberMessagesAAQToBidderRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>AddMemberMessagesAAQToBidderResponseContainer</b> container is used to correlate each + member message container in the request with its corresponding member message container in the + response. The same <b>CorrelationID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + + + + AddMemberMessagesAAQToBidder + Yes + + + + + + + + An eBay ID that uniquely identifies a given + item. Must be a currently active item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddMemberMessagesAAQToBidder + Yes + + + + + + + + Holds the content of the message. + + + + AddMemberMessagesAAQToBidder + Yes + + + + + + + + + + + Contains the response information. + + + + + + + A <b>CorrelationID</b> value is required for + each <b>AddMemberMessagesAAQToBidderRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>AddMemberMessagesAAQToBidderResponseContainer</b> container is used to correlate each + member message container in the request with its corresponding member message container in the + response. The same <b>CorrelationID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + + + + AddMemberMessagesAAQToBidder + Always + + + + + + + + Indicates the response status (e.g., success). + + + + AddMemberMessagesAAQToBidder + Always + + + + + + + + + + + Contains the data for one additional account. An additional account is + created when the user has an active account and changes country of + registry (i.e., registers with the eBay site for the new country). A + new account is created and the old account becomes inactive as an + additional account. A user who never changes country of residency while + having an account will never have any additional accounts. + + + + + + + Indicates the current balance of the additional account. + + + + GetAccount + Conditionally + + + + + + + + Indicates the currency in which monetary amounts for the additional account + are expressed. + + + + GetAccount + Conditionally + + + + + + + + Indicates the unique identifier for the additional account (the account ID). + + + + GetAccount + Conditionally + + + + + + + + + + + + + Type defining the <b>AdditionalCompatibilityEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'AdditionalCompatibilityEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Boats Parts Compatibility feature. + <br/><br/> + To verify if a specific eBay site supports Boats Parts Compatibility (for most + categories), look for a 'true' value in the + <b>SiteDefaults.AdditionalCompatibilityEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Boats Parts + Compatibility, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>AdditionalCompatibilityEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + + This enumerated type contains the possible values that can be returned in the <b>type</b> attribute of the <b>AddressAttribute</b> field. Currently, this type only contains one enumeration value, but in the future, other address attributes may be created for this type. + + + + + + + This value indicates that the value returned in the <b>AddressAttribute</b> field is the reference ID for a "Click and Collect" order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type is used to display the value of the <b>type</b> attribute of the <b>AddressAttribute</b> field. + + + + + + + + The only supported value for this attribute is 'ReferenceNumber', but in the future, other address attributes may be supported. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type used by <b>AddressType</b> to indicate whether a shipping address is on file with eBay or on file with PayPal. + + + + + + + This value indicates that the shipping address being referenced is on file with PayPal. + + + + + + + This value indicates that the shipping address being referenced is on file with eBay. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This enumerated type is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + + + + AddressRegistrationTypeCodeType. + For GetUserAddresss paypal migration + + + + + + + + + + + + + + + (out) For GetUserAddress paypal migration. + + + + + + + + + + This enumerated type is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains the data for an eBay user's address. This is the base type for a + number of user addresses, including seller payment address, buyer + shipping address and buyer and seller registration address. + + + + + + + User's name for the address. + Also applicable to Half.com (for GetOrders). + + + + This varies based on the user's country. Currently, the maximum length is 64 for + the US. Note: The eBay database allocates up to 128 characters for this field. + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetUserContactDetails + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellingManagerSoldListings + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A concatenation of Street1 and Street2, primarily for RegistrationAddress. + Not applicable to Half.com. + + + + GetBidderList + Conditionally + ShippingAddress + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingAddress + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + + + + + + Line 1 of the user's street address. + Also applicable to Half.com (for GetOrders). + + + + This varies based on the user's country. Currently, the maximum length is 180 for + the US. Note: The eBay database allocates up to 512 characters for this field. + + + GetBidderList + Conditionally + ShippingAddress + + + ReviseSellingManagerSaleRecord + No + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingAddress + ShipToAddress + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + SellerContactDetails +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Line 2 of the user's address (such as an apartment number). + Returned if the user specified a second street value for their address. + Also applicable to Half.com (for GetOrders).<br> + In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). + + + + This varies based on the user's country. Currently, the maximum length is 180 for + the US. Note: The eBay database allocates up to 512 characters for this field. + + + GetBidderList + Conditionally + ShippingAddress + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingAddress + ShipToAddress + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + + + + + + The name of the user's city. + Also applicable to Half.com (for GetOrders). + + + + This varies based on the user's country. Currently, the maximum length is 64 for + the US. Note: The eBay database allocates up to 128 characters for this field. + + + GetSellingManagerSaleRecord + Always + ShippingAddress + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + ReviseSellingManagerSaleRecord + No + + + GetBidderList + Conditionally + ShippingAddress + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingAddress + ShipToAddress + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetUserContactDetails + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + County information for the user. + This field applies to Classified Ad format listings and to the UK only. + Not applicable to Half.com. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + + The region of the user's address. + Also applicable to Half.com (for GetOrders). + + + + This varies based on the user's country. Currently, the maximum length is 64 for + the US. Note: The eBay database allocates up to 128 characters for this field. + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + ReviseSellingManagerSaleRecord + No + + + GetBidderList + Conditionally + ShippingAddress + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingAddress + ShipToAddress + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetUserContactDetails + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The two-digit code representing the country of the user.<br> + <br> + If not provided as input, eBay uses the country associated + with the eBay Site ID when the call is made.<br> + <br> + For a Global Shipping Program order, <b>GetSellerList</b> returns the country code of the buyer, not the international shipping provider.<br> + <br> + Also applicable to Half.com (for GetOrders). + + + + GetAllBidders + GetHighBidders + GetUserContactDetails + Always + + + GetBidderList + GetUserPreferences + Conditionally + + + GetItem + GetSellingManagerTemplates + RegistrationAddress + ShippingAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ ShippingAddress + ShipToAddress + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList + Conditionally + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ + + ReviseSellingManagerSaleRecord + No + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + SetUserPreferences + No + + + + + + + + The name of the user's country. + Also applicable to Half.com (for GetOrders). + + + + eBay validates the content, but not the length for this field. Note: The eBay + database allocates up to 128 characters for this field. + + + GetBidderList + Conditionally + ShippingAddress + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ ShippingAddress + ShipToAddress + Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll, ReturnSummary, none
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + User's primary phone number. This may return a value of + "Invalid Request" if you are not authorized to see the + user's phone number. + <br/><br/> + In the US, the area code (3 digits), the prefix (3 digits), the line number (4 + digits), and phone extension (if specified by the user) are returned in this field. + The extension can be one or more digits. Non-breaking spaces are used as delimiters + between these phone number components. + <br/><br/> + Also applicable to Half.com (for GetOrders). + + + + eBay validates the content (should only be integer values and delimiters), but not + the length for this field. Note: The eBay database allocates up to 128 characters + for this field. + + + GetItem + GetSellingManagerTemplates + RegistrationAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ ShippingAddress + ShipToAddress + Conditionally + + + GetBidderList + ShippingAddress + Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetUserContactDetails + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Standard ISO code for the country of the user's primary telephone phone number. + For Classified Ad format listings, this code is used to look up the country's + international calling prefix. Both the ISO code and country phone prefix are + stored with listings of this type. + This field applies to Classified Ad format listings only. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + Country Prefix of the secondary phone number. This value is derived from + inputs supplied for PhoneCountryCode. + This field applies to Classified Ad format listings only. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + Area or City Code of a user's primary phone number. + This field applies to Classified Ad format listings only. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + The local number portion of the user's primary phone number. + This field applies to Classified Ad format listings only. + <br> + <b>Note:</b> The full primary phone number is constructed by + combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. + + + 30 + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + + Standard ISO code for the country of a user's secondary telephone phone + number. For Classified Ad format listings, this code is used to look up the + country's international calling prefix. Both the ISO code and country phone + prefix are stored with listings of this type. + This field applies to Classified Ad format listings only. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + Country prefix of a user's secondary phone number. This value is derived from + inputs supplied for Phone2CountryCode. + This field applies to Classified Ad format listings only. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + Area or City Code of a user's secondary phone number. + This field applies to Classified Ad format listings only. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + The local number portion of the user's secondary phone number. + This field applies to Classified Ad format listings only. + <br> + <b>Note:</b> The full secondary phone number is constructed by + combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. + + + 30 + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + + + + + + User's postal code.<br> + <br> + For a Global Shipping Program order, <b>GetSellerList</b> and <b>GetMyeBaySelling</b> return the postal code of the buyer, not that of the international shipping provider.<br> + <br> + Also applicable to Half.com (for GetOrders). + + + + This varies based on the user's country. Currently, the maximum length is 9 (not + counting delimiter characters) for the US. Note: The eBay database allocates up to + 24 characters for this field. + + + GetBidderList + Conditionally + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + RegistrationAddress + ShippingAddress +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + ShippingAddress + ShipToAddress +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetAllBidders + GetHighBidders + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Unique ID for a user's address in the eBay database. + This value can help prevent the need to + store an address multiple times across multiple orders. + The ID changes if a user changes their address. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The realm to which the address belongs (e.g. eBay vs PayPal). + For GetOrders, applies only to Half.com. + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + ShipToAddress + + + + + + + + PayPal address status. + Not applicable to Half.com. + + + + + + + ID assigned to the address by the address owner, e.g. by the PayPal system. + Currently, the ExternalAddressID only applies for a customer address in the PayPal system. + The ID changes if a user changes their address. + Also see the AddressOwner field. + The ExternalAddressID value also is applicable to Half.com (for GetOrders). + + + 20 + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Seller's international name that is associated with the payment address. + Only applicable to SellerPaymentAddress. + Not applicable to Half.com. + + + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetBidderList + Conditionally + ShippingAddress + + + + + + + + International state and city for the seller's payment address. + Only applicable to SellerPaymentAddress. + Not applicable to Half.com. + + + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetBidderList + Conditionally + ShippingAddress + + + + + + + + Seller's international street address that is associated with the payment address. + Only applicable to SellerPaymentAddress. + Not applicable to Half.com. + + + + GetUser + Conditionally + SellerPaymentAddress +
DetailLevel: ReturnAll
+ + + GetBidderList + Conditionally + ShippingAddress + + + + + + + + User's company name. Only returned if available. + Not applicable to Half.com. + + + + GetUserContactDetails + Always + + + GetBidderList + Conditionally + ShippingAddress + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SellerContactDetails + Conditionally + + + GetUser + Conditionally + RegistrationAddress +
DetailLevel: ReturnAll
+ + + + + + + + Indicates the nature of the address (e.g., residential or business). + Not applicable to Half.com. + + + + + + + Displays the first name of the seller (in a business card + format) if the seller's SellerBusinessCodeType is set to + 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetAdFormatLeads + Conditionally +
DetailLevel: ReturnAll
+ + + + + + + + Displays the last name of the seller (in a business card + format) if the seller's SellerBusinessCodeType is set to + 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetAdFormatLeads + Conditionally +
DetailLevel: ReturnAll
+ + + + + + + + Secondary Phone number of the lead. Not returned if information is unavailable. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. + <br/><br/> + Example: "Reference #1234567890123456" + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions + GetOrders + SellerShipmentToLogisticsProvider.ShipToAddress +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + SellerShipmentToLogisticsProvider.ShipToAddress + Conditionally + + + + + + + + This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + + This enumeration type defines the address type values that are returned under the <b>AddressType</b> container. + + + + + + + This is default shipping address which is rendered to buyer on checkout. + + + + + + + This is an address which is in user's address book. + It can be used at the time of checkout. + + + + + + + This is not a valid address. Please use another address. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for fields related to affiliate tracking. For additional information, + see the annotations to the elements in this type. + + + + + + + The value you specify is obtained from your tracking partner. + For eBay Partner Network, the <b>TrackingID</b> is the Campaign ID ("campid") + provided by eBay Partner Network. A Campaign ID is a 10-digit, unique + number for associating traffic. A Campaign ID is valid across all + programs to which you have been accepted. + + + + PlaceOffer + Conditionally + + + + + + + + Specifies your tracking partner for affiliate commissions. + Required if you specify a <b>TrackingID</b>. + Depending on your tracking partner, specify one of the + following values. Not all partners are valid for all sites. + For <b>PlaceOffer</b>, only eBay Partner Network and Mediaplex are valid: + <br> + <br>2 = Be Free + <br>3 = Affilinet + <br>4 = TradeDoubler + <br>5 = Mediaplex + <br>6 = DoubleClick + <br>7 = Allyes + <br>8 = BJMT + <br>9 = eBay Partner Network + <br> + <br> + For information about the eBay Partner Network, see + <a href="https://www.ebaypartnernetwork.com" target="_blank">eBay Partner Network</a>. + + + + Affiliate Tracking Concepts + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-AffiliateTrackingConcepts.html + + + PlaceOffer + Conditionally + + + + + + + + Type of device from which the call originated. For <b>PlaceOffer</b>, if you are using + affiliate tracking, this field is required as part of the set of tags you + use in the <b>AffiliateTrackingDetails</b> container. + + + + PlaceOffer + Conditionally + + + + + + + + Need not be specified. You can define an <b>AffiliateUserID</b> + (up to 256 characters) if you want to leverage it to better monitor + your marketing efforts. + If you are using the eBay Partner Network, + and you provide an <b>AffiliateUserID</b>, the tracking URL returned + by eBay Partner Network will contain the <b>AffiliateUserID</b>, but it + will be referred to as a "customid". + + + + PlaceOffer + Conditionally + + + + + + + + + + + + An eBay-defined complex type for specifying monetary amounts. + <br><br> + A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An <b>AmountType</b> expresses both the value (a double) and the currency. + <br><br> + The <b>AmountType</b> data type is typically used to specify details such as prices, fees, costs, and payments. In some cases, a whole number (i.e., without a period) can be passed or returned as a monetary value. This is necessary to support certain currencies that are only expressed as whole numbers. + <br><br> + Because a double is used to represent the amount, this also means whole monetary amounts may be returned with only one 0 after the decimal. For example, a dollar value could be returned as 1.0 instead of 1.00 in calls like <b>AddItem</b>. + + + + + + + + Three-digit code representing the currency type being used. <br> + <br> + In Add/Revise/Relist calls, the currency can be specified in + the <b>Item.Currency</b> field in requests instead. + If you do specify this attribute in Add/Revise/Relist calls, + the value must match the site currency (i.e., it must be the same + as the value in <b>Item.Currency</b>) unless otherwise stated.<br> + <br> + In Add/Revise/Relist calls, listing fees are returned in the + currency of the user's registration site. + For example, a user who is registered on the eBay US site always + sees their fees returned in USD, even when their listing request + is sent to another site, such as eBay UK or eBay Germany. + + + + DeleteSellingManagerItemAutomationRule + DeleteSellingManagerTemplateAutomationRule + GetBidderList + GetSellingManagerTemplateAutomationRule + GetSellingManagerTemplates + GetSellingManagerItemAutomationRule + GetItemRecommendations + GetItemShipping + GetMyeBaySelling + SetSellingManagerItemAutomationRule + SetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + Order.Total + Yes + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + RespondToBestOffer + ReviseCheckoutStatus + ReviseSellingManagerSaleRecord + No + + + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected + Always + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + GetOrders + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected + Always + + + GetOrders + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected + Conditionally + + + GetSellerTransactions + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected +
DetailLevel: none
+ Conditionally + + + GetOrderTransactions + InternationalShippingServiceOption + ShippingServiceOptions + ShippingServiceSelected +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + PlaceOffer + ConvertedCurrentPrice + CurrentPrice + Always + + + PlaceOffer + MinimumToBid + Conditionally + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + No + Always + + + AddLiveAuctionItem + ReviseLiveAuctionItem + No + Always + + + GetAllBidders + GetStoreOptions + Yes + Always + + + RelistItem + No + + + AddTransactionConfirmationItem + Yes + + + SendInvoice + ShippingInsuranceCost, ShippingServiceCost, + ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee + + No + + + GetSellingManagerSaleRecord + AddItemFromSellingManagerTemplate + Always + + + + + + + + + + + + Part of the mechanism for eBay to control which announcement messages are + to be made available to the user. + + + + + + + No message is to be made available. + + + + + + + A deprecation message is to be made available, + but only if today's date is between <b>AnnouncementMessageType.AnnouncementStartTime</b> + and <b>AnnouncementMessageType.EventTime</b>. + + + + + + + A mapping message is to be made available, + but only if today's date is after <b>AnnouncementMessageType.EventTime</b>. + + + + + + + Both "Deprecation" and "Mapping" enumerations are to apply. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>ShippingServiceDetails.DeprecationDetails</b> container that is returned in the <b>GeteBayDetails</b> response. The <b>ShippingServiceDetails.DeprecationDetails</b> container consists of information related to a deprecated shipping service. + + + + + + + The date on which an upcoming event can start to be announced. + + + + GeteBayDetails + Conditionally + + + + + + + + The date on which the event occurs. This is also the ending date of the + announcement that lead up to the event (see <b>AnnouncementStartTime</b>). + + + + GeteBayDetails + Conditionally + + + + + + + + Control of what messages to display. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Contains the definition of a rule that governs the number of times your + application can access the eBay API (invoke a call) on an hourly, daily, or + periodic basis. + + + + + + + The name of the call that has an access rule. Can be a call name (e.g., + AddItem), ApplicationAggregate (returns totals for all calls), + PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter. + + + + GetApiAccessRules + Always + + + + + + + + Whether use of this call counts toward the application's + aggregate limit for all calls. + + + + GetApiAccessRules + Always + + + + + + + + The number of calls per day that your application can make to this call before + being refused. + The day starts at midnight, 00:00:00 PST (not GMT). + + + + GetApiAccessRules + Always + + + + + + + + The number of calls per day that your application can make to this call + before you receive a warning. + The day starts at midnight, 00:00:00 PST. + + + + GetApiAccessRules + Always + + + + + + + + The number of times your application has used this + call today. + + + + GetApiAccessRules + Always + + + + + + + + The number of calls that your application can make per hour to this call + before being refused. Each count begins on the hour (e.g. 1:00:00). + + + + GetApiAccessRules + Always + + + + + + + + The number of calls that your application can make to this call per hour + before you receive a warning. Each count begins on the hour (e.g. 1:00:00). + + + + GetApiAccessRules + Always + + + + + + + + The number of times your application has executed this call during this hour. + + + + GetApiAccessRules + Always + + + + + + + + The length of time before your application's periodic usage counter restarts + for this call. If the number of calls you make exceeds the periodic hard limit + before the current period ends, further calls will be refused until the next + period starts. Possible values: -1 (Periodic limit not enforced, could be any + negative integer), 0 (Calendar month), 30 (Number of days, could be any + positive integer). If the period is based on the calendar month, the usage + counters restart on the same day of every month, regardless of the number of + days in the month. + + + + GetApiAccessRules + Always + + + + + + + + Number of calls per period that your application may make before a call is + refused, if the periodic limit is enforced. The length of the period is + specified in Period. + + + + GetApiAccessRules + Always + + + + + + + + Number of calls per period that your application may make before you receive a + warning, if the periodic limit is enforced. The length of the period is + specified in Period. + + + + GetApiAccessRules + Always + + + + + + + + Number of calls that your application has already made this period. Returns 0 + if the periodic access rule has not been configured for the application. The + length of the period is specified in Period. The start date of the period is + specified in PeriodicStartDate. + + + + GetApiAccessRules + Always + + + + + + + + The time (in GMT) when this access rule's period started. The period starts at + midnight Pacific time. For example, if the period begins on June 29 in 2005 + when California is on Pacific Daylight Time, the GMT value returned would be + 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when + California is on Pacific Standard Time, the GMT value returned would be + 2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has + configured the start date for the access rule. The start date can vary per + application and per call name (i.e., per access rule). + + + + GetApiAccessRules + Conditionally + + + + + + + + The date and time this access rule was last modified by eBay. + + + + GetApiAccessRules + Always + + + + + + + + Your application's current status for this rule, including whether the rule is + set for your application and whether the application has exceeded its daily or + hourly limit. + + + + GetApiAccessRules + Always + + + + + + + + The status of the access rule, including whether the rule is turned on or off + and whether the application is currently blocked from using this call. No + effect if RuleCurrentStatus is set to NotSet. + + + + GetApiAccessRules + Always + + + + + + + + + + + + Specifies preferences about how notifications are delivered to an application. + + + + + + + The URL to which eBay delivers all notifications sent to the application. For + delivery to a server, the URL begins with http:// or https:// and must be well + formed. Use a URL that is functional at the time of the call. For delivery to + an email address, the URL begins with mailto:// and specifies a valid email + address. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + Enables or disables notifications and alerts. If you disable notifications, the + application will not receive them, but its notification preferences are + preserved. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + The email address to which eBay sends all application markup and markdown event + notifications. When setting the email address, input must be in the format + mailto://youremailaddress@yoursite.com. Enable these alerts using the + AlertEnable field. + + + Length of valid email IDs + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + <b>For SetNotificationPreferences</b>: include and set <b>AlertEnable</b> to + 'Enable' to receive application markup and markdown alerts, or set to 'Disable' to + disable the alerts. If not included, the <b>AlertEnable</b> defaults to + its current value. + <br/><br/> + <b>For GetNotificationPreferences</b>: this field's value indicates + whether application markup and markdown alerts are enabled or disabled. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + If this field is specified, the value must be eBLSchemaSOAP. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + The means of receipt of notification. In most cases, it is Platform (typical API + calls and web interaction), so this is the default, if not specified. For + wireless applications, use SMS. Do not test Client Alerts in production if you + are currently using Platform Notifications. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + Use this field to specify the API version for all notifications for the calling + application. If you do not specify PayloadVersion in + SetNotificationPreferences, the API version for notifications will be based on + the API version specified in your SetNotificationPreferences call. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + Defines settings for notification URLs (including the URL name in DeliveryURLName). You + define settings for up to 25 notification URLs (including the URL name in + DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with + notification URLs by using the token in a SetNotificationPreferences request that + specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use + comma-separated format to specify multiple URL names in + SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these + URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + Device used. + + + + + + + Browser device. + + + + + + + Wireless device. + + + + + + + Desktop device. + + + + + + + SetTopTVBox device. + + + + + + + Reserved for future use. + + + + + + + + + + This type defines the <b>AttributeArray</b> container, which is used by the + seller to specify one or more attribute values for a Half.com item. + + + + + + + This container is used by the seller to specify one or more attribute values for a + Half.com item. This container can be used in <b>ReviseItem</b> to add, + remove, or modify an attribute or its value. + <br><br> + This field is not applicable for eBay listings. + + + + AddItem + AddItems + VerifyAddItem + Yes + + + ReviseItem + + No + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + + + + + + + + + This simple type has been deprecated, as "old" eBay attributes are no longer supported. + + + + + + + Please note that we no longer recommend passing both ID-based + attributes and custom Item specifics in the same request.<br> + <br> + eBay has not converted the category from ID-based attributes to + only support custom Item Specifics. AddItem and related calls + may support passing both formats in the same request (if the + category supports both formats.) + + + + + + + eBay has converted the category from ID-based attributes to + only support custom Item Specifics. With this setting:<br> + <br> + You can pass one format or the other in the same AddItem request, + but you can't pass both formats together. If you pass in ID-based + attributes in the AddItem family of calls, eBay will convert them to + custom Item Specifics on your behalf. + + + + + + + eBay has converted the category from ID-based attributes to + only support custom Item Specifics. ID-based attributes are + no longer supported. AddItem and related calls + will fail if you pass ID-based attributes in the request. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type has been deprecated, as "old" eBay attributes are no longer supported. + + + + + + + + + + + This type was deprecated with Version 805 along with the <b>GetItemRecommendations</b> call. + + + + + + + A list of attribute sets containing recommended attributes and values. + Returned from GetItemRecommendations when the Suggested Attributes engine is used + See the eBay Web Services guide for additional details. + + + + + + + + + + + + + + + + This type is deprecated as "old" eBay attributes are no longer supported. + + + + + + + Contains a list of attributes that describe category-specific aspects or + features of an item in a standardized way.<br><br> For the + AddItem family of calls and GetItem, an AttributeSetArray can contain a + maximum of 2 full attribute sets (one for each category in which the item is + listed) if the primary and secondary categories are mapped to different + characteristic sets. If they are mapped to the same characteristic set, the + AttributeSetArray can contain one full attribute set.<br> + <br> + An AttributeSetArray can also contain any number of additional site-wide + attribute sets. In item-listing requests, AttributeSet is required if the + category is mapped to a characteristic set with required attributes. On the US + site, attributes are usually required for Tickets, eBay Motors vehicles, and + Real Estate listings. See GetCategory2CS and GetAttributesCS. See the + Developer's Guide for information about attribute meta-data and validation + rules that are applicable when listing items.<br> + <br> + In GetItem, the Half.com item condition may be returned once in an + AttributeSet node with Half.com IDs and values, and once in a separate + AttributeSet node with a site-wide eBay item condition. The Half.com IDs are + not necessarily returned in GetAttributesCS, so you can use the eBay.com data + instead. Half.com listings may also return an AttributeSet node with other + eBay attributes. + + + + + + + + + + + + + This type is deprecated as "old" eBay attributes are no longer supported. + + + 773 + NoOp + 889 + Item.ItemSpecifics + + + + + + + A salient aspect or feature of an item in a given category. + Attributes are known as "Item Specifics" in the eBay Web site. + Use attributes to describe an item in a standard way so that buyers can find it more easily. + For example, "Publication Year" is a standard attribute for books. + In item-listing requests, multiple attributes can be specified. + Some categories (e.g., Tickets) always require certain attributes to be specified. + Therefore, in item-listing requests you need to at least specify "editable" attributes + (EditType 0 and EditType 2 attributes) if they are identified as required + in the attribute meta-data. See the eBay Web Services guide for information + about attribute meta-data, how to determine the valid attributes for a category, + and how to determine whether attributes are required. + <br><br> + If you are revising or relisting an item, you don't need to pass in attributes + that were already specified in the original listing. + To remove an optional attribute, set all its value IDs to "-100". If the item has bids + (or items have been sold) but there are more than 12 hours remaining until the listing ends, + you can add Attribute nodes but you cannot remove or modify data in previously + specified Attribute nodes. If the item has bids and the listing ends within 12 hours, + you cannot add or remove Attribute nodes or modify the contents of previously + specified Attribute nodes. + <br><br> + Not applicable to Half.com. + + + + + + + + + + + + Constant value that identifies the attribute set in a language-independent way. + Unique across all eBay sites. Corresponds to a characteristics set ID. + Call GetCategory2CS to determine valid characteristics set IDs. + Not applicable to Half.com. + + + + + + + + + + Version of the attribute set being specified (in requests) or that is + currently on the site. This value changes each time changes are made to the + category-to-characteristic set mappings or characteristic set data. + The current version value is not necessarily greater than the previous + value. Therefore, when comparing versions, only compare whether the + value has changed.<br><br> + In listing requests, if you do not specify this value, eBay assumes you are + using the current attribute set version. If you specify the version number of + the attribute meta-data that you have stored locally, eBay will compare it to + the current version on the site and return a warning if the versions do not match. + If an error occurs due to invalid attribute data, this warning can be useful to help you + determine if you might be sending outdated data. + Not applicable to Half.com. + + + + + + + + + + + + A salient aspect or feature of a Half.com item that is specified by the seller so that a buyers can find the item more easily. + + + + + + + A value the seller selected or entered for the Half.com item attribute. + At least one value is required for each attribute that you specify. + Some attributes can have multiple values. + <br><br> + If using an Add/Revise/Relist call to add/revise/relist a Half.com item, this field is required. + + + + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + GetItemRecommendations + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + Conditionally + + + RelistItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyRelistItem + No + + + GetItemRecommendations + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + + + + + + + + Constant value that identifies the Half.com item attribute in a language-independent way. + Unique within the attribute set. + + + + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + GetItemRecommendations + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + AttributeSetArray + Conditionally + + + RelistItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyRelistItem + AttributeSetArray + No + + + GetItemRecommendations + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Name of the Half.com item attribute being specified. + For GetOrders, this is always returned for Half.com + orders. (It is not applicable to orders on the eBay.com site.) + For Half.com, this field is required when you use + an Add/Revise/Relist call. + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + AttributeArray + Conditionally + + + ReviseItem + ReviseSellingManagerTemplate + AttributeArray + No + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + + + + + + + + Indicates the source of the item's eligibility for the Buyer + Protection Program. + + + RESTToken + + + + + + + Buyer protection is covered by the PayPal Protection Program. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Enumerated type that defines the possible settings for the automated feedback mechanism embedded in the <b>SetSellingManagerFeedbackOptions</b> API call. This type is only applicable to Selling Manager Pro users. + + + + + + + If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will automatically leave feedback for the buyer once that buyer leaves positive feedback for the seller. + + + + + + + If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will automatically leave feedback for the buyer once that buyer pays for the line item. + + + + + + + If the <b>AutomatedLeaveFeedbackEvent</b> field is set to this value, the automated feedback mechanism will essentially be turned off. Automated feedback will not occur. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for average detailed seller ratings. If a seller has detailed ratings, + they are displayed in the Feedback Profile of the seller. + + + + + + + + + + Applicable to sites that support the Detailed Seller Ratings feature. The + AverageRatingDetails container has information about average detailed seller + ratings. When buyers leave an overall Feedback rating (positive, neutral, or + negative) for a seller, they also can leave ratings in four areas: item as + described, communication, shipping time, and charges for shipping and + handling. Users retrieve detailed ratings as averages of the ratings left by + buyers. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + + + + Applicable to sites that support the Detailed Seller Ratings feature. + The <b>AverageRatingDetailsType</b> container consists of the average detailed seller ratings in an area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. + + + + + + + The area of a specific average detailed seller rating. + Users retrieve detailed ratings as averages of the ratings left by buyers. + When buyers leave an overall Feedback rating (positive, neutral, or negative) + for a seller, they also can leave ratings in four areas: + item as described, communication, shipping time, and charges for shipping and handling. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + An average detailed seller rating applying to the area in the corresponding <b>RatingDetail</b> field. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + The number of detailed seller ratings in the area + in the corresponding <b>RatingDetail</b> field. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + + + + + Container for average detailed seller ratings. + If a seller has detailed ratings, they are displayed + in the Feedback Profile of the seller. + + + + + + + The summary period for which the detail ratings are calculated. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + Applicable to sites that support the Detailed Seller Ratings feature. + The AverageRatingDetails container has information about + average detailed seller ratings. + When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + + + + + This enumerated type is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + + + + Used for storing an optional reference ID to the binary attachment + + + + + + + + Stores an optional reference ID to the binary attachment. + + + + UploadSiteHostedPictures + No + + + + + + + + + + + + + + + + + + + + This type is deprecated, as the Basic Upgrade Pack feature on the eBay Australia site is deprecated. + + + + + + + + + + + Enumerated type that defines the possible values that can be passed in to the <b>Action</b> field in a <b>RespondToBestOffer</b> request. + + + + + + + This value should be passed in to the <b>Action</b> field to accept the Best Offer identified in the <b>BestOfferID</b> field. Note that only one Best Offer may be accepted in a single <b>RespondToBestOffer</b> call. + + + + + + + This value should be passed in to the <b>Action</b> field to decline one or more Best Offers identified by one or more <b>BestOfferID</b> fields. Note that multiple Best Offers may be declined in a single <b>RespondToBestOffer</b> call. + + + + + + + This value should be passed in to the <b>Action</b> field to counter a buyer's Best Offer or Counter Offer. Note that a seller may only counter one Best Offer in a single <b>RespondToBestOffer</b> call. If a seller is using the <b>RespondToBestOffer</b> call to counter a Best Offer, the counter offer price must be specified in the <b>CounterOfferPrice</b> field, and the quantity of items in the Best Offer must be specified in the <b>CounterOfferQuantity</b> field. + + + + + + + Reserved for internal or future use. + + + + + + + + + + An array of one or more Best Offers. This type is used in the responses of the <b>GetBestOffers</b> and <b>RespondToBestOffer</b> calls. + + + + + + + For <b>GetBestOffers</b>, each <b>BestOffer</b> container consists of detailed information on the Best Offer/Counter Offer, including the type of Best Offer (Best Offer, Buyer/Seller Counter Offer), amount of the Best Offer/Counter Offer, and status of Best Offer/Counter Offer. + <br/><br/> + For <b>RespondToBestOffer</b>, each <b>BestOffer</b> container provides the status ('Success' or 'Failure') of the Best Offer action (Accept, Counter, or Decline), which are defined in <a href="types/BestOfferActionCodeType.html">BestOfferActionCodeType</a>. + + + + RespondToBestOffer + Always + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + + + + Type defining the <b>BestOfferAutoAcceptEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BestOfferAutoAcceptEnabled' or 'BestOfferAutoDeclineEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Best Offer Auto Accept feature. + <br/><br/> + To verify if a specific eBay site supports the Best Offer Auto Accept feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BestOfferAutoAcceptEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Best Offer Auto Accept feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BestOfferAutoAcceptEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>BestOfferAutoDeclineEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BestOfferAutoDeclineEnabled' or 'BestOfferAutoAcceptEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Best Offer Auto Decline feature. + <br/><br/> + To verify if a specific eBay site supports the Best Offer Auto Decline feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BestOfferAutoDeclineEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Best Offer Auto Decline feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BestOfferAutoDeclineEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>BestOfferCounterEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BestOfferCounterEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Best Offer Counter Offer feature. + <br/><br/> + To verify if a specific eBay site supports the Best Offer Counter Offer feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BestOfferCounterEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Best Offer Counter Offer feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BestOfferCounterEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>BestOfferDetails</b> container, which consists + of Best Offer details associated with an item. The <b>BestOfferEnabled</b> + field in this container is used by Add/Revise/Relist calls to enable the Best Offer + feature on a listing. + + + + + + + The number of Best Offers made for this item, if any. In other words, if there are + no Best Offers made, this container will not appear in the response. + + + + GetBidderList + GetSellerList + Conditionally + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field indicates whether or not the Best Offer feature is enabled for this item. + A seller of a fixed-price item (in a category for which Best Offer is also enabled) can + opt that item into the Best Offer feature. This feature enables a buyer to + make a lower-priced binding offer on that item. + <br/><br/> + As long as a fixed-price listing has no Best Offer transaction completed or pending, or is not scheduled to end within 12 hours, a seller can change this value (enable or disable). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Some large merchant accounts are enabled to revise this field through a Revise call even within 12 hours of the listing's scheduled end time. The exception to this rule is that Best Offers can not be disabled if the listing has any completed or pending Best Offers. + </span> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + SetSellingManagerTemplateAutomationRule + SetSellingManagerItemAutomationRule + VerifyAddItem + VerifyRelistItem + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + DeleteSellingManagerTemplateAutomationRule + DeleteSellingManagerItemAutomationRule + GetBidderList + GetSellingManagerTemplateAutomationRule + GetSellingManagerItemAutomationRule + SetSellingManagerTemplateAutomationRule + SetSellingManagerItemAutomationRule + GetSellingManagerTemplates + Conditionally + + + + + + + + This is the amount of the buyer's current Best Offer. + This field will not appear in the <b>GetMyeBayBuying</b> response if the + buyer has not made a Best Offer. + + + + GetMyeBayBuying + BestOfferList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + This enumeration value indicates the status of the latest + Best Offer from the buyer. This field will not appear in the + <b>GetMyeBayBuying</b> response if the buyer has not made a Best Offer. + + + + GetMyeBayBuying + Conditionally + BestOfferList +
DetailLevel: none, ReturnAll
+ + + + + + + + Note: this field is no longer used. The Best Offer type is only returned in the + BestOfferCodeType field of the GetBestOffers call, and the applicable values for Best Offer + type (BuyerBestOffer, BuyerCounterOffer, SellerCounterOffer, etc.) are defined in + BestOfferTypeCodeType + + + + + + + + + + The value of this boolean field will indicate whether or not the listing is eligible for the Immediate Payment for Best Offers feature. This field's value will be 'true' if a listing is requiring immediate payment, and the item's category supports the Immediate Payment for Best Offers feature. Initially, Immediate Payment for Best Offers will be supported by the Computers & Tablets, Jewelry & Watches, and Art categories, but this feature will get enabled in more categories going forward. + <br/><br/> + If the Immediate Payment for Best Offers feature is enabled for a listing, and a buyer's Best Offer for the item is accepted by the seller, that buyer will be expected to pay immediately for the item, or that buyer will run the risk of losing the item to another buyer since that item will remain on sale until payment is made. + <br/><br/> + This field is always returned for fixed-price, Classified Ad, and Motors Local Market listings. It is not applicable to auction listings. + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>BestOfferEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BestOfferEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Best Offer feature. + <br/><br/> + To verify if a specific eBay site supports the Best Offer feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BestOfferEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Best Offer feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BestOfferEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + Unique identifier for a Best Offer. This identifier is created once a prospective buyer makes a Best Offer on an item. + + + + + + + + + Enumerated type that defines the possible values for the status of a Best Offer or a buyer's/seller's counter offer. + + + + + + + This value indicates that the buyer's Best Offer on an item is awaiting the + seller's response (accept, decline, counter offer). A buyer's Best Offer expires + after 48 hours without a seller's response. + + + + + + + Depending on context, this value can indicate that the buyer's Best offer was + accepted by the seller, or that the seller's counter offer was accepted by the + buyer. + + + + + + + Depending on context, this value can indicate that the buyer's Best offer was + declined by the seller, or that the seller's counter offer was declined by the + buyer. + + + + + + + Depending on context, this value can indicate that the buyer's Best Offer expired due + to the passing of 48 hours with no seller response (accept, decline, counter + offer), or that the seller's counter offer expired due to the passing of 48 hours + with no buyer response (accept, decline, another Best Offer). + + + + + + + Depending on context, this value can indicate that the buyer has retracted the Best + Offer, or that the seller has retracted the counter offer. + + + + + + + This value indicates that the Best Offer was ended by an eBay administrator. + + + + + + + Depending on context, this value can indicate that a buyer's Best Offer or + a seller's counter offer is in the active state. The 'Active' value can also be + used in the GetBestOffers request to retrieve only the Best Offers in the + active state. + + + + + + + This value indicates that a buyer's Best Offer has triggered a counter offer from + the seller. + + + + + + + This value is used in the GetBestOffers request to retrieve all Best Offers in + all states. + + + + + + + This value indicates that the buyer has accepted the seller's counter offer, but + the seller is still awaiting on payment from the buyer. If the buyer does not pay + within 48 hours, the counter offer will expire. + + + + + + + This value indicates that the seller is waiting on the buyer to commit to buying + the item at the counter offer price. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>BestOffer</b> container, which consists of information on one Best Offer or counter offer. This information includes the price of the offer, the expiration of the offer, and any messaging provided by the prospective buyer or seller. + + + + + + + Unique identifier for a Best Offer. This identifier is created once a prospective buyer makes a Best Offer on an item. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + PlaceOffer + Conditionally + + + + + + + + Timestamp indicating when a Best Offer will naturally expire (if the + seller has not accepted or declined the offer). + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Container consisting of information about the prospective buyer who made the Best Offer. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The amount of the Best Offer or counter offer. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The status of the Best Offer or counter offer. For <b>PlaceOffer</b>, the only applicable values are <b>Accepted</b>, <b>AdminEnded</b>, <b>Declined</b>, and <b>Expired</b>. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + Accepted, AdminEnded, Declined, Expired + PlaceOffer + Conditionally + + + + + + + + The quantity of items for which the buyer is making a Best Offer. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + A prospective buyer has the option to include a comment when placing a Best Offer or making a counter offer to the seller's counter offer. This field will display that comment. + + + 500 (in bytes) + + GetBestOffers +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + A seller has the option to include a comment when making a counter offer to the prospective buyer's Best Offer. This field will display that comment. + + + 500 (in bytes) + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates whether the corresponding offer is a Best Offer, a seller's counter offer, or a buyer counter offer to the seller's counter offer. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The value in this field ('Success' or 'Failure') will indicate whether or not the seller's attempt to accept, decline, or counter offer a Best Offer was successful. This field is only used by the <b>RespondToBestOffer</b> response. + + + + RespondToBestOffer + Always + + + + + + + + The value of this boolean field will indicate whether or not the Best Offer is part of eBay's Best Offer Beta program, which allows sellers to require immediate payment from the buyer if both the seller and the buyer agree on a Best Offer. A 'true' value indicates that the Best Offer is part of the Best Offer Beta program, and a 'false' value indicates that the Best Offer is a standard Best Offer. + <br/><br/> + Currently, Immediate Payment for Best Offers will be supported by the Computers & Tablets, Jewelry & Watches, and Art categories, but this feature will get enabled in more categories going forward. + <br/><br/> + If the Immediate Payment for Best Offers feature is enabled for a listing, and a buyer's Best Offer for the item is accepted by the seller, that buyer will be expected to pay immediately for the item, or that buyer will run the risk of losing the item to another buyer since that item will remain on sale until payment is made. + <br/><br/> + For more information about the Best Offer Beta feature, see the <a href="http://pages.ebay.com/newBestOfferBeta/" target="_blank">Best Offer Beta Help Page</a>. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This flag indicates if the seller is able to require immediate payment from the buyer for a Best Offer. This flag will only be returned if the Best Offer is part of eBay's Best Offer Beta program (value of <b>NewBestOffer</b> is 'true'). + <br/><br/> + If the Immediate Payment for Best Offers feature is enabled for a listing, and a buyer's Best Offer for the item is accepted by the seller, that buyer will be expected to pay immediately for the item, or that buyer will run the risk of losing the item to another buyer since that item will remain on sale until payment is made. + <br/><br/> + For more information about the Best Offer Beta feature, see the <a href="http://pages.ebay.com/newBestOfferBeta/" target="_blank">Best Offer Beta Help Page</a>. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type that defines the possible offer types for the Best Offer feature. + + + + + + + This value indicates that the offer is an original Best Offer made by a prospective buyer to the seller. + + + + + + + This value indicates that the offer is a prospective buyer's counter offer against the seller's counter offer. + + + + + + + This value indicates that the offer is a seller's counter offer against the seller's original Best Offer. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Possible bid action types or states. + + + + + + + Unknown. + + + + + + + The item is being offered (or was placed) as an auction listing. + + + + + + + Not used. + + + + + + + The offer was retracted by the user who extended the + offer. (This can only be done on the eBay site, not via API.) + + + + + + + The offer was automatically retracted. (This can only be done on the eBay site, not + via API.) + + + + + + + The offer was cancelled. (This can only be done on the eBay site, not via API.) + + + + + + + The offer was automatically cancelled. (This can only be done on the eBay site, not + via API.) + + + + + + + The offer placed was an absentee bid. (This can only be done on the eBay site, + not via API.) + + + + + + + The offer resulted in the successful exercise of the Buy It Now option for an + auction listing. + + + + + + + The offer is being placed, or was placed, on a fixed-price listing. + This value is used for fixed-price listings to purchase an item. + In PlaceOffer, for auction listings with the Buy It Now option, + specify 'Purchase' to buy the item. + In the case of fixed-price listings requiring immediate payment (AutoPay enabled), + PlaceOffer cannot be used for purchase. But for fixed-price listings with + AutoPay that have the BestOffer option, + PlaceOffer can be used to make an offer (but not to purchase). + + + + + + + Reserved for future use. + + + + + + + If an item is best-offer enabled, use this value if a buyer is making a best offer on + the item. After a buyer makes a best offer (or counter-offer, etc.), the buyer can get + the status of the best offer (and of a possible seller-counter-offer, etc.) using the + GetBestOffers call. + + + + + + + If an item is best-offer enabled, use this value if a buyer is making a counteroffer + to a seller's counteroffer. + + + + + + + If an item is best-offer enabled, use this value if a buyer is accepting a + counteroffer of a seller. + + + + + + + If an item is best-offer enabled, use this value if a buyer is declining a + counteroffer of a seller. + + + + + + + + + + Multiple bidders can be approved with one call. + + + + + + + + + + + This type is deprecated along with Live Auction listings. + + + + + + + + This field is deprecated along with Live Auction listings. + + + + + + + + + + + + This field is deprecated along with Live Auction listings. + + + + + + + + + + + + This field is deprecated along with Live Auction listings. + + + + + + + + + + + + This field is deprecated along with Live Auction listings. + + + + + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + Use this element to specify the bid group id for the Bid Assistant items + that you want information about. + + + + + + + + + + + + Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes + in the response. + + + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + Contains a list of bid groups. + + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + (out) The items in the group currently being bid on. + + + + + + + + + + + (out) Items in the group that were not bid on because a user retracted a bid + and closed his group or because eBay Customer Support ended a group and all + the active and pending items within that group were cancelled. + + + + + + + + + + + (out) Items in the bid group that are currently active, but have not yet been + bid on. + + + + + + + + + + + (out) Items that have been skipped and not bid on (and bidded has ended). + + + + + + + + + + + (out) Item has ended. + + + + + + + + + + + (out) Item was purchased and has ended. + + + + + + + + + + + (out) Item has ended. + + + + + + + + + + + Reserved for future use. + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + Contains a list of the items in a bid group. + + + + + + + + + + + + Contains the status of the items in the bid group. + + + + + + + + + + + + Contains the maximum bid amount for the item in the bid group. + + + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + (out) Indicates that the bid group is open. + + + + + + + + + + + (out) Indicates that the bid group is Closed. + + + + + + + + + + + Reserved for future use. + + + + + + + + + + + + + This type is deprecated as the Bid Assistant feature is no longer available. + + + + + + + + + Contains a list of bid group item types. + + + + + + + + + + + + Contains the bid group ID. + + + + + + + + + + + + Contains the bid group name. + + + + + + + + + + + + Contains the bid group status. + + + + + + + + + + + + + + + A collection of Bidder Detail. + + + + + + + Details about a Live Auctions bidder. + Returned if at least one bidder has requested approval. + + + + GetLiveAuctionBidders + Conditionally + + + + + + + + + + + Contains the data for a user who is interested in bidding on items in a Live Auctions catalog. + + + + + + + ID of the user requesting approval. + + + + GetLiveAuctionBidders + Always + + + + + + + + E-mail address of the bidder. + You cannot retrieve an email address for any user with whom + you do not have an order relationship, regardless of + site. Email is only returned for applicable calls when you + are retrieving your own user data OR when you and the other + user are in an order relationship and the call is + being executed within a certain amount of time after the + order line item is created. + Returned as CDATA. When an email address can not be returned, + the string "Invalid Request" is returned instead. + + + + GetLiveAuctionBidders + Always + + + + + + + + Aggregate feedback score for the specified user. + Feedback score is only return if the user has not chosen to make his + or her feedback private. + + + + GetLiveAuctionBidders + Conditionally + + + + + + + + Total count of negative Feedback entries received by the user, including weekly repeats. + + + + GetLiveAuctionBidders + Always + + + + + + + + Total count of positive Feedback entries received by the user, including weekly repeats. + + + + GetLiveAuctionBidders + Always + + + + + + + + Total count of neutral Feedback entries received by the user, including weekly repeats. + + + + GetLiveAuctionBidders + Always + + + + + + + + + + + + This type is deprecated because no calls use it. + + + + + + + + + Contains a seller's preferences for receiving bidder notices. + + + + + + + If true, sends the seller a notice containing the contact information for unsuccessful + bidders. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + Seller has approved the bidder. + + + + + + + + + + + Seller has denied the bidder's approval request. + + + + + + + + + + + Seller has not yet approved or denied the + bidder (or the status is still being processed). + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + (in) Retrieve all bidders for ended or open listings. + + + + + + + + + + + (in) Retrieve all high bidders. + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + Type defining the <b>BiddingDetails</b> container, which consists of + information about the buyer's bidding history on a single auction item. + + + + + + + Converted value (from seller's currency to buyer's currency) of the amount in the + <b>MaxBid</b> field. This field is only applicable and returned if the + buyer purchased an item from an eBay site in another country. For active items, + it is recommended to refresh the listing's data every 24 hours to pick up the + current conversion rates. + + + + GetMyeBayBuying + BidList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value is the dollar value of the highest bid that the buyer placed on the + auction item. + + + + GetMyeBayBuying + BidList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value is the total number of bids that the buyer placed on the + auction item throughout the duration of the listing. + + + + GetMyeBayBuying + BidList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field will only be returned if the buyer won the auction item, and if it is + returned, its value will always be '1'. + + + + GetMyeBayBuying + BidList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + (GetMyeBay only) Indicates whether the user is the current + high bidder in a currently active listing. + + + + + + + The Bid Assistant feature is retired, and this field is scheduled to + be removed from BiddingDetailsType. + + + + + + + + + + + + + + + Contains bidding summary information for the bidder of an item. + + + + + + + The number of days included in the summary. Currently, always + set to 30 days. + + + + GetAllBidders + Conditionally + + + + + + + + The total number of bids that the bidder has placed. + + + + GetAllBidders + Conditionally + + + + + + + + Percentage of the bidder's total bids that the bidder + placed on items that the seller is offering. + + + + GetAllBidders + Conditionally + + + + + + + + Number of unique sellers whose items the bidder has placed + bids on. + + + + GetAllBidders + Conditionally + + + + + + + + For items that the bidder has bid on, the number of unique + categories that they belong to. + + + + GetAllBidders + Conditionally + + + + + + + + The total number of bids that the bidder has retracted. + + + + GetAllBidders + Conditionally + + + + + + + + Detail bidding information on the items that the bidder has + bid on. + + + + GetAllBidders + Conditionally + + + + + + + + + + + + Specifies whether a listing feature is available for the site specified in the request. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + Reserved for future use. + + + + + + + + + + Specifies whether a listing feature is available for the site specified in the request. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>BrandMPNIdentifierEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BrandMPNIdentifierEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Brand/Manufacturer Part Number feature. + <br/><br/> + To verify if a specific eBay site supports the Brand/Manufacturer Part Number feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BrandMPNIdentifierEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Brand/Manufacturer Part Number feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BrandMPNIdentifierEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>BrandMPN</b> container which is used to identify a product (through unique product brand and Manufacturer Part Number combination) in the eBay Product Catalog. + + + + + + + The brand of the product. eBay searches against the + names that are publicly available in eBay's catalogs. + This means you can specify the well-known + brand name that an average user would recognize. + Specify this in combination with MPN. + + + 4000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + The manufacturer part number of the product. Use the + value specified by the manufacturer. (eBay removes special + characters and spaces to normalize the values in order to find a + match.) + + + 4000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + Enumerated type that defines the eBay user's account type. + + + + + + + This value indicates that the eBay user's account is a Partially Provisioned Account + without buying and selling privileges on eBay. + + + + + + + This value indicates that the eBay user's account is a fully provisioned account with buying + and selling privileges on eBay. + + + + + + + + + + Displays the seller's information (in a business card format) + as part of the data returned if the seller's <b>SellerBusinessCodeType</b> is set to 'Commercial'. Note that this + option is only available for sites that have Business Seller + options enabled. + + + + + + + Displays the Address of the seller (in a business card + format) as part of the data returned in the GetItem + call if the seller's SellerBusinessCodeType is set + to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the fax number of the seller (in a business + card format) as part of the data returned in the + GetItem call if the seller's SellerBusinessCodeType + is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the email address of the seller (in a business + card format) as part of the data returned in the GetItem + call if the seller's SellerBusinessCodeType is set to + 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the AdditionalContactInformation of the seller + (in a business card format) as part of the data returned + in the GetItem call if the seller's SellerBusinessCodeType + is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the TradeRegistrationNumber of the seller (in a business + card format) as part of the data returned in the GetItem call if + the seller's SellerBusinessCodeType is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the LegalInvoice of the seller (in a business + card format) as part of the data returned in the GetItem + call if the seller's SellerBusinessCodeType is set to + 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the TermsAndConditions of the seller (in a business + card format) as part of the data returned in the GetItem + call if the seller's SellerBusinessCodeType is set to + 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the VATDetails of the seller (in a business + card format) as part of the data returned in the + GetItem call if the seller's SellerBusinessCodeType + is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + + + + + Type defining the <b>BuyerGuaranteeEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'BuyerGuaranteeEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Buyer Guarantee feature. + <br/><br/> + To verify if a specific eBay site supports the Buyer Guarantee feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.BuyerGuaranteeEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Buyer Guarantee feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>BuyerGuaranteeEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>BuyerPackageEnclosure</b> container, which is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package. A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site. + + + + + + + + This attribute indicates the type of payment instructions included in the shipping package. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>BuyerPackageEnclosures</b> container, which is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s). A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site. + + + + + + + + A <b>BuyerPackageEnclosure</b> container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This enumerated type identifies all of the payment methods supported for the 'Pay Upon Invoice' feature. + + + + + + + This enumeration value indicates that no payment method was specified by the seller. + + + + + + + This enumeration value indicates that a credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a bank debit card was used to pay for the order. + + + + + + + This enumeration value indicates that PayPal was used to pay for the order. + + + + + + + This enumeration value indicates that Elektronisches Lastschriftverfahren (direct debit) was used to pay for the order. + + + + + + + This enumeration value indicates that an unknown credit card was used to pay for the order. + + + + + + + This enumeration value indicates that Elektronisches Lastschriftverfahren (direct debit) was used locally to pay for the order. + + + + + + + This enumeration value indicates that a Master Card credit card was used to pay for the order. + + + + + + + This enumeration value indicates that an American Express credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a Visa credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a Discover credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a Diners Club credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a JCB credit card was used to pay for the order. + + + + + + + This enumeration value indicates that a Switch debit card was used to pay for the order. + + + + + + + This enumeration value indicates that a Solo debit card was used to pay for the order. + + + + + + + This enumeration value indicates that Giropay was used to pay for the order. + + + + + + + This enumeration value indicates that BML was used to pay for the order. + + + + + + + This enumeration value indicates that the 'Pay Upon Invoice' option was offered to the buyer on the Germany site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This enumeration type indicates the item's eligibility status for the buyer protection + program listed in the + <strong>ApplyBuyerProtection.BuyerProtectionSource</strong> field. + + + + + + + This value indicates that the item is ineligible for buyer protection. In many + cases, the item is ineligible for buyer protection due to the category it is listed + under. + + + + + + + This value indicates that the item is eligible for buyer protection. + + + + + + + This value indicates that the eBay customer support has marked the item as + ineligible per special criteria (e.g., seller's account closed). + + + + + + + This value indicates that the eBay customer support has marked the item as + eligible per special criteria. + + + + + + + This value indicates that the item is ineligible for coverage under any buyer + protection program. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <strong>ApplyBuyerProtection</strong> container, which + consists of details related to whether or not the item is eligible for buyer protection + and which of the buyer protection programs will cover the item. + + + + + + + This value indicates the type of buyer protection program applicable for the item. + This field is always returned with the <strong>ApplyBuyerProtection</strong> container. + + + + GetItemTransactions + Conditionally + + + GetOrderTransactions + Conditionally + + + GetSellerTransactions + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + + + + + + + + This value indicates the item's eligibility for the buyer protection program listed + in the <strong>ApplyBuyerProtection.BuyerProtectionSource</strong> field. + This field is always returned with the + <strong>ApplyBuyerProtection</strong> container. + + + + GetItemTransactions + Conditionally + + + GetOrderTransactions + Conditionally + + + GetSellerTransactions + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + This enumeration type indicates the applicable buyer protection program that the item is + eligible to be covered under. + + + + + + + This value indicates that the item is possibly eligible for buyer protection under + the eBay Buyer Protection Program. + + + + + + + This value indicates that the item is possibly eligible for buyer protection under + the PayPal Purchase Protection Program. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>BuyerRequirementDetails</b> container, which allows the + seller to set buyer requirements at the listing level. For the corresponding listing, + all buyer requirement values/settings will overwrite values/settings in Buyer Requirements + preferences in My eBay. + + + + + + + The seller includes and sets this field to 'true' as a mechanism to block bidders who + reside (according to their eBay primary shipping address) in countries that are on the ship-to + exclusion list. Sellers add countries or regions to their ship-to exclusion list by adding + those countries or regions using one or more <b>ExcludeShipToLocation</b> fields + in an Add/Revise/Relist call. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This Buyer Requirements feature is only available to sellers on the China site, and is + only applicable to fixed-price or auction Buy It Now items. + <br/><br/> + The seller includes and sets this field to 'true' as a mechanism to block prospective + buyers with a feedback score of 0 from buying items with a price of 100 RMB or higher. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller includes this field as a mechanism to block bidders who have a Feedback + Score less than the specified value. To obtain the list of supported values, call + <b>GeteBayDetails</b>, include + <b>BuyerRequirementDetails</b> as a <b>DetailName</b> + value in the request, and then look for the list of Minimum Feedback Score values + returned under the <b>MinimumFeedbackScore</b> container in the + response. Currently, the valid values for the US site are -3, -2, and -1. + + + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller uses this container as a mechanism to restrict the number of items (specifying a + <b>MaximumItemCount</b> value) a prospective buyer can purchase from the seller + during a 10-day period. The seller also has the option of setting a + <b>MinimumFeedbackScore</b> requirement. If both fields of the + <b>MaximumItemRequirements</b> container are set, the <b>MaximumItemCount</b> + limit will only apply to those prospective buyers that don't equal or exceed the + specified minimum Feedback Score. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller includes and sets this field to 'true' as a mechanism to block bidders who do + not have a PayPal account linked to their eBay account. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller uses this container as a mechanism to block prospective buyers who are not verified users on PayPal, or in the case of eBay India, not verified users on PaisaPay. + <br/><br/> + The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>, and then look for the <b>BuyerRequirementDetails.VerifiedUserRequirements</b> container. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller uses this container as a mechanism to block prospective buyers who have one or + more unpaid item strikes on their account during a specified time period. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The seller uses this container as a mechanism to block prospective buyers who have one or + more buyer policy violations on their account during a specified time period. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>BuyerRoleMetrics</b> container which is returned in the <b>GetFeedback</b> response. the <b>BuyerRoleMetrics</b> container consists of a eBay user's feedback statistics for the latest one-year period, dating back from the current date. + + + + + + + Count of positive feedback entries given as a buyer. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of negative feedback entries given as a buyer. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of neutral feedback entries given as a buyer. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Percentage of leaving feedback as a buyer. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>BuyerSatisfaction</b> container returned in the + <b>GetSellerDashboard</b> response. The <b>BuyerSatisfaction</b> + container consists of the seller's buyer satisfaction rating, as well as any alerts + related to customer service. + + + + + + + This field indicates the seller's buyer satisfaction rating. To determine this + rating, eBay considers your detailed seller ratings, your overall feedback rating, + and whatever buyer protection claims might exist on your account. eBay uses the + buyer satisfaction rating to see if you are eligible for certain rewards, or if you + need additional guidance to help you give better service. + + + + NeedsWork + GetSellerDashboard + Always + + + + + + + + The <b>BuyerSatisfaction.Alert</b> container is only returned if eBay + has posted one or more informational or warning messages related to the seller's + buyer satisfaction rating. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Buyer satisfaction status. + + + NeedsWork + + + + + + + You are doing an excellent job as an eBay seller. + Be sure to continue providing members with a positive buying experience. + A buyer satisfaction rating of Excellent ensures that you are eligible + for eBay incentives. + + + + + + + You are doing a good job as an eBay seller. + Buyers have been satisfied with your customer service. Be sure to continue + providing members with a positive buying experience. A buyer satisfaction + rating of Good ensures that you are eligible for eBay incentives. + + + + + + + + + + + + + + You are not doing a good job as an eBay seller. + Some of your buyers have not been satisfied with your service. + Improve your customer service to earn a higher buyer satisfaction rating. + If your customer service continues to receive poor responses from customers, + your buyer satisfaction rating can drop and could put your eBay seller's + account at risk. + + + + + + + You are doing a very poor job as an eBay seller. + You need to improve your selling practices immediately. Too many of your + customers have not been satisfied with your customer service and you are + at risk of losing your eBay account. + + + + + + + You are doing an unacceptable job as an eBay seller. + Improve your selling practices immediately. Your account may be suspended + because of your unacceptable customer service. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains information about a user as a buyer. + + + + + + + Contains the shipping address of the buyer. See AddressType for its child elements. GetAllBidders + is returning only Country and PostalCode currently. + Output only. + + + + GetAllBidders + GetHighBidders + Always + + + GetBidderList + Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions + BuyerInfo +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList + Conditionally + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer. + <br/><br/> + It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site. + <br/><br/> + On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout. + <br/><br/> + This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A <strong>BuyerTaxIdentifier</strong> will be returned for each tax ID that is associated with the buyer's account. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The ability for Italian and Spanish sellers to require the buyer's tax ID at checkout is currently ramping up. + </span> + + + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + + + + + Information about zero or more buying guides and the site's buying guide hub. + Buying guides contain content about particular product areas, categories, or subjects + to help buyers decide which type of item to purchase based on their particular interests. + Multiple buying guides can be returned. See the <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Items-Searching.html">eBay Features Guide</a> for additional information. + + + + + + + Information that identifies a buying guide. A buying guide contains content about particular + product areas, categories, or subjects to help buyers decide which type of item + to purchase based on their particular interests. + Buying guides are useful to buyers who do not have a specific product in mind. + For example, a digital camera buying guide could help a buyer determine what kind of + digital camera is right for them. + + + + + + + + + URL of the buying guide home page for the site being searched. + Your application can present this URL as a link. Optionally, + you can use a value like "See all buying guides" as the link's + display name. + + + + + + + + + + + + + Information that identifies a buying guide. A buying guide provides content about particular + product areas, categories, or subjects to help buyers decide which type of item + to purchase based on their particular interests. + Buying guides are useful to buyers who do not have a specific product in mind. + For example, a digital camera buying guide could help a buyer determine what kind of + digital camera is right for them. + + + + + + + Display name of the buying guide. + + + + + + + + + URL for the buying guide. Your application can + present this as a link. Use the value of Name as the link's display name. + + + + + + + + + Identifies the category (if any) that is associated + with the buying guide. + For a matching categories search, + you can use this information to determine the order that the buying guides are + returned in when multiple guides are found. + Optionally, you can use this information to determine where to present + the buying guide link in your application. + Not returned for product finder searches. + + + 10 + + + + + + + Identifies the product finder (if any) that is associated with the buying guide. + Only returned for product finder searches. + + + + + + + + + + The title of the buying guide. + + + + + + + The text of the guide. If the guide is longer than + 2000 characters, the text is cut off and it ends with "...". + See BuyingGuide.URL for a link to the full text of the review. + + + + + + + The time and date when the guide was posted. + + + + + + + The author's eBay user ID. + + + + + + + + + + + Type defining the <b>BuyingSummary</b> container returned in + <b>GetMyeBayBuying</b>. The <b>BuyingSummary</b> container + consists of data that summarizes the buyer's recent buying activity, including the + number of items bid on, the number of items buyer is winning, and the number of items + the buyer has won. The <b>BuyingSummary</b> container is only returned if + the <b>BuyingSummary.Include</b> field is included in the <b>GetMyeBayBuying</b> request and set to + 'true'. + + + + + + + The number of auction items the user has bid on. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The number of auction items the user has bid on and is winning, but auctions have not yet ended. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total cost of items the user is presently winning. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The number of items the user has bid on and won. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total cost of items the user has bid on and won. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The time period for which won items are displayed. Default is 31 days. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The number of items the user has made Best Offers on. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + Type defining the <b>CalculatedHandlingDiscount</b> container that is used in the <b>SetShippingDiscountProfiles</b> call to specify the rules used to determine package handling costs for an order in which calculated shipping is used. + + + + + + + The type of discount that is detailed in the profile. + If the selection is EachAdditionalAmount, EachAdditionalAmountOff or + EachAdditionalPercentOff, the value is set in the child element of same + name in CalculatedHandlingDiscount. If the selection is CombinedHandlingFee, + specify the amount in CalculatedHandlingDiscount.OrderHandlingAmount. + If the selection is IndividualHandlingFee, the amount is determined by eBay + by adding the fees of the individual items. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + If specified, this is the fixed shipping cost to charge for an order, + regardless of the number of items in the order. + This field is mutually exclusive with the other amount and percentage + fields within this type. + This field only applies when DiscountName is CombinedHandlingFee. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + The packaging/handling cost for each item beyond the first item (where the + item with the highest packaging/handling cost is selected by eBay as the first + item). Let's say the buyer purchases three items, each assigned a + packaging/handling cost of $8, and the seller set EachAdditionalAmount to $6. + The packaging/handling cost for three items would normally be $24, but since + the seller specified $6, the total packaging/handling cost would be $8 + $6 + + $6, or $20. + This field is mutually exclusive with the other amount and percentage + fields within this type. + This field only applies when DiscountName is EachAdditionalAmount. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + The amount by which to reduce the packaging/handling cost for each item beyond + the first item (where the item with the highest packaging/handling cost is + selected by eBay as the first item). Let's say the buyer purchases three + items, each assigned a packaging/handling cost of $8, and the seller set + EachAdditionalAmountOff to $2. The packaging/handling cost for three items + would normally be $24, but since the seller specified $2, the total + packaging/handling cost would be $24 - (two additional items x $2), or $20. + This field is mutually exclusive with the other amount and percentage + fields within this type. + This field only applies when DiscountName is EachAdditionalOffAmount. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + The percentage by which to reduce the packaging/handling cost for each item + beyond the first item (where the item with the highest packaging/handling cost + is selected by eBay as the first item). Let's say the buyer purchases three + items, each assigned a packaging/handling cost of $8, and the seller set + EachAdditionalPercentOff to 0.25. The packaging/handling cost for three items + would normally be $24, but since the seller specified 0.25 ($2 out of 8), the + total packaging/handling cost would be $24 - (two additional items x $2), or + $20. + This field is mutually exclusive with the amount fields within this type. + This field only applies when DiscountName is EachAdditionalPercentOff. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + + + + + Calculated Shipping Charge Options + + + + + + + Charge the actual shipping cost and my full packaging and handling + fee for each item. + + + + + + + Charge the actual shipping cost and a packaging and handling fee of + X amount for the entire order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details of an individual discount profile defined by the + user for calculated shipping. + + + + + + + The type of discount or "rule" that is being used by the profile. Only + WeightOff is a "variable" rule, as defined in the documentation on shipping + discount profiles. + + + + GetShippingDiscountProfiles + + IndividualItemWeight, CombinedItemWeight, WeightOff + + Conditionally + + + SetShippingDiscountProfiles + + IndividualItemWeight, CombinedItemWeight, WeightOff + + Conditionally + + + GetItem + GetSellingManagerTemplates + + IndividualItemWeight, CombinedItemWeight, WeightOff + +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + Details of this particular calculated shipping discount profile. If + ModifyActionCode is Modify, all details of the new version of the profile must + be provided. If ModifyActionCode is Delete, DiscountProfileID is required, + MappingDiscountProfileID is optional, and all other fields of DiscountProfile + are ignored. Restrictions of how many profiles you can have for a given + discount rule are discussed in the documentation on shipping discount + profiles. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + + IndividualItemWeight, CombinedItemWeight, WeightOff + + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + + + + + This type is deprecated since <b>CalculatedShippingPreferences</b> are no longer maintained through the <b>CombinedPaymentPreferences</b> container in the <b>GetUserPreferences</b> and <b>SetUserPreferences</b> calls. + + + + + + + DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Calculated Shipping discount profiles. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Calculated Shipping discount profiles. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Calculated Shipping discount profiles. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through + SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. + <br><br> + InsuranceOption is only valid on the following eBay sites: AU, FR, IT, and IN. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + NotOfferedOnSite + No + + + + + + + + + + + + Calculated Shipping Rate Options. + + + + + + + Calculate the Actual Shipping Rate from Combined Item Weight + + + + + + + Calculate the Actual Shipping Rate from Individual Item Weight + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details pertinent to one or more items for which + calculated shipping (or flat rate shipping using shipping rate tables with + weight surcharges) has been offered by the seller, such as package + dimension and weight and packaging/handling costs. Also returned + with the data for an item's transaction. + <br><br> + <span class="tablenote"><strong>Note:</strong> + The <strong>CalculatedShippingRate</strong> container should only be used to specify values for the <strong>InternationalPackagingHandlingCosts</strong>, <strong>OriginatingPostalCode</strong>, and/or <strong>PackagingHandlingCosts</strong> fields. The rest of the fields in the <strong>CalculatedShippingRate</strong> container are used to specify package dimensions and package weight, and these values should now be specified in the <strong>ShippingPackageDetails</strong> container instead. + </span> + + + + + + + Postal code for the location from which the package will be shipped. + Required for calculated shipping. Use Item.PostalCode to specify the + location of the item used for searches by location. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>MeasurementUnit</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>MeasurementUnit</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + Specifies the unit type of the weight and dimensions of a + shipping package. + If MeasurementUnit is used, it overrides the system specified by measurementSystem. + If MeasurementUnit and measurementSystem are not specified, the following defaults + will be used: + <br><br> + English: US<br> + Metric: CA, CAFR, AU + <br><br> + CA and CAFR supports both English and Metric, while other sites + only support the site's default. + <br><br> + Use MeasurementUnit with weight and package dimensions. For example, + to represent a 5 lbs 2 oz package: + <br> + &lt;MeasurementUnit&gt;English&lt;/MeasurementUnit&gt; + <br> + &lt;WeightMajor&gt;5&lt;/WeightMajor&gt; + <br> + &lt;WeightMinor&gt;2&lt;/WeightMinor&gt; + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>PackageDepth</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>PackageDepth</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + Depth of the package, in whole number of inches, needed to ship the item. + This is validated against the selected shipping service. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + <br><br> + Developer impact: UPS requires dimensions for any Ground packages that are 3 + cubic feet or larger and for all air packages, if they are to provide correct + shipping cost. If package dimensions are not included for an item listed with + calculated shipping, the shipping cost returned will be an estimate based on + standard dimensions for the defined package type. eBay enforces a dimensions + requirement on listings so that buyers receive accurate calculated shipping + costs. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>PackageDepth</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>PackageDepth</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + Length of the package, in whole number of inches, needed to ship the item. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>PackageWidth</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>PackageWidth</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + Width of the package, in whole number of inches, needed to ship the item. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + Fees a seller might assess for the shipping of the item (in addition to + whatever the shipping service might charge). + Any packaging/handling cost specified on input is added to each shipping + service on output. + If domestic and international calculated shipping is offered for an item and + if packaging/handling cost is specified only for domestic shipping, that cost + will be applied by eBay as the international packaging/handling cost. (To + specify a international packaging/handling cost, you must always specify a + domestic packaging/handling cost, even if it is 0.) When UPS is one of the + shipping services offered by the seller, package dimensions are required on + list/relist/revise. + For calculated shipping only. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>ShippingIrregular</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>ShippingIrregular</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + Whether a package is irregular and therefore cannot go + through the stamping machine at the shipping service office and + thus requires special or fragile handling. For calculated + shipping only. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>ShippingPackage</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>ShippingPackage</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + The nature of the package used to ship the item(s). + This is required for calculated shipping only. + To get the applicable ShippingPackage values for your site, call + <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingPackageDetails</b>, + and then look for the ShippingPackageDetails.ShippingPackage fields in the response. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>WeightMajor</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>WeightMajor</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + <strong>WeightMajor</strong> and <strong>WeightMinor</strong> are used to specify the weight of a shipping package. Here is how you would represent a package + weight of 5 lbs 2 oz: + <code>&lt;WeightMajor unit="lbs"&gt;5&lt;/WeightMajor&gt; + &lt;WeightMinor unit="oz"&gt;2&lt;/WeightMinor&gt;</code> + <br/> + See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. + <br><br> + For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Always + + + Managing Rate Tables with the API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#ManagingRateTableswiththeAPI + flat rate shipping that requires this field + + + + + + + + <span class="tablenote"><strong>Note:</strong> + The value for <strong>WeightMinor</strong> should now be specified in the <strong>ShippingPackageDetails</strong> container instead. If the <strong>WeightMinor</strong> field is passed in the <strong>CalculatedShippingRate</strong> and the <strong>ShippingPackageDetails</strong> container, the value in the <strong>ShippingPackageDetails</strong> container will take precedence. This field may be deprecated in the future. + </span> + <br> + See the definition of <strong>WeightMajor</strong>. + <br/><br/> + For flat rate shipping (only when shipping rate tables are specified and the shipping rate table uses weight surcharges), or for calculated shipping. Required on input when calculated shipping is used. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> When used with the shipping rate tables with weight surcharge, any <strong>WeightMinor</strong> value greater than zero results in <strong>WeightMajor</strong> getting rounded up in the shipping cost calculation (for example, 1 lb, 2 oz is rounded up to 2 lbs). + </span> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Managing Rate Tables with the API + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#ManagingRateTableswiththeAPI + flat rate shipping that requires this field + + + + + + + + Fees a seller might assess for the shipping of the item (in addition to + whatever the shipping service might charge). + Any packaging/handling cost specified on input is added to each shipping + service on output. + If domestic and international calculated shipping is offered for an item and + if packaging/handling cost is specified only for domestic shipping, that cost + will be applied by eBay as the international packaging/handling cost. (To + specify a international packaging/handling cost, you must always specify a + domestic packaging/handling cost, even if it is 0.) + For international calculated shipping only. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + + + + + Type used by the <b>CancelDetail</b> container, which consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled. + + + + + + + This value indicates the reason why the eBay order was cancelled. This field is always returned with the <b>CancelDetail</b> container. Cancel reasons that may show up in this field include 'BuyerCancelOrder', 'OutOfStock', 'ValetUnavailable', or 'BuyerNoShow'. 'BuyerCancelOrder' will be the returned value for non-eBay Now orders that are cancelled by the buyer through My eBay. 'OutOfStock' will be the returned value for eBay orders that are cancelled by the seller due to the item being out-of-stock. All other values besides these two values are specific to eBay Now orders. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Currently, the <b>CancelReason</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future. + </span> + + + CancelReasonCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The detailed reason for the cancellation of an eBay order. This field is only returned if it is available for the cancelled eBay order. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Currently, the <b>CancelReasonDetails</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This value indicates which party initiated the cancellation of the eBay order. It will usually be 'Buyer' or 'Seller', but it can also be 'CS' (eBay Customer Support). See CancelInitiatorCodeType for the complete list of enumeration values that can be returned in this field. This field is always returned with the <b>CancelDetail</b> container. + + + CancelInitiatorCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This timestamp indicates when the cancellation of the eBay order was initiated. This field is always returned with the <b>CancelDetail</b> container. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Timestamp indicating when the cancellation process of an eBay order has been completed, which will be indicated if the <b>Order.CancelStatus</b> field has a value of 'CancelComplete'. This field will not be returned until the cancellation process is completed. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + OrderReport + Conditionally + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type that defines the possible parties that can initiate the cancellation of an eBay order. + + + + + + + This value indicates that the party whom initiated the cancellation of the order is not known. + + + + + + + This value indicates that the seller initiated the cancellation of the order. + + + + + + + This value indicates that the buyer initiated the cancellation of the order. + + + + + + + This value indicates that eBay customer support initiated the cancellation of the order. + + + + + + + This value indicates that the cancellation of the order was initiated by the system. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Container for a list of offers. May contain zero, one, or multiple + OfferType objects, each of which represents one offer extended by + a user on a listing. + + + + + + + Contains the data for one offer. This includes: data for the user making the + offer, the amount of the offer, the quantity of items being bought from the + listing, the type of offer being made, and more. + + + + + + + + + + + Container for a list of offers. May contain zero, one, or multiple + OfferType objects, each of which represents one offer extended by + a user on a listing. + + + + + + + Contains the data for one offer. This includes: data for the user making the + offer, the amount of the offer, the quantity of items being bought from the + listing, the type of offer being made, and more. + + + + + + + + + + + + + + + + + Enumerated type that defines all possible reasons why an eBay order can be cancelled. + + + + + + + This value indicates that the eBay order was cancelled by the seller due to the fact that one or more order line items were out-of-stock. + + + + + + + This value indicates that the eBay Now order was cancelled due to the fact that the buyer was not at the expected delivery location to receive the order. This value is only applicable to eBay Now orders. + + + + + + + This value indicates that the eBay Now order was cancelled due to the fact that the buyer refused to accept the order. This value is only applicable to eBay Now orders. + + + + + + + This value indicates that the eBay Now order was cancelled due to the fact that the buyer did not successfully schedule the delivery of the order. This value is only applicable to eBay Now orders. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the buyer. + + + + + + + This value indicates that the eBay Now order was cancelled due to the fact that the eBay Now valet had an issue delivering the order to the buyer. This value is only applicable to eBay Now orders. + + + + + + + This value indicates that the eBay Now order was cancelled due to the fact that no eBay Now valet was available to deliver the order to the buyer. This value is only applicable to eBay Now orders. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the buyer because the order was placed by mistake. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer decided that the price for the item was too high. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer found the same item somewhere else at a cheaper price. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the buyer because the buyer realized that the order will not arrive within the expected delivery time. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the seller at the request of the buyer, or that there was an issue with the destination address. + + + + + + + This value indicates that the cancellation of the eBay order was initiated by the seller because the item was out of stock, or due to another reason why the seller was unable to fulfill the order. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Enumerated type that defines the possible states of an eBay order cancellation. + + + + + + + This value indicates that the order cancellation request is invalid. + + + + + + + This value indicates that the order cancellation request is not applicable. + + + + + + + This value indicates that the buyer has initiated the cancellation of the eBay order. It will be up to the seller to decide to approve or reject the cancellation request. + + + + + + + This value indicates that the cancellation of the eBay order has been initiated by the buyer and approved by the seller, but the cancellation request has yet to be completed. + + + + + + + This value indicates that the cancellation of the eBay order initiated by the buyer has been rejected by the seller. + + + + + + + This value indicates that the order cancellation request has been closed, with no refund issued to the buyer. + + + + + + + This value indicates that the order cancellation request has been closed, with a refund issued to the buyer. + + + + + + + This value indicates that the order cancellation request has been closed, and it is unknown whether or not a refund was issued to the buyer. This value will generally be returned when the payment method used to pay for the order was something other than PayPal. + + + + + + + This value indicates that the order cancellation request has been closed because the buyer has already committed to buying the item(s). + + + + + + + This value indicates that the cancellation of the eBay order has been completed. + + + + + + + This value indicates that the cancellation of the eBay order has failed. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Details about an item in a cart. + + + + + + + + + + When used as input, this is the item to be added, removed or updated in the cart. + Only ItemID and Quantity apply. + This is only required as input if the parent container is submitted. + When returned, this is one of the items remaining in the cart. + + + + + + + An ID created by eBay and returned along with an item, if items are returned. + This ID must be provided on input to SetCart along with the corresponding item + when doing a Delete or Update related to that item. + + + + + + + What is to be done with the item. If the action is Delete or Update, + ReferenceID must be provided. (It was returned with the item + when the item was initially added to the cart.) + This is only required if the parent container is submitted. + + + + + + + + + + + Information about an eBay catalog product. + + + + + + + The title of the product. Always returned when Product is returned. + + + + + + + Fully qualified URL for optional information about the product, + such as a movie's description or film credits. This information + is hosted through the eBay Web site and it cannot be edited. + Portions of the content are protected by copyright. + Applications can include this URL as a link in product search results + so that end users can view additional descriptive details about + the product.<br> + <br> + <span class="tablenote"><b>Note:</b> You can use + the ProductMementoString parameter in this URL as the ProductID value in + GetSearchResults requests. This parameter is a colon-delimited + alphanumeric value. </span> + + + + + + + Fully qualified URL for a stock image (if any) that is associated + with the eBay catalog product. The URL is for the image eBay + usually displays in product search results (usually 70px tall). + It may be helpful to calculate the dimensions of the photo + programmatically before displaying it. + + + + + + + If true, your application can attempt to display stock photos that + are returned. If false, your application should not attempt to display + any stock photos that are returned. This recommendation is useful for + catalog data related to products like coins, where stock photos are not + necessarily applicable or available. An application with a graphical + user interface can use this flag to determine + when to hide customized stock photo widgets. + + + + + + + Total number of listings on the specified eBay site that use + stock information from this catalog product. This value can be greater + than the number of listings returned in ItemArray. To retrieve more + listings, use GetSearchResults. + Only returned when you use ExternalProductID or ProductReferenceID + and you set IncludeItemArray to true. + + + + + + + An ISBN, UPC, or EAN value that is associated with this + eBay catalog product (if any). These values are only returned + for products in "media" domains (Books, DVDs and Movies, Music, and + Video Games). Products in other domains don't return this value + (even if a UPC is available in the Item Specifics.) + + + + + + + The numeric ID for the eBay catalog product. After selecting a product + returned from a keyword query, pass this value in GetProducts to + retrieve more information about that product. + + + + + + + Numeric ID for the product's domain (characteristic set). + When you use GetProducts by itself, this can be useful when + you want to group product results + by domain (e.g., all book products together). + For a mapping of attribute set IDs to names, see the + <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Items-Retrieving.html#RetrievinganItemwithItemSpecificsandorPr">eBay Features Guide</a>. Alternatively, use GetCategory2CS + to retrieve the mappings periodically (e.g., once a day) and + store them locally. (We do not recommend using the product histogram, + for this purpose.) + + + + + + + A list of attribute and value pairs that are included in the product's + pre-filled Item Specifics. + Also see ExternalProductID for ISBN, UPC, or MPN values, if applicable. + This is usually returned. (We are not aware of any cases in which this + node is not be returned. However, it may be safest to check for the + existence of this node.) + + + + + + + The total number of reviews that are available for this product + on the eBay web site. This can be greater than the number of + reviews returned by GetProducts. See ReviewDetails.Review.URL + for information about viewing more reviews. + + + + + + + The product's most helpful reviews, if any. + The reviews are sorted by most helpful review (most votes) first. + Only returned when you pass in ExternalProductID or + ProductReferenceID and you set IncludeReviewDetails to true. + Up to 20 of the reviews are returned. If more reviews are available, + (that is, if ReviewCount is greater than 20), the user can look at + additional reviews on the eBay Web site. + See ReviewDetails.Review.URL for information about viewing more + reviews. + + + + + + + Indicates that the product has changed or will soon change (usually due to a migration + from one catalog to another catalog). Typically, this field is returned for up to 90 + days for a given product. After that, the product either no longer returns this field + or the product is no longer returned (depending on the state change). + <br><br> + This data is primarily applicable to catalogs used by the US, Germany, Austria, and + Switzerland sites. Other sites may undergo catalog changes in the future. + + + + + + + + + + + Container for a list of categories. + + + + + + + Contains details about one category. For GetCategories, + this node is not returned when no detail level is specified. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + + + + + + + This type is deprecated. Use <b>DetailLevelCodeType</b> instead. + + + + + + + + + Return all available data. + + + + + + + + + + + Return the category feature definitions only. + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + Type defining the <b>Category</b> container that is returned in the <b>GetCategoryFeatures</b> response. A <b>Category</b> node is returned for each category that is relevant/applicable to the input criteria in the <b>GetCategoryFeatures</b> request. The <b>CategoryID</b> value identifies the eBay category. The rest of the <b>CategoryFeatureType</b> fields that are returned will be dependent on which <b>FeatureID</b> value(s) are specified in the <b>GetCategoryFeatures</b> request. + + + + + + + Specifies the identifier of the category that has the feature. + + + 10 + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Identifies the listing duration set that applies to the category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category requires sellers to specify shipping details. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports Best Offers from buyer. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent.. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field is no longer applicable as Dutch auctions are no longer available on + eBay sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether a bidder must consent to the bid by confirming that + he or she read and agrees to the terms in eBay's privacy policy. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not it is possible to enhance a listing by putting + it into a rotation for display on a special area of the eBay home page. + Support for this feature varies by site. Item or feedback restrictions may apply. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Pro Pack Bundle listing upgrade. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This listing upgrade is no longer available on any site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Value Pack bundle listing upgrade. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Pro Pack Plus bundle listing upgrade. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports Classified Ad listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports buyers and sellers offering counter offers against Best Offers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Best Offer Auto Decline feature. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Local Market Speciality Subscription feature. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Local Market Regular Subscription feature. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Local Market Premium Subscription feature. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the Local Market Non Subscription feature. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This feature is no longer supported on any eBay site, as eBay Express is deprecated. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + 579 + NoOp + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This feature is no longer supported on any eBay site, as eBay Express is deprecated. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + 579 + NoOp + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This feature is no longer supported on any eBay site, as eBay Express is deprecated. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + + + + + + + Indicates whether Minimum Reserve Price is enabled for this category. On the Germany, Austria, Belgium French, + and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, + Watches and Jewelry, and Motorbikes categories. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports seller-level contact information for + Classified Ad format listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the Transaction Confirmation Request feature is supported for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Store Inventory listings are no longer supported on any eBay site. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports messaging through Skype for fixed-price and auction listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports messaging through Skype for classified ad listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the payment method should be displayed to the user for + Classified Ad format listings. + Even if enabled, checkout may or may not be enabled. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for Classified Ad listings + in the category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best offer is enabled for Classified Ad listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Classified Ad listings + for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether automatic decline for best offers for Classified Ad listings is allowed for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the telephone is supported as a contact method for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports email as a contact method. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether listings in this category need to have a safe + payment method, for all sellers registered after 2007. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if pay-per-lead listings are allowed for this category. + Pay-per-lead listings can be applicable if the ListingType is + LeadGeneration and the ListingSubtype is ClassifiedAd. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports custom Item Specifics. + If enabled, sellers can use the <b>Item.ItemSpecifics</b> node in Add/Revise/Relist calls to fill in Item Specifics. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the 'PaisaPayEscrow' payment method. This feature is only applicable to the India site. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the UPC Identifier field. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the EAN Identifier field. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the ISBN Identifier field. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports setting + a price at which Best Offers are automatically accepted + for Classified Ads. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports setting + a price at which Best Offers are automatically accepted. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports specifying that listings be displayed in the default search results of North America sites. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports specifying that listings + be displayed in the default search results of the UK and Ireland sites. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports specifying that listings be displayed in the default search results of the Australia site. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + For the Australia site, if both PayPalBuyerProtectionEnabled + and BuyerGuaranteeEnabled are returned, then + buyer protection is allowed for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + For the Australia site, if both PayPalBuyerProtectionEnabled + and BuyerGuaranteeEnabled are returned, then + buyer protection is allowed for this category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports + combined fixed price treatment for Basic Fixed Price listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports + durations for "Gallery Featured". + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category requires PayPal as a payment method. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category allows Classified Ad listings. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including the telephone in the + seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled for the seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including the address in the + seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled for the seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including the company name in the + seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including an email address in the + seller's contact information. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is supported for Classified Ad listings + in this category. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category allows + auto-accept for Best Offers for Classified Ads. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category allows + auto-decline for Best Offers for Classified Ads. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user + for this category. Even if enabled, checkout may or may not + be enabled. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for this category. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for + this category. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category allows seller-level contact information for Classified Ad listings. A value of true + means seller-level contact information is available for Classified Ad listings. + This element is for eBay Motors Pro users. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category supports Classified Ad listings. + This is added for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including a telephone number in the + seller's contact information. + This element is added for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled for the seller's contact information. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an address in the + seller's contact information. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option for is included in the + seller's contact information. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a company name in the + seller's contact information. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an email address in the + seller's contact information. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings + in this category. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category supports auto-accept for best offers for Classified Ads. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether this category supports auto-decline for Best Offers for Classified Ads. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user + for this category. Even if enabled, checkout may or may not + be enabled. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for this category. + This element is for Local market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for + this category. + This element is for Local market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the whether this category allows + seller-level contact information for Classified Ad listings. + This element is for Local Market dealers. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is included in the + seller's contact information. + This element is for For Sale By Owner listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including an address in the + seller's contact information. + This element is for For Sale By Owner listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is included in the + seller's contact information. + This element is for For Sale By Owner listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether this category supports including a company name in the + seller's contact information. + This element is for For Sale By Owner listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the escrow workflow version that applies to the category on the + India site: Default Workflow, Workflow A or Workflow B. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category requires that an eBay Store owner offer PayPal as a payment method for all listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates if the category allows the seller to revise the quantity of a multi-quantity, active listing. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates if the category allows the seller to revise the price of a fixed-price listing. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if extended store owner listing durations are enabled in a given category. + When the value of this element is true, it means the listing duration values + defined in StoreOwnerExtendedListingDurations are applicable to fixed price + listings in a given category. + Applies to Fixed Price Listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Provides additional listings durations that are available to eBay Store owners. + The extended listing durations provided here in this element should be merged + in with the baseline listing durations provided in the ListingDurations element. + Applies to Fixed Price Listings. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + <b>For most sites:</b> If true, listings in this + category require a return policy. <br> + <br> + <b>For eBay India (IN), Australia (AU), and + US eBay Motors Parts and Accessories:</b> + If true, the category supports but does not require a + return policy. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + If false, listings in this category require a handling time + (see DispatchTimeMax in AddItem) when flat or calculated shipping + is specified. (A handling time is not required for local pickup + or for freight shipping.)<br> + <br> + The handling time is the maximum number of business days the seller + commits to for preparing an item to be shipped after receiving a + cleared payment. The seller's handling time does not include the + shipping time (the carrier's transit time). + <br> + For a list of the handling time values allowed for each site, use + DispatchTimeMaxDetails in GeteBayDetails.<br> + <br> + <span class="tablenote"><b>Note:</b> + Although the field name ends with "Enabled", a value of true means + that a handling time is NOT supported, and value of false means + that a handling time IS supported.</span> + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The maximum cost the seller can charge for the first domestic flat rate shipping + service. The total shipping cost is the seller's base flat rate + shipping cost plus the cost of insurance, if insurance is required. + Only returned if MaxFlatShippingCostEnabled is true. + Mutually exclusive with the GroupNMaxFlatShippingCost elements. + <br><br> + Returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group1. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group2. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group3. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the acceptable payment methods (e.g., to use in AddItem + and related calls). + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + If true, you can pass in Item.Variations in the + AddFixedPriceItem family of calls when you list in this + category.<br> + <br> + Multi-variation listings contain items that are logically the same + product, but that vary in their manufacturing details or packaging. + For example, a particular brand and style of shirt could be + available in different sizes and colors, such as "large blue" and + "medium black" variations. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field is deprecated since "old" eBay attributes are no longer supported. + + <br><br> + + + + + + + + + + + + + Indicates whether the category supports + free, automatic upgrades for Gallery Plus, which + enhances pictures in search results. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports + free, automatic upgrades for Picture Pack, a discount + package that includes super-sizing of pictures. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports parts compatibility by application + (ByApplication), by specification (BySpecification), or not at all + (Disabled). Categories cannot support both types of parts compatibility. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories + categories for the US eBay Motors (site ID 0) only. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field specifies the minimum number of required compatible applications + for listing items. A value of "0" indicates it is not mandatory to specify + parts compatibilities when listing. + <br><br> + This applies to categories that are enabled for compatibility by application + only. Parts compatibility by application can be specified by listing with a + catalog product that supports parts compatibility or by specifying parts + compatibility by application manually (<b class="con"> + Item.ItemCompatibilityList</b>). + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the maximum number of compatible applications allowed per item when + adding or revising items. Use value to check the total number of + compatibilities that can be provided at the Year, Make, and Model granularity. + This is relevant for specifying parts compatibility by application manually + (<b class="con">Item.ItemCompatibilityList</b>) only. + <br><br> + Applicable for the US site only. + <br><br> + For DE, UK, and AU sites, this field returns the same value as <b + class="con">MaxGranularFitmentCount</b>. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports (or requires) + using Item.ConditionID to specify an item's condition + in AddItem and related calls. See ConditionValues for + a list of valid IDs.<br> + <br> + <span class="tablenote"><b>Note:</b> + Some categories may still support using the older Attribute model + and/or Custom Item Specifics model for item condition. + If ConditionEnabled=Enabled (or Required) for a category, + you should stop using these other fields to specify the condition + in your listings. + </span> + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the supported item conditions for the category, + plus related policies and other details. + Only returned if ConditionEnabled is Enabled or Required + for the category (and the condition values are different than the + site defaults). + <br><br> + Returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Some eBay sites may select a few categories and designate them as + "value categories". These are typically selected from + categories where buyers can find great deals. (Not all categories + with great deals are designated as value categories.) + This designation can change over time. <br> + <br> + While a category is designated as a value category (i.e., + when ValueCategory is true), it is subject to the following rule: + Items in value categories can only be listed in one category.<br> + <br> + For example, if you attempt to list in two categories and the + PrimaryCategory or SecondaryCategory is a value category, + then eBay drops the SecondaryCategory and lists the + item in the PrimaryCategory only. + Similarly, if you attempt to add a secondary category to an existing + listing, or you change the category for an existing listing, + and if the primary or secondary category is a value category, + then eBay drops the secondary category. + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether a category supports (or requires) product creation in listings. + Use this to determine whether it is mandatory to send + product id in AddItem and related calls. This also specifies if product creation is + enabled so a new product can be created + <br><br> + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the maximum number of compatible applications allowed per item when + adding or revising items with compatibilities provided at the most detailed + granularity. For example, in Car & Truck Parts on the US site, the most + granular application would include Year, Make, Model, Trim, and Engine. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field is for future use. It is currently returned as an empty field, but + in the future, the string value in this field will indicate Parts + Compatibility vehicle type (e.g. cars, motorcycles, boats). + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which payment options group a category supports in listings. + <br><br> + + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + Indicates the Business Policies category group that may be used for Shipping profiles. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the Business Policies category group that may be used for Payment profiles. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the Business Policies category group that may be used for Return Policy profiles. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + Indicates if the category supports the use of the VIN (Vehicle Identification Number) field to identify a motor vehicle and create a listing. VINs are supported on the US, Canada, Canada-French, and Australia sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the category supports the use of the VRM (Vehicle Registration Mark) field to identify a motor vehicle and create a listing. VRMs are only supported on the UK site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Seller Provided Title will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports Seller Provided Title. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Deposit will no longer be supported as primary attributes, + rather consumers should use new tags. This feature helps consumers in identifying + if category supports Deposit. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether or not the corresponding category supports the Global Shipping + Program (GSP). + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + This field indicates whether or not the category (specified in the + <b>Category.CategoryID</b> field) supports Boats Parts + compatibility. If true, parts compatibility name-value pairs for boats can be + added to an item listed in the specified category. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + A 'true' value in this field indicates that items listed in the category (specified in the <b>Category.CategoryID</b> field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. A 'false' value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature. + <br/><br/> + The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + Type defining the <b>CategoryGroup</b> container, which defines the category + group to which the corresponding Business Policies profile will be applied, and a flag that + indicates whether or not that Business Policies profile is the default for that category + group. + + + + + + + Defines the name of the category group tied to a Business Policies profile. Valid values are + ALL (referring to all non-motor vehicle category groups) or MOTORS_VEHICLE (referring to + only motor vehicle category groups). + <br><br> + The <b>CategoryGroup</b> container is only returned in <b>GetUserPreferences</b> + if the <b>ShowSellerProfilePreferences</b> field is included in the request + and set to 'true'. + + + + GetUserPreferences + Conditionally + + + + + + + + Identifies that the corresponding Business Policies profile is the default for the category + group. + <br><br> + The <b>CategoryGroup</b> container is only returned in <b>GetUserPreferences</b> + if the <b>ShowSellerProfilePreferences</b> field is included in the request + and set to 'true'. + + + + GetUserPreferences + Conditionally + + + + + + + + + + + Defines details about recommended names and values for custom Item Specifics. + + + + + + + An eBay category ID. This call retrieves recommended + Item Specifics (if any) for each category you specify. + (The call returns no results for a parent category.) + To determine which categories support listing with custom Item Specifics, use GetCategoryFeatures. + <br> + <br> + The request requires either CategoryID, + CategorySpecfics.CategoryID, or CategorySpecificsFileInfo + (or the call returns an error). + CategoryID and CategorySpecific.CategoryID can both be used + in the same request. (CategorySpecific offers more options + to control the response.) + Some input fields, such as IncludeConfidence, only work when + CategoryID or CategorySpecfics.CategoryID is specified.<br> + <br> + You can specify multiple categories, but more categories + can result in longer response times. + If your request times out, specify fewer IDs. + If you specify the same ID twice, we use the first instance. + + + 10 + 100 + + GetCategorySpecifics + Conditionally + + + + + + + + In the request, use this to retrieve recommended values for a + particular name (in the specified category). This could be + an arbitrary name that the seller wants to check, or it could + be a name that was returned in a prior response. + At the time of this writing, this value is case-sensitive. + (Wildcards are not supported.)<br> + <br> + In the response, contains a list of Item Specifics (if any) + that eBay recommends as most popular within the specified + category. + + + + GetCategorySpecifics + Conditionally + + + + + + + + + + + + Mapping between an old category ID and an active category ID. + + + + + + + + + Identifier for an old category that has been combined with an active category. + Unique for the site. These IDs correspond to older category IDs that + calls like GetCategories have returned in the past. + In GetCategoryMappings, this is always returned when CategoryMapping is returned. + + + + GetCategoryMappings + Conditionally + + + + + + + + Identifier for an active category. Unique for the site. + These IDs correspond to the current IDs in the category hierarchy + (returned from GetCategories and related calls). Multiple mappings can + specify the same active category ID, because different old IDs can be mapped + to the same active category. See <a href="http://developer.ebay.com/DevZone/guides/ebayfeaturesevelopment/Categories-DataMaintenance.html#MappingCategoriesontheClientSide">Mapping Categories on the Client Side</a>. + In GetCategoryMappings, this is always returned when CategoryMapping is returned. + + + + GetCategoryMappings + Conditionally + + + + + + + + + + Container for data on one listing category. Many <b>CategoryType</b> fields are only returned in the <b>GetCategories</b> response. Add/Revise/Relist calls only use the <b>CategoryID</b> field to specify which eBay category in which to list the item. + + + + + + + If this field is returned as 'true', the corresponding category supports Best Offers. If the field is not present, the category does not support Best Offers. This field is not returned when 'false'. + + + + GetCategories +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + If true, indicates that the category supports immediate payment. + If not present, the category does not support + immediate payment. Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Conditionally + + + Requiring Immediate Payment + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-PaymentMethod.html + + + + + + + + If true, the category supports business-to-business (B2B) VAT + listings. Applicable to the eBay Germany (DE), Austria (AT), + and Switzerland CH) sites only. If not present, + the category does not support this feature. Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Conditionally + + + Working with Business Features and VAT + + + + + + + + + If this field is returned as 'true', the category supports eBay catalog product details. This field is not returned if 'false'. + + + + GetCategory2CS + MappedCategoryArray +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Distinct numeric ID for a category on eBay. + In <b>GetItem</b> and related calls, see <b>CategoryName</b> for the text name of + the category. Use <b>GetCategories</b> to look up the category parent ID. + <br> + <br> + For <b>GetItem</b>, Half.com items return the Half.com category ID + in <b>PrimaryCategory</b>. This ID is not necessarily returned in + <b>GetCategories</b>. + <br> + <br> + In an Add/Revise/Relist call, the <b>PrimaryCategory.CategoryID</b> is always required, and the <b>SecondaryCategory.CategoryID</b> is also required if a Secondary Category is used. + + + 10 + + AddItem + AddItems + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + PrimaryCategory + Yes + + + AddItem + AddItems + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + SecondaryCategory + Conditionally + + + AddSellingManagerTemplate + PrimaryCategory + Yes + + + AddSellingManagerTemplate + SecondaryCategory + No + + + GetBidderList + PrimaryCategory + Always + + + GetBidderList + Conditionally + FreeAddedCategory + SecondaryCategory + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + GetContextualKeywords + Always + + + GetCategory2CS + MappedCategoryArray +
DetailLevel: ReturnAll
+ Always + + + GetCategory2CS + UnmappedCategoryArray +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + PrimaryCategory +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItem + Conditionally + FreeAddedCategory + SecondaryCategory +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSuggestedCategories + Conditionally + + + GetSellerList + Conditionally + FreeAddedCategory + SecondaryCategory +
DetailLevel: ItemReturnDescription, ReturnAll
+ + + GetSellerList + Conditionally + PrimaryCategory + SecondaryCategory +
DetailLevel: ItemReturnDescription, ReturnAll
+ + + + + + + + The level where the category fits in the site's category hierarchy. + For example, if this field has a value of '2', then the category is two + levels below the root category in the site's category hierarchy. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + Display name of the category as it would appear on + the eBay Web site. + In GetItem, this is a fully qualified category name + (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).<br> + <br> + In GetItem, always returned for eBay.com listings. + Not returned in PrimaryCategory for Half.com listings. + + + 30 + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + GetContextualKeywords + Always + + + GetBidderList + Always + PrimaryCategory + + + GetBidderList + Conditionally + FreeAddedCategory + SecondaryCategory + + + GetItem + GetSellingManagerTemplates + Conditionally + PrimaryCategory +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItem + GetSellingManagerTemplates + Conditionally + FreeAddedCategory + SecondaryCategory +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSuggestedCategories + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Category ID identifying a category that is an ancestor of + the category indicated in CategoryID. + For GetCategories, returns the same value as CategoryID + if the CategoryLevel is 1. + For GetSuggestedCategories, multiple CategoryParentID fields + can be returned in sequence, starting with the root category + and ending with the category that is the direct parent of + the category specified in CategoryID. + Use these parent fields and the CategoryID field to build + the fully qualified category browse path or "breadcrumbs" + (e.g., 58058:3516:3517). + + + 10 + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + GetSuggestedCategories + Conditionally + + + + + + + + Display name of the category indicated in CategoryParentID. + For GetSuggestedCategories, multiple CategoryParentName fields + can be returned in sequence, starting with the root category + and ending with the category that + is the direct parent of the category specified in CategoryName. + Use these parent fields and the CategoryName field to build the + fully qualified category browse path or "breadcrumbs" + (e.g., Computers & Networking > Technology Books > Certification). + + + + GetSuggestedCategories + Conditionally + + + + + + + + No longer applicable to any category. + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + If true, indicates a category that has expired and + to which items may not be listed. Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + Used for Store Inventory listings, which are no longer supported on any eBay site. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + If true, indicates that the category indicated in CategoryID is a leaf category, + in which items may be listed (if the category is not also expired or virtual). Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + If true, indicates the category indicated in CategoryID is a + virtual category, to which items may not be listed. Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + No longer applicable to any category. + + + + + + + + + + No longer supported. + + + + + + + + + + Indicates whether the category (and its subcategories) + allows or disallows listing with a reserve price, + depending on the prevailing site configuration indicated by + ReservePriceAllowed. + ORPA (override reserve price allowed) indicates when the category + is an exception to the site's ReservePriceAllowed policy.<br> + <br> + If ORPA is true, the category overrides (toggles or reverses) the + site's ReservePriceAllowed setting. In other words:<br> + - If ReservePriceAllowed is true, reserve price is not allowed in this category.<br> + - If ReservePriceAllowed is false, reserve price is allowed in this category.<br><br> + If ORPA is not present, there is no override. + That is, the category's setting is the same as the site's ReservePriceAllowed setting.<br> + <br> This field will not be returned in the response if false. + This toggling logic is designed to reduce the size of the GetCategories + response by only returning ORPA when the category's policy is different + from the site's policy. (If ORPA is true for a category, you can assume + its subcategories inherit the same setting unless otherwise specified.) + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + Indicates whether the category (and its subcategories) allows + or disallows reducing a listing's reserve price, + depending on the prevailing site configuration indicated by ReduceReserveAllowed. + ORRA (override reduce reserve allowed) indicates when the category is an exception + to the site's ReduceReserveAllowed policy.<br><br> + If ORRA is true, the category overrides (toggles or reverses) the + site's ReduceReserveAllowed setting. In other words:<br> + - If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.<br> + - If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.<br><br> + If ORRA is not present, there is no override. Will not be returned in the response if false. + That is, the category's setting is the same as the site's ReduceReserveAllowed setting.<br> + <br> + This toggling logic is designed to reduce the size of the GetCategories + response by only returning ORRA when the category's policy is different + from the site's policy. (If ORRA is true for a category, you can assume + its subcategories inherit the same setting unless otherwise specified.) + + + + GetCategories +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + "Lot Size Disabled (LSD)" indicates that Item.LotSize is not permitted when you list in this category. + If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false. + + + + GetCategories +
DetailLevel: ReturnAll
+ Always + + + + + + + + No longer supported. + + + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + Numeric identifier for a domain (characteristic set).<br> + <br> + For GetProductSearchResults (for selling tools), it's best to use + GetCategory2CS to determine mappings between categories and + characteristic sets that are flagged as CatalogEnabled. + + + + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + + + + Constant value that identifies the characteristic in a language-independent way. + Unique within the characteristic set. + + + + + + + + + + + Applicable when working with Pre-filled Item Information (Catalogs) functionality. + Returned if the characteristic is a Date data type. Specifies the pattern + to use when presenting the date to a user. Possible values: + Day/Month/Year, Month/Year, Year Only. + For example, the Year Only format would indicate that the date + should be a value like 1999. + Output only. + + + + + + + + + + + The suggested order in which the characteristic should be presented + to the user in a list. Indicates the relative position of the sort + key in the list of characteristics. The characteristic with the + lowest display sequence is considered the default sort key in calls + to GetProductSearchResults. Aside from that, usage of this display + sequence information is optional. For example, in an application + with a graphical user interface, a characteristic with a display + sequence of 2 could be presented before one with a display sequence + of 3 in a drop-down list. If multiple sort characteristics are + returned for a characteristic set, compare their display sequence + values to determine the lowest available value (usually 0) and the + overall sequence. + + + + + + + + + + + Applicable when working with Pre-filled Item Information (Catalogs) functionality. + The unit of measure (e.g., Inch) to use when the characteristic is numeric indicates a measurement. + Not returned if not applicable. + Output only. + + + + + + + + + + + Applicable when working with Pre-filled Item Information (Catalogs) functionality. + The label to display when presenting the attribute to a user. + Not necessarily the same as the attribute's label as defined in the + characteristic set (i.e., the label could be overridden by the catalog). + + + + + + + + + + + Applicable when working with Pre-filled Item Information (Catalogs) functionality. + Indicates the order in which eBay's search engine will sort the results if you + pass this characteristic as a sort attribute in GetProductSearchResults. + You cannot change the sort order of a characteristic when you perform a search. + (Of course, you can change the sort order when you present results in your own application.) + In GetProductSearchPage, if SortOrder is not returned at all, it means the results will be returned + in the order in which they are stored on eBay (which can be useful for + international sites that use ideographic characters). + Output only. + + + + + + + + + + + List of one or more valid values for the characteristic. + + + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + + + This field is <b>deprecated</b>. + + + + + + + + + + This field is <b>deprecated</b>. + + + + + + + + + + This field is <b>deprecated</b>. + + + + + + + + + + + + + A generic type used for histograms. + + + + + + + In GetProducts, each histogram entry shows how many matching products + were found in each matching domain. A domain is like a high-level + category. (A domain is also called an attribute set or a + characteristic set.) + + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + The well-known name of the characteristic set (e.g., "Tickets" or "Books"). + + + + + + + + + + Numeric value that identifies the characteristic set in a language-independent + way. Identifies the characteristic set that is mapped to a catalog-enabled + category associated with the product. Unique across all eBay sites. + + + + + + + + + + Version of the characteristics set. Not to be confused with + AttributeSystemVersion, which can be used to retrieve changes to attribute + meta-data. In item-listing requests, if you specify the version of the + attribute set that you have stored locally, eBay will compare it to the + current version on the site and return a warning if the versions do not match. + If an error occurs due to invalid attribute data, this warning can be useful + to help determine if you might be sending outdated data. The current value of + version is not necessarily "greater than" the previous value. + + + + + + + + + + A salient aspect or feature of an item. Used to describe an item in a standard + way so that buyers can find it more easily. An individual, standardized + characteristic that is common to all items within the specified characteristic + set. In the context of GetProductSearchPage, each characteristic identifies a + single searchable attribute. A searchable attribute is a product aspect or + feature that can be used as a criterion in a search for catalog content. For + example, "Title" might be a criterion for searching the book catalog for Pre- + filled Item Information related to books. See the eBay Web Services guide for + more information. + + + + + + + + + + + + + + Type defining the <b>CharityAffiliationDetail</b> container that is returned in the <b>GetUser</b> response. The <b>CharityAffiliationDetail</b> container consists of information on a nonprofit charity organization associated with the seller's account. A separate <b>CharityAffiliationDetail</b> container is returned for each nonprofit charity organization associated with the seller's account. + + + + + + + The affiliation ID for nonprofit charity organizations + registered with the dedicated eBay Giving Works provider. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the affiliation status of the nonprofit charity + organization registered with the eBay Giving Works provider. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the affiliation last used date of the nonprofit charity + organization registered with the eBay Giving Works provider. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + Lists the nonprofit charity organization affiliations for a specified user. + + + + + + + Indicates the affiliation status for nonprofit charity organizations + registered with the dedicated eBay Giving Works provider. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + Defines the affiliation status for a nonprofit charity organization registered with the dedicated eBay Giving Works provider. + + + + + + + + + + + + + This enumeration type defines the possible values that can be returned for the <b>CharityAffiliationDetail.AffiliationType</b> field in the <b>GetUser</b> response. + + + + + + + (out) The specified nonprofit charity organization has a community affiliation. + + + + + + + (out) The specified nonprofit charity organization has direct affiliation. + + + + + + + (out) The specified nonprofit charity organization is no longer affiliated. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Lists the nonprofit charity organization affiliations for a specified user. + + + + + + + Indicates the affiliation status for nonprofit charity organizations + registered with the dedicated eBay Giving Works provider. + + + + GetBidderList + Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + NoOp + User.SellerInfo.CharityAffiliationDetails.CharityAffiliationDetail.CharityID + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Defines the affiliation status for a nonprofit charity + organization registered with the eBay Giving Works provider. + + + + + + + + Indicates the affiliation status of the nonprofit charity + organization registered with the eBay Giving Works provider. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>Charity</b> container, which consists of all details + related to a nonprofit charity organization. + + + + + + + The name of a non-profit charity organization. The <b>Name</b> field is + required if non-registered charity organization, since these companies will not have a + eBay Giving Works <b>CharityID</b> + + + 150 + + GetCharities + Conditionally + + + + + + + + + This flag is for internal use only. + + + + + SetCharities + No + + + + + + + + + This field is for internal use only. + + + + 150 + + SetCharities + Conditionally + + + + + + + + + This field is for internal use only. + + + + 150 + + SetCharities + Conditionally + + + + + + + + + + The mission statement of a nonprofit charity organization registered with eBay Giving + Works. The mission statement is returned in <b>GetCharities</b> and is + displayed in item listings if the nonprofit charity organization is registered with + eBay Giving Works. + + + 511 + + GetCharities + Conditionally + + + + + + + + This URL indicates the location of the nonprofit charity organization's logo image. The + image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is + displayed in item listings if the nonprofit charity organization is registered with + eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity + organization's logo if the <b>LogoURL</b> or <b>LogoURLSelling</b> + values are not provided or these value point to bad URLs or to URLs containing no images + or images not meeting eBay logo size and format requirements. This value is returned if + set. + + + + GetCharities + Conditionally + + + + + + + + Enumeration value that indicates whether or not the charity is a valid eBay Giving Works + nonprofit organization. + + + + + + + + + + Keyword string to be used for search purposes. + + + + + + + + + + Integer value that indicates the nonprofit charity organization's region. Each nonprofit + charity organization may be associated with only one region. + + + + GetCharities + Conditionally + + + + + + + + Integer value that indicates the domain (mission area) of the nonprofit charity + organization. A nonprofit charity organization does not have to specify a charity + domain, so it is possible that this field will not be returned in + <b>GetCharities</b>. Each nonprofit charity organization can belong to as + many as three charity domains. + + + + GetCharities + Conditionally + + + + + + + + A unique identifier created by eBay and assigned to registered nonprofit charity + organizations. This identifier can be used as a filter in the <b>GetCharities</b> + request, and it will always be returned if the nonprofit charity organization is + registered with eBay Giving Works. + + + + + + + + + + An alternative to the <b>LogoURL</b> value. This URL indicates the location + of the nonprofit charity organization's logo image. The image file must be JPG or GIF + format, and its size cannot exceed 50 KB. This URL will be used if the + <b>LogoURL</b> value points to a broken link or if that location either + contains no image or contains an image that does not meet the eBay requirements - GIF or + JPG file; maximum size of 50 KB. A nonprofit charity organization's logo is displayed in + item listings if the nonprofit charity organization is registered with eBay Giving + Works. A standard eBay Giving Works logo is used in place of the charity organization's + logo if the Logo URL is not provided. This value is returned if set. + + + + GetCharities + Conditionally + + + + + + + + <b>Deprecated.</b> This field will be removed from the schema + in a future release. Recommended to use IsFeaturedInSYI. + This boolean value should be set to true if an alternate logo URL should + be supplied by sellers using the eBay Sell Your Item flow. If this field + has not been set to true, it will return the default value of false. + + + + GetCharities + Conditionally + 659 + 672 + NoOp + FeaturedInSelling + --> + + + + + + + <b>Deprecated.</b> This field will be removed from the schema + in a future release. Recommended to use a combination of + IsFeaturedInXO/DisplayAtCheckout, based on the scenario. + Set this boolean value to true if the name of the nonprofit company should + be shown during checkout. If this field has not been set to true, + it will return the default value of false. If the user rolls their mouse + over the name of the nonprofit company, they will see the nonprofit company's + mission statement. + + + + + + + + + + + This field provides a short description about the nonprofit charity organization's + primary purpose. "I want to support" will be added to the beginning of the contents of + this field. For example, if the description is "the fight against cancer", then on the + checkout page "I want to support the fight against cancer" will be displayed. The + description may contain a maximum of 115 characters. This value is returned if set. + + + 4000 + + GetCharities + Conditionally + + + + + + + + This field must be used with the DisplayNameInCheckout field to control the options that are visible + to a buyer during checkout. If the + DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout + field is set to False, a checkbox with the one dollar option will be displayed during checkout. + If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout + field is set to False, no options will be displayed during checkout. + <br><br> + Reserved for future use. If the DisplayNameInCheckout field is set to True, and the + ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts + will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the + ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout, + but the multiple donation amount field will be set. + + + + + + + + + + + A unique identifier created and used by MissionFish to identify a registered nonprofit + charity organization. This field is only returned for charities that are registered with + MissionFish. + + + 4000 + + GetCharities + Conditionally + + + + + + + + + An integer value that indicates a nonprofit charity organization's popularity rank in + comparison with other registered eBay Giving Works organizations. This value is + determined and managed by MissionFish and is based on various factors. This value is + always returned for nonprofit organizations registered with eBay Giving Works. + + + + SetCharities + No + + + + + + + + This value is the Employer Identification Number (EIN) of the nonprofit charity + organization. A nonprofit company's EIN is used for tax purposes by the Internal + Revenue Service. This value is returned if the nonprofit organization has an EIN and + it has been set. + + + + SetCharities + No + + + + + + + + An alternative name for the nonprofit charity organization. This value is used by + PayPal to search for nonprofit organizations. This value is returned if set. + + + + SetCharities + No + + + + + + + + Container consisting of the address (including latitude and longitude) of a nonprofit + charity organization. This container is always returned if it is set. + + + + SetCharities + No + + + + + + + + Container consisting of the nonprofit charity organization's social networking site ID/handle. + A <b>NonProfitSocialAddress</b> container will exist for each social + networking site that the charity organization is associated with. Supported social + networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One + or more of these containers are returned if set. + + + + SetCharities + No + + + + + + + + + + This attribute is a unique identifier used by the corresponding social networking site to + identify the nonprofit charity organization. + + + + GetCharities + Conditionally + + + + + + + + + Type defining the <b>NonProfitSocialAddress</b> container, which identifies the + nonprofit organization's social networking site account ID. A <b>NonProfitSocialAddress</b> + container will exist for each social networking site that the charity organization is + associated with. + + + + + + + Enumeration value that indicates the social networking site that the nonprofit charity + organization is associated with. This is a required field for each social networking + account associated with the nonprofit organization. + + + 512 + + SetCharities + Yes + + + + + + + + The account ID/handle associated with the nonprofit charity organization's social + networking site. This is a required field for each social networking account associated + with the nonprofit organization. + + + 512 + + SetCharities + No + + + + + + + + + + Enumerated type that defines the social networking sites that are supported by eBay Giving + Works. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's Facebook account. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's Twitter account. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's LinkedIn account. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's Google+ account. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's MySpace account. + + + + + + + This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> + is associated with the nonprofit company's Orkut account. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Enumerated type defining the possible states for a seller's charity seller account. + + + RegisteredNoCreditCard, DirectDebitRejected + + + + + + + The seller's charity seller account is suspended. + + + + + + + The seller is a registered charity seller. + + + + + + + The seller is no longer a registered charity seller. The account with the eBay Giving Works provider is closed. + + + + + + + The credit card associated with a seller's charity seller account has expired. + + + + + + + The token associated with a seller's charity seller account has expired. + + + + + + + The credit card associated with a seller's charity seller account will expire in 15 (or fewer) days. + + + + + + + + + + + + + + The seller is no longer a registered charity seller and has lost direct seller status. + + + + + + + + + + + + + + The seller is a registered direct seller, but has no credit card associated with the charity seller account. + + + + + + + The seller is a registered charity seller with no donation payment method on file. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains information about one seller with a eBay Giving Works provider + charity seller account. + + + + + + + Indicates the status of the seller's charity seller account. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. + + + + + + + Indicates if the seller has accepted eBay GivingWorks Terms and Conditions. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type defining the possible states for a nonprofit charity organization registered with the dedicated eBay Giving Works provider. + + + + + + + (out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. + + + + + + + (out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Identifies a Giving Works listing and benefiting nonprofit charity organization. + + + + + + + The name of the benefiting nonprofit charity organization selected by the + charity seller. + + + 150 + + GetBidderList + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + A unique identifier assigned to a nonprofit + charity organization by the dedicated provider of + eBay Giving Works. This value can contain up to 10 digits. + This value is superseded by CharityID. + + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The percentage of the purchase price that the + seller chooses to donate to the selected nonprofit + organization. This percentage is displayed in the Giving + Works item listing. Possible values: 10.0 to 100.0. + Percentages must increment by 5.0. Minimum donation + percentages may be required for Giving Works listings, see + http://pages.ebay.com/help/sell/selling-nonprofit.html for + details. DonationPercent is required input when listing + Giving Works items. + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + A unique identification number assigned by eBay to + registered nonprofit charity organizations. Required input + when listing Giving Works items. + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The stated mission of the nonprofit charity + organization. This mission is displayed in the Giving Works + item listing. + + + 511 + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The URL of the nonprofit charity organization. This + URL is displayed in the Giving Works item listing. + + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + + + + + + The status of the nonprofit charity organization. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + If true, indicates that the seller has chosen to use + eBay Giving Works to donate a percentage of the item's + purchase price to a selected nonprofit organization. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + This type is deprecated as the 3rd Party Checkout is no longer available. + + + + + + + + This field is deprecated + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + Details of the order for a checked out cart. + + + + + + + + + + The total item cost of all items in the cart. + + + + + + + + The total shipping cost of all items in the cart. + + + + + + + The total tax for all items in the cart. + + + + + + + + The overall total cost (including item cost, shipping cost and taxes). + + + + + + + + + + + Enumerated type that lists the possible checkout states of an order line item. + + + + + + + This value indicates that the buyer has paid and checkout is complete. + + + + + + + This value indicates that checkout is incomplete, generally because the buyer has not paid yet. + + + + + + + This value indicates that the buyer wants to confirm the total price of the order line item before making a payment. + + + + + + + This value indicates that the seller has just responded to the buyer concerning the total price of the order line item. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>CheckoutStatus</b> container that is returned in + <b>GetOrders</b> and <b>GetOrderTransactions</b> to indicate + the current checkout status of the order. + + + + + + + This value indicates the payment status of an order. + <br><br> + Also applicable to Half.com orders (GetOrders only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + SoldReport + Always + + + + + + + + Indicates the last time that there was a change in value of the + <b>CheckoutStatus.Status</b> field, such as 'Pending' to 'Complete'. + <br><br> + This field is also applicable to Half.com orders (GetOrders only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + The payment method that the buyer selected to pay for the order. + <br> + <br> + This field is also applicable to Half.com orders (GetOrders only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + SoldReport + Always + + + + + + + + Indicates the status of the order. This value is subject to change based on the + status of the checkout flow. Generally speaking, the <b>Status</b> + field reads 'Incomplete' + when payment has yet to be initiated, 'Pending' when payment has been initiated + but is in process, and 'Complete' when the payment process has completed. + <br><br> + <b>Note</b>: If the PaymentMethod is CashOnPickup, the Status value + will read Complete right at Checkout, even though the seller may not have been + officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. + The CheckoutStatus.Status value will remain as Complete even if the seller uses + ReviseCheckoutStatus to change the checkout status to Pending. However, the + eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to + PaymentInProcess. + <br><br> + This field is also applicable to Half.com orders (GetOrders only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + SoldReport + Always + + + + + + + + Indicates whether the item can be paid for through a payment gateway (Payflow) account. + If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is + enabled for credit cards because the seller has a payment gateway account. + Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or + VisaMC is returned for an item, then on checkout, an online credit-card payment + is processed through a payment gateway account. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + This container is no longer used. + + + + + + + + + The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the <b>PaymentMethod</b> field. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>ClassifiedAdAutoAcceptEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'ClassifiedAdAutoAcceptEnabled' or 'ClassifiedAdAutoDeclineEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Classified Ad Auto Accept feature. + <br/><br/> + To verify if a specific eBay site supports the Classified Ad Auto Accept feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.ClassifiedAdAutoAcceptEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Classified Ad Auto Accept feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>ClassifiedAdAutoAcceptEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>ClassifiedAdAutoDeclineEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'ClassifiedAdAutoDeclineEnabled' or 'ClassifiedAdAutoAcceptEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Classified Ad Auto Decline feature. + <br/><br/> + To verify if a specific eBay site supports the Classified Ad Auto Decline feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.ClassifiedAdAutoDeclineEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Classified Ad Auto Decline feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>ClassifiedAdAutoDeclineEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Enumerated type that defines the values used to indicate whether Best Offers for the Classified Ad listing format are enabled/disabled for all/most of a site's categories (<b>SiteDefaults.ClassifiedAdBestOfferEnabled</b>), or enabled/required/disabled for a specific eBay category (<b>Category.ClassifiedAdBestOfferEnabled</b>). + + + + + + + This value indicates that Classified Ad Best Offer feature is disabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field), or disabled for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field). + + + + + + + This value indicates that Classified Ad Best Offer feature is enabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field), or enabled for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field). + + + + + + + This value indicates that Classified Ad Best Offer feature is required for a specific category (if returned in the <b>Category.ClassifiedAdBestOfferEnabled</b> field). This value is not applicable at the site level (<b>SiteDefaults</b> container). + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>ClassifiedAdBestOfferEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'ClassifiedAdBestOfferEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Classified Ad Best Offer feature. + <br/><br/> + To verify if a specific eBay site supports the Classified Ad Best Offer feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Classified Ad Best Offer feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>ClassifiedAdBestOfferEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Indicates whether the category supports the use of a company name + when contacting the seller for Classified Ad format listings. + Added for the For Sale By Owner format. + + + + + + + + + + + Indicates whether the category supports the use of an address when + contacting the seller for Classified Ad format listings. + Added for the For Sale By Owner format. + + + + + + + + + + + Indicates if Email can be a contact method for the category + + + + + + + + + + + Indicates whether the telephone can be a contact method for the category. + + + + + + + + + + + Type defining the <b>ClassifiedAdCounterOfferEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'ClassifiedAdCounterOfferEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the Classified Ad Best Offer Counter Offer feature. + <br/><br/> + To verify if a specific eBay site supports the Classified Ad Best Offer Counter Offer feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.ClassifiedAdCounterOfferEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Classified Ad Best Offer Counter Offer feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>ClassifiedAdCounterOfferEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Defines the pay-per-lead feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Used to indicate whether the payment method will be displayed for a category + belonging to the Lead Generation Format. + + + + + + + Display the payment method and permit checkout. + + + + + + + Display the payment method and suppress checkout. + + + + + + + Do not display the payment method. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates whether Contact Seller is enabled Classified Ads. + + + + + + + + + + + Indicates which phone option the category supports for contacting + the seller for Classified Ad format listings. + Added for the For Sale By Owner format. + + + + + + + + + + + Indicates whether shipping options are available for the category. + + + + + + + + + + + Indicates which address option the category supports for + Classified Ad format listings. + Added for the For Sale By Owner format. + + + + + + + + + + + Defines the Combined Fixed Price Treatment feature. If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Enumerated type that defines the seller's preference for allowing + <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + orders that pass on a shipping discounts to the buyer. + + + + + + + This value indicates that the seller does not allow Combined Invoice orders. In + other words, the buyer must pay for each order line item separately, and cannot + combine multiple single line item orders into one Combined Invoice order and make + one payment for that order. + + + + + + + This value indicates that the seller allows Combined Invoice orders, and that the + seller has one or more shipping discount rules (Flat, Calculated, or Promotional) + that can be applied at the listing level. + + + + + + + This value indicates that the seller allows Combined Invoice orders, and that the + seller will apply any shipping discounts after the creation of the Combined Invoice + order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This enumerated type contains the list of values that can be used by the seller to set + the number of days after item purchase that an unpaid order can be combined with one + or more other mutual (same buyer and same seller) unpaid orders into one + <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + order. Either the buyer or the seller can initiate the Combined Invoice + process. Sellers can offer buyers shipping discounts through Combined Invoice orders, + and buyers only have to make one payment for multiple orders as opposed to a payment + for each order. + + + + + + + This value indicates that an unpaid order can be combined into a Combined Invoice + order within three days after purchase (creation of order). + + + + + + + This value indicates that an unpaid order can be combined into a Combined Invoice + order within five days after purchase (creation of order). + + + + + + + This value indicates that an unpaid order can be combined into a Combined Invoice + order within seven days after purchase (creation of order). + + + + + + + This value indicates that an unpaid order can be combined into a Combined Invoice + order within 14 days after purchase (creation of order). + + + + + + + This value indicates that an unpaid order can be combined into a Combined Invoice + order within 30 days after purchase (creation of order). + + + + + + + This value indicates that an order is not eligible to be combined into a Combined + Payment order. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Type used to define all combined payment preferences, including preferences and + rules for Calculated and Flat Rate shipping, a flag to allow or disallow <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + orders, and the time period in which to allow buyers to combine multiple + purchases from the seller into a Combined Invoice order. + + + + + + + DO NOT USE THIS CONTAINER. As an alternative, use + SetShippingDiscountProfiles to set all Calculated Shipping rules and + preferences, and use GetShippingDiscountProfiles to retrieve the same + information. + + + + + + + + + Specifies whether or not a seller wants to allow buyers to combine single + order line items into a Combined Invoice order. A Combined Invoice order can + be created by the buyer or seller if multiple unpaid order line items exist + between the same buyer and seller. Often, a Combined Invoice order can + reduce shipping and handling expenses for the buyer and seller. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + DO NOT USE THIS FIELD. As an alternative, use the CombinedDuration field in + SetShippingDiscountProfiles to specify the time period in which to allow + buyers to combine order line items into a Combined Invoice order. Use + GetShippingDiscountProfiles to retrieve the CombinedDuration value. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + DO NOT USE THIS CONTAINER. As an alternative, use + SetShippingDiscountProfiles to set all Flat Rate Shipping rules + and preferences, and use GetShippingDiscountProfiles to retrieve + the same information. + + + + + + + + + + + + + This enumerated type list the Feedback ratings that can be left by one eBay user for + another user regarding that user's experience with the another user during the + purchase/checkout flow of an order line item. + + + + + + + This value indicates that the submitting user's experience with the other user + (receiving feedback) was rated as a "Positive" experience. If an eBay user receives + a Positive rating for an order line item from a Verified User, their overall + Feedback score increases by a value of 1. + + + + + + + This value indicates that the submitting user's experience with the other user + (receiving feedback) was rated as a "Neutral" experience. If an eBay user receives + a Neutral rating for an order line item from a Verified User, their overall + Feedback score remains the same. + + + + + + + This value indicates that the submitting user's experience with the other user + (receiving feedback) was rated as a "Negative" experience. If an eBay user receives + a Negative rating for an order line item from a Verified User, their overall + Feedback score decreases by a value of 1. + + + + + + + This value indicates that a submitted Feedback entry was withdrawn. If a Feedback + entry is withdrawn, the effect of that entry on the overall Feedback score is + nullified. However, Feedback comments from the withdrawn entry are still visible. + + + + + + + This value indicates that a submitted Feedback entry was withdrawn based on the + decision of a third-party (such as eBay). If a Feedback + entry is withdrawn, the effect of that entry on the overall Feedback score is + nullified. + <br><br> + This value is only applicable to the eBay Motors site only. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Defines the vehicle type to which parts compatibility applies. If the field is + present, the corresponding feature applies to the site. The field is returned as an + empty element (e.g., a boolean value is not returned). + + + + + + + + + + + Indicates whether the order is complete, incomplete, or pending. + + + + + + + The order is incomplete. Generally speaking, an order is incomplete when payment + from the buyer has yet to be initiated. + + + + + + + The order is complete. Generally speaking, an order is complete when payment + from the buyer has been initiated and processed. + <br><br> + <b>Note</b>: If the <b>PaymentMethodUsed</b> is 'CashOnPickup', + the <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will be + 'Complete' right at Checkout, even though the seller may not have been officially paid + yet. The <b>CheckoutStatus.Status</b> value in <b>GetOrders</b> will + remain as 'Complete' even if the seller uses <b>ReviseCheckoutStatus</b> to + change the checkout status to Pending. However, the <b>eBayPaymentStatus</b> + value in <b>GetOrders</b> will change from 'NoPaymentFailure' to + 'PaymentInProcess'. + + + + + + + The order is pending. Generally speaking, an order is pending when payment + from the buyer has been initiated but has yet to be fully processed. + <br><br> + <b>Note</b>: If the PaymentMethod is CashOnPickup, the + CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, + even though the seller may not have been officially paid yet. The + CheckoutStatus.Status value in GetOrders will remain as Complete even if the + seller uses ReviseCheckoutStatus to change the checkout status to Pending. + However, the eBayPaymentStatus value in GetOrders will change from + NoPaymentFailure to PaymentInProcess. + + + + + + + Reserved for internal or future use + + + + + + + + + + Enumerated type that defines the values used to indicate whether Condition IDs are enabled/disabled for all/most of a site's categories (<b>SiteDefaults.ConditionEnabled</b>), or enabled/required/disabled for a specific eBay category (<b>Category.ConditionEnabled</b>). + + + + + + + This value indicates that Condition IDs are disabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ConditionEnabled</b> field), or disabled for a specific category (if returned in the <b>Category.ConditionEnabled</b> field). + + + + + + + This value indicates that Condition IDs are enabled for all/most of a site's categories (if returned in the <b>SiteDefaults.ConditionEnabled</b> field), or enabled for a specific category (if returned in the <b>Category.ConditionEnabled</b> field). + + + + + + + This value indicates that Condition IDs are required for a specific category (if returned in the <b>Category.ConditionEnabled</b> field). This value is not applicable at the site level (<b>SiteDefaults</b> container). + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>ConditionEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'ConditionEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support the use of Condition IDs to express the condition of an item. + <br/><br/> + To verify if a specific eBay site supports Condition IDs (for most + categories), look for a 'Enabled' value in the + <b>SiteDefaults.ConditionEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Condition IDs, pass in a <b>CategoryID</b> value in the request, and then + look for an 'Enabled' or 'Required' value in the <b>ConditionEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>ConditionValues.Condition</b> container that is returned at the category level in the <b>GetCategoryFeatures</b> response if 'ConditionValues' is specified as a <b>FeatureID</b> value, or if no <b>FeatureID</b> values are specified. A <b>ConditionValues.Condition</b> container is returned for each supported item condition value for each eBay category returned in the response. + + + + + + + The numeric ID of a condition (e.g., 1000). Use the ID in + AddItem and related calls. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The human-readable label for the condition (e.g., "New"). + This value is typically localized for each site. + The display name can vary by category. + For example, condition ID 1000 could be called + "New: with Tags" in one category and "Brand New" in another. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Defines the Item Condition feature. If a field of this type is present, + the corresponding feature applies to the site. The field is returned as + an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + Fields in this type provide condition values and display names. + + + + + + + Defines an item condition that a category supports. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + URL to the eBay Web site's item condition help for the + category. This may include policies about how to assess the + condition of an item in the category. To reduce + item-not-as-described disputes, we recommend that + you refer sellers (and buyers) to these help pages. + These help pages may vary for some categories.<br> + <br> + The Sandbox might not return valid help URLs. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>ContactHoursDetails</b> container, which is used in Add/Revise/Relist calls to provide contact hours for the owner of a Classified Ad. The <b>ContactHoursDetails</b> container is only applicable to Classified Ad listings. + + + + + + + Indicates the local time zone of the values provided for Hours1From/Hours1To + and Hours2From/Hours2To. If you specify a contact hours time range with + Hours1From and Hours1To, you must provide a local time zone. + To retrieve a complete list of the TimeZoneID values + supported by eBay, call <b>GeteBayDetails</b> with <b>DetailName</b> + set to <b>TimeZoneDetails</b>. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the range of days for which the primary contact hours + specified by Hours1AnyTime or Hours1From and Hours1To apply. + If a value of None is provided for this field, the values provided for + Hours1AnyTime, Hours1From, Hours1To are ignored. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not a user is available to be contacted 24 hours a day + during the range of days specified using the Hours1Days element. + True indicates the user is available 24 hours a day, false indicates otherwise. + In the case of this field being true, all values provided for Hours1From and + Hours1To will be ignored. In the case of this field being false, + the values provided Hours1From and Hours1To will be considered. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the starting time of day this eBay user is available for other eBay + members to contact for the range of days specified using Hours1Days. + Enter times in 30 minute increments from the top of the hour. That is, enter + values either on the hour (:00) or 30 minutes past the hour (:30). + Other values will be will be rounded down to the next closest 30 minute + increment. Times entered should be local to the value provided for TimeZoneID. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the ending time of day this eBay user is available for other eBay + members to contact them for the range of days specified using Hours1Days. + Enter times in 30 minute increments from the top of the hour. That is, enter + values either on the hour (:00) or 30 minutes past the hour (:30). + Other values will be will be rounded down to the next closest 30 minute + increment. Times entered should be local to the value provided for TimeZoneID. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the range of days for which the secondary contact hours + specified by Hours2AnyTime or Hours2From and Hours2To apply. + If a value of None is provided for this field, the values provided for + Hours2AnyTime, Hours2From, Hours2To are ignored. + <br> + <b>Note:</b> You cannot set Hours2Days to EveryDay. If Hours1Days + is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be + set to the same value as Hours1Days. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not a user is available to be contacted 24 hours a day + during the range of days specified using the Hours2Days element. + True indicates the user is available 24 hours a day, false indicates otherwise. + In the case of this field being true, all values provided for Hours2From and + Hours2To will be ignored. In the case of this field being false, + the values provided Hours2From and Hours2To will be considered. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the starting time of day this eBay user is available for other eBay + members to contact for the range of days specified using Hours2Days. + Enter times in 30 minute increments from the top of the hour. That is, enter + values either on the hour (:00) or 30 minutes past the hour (:30). + Other values will be will be rounded down to the next closest 30 minute + increment. Times entered should be local to the value provided for TimeZoneID. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the ending time of day this eBay user is available for other eBay + members to contact them for the range of days specified using Hours1Days. + Enter times in 30 minute increments from the top of the hour. That is, enter + values either on the hour (:00) or 30 minutes past the hour (:30). + Other values will be will be rounded down to the next closest 30 minute + increment. Times entered should be local to the value provided for TimeZoneID. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>ContextSearchAsset</b> container that is returned in the <b>GetContextualKeywords</b> response for each keyword that is found. + + + + + + + The name of the keyword that was found in the search. + + + 64 + + GetContextualKeywords + Always + + + + + + + + The eBay category in which the keyword is used. + + + + GetContextualKeywords + Always + + + + + + + + The ranking of the corresponding keyword/category combination relative to + other keywords that were returned in the response. + + + 1 + 2147483647 + + GetContextualKeywords + Always + + + + + + + + + + + This enumerated type is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + This value is not used. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This enumerated type contains a partial list of ISO 3166 standard two-letter codes that represent countries around the world. + <br><br> + It is recommended that users use the <b>GeteBayDetails</b> call to see the full list of currently supported country codes, + and the English names associated with each code (e.g., KY="Cayman Islands"). Call + <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>Country</b>, and then look for <b>CountryDetails.Country</b> fields in the response. + + + QP + + + + + + + Afghanistan. + + + + + + + Albania. + + + + + + + Algeria. + + + + + + + American Samoa. + + + + + + + Andorra. + + + + + + + Angola. + + + + + + + Anguilla. + + + + + + + Antarctica. + + + + + + + Antigua and Barbuda. + + + + + + + Argentina. + + + + + + + Armenia. + + + + + + + Aruba. + + + + + + + Australia. + + + + + + + Austria. + + + + + + + Azerbaijan. + + + + + + + Bahamas. + + + + + + + Bahrain. + + + + + + + Bangladesh. + + + + + + + Barbados. + + + + + + + Belarus. + + + + + + + Belgium. + + + + + + + Belize. + + + + + + + Benin. + + + + + + + Bermuda. + + + + + + + Bhutan. + + + + + + + Bolivia. + + + + + + + Bosnia and Herzegovina. + + + + + + + Botswana. + + + + + + + Bouvet Island. + + + + + + + Brazil. + + + + + + + British Indian Ocean Territory. + + + + + + + Brunei Darussalam. + + + + + + + Bulgaria. + + + + + + + Burkina Faso. + + + + + + + Burundi. + + + + + + + Cambodia. + + + + + + + Cameroon. + + + + + + + Canada. + + + + + + + Cape Verde. + + + + + + + Cayman Islands. + + + + + + + Central African Republic. + + + + + + + Chad. + + + + + + + Chile. + + + + + + + China. + + + + + + + Christmas Island. + + + + + + + Cocos (Keeling) Islands. + + + + + + + Colombia. + + + + + + + Comoros. + + + + + + + Congo. + + + + + + + Congo, The Democratic Republic of the. + + + + + + + Cook Islands. + + + + + + + Costa Rica. + + + + + + + Cote d'Ivoire. + + + + + + + Croatia. + + + + + + + Cuba. + + + + + + + Cyprus. + + + + + + + Czech Republic. + + + + + + + Denmark. + + + + + + + Djibouti. + + + + + + + Dominica. + + + + + + + Dominican Republic. + + + + + + + No longer in use. + + + + + + + Ecuador. + + + + + + + Egypt. + + + + + + + El Salvador. + + + + + + + Equatorial Guinea. + + + + + + + Eritrea. + + + + + + + Estonia. + + + + + + + Ethiopia. + + + + + + + Falkland Islands (Malvinas). + + + + + + + Faroe Islands. + + + + + + + Fiji. + + + + + + + Finland. + + + + + + + France. + + + + + + + French Guiana. + + + + + + + French Polynesia. Includes Tahiti. + + + + + + + French Southern Territories. + + + + + + + Gabon. + + + + + + + Gambia. + + + + + + + Georgia. + + + + + + + Germany. + + + + + + + Ghana. + + + + + + + Gibraltar. + + + + + + + Greece. + + + + + + + Greenland. + + + + + + + Grenada. + + + + + + + Guadeloupe. + + + + + + + Guam. + + + + + + + Guatemala. + + + + + + + Guinea. + + + + + + + Guinea-Bissau. + + + + + + + Guyana. + + + + + + + Haiti. + + + + + + + Heard Island and McDonald Islands. + + + + + + + Holy See (Vatican City state). + + + + + + + Honduras. + + + + + + + Hong Kong. + + + + + + + Hungary. + + + + + + + Iceland. + + + + + + + India. + + + + + + + Indonesia. + + + + + + + Islamic Republic of Iran. + + + + + + + Iraq. + + + + + + + Ireland. + + + + + + + Israel. + + + + + + + Italy. + + + + + + + Jamaica. + + + + + + + Japan. + + + + + + + Jordan. + + + + + + + Kazakhstan. + + + + + + + Kenya. + + + + + + + Kiribati. + + + + + + + Democratic People's Republic of Korea. + + + + + + + Republic of Korea. + + + + + + + Kuwait. + + + + + + + Kyrgyzstan. + + + + + + + Lao People's Democratic Republic. + + + + + + + Latvia. + + + + + + + Lebanon. + + + + + + + Lesotho. + + + + + + + Liberia. + + + + + + + Libyan Arab Jamahiriya. + + + + + + + Liechtenstein. + + + + + + + Lithuania. + + + + + + + Luxembourg. + + + + + + + Macao. + + + + + + + The Former Yugoslav Republic of Macedonia. + + + + + + + Madagascar. + + + + + + + Malawi. + + + + + + + Malaysia. + + + + + + + Maldives. + + + + + + + Mali. + + + + + + + Malta. + + + + + + + Marshall Islands. + + + + + + + Martinique. + + + + + + + Mauritania. + + + + + + + Mauritius. + + + + + + + Mayotte. + + + + + + + Mexico. + + + + + + + Federated States of Micronesia. + + + + + + + Republic of Moldova. + + + + + + + Monaco. + + + + + + + Mongolia. + + + + + + + Montserrat. + + + + + + + Morocco. + + + + + + + Mozambique. + + + + + + + Myanmar. + + + + + + + Namibia. + + + + + + + Nauru. + + + + + + + Nepal. + + + + + + + Netherlands. + + + + + + + Netherlands Antilles. + + + + + + + New Caledonia. + + + + + + + New Zealand. + + + + + + + Nicaragua. + + + + + + + Niger. + + + + + + + Nigeria. + + + + + + + Niue. + + + + + + + Norfolk Island. + + + + + + + Northern Mariana Islands. + + + + + + + Norway. + + + + + + + Oman. + + + + + + + Pakistan. + + + + + + + Palau. + + + + + + + Palestinian territory, Occupied. + + + + + + + Panama. + + + + + + + Papua New Guinea. + + + + + + + Paraguay. + + + + + + + Peru. + + + + + + + Philippines. + + + + + + + Pitcairn. + + + + + + + Poland. + + + + + + + Portugal. + + + + + + + Puerto Rico. + + + + + + + Qatar. + + + + + + + Reunion. + + + + + + + Romania. + + + + + + + Russian Federation. + + + + + + + Rwanda. + + + + + + + Saint Helena. + + + + + + + Saint Kitts and Nevis. + + + + + + + Saint Lucia. + + + + + + + Saint Pierre and Miquelon. + + + + + + + Saint Vincent and the Grenadines. + + + + + + + Samoa. + + + + + + + San Marino. + + + + + + + Sao Tome and Principe. + + + + + + + Saudi Arabia. + + + + + + + Senegal. + + + + + + + Seychelles. + + + + + + + Sierra Leone. + + + + + + + Singapore. + + + + + + + Slovakia. + + + + + + + Slovenia. + + + + + + + Solomon Islands. + + + + + + + Somalia. + + + + + + + South Africa. + + + + + + + South Georgia and the South Sandwich Islands. + + + + + + + Spain. + + + + + + + Sri Lanka. + + + + + + + Sudan. + + + + + + + Suriname. + + + + + + + Svalbard and Jan Mayen. + + + + + + + Swaziland. + + + + + + + Sweden. + + + + + + + Switzerland. + + + + + + + Syrian Arab Republic. + + + + + + + Taiwan, Province of China. + + + + + + + Tajikistan. + + + + + + + Tanzania, United Republic of. + + + + + + + Thailand. + + + + + + + Togo. + + + + + + + Tokelau. + + + + + + + Tonga. + + + + + + + Trinidad and Tobago. + + + + + + + Tunisia. + + + + + + + Turkey. + + + + + + + Turkmenistan. + + + + + + + Turks and Caicos Islands. + + + + + + + Tuvalu. + + + + + + + Uganda. + + + + + + + Ukraine. + + + + + + + United Arab Emirates. + + + + + + + United Kingdom. + + + + + + + United States. + + + + + + + NOTE: United States Minor Outlying Islands was + defined in the eBay list previously + but is no longer a viable option. This country + will remain on eBay country list for backward + compatibility. Use 'US' instead. + + + + + + + Uruguay. + + + + + + + Uzbekistan. + + + + + + + Vanuatu. + + + + + + + Venezuela. + + + + + + + Vietnam. + + + + + + + Virgin Islands, British. + + + + + + + Virgin Islands, U.S. + + + + + + + Wallis and Futuna. + + + + + + + Western Sahara. + + + + + + + Yemen. + + + + + + + No longer in use. See RS for Serbia and ME for Montenegro. + + + + + + + Zambia. + + + + + + + Zimbabwe. + + + + + + + NOTE: APO/FPO was defined in eBay list previously + but they are not defined in ISO 3166. This country + will remain on eBay country code list for backward + compatibility. + + + + + + + NOTE : Guernsey was defined in eBay list previously + but they are not defined in ISO 3166. This country + will remain on eBay country list for backward + compatibility. + + + + + + + NOTE: Jan Mayen was defined in eBay list previously + but they are not defined in ISO 3166. This country + will remain on eBay country list for backward + compatibility. + + + + + + + NOTE: Jersey was defined in eBay list previously + but they are not defined in ISO 3166. This country + will remain on eBay country list for backward + compatibility. + + + + + + + + + + + + + + Jersey + + + + + + + Guernsey + + + + + + + Unknown country + + + + + + + Serbia + + + + + + + Montenegro. + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + Details about a specific country. + + + + + + + Two-letter code representing a country. These two-letter codes are typically used + in Add/Revise/Relist calls when referring to a country.<br><br> + + + + Item.Country in AddItem + AddItem.html#Request.Item.Country + + + GeteBayDetails + Conditionally + + + + + + + + Full country name for display purposes. May be similar to (but not necessarily identical to) + CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser). + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be used to + determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. This timestamp can be used to + determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Type defining the <b>CrossBorderTradeAustraliaEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support Cross Border Trade listings on the eBay Australia site. + <br/><br/> + To verify if a specific eBay site supports Cross Border Trade listings on the eBay Australia site (for most + categories), look for a 'true' value in the + <b>SiteDefaults.CrossBorderTradeAustraliaEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay Australia site, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>CrossBorderTradeAustraliaEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>CrossBorderTradeGBEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support Cross Border Trade listings on the eBay UK and eBay Ireland sites. + <br/><br/> + To verify if a specific eBay site supports Cross Border Trade listings on the eBay UK and eBay Ireland sites (for most + categories), look for a 'true' value in the + <b>SiteDefaults.CrossBorderTradeGBEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay UK and eBay Ireland sites, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>CrossBorderTradeGBEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Type defining the <b>CrossBorderTradeNorthAmericaEnabled</b> field that is + returned under the <b>FeatureDefinitions</b> container of the + <b>GetCategoryFeatures</b> response (as long as + 'CrossBorderTradeEnabled' is included as a <b>FeatureID</b> value in + the call request or no <b>FeatureID</b> values are passed into the call + request). This field is returned as an + empty element (a boolean value is not returned) if one or more eBay API-enabled sites + support Cross Border Trade listings on the eBay US and eBay Canada sites. + <br/><br/> + To verify if a specific eBay site supports Cross Border Trade listings on the eBay US and eBay Canada sites (for most + categories), look for a 'true' value in the + <b>SiteDefaults.CrossBorderTradeNorthAmericaEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Cross Border Trade listings on the eBay US and eBay Canada sites, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>CrossBorderTradeNorthAmericaEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + + + + + + + + Contains preferences describing how items similar to the one the user is + presently viewing are promoted. + <br><br> + <span class="tablenote"><b>Note:</b> + eBay Store Cross Promotions are no longer supported in the Trading API, so the + <b>CrossPromotionPreferences</b> container and the + <b>ShowCrossPromotionPreferences</b> flag (in + <b>GetUserPreferences</b>) should no longer be used/set. + </span> + + + + + + + (For eBay store owners only) + Specifies whether cross-promotions are enabled for the seller's listings. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies which items should be shown + in cross-sell promotions (such as Buy It Now) and + in which sequence. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies whether to display only items with + gallery images and whether they should precede other items in cross-sell + promotions. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies how to sort items displayed in + a cross-sell promotion. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies which items (such as Buy It Now) should be shown in upsell promotions and in which + sequence. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies whether to display only items with + gallery images in upsell promotions and whether they should precede other items. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay store owners only) Specifies how to sort items used in an upsell promotion. + <br><br> + <span class="tablenote"><b>Note:</b> + This field should no longer be used as eBay Store Cross Promotions are no + longer supported in the Trading API. + </span> + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + eBay Store Cross Promotions are no longer supported in the Trading API, so the + <b>CrossPromotion</b> container will either not be returned, or, if it is + returned, the data in the container may not be accurate. Contains one or + more items cross-promoted with the display or purchase of a referring item. + + + + + + + Unique item ID for the referring item. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Always + + + + + + + + The primary cross-promotion rule scheme that + was applied to return the cross-promoted item. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Always + + + + + + + + The type of promotion, CrossSell or UpSell. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Always + + + + + + + + The eBay user ID of the seller offering the + cross-promoted item. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Always + + + + + + + + Whether a shipping discount is offered by the seller + when the cross-promoted item is purchased. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Always + + + + + + + + The store name of the seller offering the cross-promoted item. + + + + GetCrossPromotions + + + Conditionally + + + + + + + + Contains one cross-promoted item. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetCrossPromotions + Conditionally + + + + + + + + + + + + This enumeration type contains a list of standard 3-digit ISO 4217 currency codes for + currency used in countries around the world. + <br/><br/> + When adding an item through <b>AddItem</b> (or related API call), the + <b>Item.Currency</b> value will default to the currency used on the listing + site. Otherwise, only the following currency types may be specified through an + Add/Revise/Relist call, since these are the currencies of all the countries where + the Trading API is supported: + <ul> + <li>USD - US Dollar</li> + <li>CAD - Canadian Dollar</li> + <li>GBP - British Pound</li> + <li>AUD - Australian Dollar</li> + <li>EUR - Euro</li> + <li>CHF - Swiss Franc</li> + <li>CNY - Chinese Renminbi</li> + <li>HKD - Hong Kong Dollar</li> + <li>PHP - Philippines Peso</li> + <li>PLN - Polish Zloty</li> + <li>SEK - Sweden Krona</li> + <li>SGD - Singapore Dollar</li> + <li>TWD - Taiwanese Dollar</li> + <li>INR - Indian Rupee</li> + <li>MYR - Malaysian Ringgit</li> + </ul> + <br/> + Other currency codes in this enumerated type may be returned in + <b>GetItem</b> (and other calls) based on the buyer's and/or seller's + registration country. However, only the values listed above will be returned if you + call <b>GeteBayDetails</b> with <b>DetailName</b> set to + <b>CurrencyDetails</b>. + http://www.xe.com/iso4217.htm + + + + + + + This value is a 3-digit code for an Afghan afghani, a currency used in Afghanistan. + + + + + + + This value is a 3-digit code for an Albanian lek, a currency used in Albania. + + + + + + + This value is a 3-digit code for an Algerian dinar, a currency used in Algeria. + + + + + + + This value is a 3-digit code for an Andorran peseta, a currency used in Andorra. + + + + + + + This value is a 3-digit code for an Angolan kwanza, a currency used in Angola. + + + + + + + This value is a 3-digit code for an Argentine peso, a currency used in Argentina. + + + + + + + This value is a 3-digit code for an Armenian dram, a currency used in Armenia. + + + + + + + This value is a 3-digit code for an Aruban florin, a currency used in Aruba. + + + + + + + This value is a 3-digit code for an Azerbaijani manat, a currency used in Azerbaijan. + + + + + + + This value is a 3-digit code for a Bahamian dollar, a currency used in the Bahamas. + + + + + + + This value is a 3-digit code for a Bahraini dinar, a currency used in the Bahrain. + + + + + + + This value is a 3-digit code for a Bangladeshi taka, a currency used in Bangladesh. + + + + + + + This value is a 3-digit code for a Barbados dollar, a currency used in Barbados. + + + + + + + This value is a 3-digit code for a Belarusian ruble, a currency used in Belarus. + + + + + + + This value is a 3-digit code for a Belize dollar, a currency used in Belize. + + + + + + + This value is a 3-digit code for a Bermudian dollar, a currency used in Bermuda. + + + + + + + This value is a 3-digit code for a Bhutanese ngultrum, a currency used in Bhutan. + + + + + + + This value is a 3-digit code for an Indian rupee, a currency used in India. This is + the value that should be passed in the <b>Item.Currency</b> field by the + seller when listing an item on the eBay India site (Site ID 203). + + + + + + + This value is a 3-digit code for a Bolivian Mvdol, a currency used in Bolivia. + + + + + + + This value is a 3-digit code for a Boliviano, a currency used in Bolivia. + + + + + + + This value is a 3-digit code for a Bosnia and Herzegovina convertible mark, a + currency used in Bosnia and Herzegovina. + + + + + + + This value is a 3-digit code for a Botswana pula, a currency used in Botswana. + + + + + + + This value is a 3-digit code for a Brazilian real, a currency used in Brazil. + + + + + + + This value is a 3-digit code for a Brunei dollar, a currency used in Brunei and + Singapore. + + + + + + + This value is a 3-digit code for the old Bulgarian lev, a currency previously used + in Bulgaria. This currency has been replaced by the new Bulgarian lev (3-digit + code: BGN). + + + + + + + This value is a 3-digit code for a Bulgarian lev, a currency used in Bulgaria. This + currency replaced the old Bulgarian lev (3-digit code: BGL). + + + + + + + This value is a 3-digit code for a Burundian franc, a currency used in Burundi. + + + + + + + This value is a 3-digit code for a Cambodian riel, a currency used in Cambodia. + + + + + + + This value is a 3-digit code for a Canadian dollar, a currency used in Canada. This is + the value that should be passed in the <b>Item.Currency</b> field by the + seller when listing an item on the eBay Canada site (Site ID 2). Note that items + listed on the Canada site can also specify 'USD'. + + + + + + + This value is a 3-digit code for a Cape Verde escudo, a currency used in Cape + Verde. + + + + + + + This value is a 3-digit code for a Cayman Islands dollar, a currency used in + the Cayman Islands. + + + + + + + This value is a 3-digit code for a Central African CFA franc, a currency used in + Cameroon, Central African Republic, Republic of the Congo, Chad, Equatorial + Guinea, and Gabon. + + + + + + + This value is a 3-digit code for a Unidad de Fomento, a currency used in Chile. + + + + + + + This value is a 3-digit code for a Chilean peso, a currency used in Chile. + + + + + + + This value is a 3-digit code for a Chinese yuan (also known as the renminbi), a + currency used in China. + + + + + + + This value is a 3-digit code for a Columbian peso, a currency used in Columbia. + + + + + + + This value is a 3-digit code for a Comoro franc, a currency used in Comoros. + + + + + + + This value is a 3-digit code for a Congolese franc, a currency used in Democratic + Republic of Congo. + + + + + + + This value is a 3-digit code for a Costa Rican colon, a currency used in Costa + Rica. + + + + + + + This value is a 3-digit code for a Croatian kuna, a currency used in Croatia. + + + + + + + This value is a 3-digit code for a Cuban peso, a currency used in Cuba. + + + + + + + This value is a 3-digit code for a Cypriot pound, a currency previously used in + Cyprus. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + This value is a 3-digit code for a Czech koruna, a currency used in the Czech + Republic. + + + + + + + This value is a 3-digit code for a Danish krone, a currency used in Denmark, + the Faroe Islands, and Greenland. + + + + + + + This value is a 3-digit code for a Djiboutian franc, a currency used in Djibouti. + + + + + + + This value is a 3-digit code for a Dominican peso, a currency used in the Dominican + Republic. + + + + + + + This value is a 3-digit code for a Portuguese Timorese escudo, a currency + previously used in Portuguese Timor. + + + + + + + This value is an old 3-digit code for a Cape Verde escudo, a currency used in + Cape Verde. The 'ECV' code has been replaced by 'CVE'. + + + + + + + This value is a 3-digit code for an Ecuadorian sucre, a currency previously used in + Ecuador. This currency has been replaced by the US Dollar (3-digit code: USD). + + + + + + + This value is a 3-digit code for an Egyptian pound, a currency used in Egypt. + + + + + + + This value is a 3-digit code for a Salvadoran colon, a currency previously used in + El Salvador. This currency has been replaced by the US Dollar (3-digit code: USD). + + + + + + + This value is a 3-digit code for an Eritrean nakfa, a currency used in Eritrea. + + + + + + + This value is a 3-digit code for an Estonian kroon, a currency previously used in + Estonia. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + This value is a 3-digit code for an Ethiopian birr, a currency used in Ethiopia. + + + + + + + This value is a 3-digit code for a Falkland Islands pound, a currency used in + the Falkland Islands. + + + + + + + This value is a 3-digit code for a Fiji dollar, a currency used in Fiji. + + + + + + + This value is a 3-digit code for a Gambian dalasi, a currency used in Gambia. + + + + + + + This value is a 3-digit code for a Georgian Iari, a currency used in the country of + Georgia. + + + + + + + This value is an old 3-digit code for a Ghanaian cedi, a currency used in Ghana. + The 'GHC' code has been replaced by 'GHS'. + + + + + + + This value is a 3-digit code for a Gibraltar pound, a currency used in Gibraltar. + + + + + + + This value is a 3-digit code for a Guatemalan quetzal, a currency used in + Guatemala. + + + + + + + This value is a 3-digit code for a Guinean franc, a currency used in Guinea. + + + + + + + This value is a 3-digit code for a Guinea-Bissau peso, a currency previously used + in Guinea-Bissau. This currency has been replaced by the West African CFA franc + (3-digit code: XOF). + + + + + + + This value is a 3-digit code for a Guyanese dollar, a currency used in Guyana. + + + + + + + This value is a 3-digit code for a Haitian gourde, a currency used in Haiti. + + + + + + + This value is a 3-digit code for a Honduran lempira, a currency used in Honduras. + + + + + + + This value is a 3-digit code for a Hong Kong dollar, a currency used in Hong Kong + and Macau. This is the value that should be passed in the + <b>Item.Currency</b> field by the seller when listing an item on the + eBay Hong Kong site (Site ID 201). + + + + + + + This value is a 3-digit code for a Hungarian forint, a currency used in Hungary. + + + + + + + This value is a 3-digit code for an Icelandic krona, a currency used in Iceland. + + + + + + + This value is a 3-digit code for an Indonesian rupiah, a currency used in + Indonesia. + + + + + + + This value is a 3-digit code for an Iranian rial, a currency used in Iran. + + + + + + + This value is a 3-digit code for an Iraqi dinar, a currency used in Iraq. + + + + + + + This value is a 3-digit code for an Israeli new shekel, a currency used in + Israel and in the Palestinian territories. + + + + + + + This value is a 3-digit code for a Jamaican dollar, a currency used in Jamaica. + + + + + + + This value is a 3-digit code for a Japanese yen, a currency used in Japan. + + + + + + + This value is a 3-digit code for a Jordanian dinar, a currency used in Jordan. + + + + + + + This value is a 3-digit code for a Kazahhstani tenge, a currency used in + Kazakhstan. + + + + + + + This value is a 3-digit code for a Kenyan shilling, a currency used in Kenya. + + + + + + + This value is a 3-digit code for an Australia dollar, a currency used in Australia. + This is the value that should be passed in the <b>Item.Currency</b> + field by the seller when listing an item on the eBay Australia site + (Site ID 15). + + + + + + + This value is a 3-digit code for a North Korean won, a currency used in North + Korea. + + + + + + + This value is a 3-digit code for a South Korean won, a currency used in South + Korea. + + + + + + + This value is a 3-digit code for a Kuwaiti dollar, a currency used in Kuwait. + + + + + + + This value is a 3-digit code for a Kyrgzstani som, a currency used in Kyrgystan. + + + + + + + This value is a 3-digit code for a Lao kip, a currency used in Laos. + + + + + + + This value is a 3-digit code for a Latvian lats, a currency used in Latvia. + + + + + + + This value is a 3-digit code for a Lebanese pound, a currency used in Lebanon. + + + + + + + This value is a 3-digit code for a Lesotho loti, a currency used in Lesotho. + + + + + + + This value is a 3-digit code for a Liberian dollar, a currency used in Liberia. + + + + + + + This value is a 3-digit code for a Libyan dinar, a currency used in Libya. + + + + + + + Swiss Franc. + For eBay, you can only specify this currency for listings you submit to the + Switzerland site (site ID 193). + + + + + + + This value is a 3-digit code for a Lithuanian litas, a currency used in Lithuania. + + + + + + + This value is a 3-digit code for a Macanese pataca, a currency used in Macao. + + + + + + + This value is a 3-digit code for a Macedonian denar, a currency used in Macedonia. + + + + + + + This value is a 3-digit code for a Malagay franc, a currency previously used + in Madagascar. This currency has been replaced by the Malagasy ariary + (3-digit code: MGA). + + + + + + + This value is a 3-digit code for a Malawian kwacha, a currency used in Malawi. + + + + + + + This value is a 3-digit code for a Malaysian Ringgit, a currency used in Malaysia. + This is the value that should be passed in the <b>Item.Currency</b> + field by the seller when listing an item on the eBay Malaysia site + (Site ID 207). + + + + + + + This value is a 3-digit code for a Maldivian rufiyaaa, a currency used in the + Maldives. + + + + + + + This value is a 3-digit code for a Maltese lira, a currency previously used in + Malta. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + This value is a 3-digit code for a EURO, a currency used in Andorra, Austria, + Belgium, Cyprus, Estonia, Finland, France, Germany, Greece, Ireland, Italy, Kosovo, + Luxembourg, Malta, Monaco, Montenegro, Netherlands, Portugal, San Marino, Slovakia, + Slovenia, Spain, and Vatican City. This is the value that should be passed in the + <b>Item.Currency</b> field by the seller when listing an item on the + following sites: Austria (Site ID 16), Belgium_French (Site ID 23), + France (Site ID 71), Germany (Site ID 77), Italy (Site ID 101), Belgium_Dutch (Site + ID 123), Netherlands (Site ID 146), Spain (Site ID 186), and Ireland (Site ID 205). + + + + + + + This value is a 3-digit code for a Mauritanian ouguiya, a currency used in + Mauritania. + + + + + + + This value is a 3-digit code for a Mauritian rupee, a currency used in + Mauritius. + + + + + + + This value is a 3-digit code for a Mexican peso, a currency used in + Mexico. + + + + + + + This value is a 3-digit funds code for a Mexican peso, a currency used in + Mexico. + + + + + + + This value is a 3-digit code for a Moldovan leu, a currency used in + Moldova. + + + + + + + This value is a 3-digit code for a Mongolian tugrik, a currency used in + Mongolia. + + + + + + + This value is a 3-digit code for an Easy Caribbean dollar, a currency used in + Anguilla, Antigua and Barbuda, Dominica, Grenada, Montserrat, Saint Kitts and + Nevis, Saint Lucia, and Saint Vincent and the Grenadines. + + + + + + + This value is an old 3-digit code for a Mozambican metical, a currency used in + Mozambique. The 'MZM' code has been replaced by 'MZN'. + + + + + + + This value is a 3-digit code for a Myanma kyat, a currency used in + Myanmar. + + + + + + + This value is a 3-digit code for a South African rand, a currency used in + South Africa. + + + + + + + This value is a 3-digit code for a Namibian dollar, a currency used in + Namibia. + + + + + + + This value is a 3-digit code for a Nepalese rupee, a currency used in Nepal. + + + + + + + This value is a 3-digit code for a Netherlands Antillean guilder, a currency used + in Curacao and Sint Maarten. + + + + + + + This value is a 3-digit code for a CFP franc, a currency used in French Polynesia, + New Caledonia, and Wallis and Futuna. + + + + + + + This value is a 3-digit code for a New Zealand dollar, a currency used in the + Cook Islands, New Zealand, Niue, Pitcairn, and Tokelau, Ross Dependency. + + + + + + + This value is a 3-digit code for a Nicaraguan cordoba, a currency used in + Nicaragua. + + + + + + + This value is a 3-digit code for a Nigerian naira, a currency used in Nigeria. + + + + + + + This value is a 3-digit code for a Norwegian kron, a currency used in Norway, + Svalbard, Jan Mayen, Bouvet Island, Queen Maud Land, and Peter I Island. + + + + + + + This value is a 3-digit code for an Omani rial, a currency used in Oman. + + + + + + + This value is a 3-digit code for a Pakistani rupee, a currency used in Pakistan. + + + + + + + This value is a 3-digit code for a Panamanian balboa, a currency used in Panama. + + + + + + + This value is a 3-digit code for a Papua New Guinea kina, a currency used in + Papua New Guinea. + + + + + + + This value is a 3-digit code for a Paraguayan guarani, a currency used in + Paraguay. + + + + + + + This value is a 3-digit code for a Peruvian nuevo sol, a currency used in Peru. + + + + + + + This value is a 3-digit code for a Philippine peso, a currency used in the + Philippines. This is the value that should be passed in the + <b>Item.Currency</b> field by the seller when listing an item on the + eBay Philippines site (Site ID 211). + + + + + + + This value is a 3-digit code for a Polish zloty, a currency used in Poland. This + is the value that should be passed in the <b>Item.Currency</b> field + by the seller when listing an item on the eBay Poland site (Site ID 212). + + + + + + + This value is a 3-digit code for a US dollar, a currency used in the United + States, America Samoa, Barbados, Bermuda, British Indian Ocean Territory, British + Virgin Islands, Caribbean Netherlands, Ecuador, El Salvador, Guam, Haiti, Marshall + Islands, Federated States of Micronesia, Northern Mariana Islands, Palau, Panama, + Puerto Rico, Timor-Leste, Turks and Caicos Islands, US Virgin Islands, and + Zimbabwe. This is the value that should be passed in the + <b>Item.Currency</b> field by the seller when listing an item on the + eBay US or US eBay Motors site (Site ID 0). 'USD' can also + be specified as the <b>Item.Currency</b> on the eBay Canada site + (Site ID 2). + + + + + + + This value is a 3-digit code for a Qatari riyal, a currency used in Qatar. + + + + + + + This value is a 3-digit code for the old Romanian leu, a currency previously used + in Romania. This currency has been replaced by the Romanian new leu (3-digit code: + RON). + + + + + + + This value is a 3-digit code for a Russian rouble, a currency used in Russia, + Abkhazia, and South Ossetia. This value replace the old 3-digit code for the + Russian rouble, 'RUR'. + + + + + + + This value is the old 3-digit code for a Russian rouble, a currency used in + Russia. This value was replaced by the new 3-digit code for the Russian rouble, + 'RUB'. + + + + + + + This value is a 3-digit code for a Rwandan franc, a currency used in Rwanda. + + + + + + + This value is a 3-digit code for a Saint Helena pound, a currency used in Saint + Helena. + + + + + + + This value is a 3-digit code for a Samoan tala, a currency used in Samoa. + + + + + + + This value is a 3-digit code for a Sao Tome and Principe dobra, a currency used in + Sao Tome and Principe. + + + + + + + This value is a 3-digit code for a Saudi riyal, a currency used in Saudi Arabia. + + + + + + + This value is a 3-digit code for a Seychelles rupee, a currency used in Seychelles. + + + + + + + This value is a 3-digit code for a Sierra Leonean leone, a currency used in Sierra + Leone. + + + + + + + This value is a 3-digit code for a Singapore dollar, a currency used in Singapore + and Brunei. This is the value that should be passed in the + <b>Item.Currency</b> field by the seller when listing an item on the + eBay Singapore site (Site ID 216). + + + + + + + This value is a 3-digit code for a Slovak koruna, a currency previously used in + Slovakia. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + This value is a 3-digit code for a Slovenian tolar, a currency previously used in + Slovenia. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + This value is a 3-digit code for a Solomon Islands dollar, a currency used in + the Solomon Islands. + + + + + + + This value is a 3-digit code for a Somali shilling, a currency used in Somalia. + + + + + + + This value is a 3-digit code for a Sri Lankan rupee, a currency used in Sri Lanka. + + + + + + + This value is the 3-digit code for a Sudanese dinar, a currency previously used in + Sudan. The Sudanese dinar was replaced by the Sudanese pound, which has a 3-digit + code of 'SDG'. + + + + + + + This value is the 3-digit code for a Suriname guilder, a currency previously used + in Suriname. The Surinam guilder was replaced by the Surinamese dollar, which has + a 3-digit code of 'SRD'. + + + + + + + This value is a 3-digit code for a Swazi lilangeni, a currency used in Swaziland. + + + + + + + This value is a 3-digit code for a Swedish krona, a currency used in Swedn. This + is the value that should be passed in the <b>Item.Currency</b> field + by the seller when listing an item on the eBay Sweden site (Site ID 218). + + + + + + + This value is a 3-digit code for a Syrian pound, a currency used in Syria. + + + + + + + This value is a 3-digit code for the New Taiwan dollar, a currency used in Taiwan. + + + + + + + This value is a 3-digit code for a Tajikistani somoni, a currency used in + Tajikistan. + + + + + + + This value is a 3-digit code for a Tanzanian shilling, a currency used in + Tanzania. + + + + + + + This value is a 3-digit code for a Thai baht, a currency used in Thailand. + + + + + + + This value is a 3-digit code for a West African CFA franc, a currency used in + Benin, Burkina Faso, Cote d'Ivoire, Guinea-Bissau, Mali, Niger, Senegal, and + Togo. + + + + + + + This value is a 3-digit code for a Tongan pa'anga, a currency used in Tonga. + + + + + + + This value is a 3-digit code for a Trinidad and Tobago dollar, a currency used in + Trinidad and Tobago. + + + + + + + This value is a 3-digit code for a Tunisian dinar, a currency used in Tunisia. + + + + + + + This value is the old 3-digit code for a Turkish lira, a currency used in Turkey + and Northern Cyprus. This value was replaced by the new 3-digit code for the + Turkish lira, 'TRY'. + + + + + + + This value is the old 3-digit code for a Turkmenistani manat, a currency used in + Turkmenistan. This value was replaced by the new 3-digit code for + the Turkmenistani manat, 'TMT'. + + + + + + + This value is a 3-digit code for a Ugandan shilling, a currency used in Uganda. + + + + + + + This value is a 3-digit code for a Ukrainian hryvnia, a currency used in the + Ukraine. + + + + + + + This value is a 3-digit code for an United Arab Emirates dirham, a currency used + in the United Arab Emirates. + + + + + + + This value is a 3-digit code for a Pound sterling, a currency used in the United + Kingdom and British Crown dependencies. This is the value that should be passed in + the <b>Item.Currency</b> field by the seller when listing an item on + the eBay UK site (Site ID 3). + + + + + + + This value is a 3-digit code for a same-day transaction involving US dollars. + + + + + + + This value is a 3-digit code for a next-day transaction involving US dollars. + + + + + + + This value is a 3-digit code for a Uruguayan peso, a currency used in Uruguay. + + + + + + + This value is a 3-digit code for a Uzbekistan som, a currency used in the + Uzbekistan. + + + + + + + This value is a 3-digit code for a Vanuatu vatu, a currency used in Vanuatu. + + + + + + + This value is a 3-digit code for a Venezuelan bolivar, a currency previously used + in Venezuela. The Venezuela bolivar was replaced by the Venezuelan bolivar + fuerte, which has a 3-digit code of 'VEF'. + + + + + + + This value is a 3-digit code for a Vietnamese dong, a currency used in Vietnam. + + + + + + + This value is a 3-digit code for a Moroccan dirham, a currency used in Morocco. + + + + + + + This value is a 3-digit code for a Yemeni rial, a currency used in Yemen. + + + + + + + This value is a 3-digit code for a Yugoslav dinar, a currency previously used in + Yugoslavia. The Yugoslav dinar was replaced by the Serbian dinar, which has a 3- + digit code of 'RSD'. + + + + + + + This value is the old 3-digit code for a Zambian kwacha, a currency used in + Zambia. The 'ZMK' code has been replaced by 'ZMW'. + + + + + + + This value is the old 3-digit code for a Zimbabwean dollar, a currency previously + used in Zimbabwe. The US dollar replaced the Zimbabwean dollar as the official + currency in Zimbabwe. + + + + + + + This value is a 3-digit code for an Austrian schilling, a currency previously used + in Austria. This currency has been replaced by the Euro (3-digit code: EUR). + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>CurrencyDetails</b> container that is returned in the <b>GeteBayDetails</b> response if 'CurrencyDetails' is used as a <b>DetailName</b> value in the request, or no <b>DetailName</b> values are used in the request. A <b>CurrencyDetails</b> container is returned for each currency value that is available to use in the <b>Item.Currency</b> field in an Add/Revise/Relist call. + + + + + + + Three-digit currency codes as defined in ISO 4217. The currency codes returned in + <b>GeteBayDetails</b> can be used as values in the + <b>Currency</b> field of the Add/Revise/Relist and other Trading API + calls. + <br><br> + + + + Item.Currency + AddItem.html#Request.Item.Currency + + + Item.StartPrice + AddItem.html#Request.Item.StartPrice + + + GeteBayDetails + Conditionally + + + + + + + + Full currency name for display purposes. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be used + to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. This timestamp can be used to determine if + and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + + An HTML snippet that specifies hints for the user, help links, help graphics, + and other supplemental information that varies per characteristic set. + In GetProductSearchPage, one DataElement value contains a hint (including an empty HTML anchor element), + one DataElement value may contain a URL to insert into the HTML anchor as the href value, + and one DataElement value may contain a URL that eBay uses as a help graphic. + If no value is available in the meta-data, a dash ("--") is returned instead. + Usage of this information is optional and may require developers to inspect + the information to determine how it can be applied in an application. + Because this is returned as a string, the HTML markup elements are escaped with + character entity references (e.g.,&lt;a href=""&gt;&lt;Attributes&gt;...). + See the appendices in the eBay Web Services guide for general information about + string data types. + + + + + + + + + + + + Identifier for a data element. This is primarily for internal use by eBay. + Developers can choose to inspect this information and determine how it + can be applied in their applications. + + + + + + + + + + + + + + Matches the AttributeSetID associated with a response + returned from the same call that returned the data element set. + As calls like GetProductSearchResults can perform batch searches, this ID helps + you determine which attribute set the data element set is associated with. + + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + + + (in) The month subcomponent of a date. + + + + + + + + + + + (in) The day subcomponent of a date. + + + + + + + + + + + (in) The year subcomponent of a date. + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + Defines year, month, and day as individual components of a date. + Only applicable to use cases that support incomplete dates. + Otherwise, we use xs:dateTime (or xs:date, as appropriate). + + + + + + + A year in the form YYYY. For ticket searches on the US site, + only specify 2007 or 2008. If you specify any other year, + it is ignored. + + + + + + + + + + A calendar month (e.g., 2 or 02 for February). + For ticket searches, Month is required if + Day is specified. + + + + + + + + + + A calendar day (e.g., 2 or 02). For ticket searches, + Day is only valid if Month is also specified. + + + + + + + + + + + + + + DayOfWeekCodeType - Specifies the day of week. + + + + + + + Sunday + + + + + + + Monday + + + + + + + Tuesday + + + + + + + Wednesday + + + + + + + Thursday + + + + + + + Friday + + + + + + + Saturday + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies the range of days the seller can be contacted. + + + + + + + Seller does not want to be contacted. Contact hours will not be supported for + any days. If contact hours are specified, they will be ignored. + + + + + + + Seller can be contacted any day during the specified contact hours. + + + + + + + Seller can be contacted Monday through Friday during the specified + contact hours. + + + + + + + Seller can be contacted Saturday or Sunday during the specified + contact hours. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines settings for a notification URL (including the URL name in DeliveryURLName). + + + + + + + The name of a notification delivery URL. You can list up to 25 instances of + DeliveryURLName, and then subscribe these URLs to notifications by listing them in comma- + separated format in the DeliveryURLName element outside of + ApplicationDeliveryPreferences. + + + + GetNotificationPreferences + Conditionally + + + SetNotificationPreferences + No + + + + + + + + The address of a notification delivery URL. + This address applies to the DeliveryURLName + within the same + ApplicationDeliveryPreferences.DeliveryURLDetails container. + For delivery to a server, the URL + begins with http:// or https:// and must be well + formed. Use a URL that is functional at the time of the + call. For delivery to an email address, the URL begins + with mailto: and specifies a valid email address. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + The status of a notification delivery URL. + This status applies to the DeliveryURLName and delivery URL + within the same ApplicationDeliveryPreferences.DeliveryURLDetails container. + If the status is disabled, then notifications will not be sent to the delivery URL. + + + + GetNotificationPreferences + Conditionally + + + SetNotificationPreferences + No + + + + + + + + + + + + If present, the site defines category settings for whether the seller can specify a vehicle deposit for US eBay Motors listings. + + + + + + + + + + + For vehicles listed through the US eBay Motors site, DepositType + indicates how the buyer should pay the deposit amount. It is + used in conjunction with a buyer payment method (BuyerPaymentMethodCodeType). + + + + + + + (out) No deposit needed. + + + + + + + (out) Pay the deposit using PayPal, and then + use any of the other specified payment methods to pay the balance. + + + + + + + (out) No longer used. + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + Enumerated type containing the list of values that can be used when revising the + item description of an active listing through the Revise API calls. + + + + + + + Use this value in the <b>Item.DescriptionReviseMode</b> field if you want + to completely replace (overwrite) the item description of the active listing. + + + + + + + Use this value in the <b>Item.DescriptionReviseMode</b> field if you want + to prepend text to the item description of the active listing. + + + + + + + Use this value in the <b>Item.DescriptionReviseMode</b> field if you want + to append text to the item description of the active listing. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Enumerated type that defines Listing Designer template types. + + + + + + + This value indicates that the Listing Designer template is a layout template that controls how pictures and description text are + positioned on the View Item page. + + + + + + + This value indicates that the Listing Designer template is a theme template that determines which eBay-provided theme (e.g. Valentine's Day) is to be applied for presenting pictures and description text. + + + + + + + Reserved for future use. + + + + + + + + + + The information for one Theme or one Layout. + + + + + + + Unique identifier for the group in which a Theme falls + (holidays, special events, etc.). Not returned for Layouts. + + + + GetDescriptionTemplates + Always + + + + + + + + Unique identifier for one Theme or Layout. + + + + GetDescriptionTemplates + Always + + + + + + + + URL for a small (100x120 pixel) image providing a sample of how a Theme or Layout looks. + + + + GetDescriptionTemplates + Always + + + + + + + + Unique text name of the Theme or Layout. + + + + GetDescriptionTemplates + Always + + + + + + + + XML defining the template. Elements you must include + in your XML: ThemeTop, ThemeUserCellTop, ThemeUserContent, + ThemeUserCellBottom, ThemeBottom. Not returned for Layouts. + + + + GetDescriptionTemplates + Always + + + + + + + + Either Layout or Theme. + + + + GetDescriptionTemplates + Always + + + + + + + + + + + + This enumerated type contains all exclusive data filters that can be used to control which metadata is returned in the response of a <b>GeteBayDetails</b> call. The user can use as little or as many values as desired. If none of these data filters are used, all applicable metadata will be returned. + + + PaymentOptionDetails, RegionDetails, RegionOfOriginDetails + + + + + + + This value is specified to list the country code and associated name of each country supported by the eBay system. + + + + + + + This value is specified to list the currencies supported by the eBay system. + + + + + + + Not functional. Do not use this value. + + + + + + + Not functional. Do not use this value. + + + + + + + This value is specified to list the regions and locations supported by eBay's shipping services. + + + + + + + This value is specified to list the shipping services supported by the specified eBay site. + + + + + + + This value is specified to list the available eBay sites and their associated SiteID values. + + + + + + + This value is specified to list the different tax jurisdictions supported by the specified eBay site. + + + + + + + This value is specified to list the different eBay URLs associated with the specified eBay site. + + + + + + + This value is specified to list the details of the time zones supported by the eBay system. + + + + + + + Not functional. Do not use this value. + + + + + + + This value is specified to list the handling time values (in number of business days) that the seller can set on a listing. The seller must ship an order line item within this time or risk getting a seller defect. + + + + + + + This value is specified to list maximum thresholds when using Item Specifics. + + + + + + + This value is specified to list the suggested unit-of-measurement strings to use with Item Specifics descriptions. + + + + + + + This value is specified to list the various shipping packages supported by the specified site. + + + + + + + Reserved for future use. + + + + + + + This value is specified to list the shipping carriers supported by the specified site. + + + + + + + This value is specified to list the minimum starting prices for the supported types of eBay listings. + + + + + + + This value is specified to list the return policy values that can be passed in through the <b>ReturnPolicy</b> container of an Add/Revise/Relist API call. + + + + + + + This value is specified to list the Buyer Requirement values that can be passed in through the <b>BuyerRequirementDetails</b> container of an Add/Revise/Relist API call. + + + + + + + This value is specified to list the listing features/upgrades that are enabled or disabled for the specified site. + + + + + + + This value is specified to list the maximum thresholds when using multi-variation listings. + + + + + + + This value is specified to list the geographical regions and individual countries that can be passed in to the <b>ShippingDetails.ExcludeShipToLocation</b> field in an Add/Revise/Relist API call. Multiple <b>ShippingDetails.ExcludeShipToLocation</b> can be used, and any region or country value that is passed in to one of these fields will exclude that region or country as a "ship-to" location. + + + + + + + This value is specified to list whether or not a recoupment policy is enforced on either the listing site or the seller's registration site. + + + + + + + This value is specified to list the shipping service categories (Standard, Expedited, Economy) supported for the site. + + + + + + + + + + The means of receipt of notification. + + + + + + + Typical API, web page interaction. + + + + + + + For SMS/wireless application. + Note that SMS is currently reserved for future use. + + + + + + + Warning: do NOT set this value in production if you currently use Platform Notifications + with this application ID. Setting this value will discontinue all platform + notifications for this application ID, until this value is reset to Platform. <br> + <br> + Set this enum value to specify that the notification client is a Client Alerts API client. + Alerts will be delivered through the Client Alerts system. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies which discount type to use. + + + + + + + Specifies discount type as percentage. + + + + + + + Specifies discount type as a fixed amount. Discount will be in the + currency of the original listing. + + + + + + + Future use + + + + + + + + + + The type of shipping discount profile. + + + + + + + The cost to ship each item beyond the first item (where the item with the + highest shipping cost is selected by eBay as the first item). + Let's say the buyer purchases three items, each set to ship for $8, and + the seller set EachAdditionalAmount to $6. The cost to ship three items would + normally be $24, but since the seller specified $6, the total shipping + cost would be $8 + $6 + $6, or $20. + For flat shipping discount profile only. + + + + + + + The amount by which to reduce the cost to ship each item beyond the + first item (where the item with the highest shipping cost is selected by eBay + as the first item). + Let's say the buyer purchases three items, each set to ship for $8, and + the seller set EachAdditionalAmountOff to $2. The cost to ship three items would + normally be $24, but since the seller specified $2, the total shipping + cost would be $24 - (two additional items x $2), or $20. + For flat shipping discount profile only. + + + + + + + The percentage by which to reduce the cost to ship each item beyond + the first item (where the item with the highest shipping cost is selected by + eBay as the first item). + Let's say the buyer purchases three items, each set to ship for $8, and + the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would + normally be $24, but since the seller specified 0.25 ($2 out of 8), the total shipping + cost would be $24 - (two additional items x $2), or $20. + For flat rate shipping discount profile only. + + + + + + + Shipping cost is the total of what it would cost to ship each item individually. + This is simply a way to define how shipping is to be calculated--there is no + discount for the buyer with this selection. + For calculated shipping discount profile only. + + + + + + + Shipping cost is based on the total weight of all individual items. + This is simply a way to define how shipping is to be calculated--there is no + discount for the buyer with this selection. + For calculated shipping discount profile only. + + + + + + + The amount of weight to subtract for each item beyond the first item + before shipping costs are calculated. For example, there may be less packing + material when the items are combined in one box than if they were shipped + individually. Let's say the buyer purchases three items, each 10 oz. in weight, and + the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since + the seller specified 2 oz. off, the total weight for shipping cost calculation + would be 30 oz. - (two additional items x 2 oz.), or 26 oz. + For calculated shipping discount profile only. + + + + + + + Shipping cost X applies if the total cost of items purchased is Y. + For promotional discount only. + + + + + + + Shipping cost X applies if the total number of items purchased is N. + For promotional discount only. + + + + + + + The shipping cost will not exceed this. + For promotional discount only. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Using this container, a seller can supply original retail price and + discount price for an item to clarify the discount treatment (also known + as strike-through pricing). This only applies to fixed-price listings and auction listings with the Buy It Now + option. This feature is available for large enterprise sellers via + white list. A seller can provide discount treatment regardless of + whether the listing includes a SKU. + + + + + + + The actual retail price set by the manufacturer (OEM). + eBay does not maintain or validate the OriginalRetailPrice supplied + by the seller. OriginalRetailPrice should always be more than + StartPrice. Compare the StartPrice/BuyItNowPrice to + OriginalRetailPrice to determine the amount of savings to the buyer. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Minimum Advertised Price (MAP) is an agreement between suppliers (or + manufacturers (OEM)) and the retailers (sellers) stipulating + the lowest price an item is allowed to be advertised at. + Sellers can offer prices below MAP by means of other discounts. + This only applies to fixed-price listings and auction listings with the Buy It Now option. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + For MinimumAdvertisedPrice (MAP) listings only. + A seller cannot show the actual discounted price on eBay's View Item + page. Instead, the buyer can either click on a pop-up on eBay's + View Item page, or the discount price will be shown during checkout. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Based on OriginalRetailPrice, + MinimumAdvertisedPrice, and StartPrice values, eBay identifies + whether the listing falls under MAP or STP (aka + OriginalRetailPrice). GetItem returns this for items listed with one + of these discount pricing treatments. GetSellerList returns the + DiscountPriceInfo container. This field is not applicable for Add/Revise/Relist calls. + + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + false + + + + + + + Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount + price (specified as StartPrice) is the price for which the seller offered the same (or + similar) item for sale on eBay within the previous 30 days. The discount price is always + in reference to the seller's own price for the item. + <br><br> + If this field is set to 'true', eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next + to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields + are set to 'true', SoldOneBay takes precedence. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + false + + + + + + + Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount + price (specified as StartPrice) is the price for which the seller offered the same (or + similar) item for sale on a Web site or offline store other than eBay in the previous 30 + days. The discount price is always in reference to the seller's own price for the item. + <br><br> + If this field is set to 'true', eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, + next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay + fields are set, SoldOneBay takes precedence. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + false + + + + + + + Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).<br> + <br> + The comparison price is the price of a comparable product sold + through non-outlet channels on eBay (or elsewhere), or not + specifically made for the outlet.<br> + <br> + In fashion, a "comparable" product shares the same design, but is + not considered an identical product. Some products are specifically + made for outlets, and may have a different SKU than the "comparable" + product. These made-for-outlet products may be manufactured in a + different place, with different materials, or according to different + specifications (i.e. different stitch pattern, seam reinforcement, + button quality, etc.) + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Details of a flat or calculated shipping discount profile. + + + + + + + The unique eBay-created ID for the shipping discount, assigned when the + profile is created. On input, if ModifyActionCode is Add, this is ignored if + provided. If ModifyActionCode is Modify, all details of the new version of the + profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is + required, MappingDiscountProfileID is optional, and all other fields of + DiscountProfile are ignored. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The user's title for this profile. On input, if ModifyActionCode is Add, this + is ignored (if provided) if this is the first profile being created and + required if there is more than one profile of that type (flat rate versus + calculated) already. To modify the name, set ModifyActionCode to Update and + provide all details for the profile. On output, DiscountProfileName is only + returned if the user defined more than one profile. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The amount, if the seller specified EachAdditionalAmount as the type of profile, + as noted in FlatShippingDiscount.DiscountName. + Flat rate shipping only. + + + + GetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + SetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + GetItem + GetSellingManagerTemplates + FlatShippingDiscount + InternationalFlatShippingDiscount +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The amount, if the seller specified EachAdditionalAmountOff as the type of profile, + as noted in FlatShippingDiscount.DiscountName. + Flat rate shipping only. + + + + GetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + SetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + GetItem + GetSellingManagerTemplates + FlatShippingDiscount + InternationalFlatShippingDiscount +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The percent (expressed in decimal, as in .5 for 50%), if the seller specified + EachAdditionalPercentOff as the type of profile, + as noted in FlatShippingDiscount.DiscountName. + Flat rate shipping only. + + + + GetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + SetShippingDiscountProfiles + FlatShippingDiscount + Conditionally + + + GetItem + GetSellingManagerTemplates + FlatShippingDiscount + InternationalFlatShippingDiscount +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The weight by which to reduce the combined item weight, if the seller + specified WeightOff as the type of profile, as noted in + CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. + ounces). + Calculated shipping only. + + + + GetShippingDiscountProfiles + CalculatedShippingDiscount + Conditionally + + + SetShippingDiscountProfiles + CalculatedShippingDiscount + Conditionally + + + GetItem + GetSellingManagerTemplates + CalculatedShippingDiscount + InternationalCalculatedShippingDiscount +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when + ModifyActionCode is Delete, any listings currently using the profile + identified by DiscountProfileID will have that profile removed. For + SetShippingDiscountProfiles and GetItem, this is the intended discount profile + mapping. + + + + GetShippingDiscountProfiles + CalculatedShippingDiscount + Conditionally + + + SetShippingDiscountProfiles + CalculatedShippingDiscount + Conditionally + + + GetItem + GetSellingManagerTemplates + CalculatedShippingDiscount + InternationalCalculatedShippingDiscount +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + The nature of the discount. + + + + + + + An offer that applies to a limited number of listings during the offering + period. Example: "There is no insertion fee for up to 5 auctions when + listing between 12/1 and 12/10." + + + + + + + An offer that applies to an unlimited number of listings during the offering + period. Example: "Get subtitle for $0.10 in Tech category when listing between + 12/25 and 12/28. No limit to the number of items listed during this period." + + + + + + + Reserved for future use + + + + + + + + + + Contains a seller's cut off time preferences for same day handling for item shipping. + + + + + + + If the seller specifies a <strong>DispatchTimeMax</strong> value of <code>0</code> to indicate same day handling for an item, the seller's shipping commitment depends on the value of <strong>CutoffTime</strong> for the eBay site on which the item is listed. + <br/><br/> + For orders placed (and cleared payment received) before the indicated cut off time, the item must be shipped by the end of the current day. For orders completed on or after the cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. + </span> + <strong>CutoffTime</strong> has a default initial value for each eBay site, but you can use <strong>SetUserPreferences</strong> to override the default for individual sellers. The default value for most eBay sites is 2:00PM local time. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for <strong>TimeZoneID</strong>. + + + + SetUserPreferences + Conditionally + 00:00 + 23:59 + + + GetUserPreferences + Conditionally + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + details about dispatch cut off times + + + + + + + + + + + + Details about the maximum number of business days required to ship an item to domestic buyers after receiving a cleared payment. + + + + + + + Integer value that indicates the maximum number of business days that the eBay site allows as a seller's handling time. The clock starts ticking when the buyer pays for the order. This means that if a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday) if the <b>DispatchTimeMax</b> value is set to <code>1</code>. Typical values for this field are 0, 1, 2, 3, 4, 5, 10, 15, or 20. + <br/><br/> + A <b>DispatchTimeMax</b> value of <code>0</code> indicates <em>same day handling</em> for an item. In this case, the seller's handling time commitment depends on the <em>order cut off time</em> set in the seller's user preferences. This defaults to 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). + <br/><br/> + + <span class="tablenote"> + <strong>Note:</strong> If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. + </span> + + If using <b>GeteBayDetails</b> specifically to return this value, the caller sets the DetailName field in the request to <b>DispatchTimeMaxDetails</b>. + <br/><br/> + When creating, revising, or relisting an item, the seller cannot set the <b>Item.DispatchTimeMax</b> value higher than the value returned in this field. + + + + GeteBayDetails + Conditionally + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + details about same day handling + + + + + + + + Value and unit (e.g., 10 Days) for the maximum dispatch time. + Useful for display purposes. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. This timestamp can be used to determine + if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + A value of <code>true</code> indicates that the seller has specified a handling time of 4 business days or more (an <em>exception handling time</em>). Sellers should be aware that long handling times might adversely affect the buying decisions of potential customers. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Ways to Display PayNow Button + + + + + + + Show PayNow Button For All Payment Methods + + + + + + + Show PayNow Button For PayPal Only + + + + + + + Reserved for internal or future use + + + + + + + + + + Represents a list of disputes. Can hold zero or more Dispute + types, each of which describes a dispute. + + + + + + + The information that describes a dispute, including + the buyer's name, the transaction ID, the dispute state + and status, whether the dispute is resolved, + and any messages posted to the dispute. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + + + + + + + + + Contains all information describing a dispute. + + + + + + + The unique identifier of an eBay dispute. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + A value to indicate the type of dispute. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The internal state of the dispute. The value determines + which values of <b>DisputeActivity</b> are valid when responding + to a dispute. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The status of the dispute, which provides additional + information about the dispute state. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The role of the person involved in the dispute who is + not taking action or requesting information. The role is + either <b>Buyer</b> or <b>Seller</b>. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The user name of the person involved in the dispute who + is not taking action or requesting information. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The role of the person involved in the dispute who is taking action or + requesting information. The role is either <b>Buyer</b> or <b>Seller</b>. + + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The eBay user ID of the buyer involved in the dispute. + + + + GetDispute + Always + + + + + + + + The eBay user ID of the seller involved in the dispute. + + + + GetDispute + Always + + + + + + + + The unique identifier of the order line item (transaction) under dispute. An + order line item is created once there is a commitment from a + buyer to purchase an item. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b> + responses, this value identifies the order line item involved in the + dispute. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + Container consisting of high-level details about the item involved in the + dispute. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The top-level reason for the dispute. The value of <b>DisputeReason</b> + determines which values of <b>DisputeExplanation</b> are valid. + See <b>DisputeExplanationCodeList</b> for details. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The detailed explanation for the dispute. Valid values + depend on the value of <b>DisputeReason</b>. See <b>DisputeExplanationCodeList</b> + for details. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + A value to indicate whether or not the seller is currently eligible for a + Final Value Fee credit. The seller becomes eligible for a Final Value Fee + credit after filing and winning an Unpaid Item case. This tag only + indicates credit eligibility and does not mean that the case can be closed. + The seller can open a UPI case as soon as two days after the listing ends. + <br> + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The date and time the dispute was created, in GMT. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The date and time the dispute was modified, in GMT. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + The action resulting from the dispute resolution. The + action might include a Final Value Fee credit to the seller, a strike + to the buyer, a reversal, or an appeal. + + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + A response or message posted to a dispute, either by + an application or by a user on the eBay site. + + + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + Whether the buyer can close a dispute unhappy and escalate it + to the eBay Standard Purchase Protection Program. To escalate, the buyer + must be eligible for the PPP. Used in Item Not Received disputes. + + + + GetDispute + Always + + + + + + + + Whether the buyer is eligible for the eBay Standard Purchase Protection + Program. The eligibility rules are described in the eBay site online help. + Used in Item Not Received disputes. + + + + GetDispute + Always + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b> + responses, this value identifies the order line item involved in the + dispute. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + GetDispute + Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + The measurement used in a proximity search distance calculation. + + + + + + + + + + + + + The unit used in a proximity search distance calculation. + + + + + + + + + + + + + + + + This type is deprecated as Dutch auctions are deprecated. + + + + + + + + + + + This type defines the European Article Number (EAN) feature, and whether this + feature is enabled at the site level. An empty EANIdentifierEnabled field is + returned under the FeatureDefinitions container in GetCategoryFeatures if the feature + is applicable to the site and if EANIdentifierEnabled is passed in as a + FeatureID (or if no FeatureID is passed in, hence all features are returned). + + + + + + + + + + + + + + + + + + + PictureManagerLevel1, PictureManagerLevel2, PictureManagerLevel3, + PictureManagerLevel4, PictureManagerLevel5, PictureManagerLevel6, PictureManagerLevel7 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + This value is no longer applicable because Picture Manager has been EOLed. + + + + + + + + + + + + + + + + + + + + + + + + + Allowed categories are Motorcycles, Powersports, and Other Vehicles. + + + + + + + In addition to the categories allowed by LocalMarketSpecialty, allows + Passenger Vehicles. Includes five sub-types. See LocalMarketRegularSubscriptionDefinitionType for details. + + + + + + + Allows same categories as LocalMarketRegular. + + + + + + + + + + + + + + + + The status of a particular entry. + + + + + + + The entry is enabled. + + + + + + + The entry is disabled. + + + + + + + Reserved for future use. + + + + + + + + + + A container to specify a single eBay item to end. + + + + + + + The ID of the item listing to be ended. + An ItemID must be specified in the EndItems request, except that in the case of a Half.com item, + either an ItemID or a SellerInventoryID must be specified. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + EndItems + Conditionally + + + + + + + + Indicates the seller's reason for ending the listing early. + This field is required if the seller is ending the item early and + the item did not successfully sell. + Also applicable to Half.com. + + + + EndItems + Conditionally + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. With + <b>EndItems</b>, the seller can pass in a different + <b>MessageID</b> value for + each <b>EndItemRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>EndItemResponseContainer</b> container is used to correlate each + End Item request container with its corresponding End Item response container. The same <b>MessageID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + <br> + <br> + If you do not pass in a <b>MessageID</b> value in the request, + <b>CorrelationID</b> is not returned. + + + + EndItems + No + + + + + + + + A unique identifier that the seller specified in Item.SellerInventoryID + when they listed an item on Half.com. + In the case of a Half.com item, either an ItemID or a SellerInventoryID + must be specified in the call request. + <br><br> + The SellerInventoryID field is applicable only to Half.com. + <br><br> + For a Half.com item, you can either specify an ItemID or + SellerInventoryID. An error occurs if you try to specify a conflicting + ItemID and SellerInventoryID (for the same item). + + + + EndItems + Conditionally + + + + + + + + + + + + Includes the acknowledgement of date and time the auction was + ended due to the call to EndItem. + + + + + + + Indicates the date and time (returned in GMT) the specified item listing + was ended. + Also applicable to Half.com. + + + + EndItem + EndItems + Always + + + + + + + + Most Trading API calls support a <b>MessageID</b> element in the request + and a <b>CorrelationID</b> element in the response. With + <b>EndItems</b>, the seller can pass in a different + <b>MessageID</b> value for + each <b>EndItemRequestContainer</b> container that is used in the request. The + <b>CorrelationID</b> value returned under each + <b>EndItemResponseContainer</b> container is used to correlate each + End Item request container with its corresponding End Item response container. The same <b>MessageID</b> value that you pass into a request will + be returned in the <b>CorrelationID</b> field in the response. + <br> + <br> + If you do not pass in a <b>MessageID</b> value in the request, + <b>CorrelationID</b> is not returned. + + + + EndItems + Conditionally + + + + + + + + A list of application-level errors or warnings (if any) that were raised + when eBay processed the request. <br> + <br> + Application-level errors occur due to + problems with business-level data on the client side or on the eBay + server side. For example, an error would occur if the request contains + an invalid combination of fields, or it is missing a required field, + or the value of the field is not recognized. An error could also occur + if eBay encountered a problem in our internal business logic while + processing the request.<br> + <br> + Only returned if there were warnings or errors. + + + + + Conditionally + + + + + + + + + + + + Contains the seller's preferences for the email sent to the buyer after the creation of the order line item. + + + + + + + The text of the custom message for the email. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + The URL of the logo to include in the customized email. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + The type of logo to include in the customized email. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + None + No + + + + + + + + Indicates whether or not the seller wishes to send a customized email to winning buyers. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Indicates whether or not the text of the customized message will be customized. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Indicates whether or not the seller wishes to include a logo in the customized email. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + This field is non-operational and will always be set to false. + Indicates whether or not the seller wishes to receive a copy of the customized + email sent to the winning buyer. + + + + + + + + + + + + + + EndOfAuctionLogoTypeCodeType - Type declaration to be used by other schema. + Indicates the type of logo to be used in a customize end of auction (EOA) email. + + + + + + + The PayPal Winning Bidder Notice logo. + + + + + + + The seller's eBay Store logo. + + + + + + + A custom logo specified in LogoURL. + + + + + + + (out) Reserved for internal or future use. + + + + + + + Indicates that no logo has been specified for use in + the end of auction (EOA) email. + + + + + + + + + + Specifies the seller's reason for ending an item listing early. This + is required if the seller ends a listing early. This can be on an item that hasn't + sold and has no bids or on an item that has bids and the seller wants to sell the item + to the high bidder now. + + + + + + + The item was lost or broken. + + + + + + + The item is no longer available for sale. + + + + + + + The start price or reserve price is incorrect. + + + + + + + The listing contained an error (other than start price or reserve + price). + + + + + + + Reserved for internal or future use. + + + + + + + Seller want to sell the listing to the high bidder. A seller can end a listing + in order to seller to the current high bidder when + the listing has qualifying bids (i.e., there is a current high bid that, + when applicable, meets the minimum reserve price) and there is more + than 12 hours before the listing ends. + <br> + <b>Note</b>: In the last 12 hours of an item listing, you cannot end an item early + if it has bids. + + + + + + + The vehicle was sold. Applies to local classified listings for vehicles only. + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + By Buyer + + + + + + + + + + + By Seller + + + + + + + + + + + None + + + + + + + + + + + Reserved for internal or future use + + + + + + + + + + + + + Container for the list of site-specific locations supported by the Exclude Ship To + Locations feature. + + + + + + + The localized location name. + + + + GeteBayDetails + Conditionally + + + + + + + + The location or region code to be used with the AddItem family of calls. These + codes are also returned by GetItem. This code reflects the <a href= + "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm" + >ISO 3166</a> codes. + + + + GeteBayDetails + Conditionally + + + + + + + + The region code to which the location belongs. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the current version number of the ExcludeShippingLocation data. Use + the version number to determine if you need to refresh your cached client data. + + + + GeteBayDetails + Conditionally + + + + + + + + The time in GMT that the feature flags for the details were last updated. + Use this timestamp to determine if you need to refresh your cached client data. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + This type is deprecated as the eBay Express is no longer available. + + + + + + + + + + + + + + + + + This type is deprecated as the eBay Express is no longer available. + + + + + + + + + + + + + + + + + This type is deprecated as the eBay Express is no longer available. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as the eBay Express is no longer available. + + + + + + + + + + + + + + + + Contains extended contact information for an eBay user. + + + + + + + All fields related to contact hours including time ranges and + user-designated time zone. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Returned for classified ads to indicate whether contact by email is enabled. + In the pay-per-lead feature, which will be available in upcoming months on the + US site, this field will specify whether potential buyers can email the seller + after viewing a pay-per-lead listing. + + + + AddItem + AddItems + AddSellingManagerTemplate + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + RelistItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + The pay-per-lead feature is no longer available, and this field is scheduled to + be removed from the WSDL. + + + + + + + + + + + + + + + This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay + Picture Services (EPS), that was generated when the self-hosted picture was uploaded. + + + + + + + + This container returns the <b>eBayPictureURL</b> (images hosted by eBay + Picture Services) and the <b>ExternalPictureURL</b> (images hosted outside of eBay) fields. + + + + GetItem + Conditionally + + + + + + + + + + + + This type is deprecated as the call is no longer available. + + + + + + + A product finder ID. GetCategory2CS always (and only) returns this + when Category.ProductFinderIDs is returned. + + + + GetCategory2CS +
DetailLevel: ReturnAll
+ Conditionally + MappedCategoryArray + + + + + + + + If false or not present, the product finder can be used as input to + GetProductSearchResults to search for catalog data (Pre-filled Item Information) + that a seller might want to include in a listing. + + + + GetCategory2CS +
DetailLevel: ReturnAll
+ Conditionally + MappedCategoryArray + + + Knowledge Base: ProductFinderID for Buy-Side Searches + https://ebaydts.com/eBayKBDetails?KBid=560 + + + + + + + + + + + + + + + + + This type is deprecated as the parent of this type is no longer available. + + + + + + + + + ExternalProductID.Value contains an ISBN value. + Required when you pass an ISBN as the external product ID. + (This value is also applicable to Half.com listings.) + + + + + + + + + + + ExternalProductID.Value contains a UPC value. + Required when you pass a UPC as the external product ID. + (This value is also applicable to Half.com listings.) + + + + + + + + + + + ExternalProductID.Value contains an eBay catalog product ID. + Required when you pass an eBay product ID + as the external product ID. + + + + + + + + + + + ExternalProductID.Value contains an EAN value. + Required when you pass an EAN as the external product ID. + + + + + + + + + + + ExternalProductID.Value contains a set of keywords that uniquely identify the product. + Only applicable when listing event ticket. + See the eBay Web Services guide for information about valid + ticket keywords for an external product ID. + Required when you pass a set of keywords as the external product ID. + + + + + + + + + + + Reserved for future use. + + + + + + + + + + + Reserved for internal or future use + + + + + + + + + + + + + This type is deprecated as the parent of this type is no longer available. + + + + + + + + + An industry-standard value that uniquely identifies the product. The valid + values are dictated by the Type property. Required if Type is specified. Max + length 13 for ISBN, 13 for EAN, 12 for UPC, and 4000 for + ProductID. No max length for ticket keywords (but passing too much data can + result in "no match found" errors).<br> + <br> + <b>For AddItem and related calls:</b> + If the primary and secondary categories are both catalog-enabled, the value must + apply to the primary category. Event tickets listings support a set of keywords + that uniquely identify the listing. The ticket keywords specify the event name + (the title shown on the ticket), venue name, and event date and time. See the + eBay Web Services guide for more information and validation rules. For + convenience, you can pass an eBay product ID as input (not limited to media + categories).<br> + <br> + Required for Half.com listing use cases, and this can only be an ISBN, UPC, or + EAN value.<br> + <br> + <b>For GetSellerPayments output only:</b> + Also see AlternateValue, which is returned if the catalog defines multiple + ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that + some catalogs return ISBN values that are not 10 or 13 characters, and some + values contain non-alphanumeric symbols (e.g., $). + + + + + + + + + + + + + + + Applicable for listing use cases only (not buy-side searching). + Indicates what eBay should do if more than one product matches + the value passed in Value. Only takes effect when more than one + match is found. If true, the response should include an error + and all matching product IDs. If false, the response should include + an error but should not return the matching product IDs. + This field is also applicable when listing Half.com items. + + + + + + + + + + + + + + The kind of identifier being used. The choices are listed + For requests, required if Value is specified. + For Half.com listing use cases, only ISBN, UPC, and EAN are supported. + + + + + + + + + + + + + + + + + + An industry-standard value that provides an alternate identification for + the product, if any. Currently, this only returns an alternate ISBN + value. If the catalog defines both an ISBN-13 and ISBN-10, + then the ISBN-13 is returned in Value and the ISBN-10 is returned in + AlternateValue. (That is, the ISBN-13 is considered to be the preferred + identifier.) If the catalog only defines one ISBN, it is returned in + Value (and AlternateValue is not returned). Please note that some + catalogs return ISBN values that are not 10 or 13 characters, + and some values contain non-alphanumeric symbols (e.g., $). + + + + + + + + + + + + + + + + Container consisting of details related to payment of an eBay order on an + external system such as PayPal. This container is only returned if payment has + been made on an order. For GetSellerTransaactions and GetItemTransactions, this + container is not returned for multiple line item orders. + + + + + + + Unique identifier for a PayPal payment of an eBay order. If the order was purchased + with a payment method other than PayPal, "SIS" is returned, which stands for "Send + Information To Seller." This field is only returned after payment has been made. + + + + ReviseCheckoutStatus + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Always + + + + + + + + Timestamp for payment transaction. + + + + ReviseCheckoutStatus + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + SoldReport + Always + + + + + + + + Fee Amount is a positive value and Credit Amount is a negative value. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + SoldReport + Always + + + + + + + + If positive, the amount the buyer pays + the seller through PayPal on the purchase of items. If + negative, the amount refunded the buyer. Default = 0. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + SoldReport + Always + + + + + + + + The current processing status of a PayPal payment for an eBay order. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + + + + + A container node for definitions of the features specified in FeatureID in the + GetCategoryFeatures request. If no feature ID was specified, all definitions are + returned. + + + + + + + Specifies one or more sets of listing durations. Each set gives durations for + listing types a category could allow. If present, the corresponding feature + ID was passed in the request or all features were requested (i.e., no feature + IDs were specified). Use the data provided in SiteDefaults and Category to + determine which listing formats support each listing duration and whether any + categories override the standard settings. + <br><br> + <bold>Note:</bold> Durations for Local Market listings are not + supported by GetCategoryFeatures. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + Listing US and CA eBay Motors Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayMotors.html#LocalMarketListings + + + + + + + + Some categories may require the seller to specify at least one + domestic shipping service and associated cost for an listing. + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs were specified). Currently, + this field contains no other special meta-data. (An empty element is + returned.) Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This field is no longer applicable as Dutch auctions are no longer available on + eBay sites. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Some categories allow you to enhance a listing by putting it into a rotation + for display on a special area of the eBay home page. Item or feedback + restrictions may apply.<br><br> If present, the corresponding + feature ID was passed in the request or all features were requested (i.e., no + feature IDs were specified). Currently, this field contains no other special + meta-data. (An empty element is returned.) Use the data provided in + SiteDefaults and Category to determine which categories (if any) support this + feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the ProPack feature (a feature pack). + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Not applicable to any site. + Defined the BasicUpgradePack bundle feature (a feature pack). + Formerly, applicable to the Australia site (site ID 15, abbreviation AU) only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the ValuePack bundle feature (a feature pack). + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the ProPackPlus bundle feature (a feature pack). + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Specialty Vehicles. If the field is present, + the category supports Local Market listings by sellers with a Local Market + for Specialty Vehicles subscription. The field is returned as an empty + element (i.e., a boolean value is not returned). + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. Support in some categories is based on subscription + level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Vehicles. If the field is present, the + category supports Local Market listings by sellers with a Local Market for + Vehicles subscription. The field is returned as an empty element (i.e., a + boolean value is not returned). + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. Support in some categories is based on subscription + level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers with + premium Local Market subscriptions. If the field is present, the category + supports Local Market listings by sellers with a premium Local Market + subscription. The field is returned as an empty element (i.e., a boolean + value is not returned). + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. Support in some categories is based on subscription + level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers who + have not subscribed to either Local Market for Vehicles or Local Market for + Specialty Vehicles. If the field is present, the category supports Local + Market listings by sellers without a Local Market subscription. The field is + returned as an empty element (i.e., a boolean value is not returned). + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. Support in some categories is based on subscription + level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + For the US and Germany sites, an eBay item must meet a number of eligibility + requirements in order to also be included on eBay Express. One requirement is + that the category needs to support Express. For example, categories that are + not covered by PayPal Buyer Protection (e.g., Live Auctions and Motors + vehicles) are excluded from Express.<br><br> If present, the + corresponding feature ID was passed in the request or all features were + requested (i.e., no feature IDs were specified). Currently, this field + contains no other special meta-data. (An empty element is returned.) Use the + data provided in SiteDefaults and Category to determine which categories are + enabled for Express. + + + + + + + + + + For the US and Germany sites, an eBay item must meet a number of eligibility + requirements in order to also be included on eBay Express. One requirement is + that the item must include a picture (or gallery image). Some categories + (e.g., Event Tickets) may waive this requirement if a picture is not normally + expected.<br><br> If present, the corresponding feature ID was + passed in the request or all features were requested (i.e., no feature IDs + were specified). Currently, this field contains no other special meta-data. + (An empty element is returned.) Use the data provided in SiteDefaults and + Category to determine which categories requires an item to include a picture + in order to be eligible for Express. + + + + + + + + + + For the US and Germany sites, an eBay item must meet a number of eligibility + requirements in order to also be included on eBay Express. One requirement is + that the item must include the Item Condition attribute (using Item + Specifics). Some categories may waive this requirement.<br><br> If + present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + require an item to include the Item Condition attribute in order to be + eligible for Express. + + + + + + + + + + If present, the corresponding feature ID was passed in the request or all features + were requested (i.e., no feature IDs were specified). On the Germany, Austria, + Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the + Art and Antiques, Watches and Jewelry, and Motorbikes categories. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Applies to the US eBay Motors site (except Parts and Accessories category). + Defines the Transaction Confirmation Request feature. If the field is + present, the corresponding feature applies to the category. The field is + returned as an empty element (i.e., a boolean value is not returned). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the SellerContactDetails feature. If the field is present, the + corresponding feature applies to the category. The field is returned as an + empty element (e.g., a boolean value is not returned). + Applies to Classified Ad format listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed + in the request or all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the valid local listing distances allowed for listing Local Market + items by sellers subscribed to Local Market for Vehicles. + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. The set of valid distances (radii) supported by a + category is based on subscription level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the valid local listing distances allowed for listing Local Market + items by sellers subscribed to Local Market for Specialty Vehicles. + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. The set of valid distances (radii) supported by a + category is based on subscription level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the valid local listing distances allowed for listing Local Market + items by sellers who have not subscribed to either Local Market for Vehicles + or Local Market for Specialty Vehicles. + <br> + Some categories support listing vehicles for the eBay Motors Local Market + only, where Local Market is defined as the area within a set radius about a + specified postal code. The set of valid distances (radii) supported by a + category is based on subscription level. + <br> + Local Market listings are supported for vehicle categories on the US eBay + Motors site only and for US postal codes only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user for + Classified Ad format listings. + Even if enabled, checkout may or may not be enabled. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for Classified Ad listings + in this category. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings in this + category. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for Classified Ad + listings in this category. + Returned only if this category overrides the site default. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether automatic decline for Best Offers is allowed for Classified + Ad listings in this category. Returned only if this category overrides + the site default. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a telephone number in the + seller's contact information for Classified Ad listings. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an email address in the + seller's contact information for Classified Ad listings. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + For the US, Canada and Australia sites, users registered after January + 17,2007 are required to offer at least one safe payment method (i.e. + PayPal/PaisaPay, or one of the credit cards specified in + Item.PaymentMethods). + <br> + If a seller has a 'SafePaymentExempt' status, they are exempt from the + category requirement to offer at least one safe payment method when listing + an item on a site that has the safe payment requirement. + <br> + The safe payment requirement also applies to two-category listings that have + one ship-to or available-to location in the US, Canada, or Australia. The + French Canadian (CAFR) site is a special case, because listings on the CAFR + site with ship-to or available-to locations in Canada do not require a Safe + Payment method, yet listings on the CAFR site with ship-to or available-to + locations in the US or Australia do require a Safe Payment method. + <br> + The Business and Industrial, Motors, Real Estate, and Mature Audiences + categories, and all listings that don't support Item.PaymentMethods are + exempt from this requirement. Therefore, listings in those categories do not + require a safe payment method. + <br> + Currently, this field contains no other special meta-data.(An empty element + is returned.) + <br> + Use SiteDefaults.SafePaymentRequired and Category.SafePaymentRequired to + determine which categories require a safe payment method. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Some categories can support pay-per-lead listings. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Some categories can support custom Item Specifics. + Item Specifics are typical aspects of items in the same category. + They enable users to classify items by presenting descriptive details + in a structured way. For example, in a jewelry category, sellers might + describe lockets with specifics like "Chain Length=18 in." and + "Main Shape=Heart", but in a Washers & Dryers category, + sellers might include "Type=Top-Loading" instead of "Main Shape=Heart".<br> + <br> + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. + (An empty element is returned.) Use the data provided in SiteDefaults + and Category to determine which categories (if any) support + this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports Paisapay Escrow payment method. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports ISBN field for that specific item. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports UPC field for that specific item. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports EAN field for that specific item. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports BrandMPN field for that specific item. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows sellers to set a + price at which best offers are automatically accepted. + If present, the corresponding feature ID is passed in the request or all + features are requested (i.e., no feature IDs are specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows sellers to set a + price at which best offers are automatically accepted for Classified Ads. + If present, the corresponding feature ID is passed in the request or all + features are requested (i.e., no feature IDs are specified). + Currently, this field contains no other special meta-data. + (An empty element is returned.) Use the data provided + in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows you to specify that listings be displayed + in the default search results of the respective site. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows you to specify that listings be displayed + in the default search results of the respective site. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows you to specify that listings be displayed + in the default search results of the respective site. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + For the Australia site, PayPalBuyerProtectionEnabled and BuyerGuaranteeEnabled + define the feature that allows buyer protection. + If PayPalBuyerProtectionEnabled present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + For the Australia site, PayPalBuyerProtectionEnabled and BuyerGuaranteeEnabled + define the feature that allows buyer protection. + If BuyerGuaranteeEnabled present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Used for Store Inventory listings, which are no longer supported on any eBay site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Defines the feature that enables durations for "Gallery Featured". + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the workflow timeline applicable for the given category on the India site, if + the category supports PaisaPayFullEscrow. If present, the corresponding feature + ID was passed in the request or all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines PayPal as a required payment method. + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature.Added for eBay Motors Pro users + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a phone number in the + seller's contact information for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled for the seller's contact information for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an address in the + seller's contact information for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option this category supports for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a company name in the + seller's contact information for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an email address in the + seller's contact information for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings in this + category. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of auto accept + for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of auto decline + for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of payment method checkOut + for Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for Classified Ad format listings + in this category. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for Classified Ad + listings in this category. + Returned only if this category overrides the site default. + Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Defines the SellerContactDetails feature. If the field is present, the + corresponding feature applies to the category. The field is returned as an + empty element (e.g., a boolean value is not returned). + Applies to Classified Ad listings. Added for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature.Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a phone number in the + seller's contact information for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled for the seller's contact information for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an address in the + seller's contact information for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled for the seller's contact information for Classified Ad format listings. + Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including a company name in the + seller's contact information for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an email address in the + seller's contact information for Classified Ad format listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature.Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of auto accept + for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of auto decline + for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports the use of payment method checkOut + for Classified Ad listings. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for Classified Ad format listings + in this category. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for Classified Ad + listings in this category. + Returned only if this category overrides the site default. Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Defines the SellerContactDetails feature. If the field is present, the + corresponding feature applies to the category. The field is returned as an + empty element (e.g., a boolean value is not returned). + Added for Local Market users. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled for the seller's contact information for Classified Ad listings. Added for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including an address in the + seller's contact information for Classified Ad listings. Added for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled for the seller's contact information for Classified Ad format listings. + Added for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category supports including the company name in the + seller's contact information for Classified Ad listings. Added for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Specialty Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Regular Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Premium Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This is for For Sale By Owner. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that specifies whether a return policy + could be required on the site. + If present, the corresponding feature ID was passed in the request or + all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. + (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that specifies whether a handling time (dispatch time) + could be required on the site. The handling time is the maximum number of business days the seller + commits to for preparing an item to be shipped after receiving a + cleared payment. The seller's handling time does not include the + shipping time (the carrier's transit time).<br> + <br> + If present, the corresponding feature ID was passed in the request or + all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. + (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that specifies whether PayPal is required for Store Owners. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings as well as Sif Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if quantity can be revised while a listing is in semi or fully restricted mode. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if price can be revised while a listing is in semi or fully restricted mode. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Provides additional listings durations that are supported by Business Sellers. + A Business Seller constitutes a seller who has completed Business Seller Registration + on an eBay site that supports the Business Seller Registration framework. + The extended listing durations provided here in this element should be merged + in with the baseline listing durations provided in the ListingDurations element. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Provides additional listings durations that are supported by eBay Store + Owners. The extended listing durations provided here in this element should + be merged in with the baseline listing durations provided in the + ListingDurations element. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the payment methods feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the applicable max cap per shipping cost for shipping service group1. + The field is returned as an empty element (e.g., a boolean value is not returned). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the applicable max cap per shipping cost for shipping service group2. + The field is returned as an empty element (e.g., a boolean value is not returned). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the applicable max cap per shipping cost for shipping service group3. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether a maximum flat rate shipping cost + is imposed on sellers who list in categories on this site yet are shipping an + item into the country of this site from another country. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + A maximum flat rate shipping cost is applied to some categories (or combination + of category and shipping service group). This feature returns elements related + to maximum flat rate shipping cost. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings for + multi-variation listings.<br> + <br> + Multi-variation listings contain items that are logically the same + product, but that vary in their manufacturing details or packaging. + For example, a particular brand and style of shirt could be + available in different sizes and colors, such as "large blue" and + "medium black" variations.<br> + <br> + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs were specified). + Currently, this field contains no other special meta-data. + (An empty element is returned.) Use the data provided in + SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This field is deprecated since "old" eBay attributes are no longer supported. + + + + + + + + + + + Defines the feature that allows free, automatic upgrades for Gallery Plus. + If present, the corresponding feature ID is passed in the request or all + features are requested (i.e., no feature IDs are specified). This + field contains no meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the feature that allows free, automatic upgrades for Picture Pack. + If present, the corresponding feature ID is passed in the request or all + features are requested (i.e., no feature IDs are specified). This + field contains no meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings for items + listed with parts compatibilities. + <br><br> + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, + this field contains no other special meta-data. (An empty element is + returned.) Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories + categories for the US eBay Motors (site ID 0) only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines a maximum limit for the + number of compatible applications for items listed with parts compatibilities + by application. + <br><br> + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, + this field contains no other special meta-data. (An empty element is + returned.) Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories + categories for the US eBay Motors (site ID 0) only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines a minimum number of + required compatible applications for listing items. + <br><br> + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, + this field contains no other special meta-data. (An empty element is + returned.) Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories + categories for the US eBay Motors (site ID 0) only. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings + for item condition support.<br> + <br> + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs are specified). + This field contains no meta-data. (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings for item condition values.<br> + <br> + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs are specified). + This field contains no meta-data. (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings for + value categories.<br> + <br> + If present, the corresponding feature ID was passed in the request or all + features were requested (i.e., no feature IDs were specified). Currently, this + field contains no other special meta-data. (An empty element is returned.) Use + the data provided in SiteDefaults and Category to determine which categories + (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the specified site defines settings + for product creation support.<br> + <br> + If present, the corresponding feature ID was passed in the request + or all features were requested (i.e., no feature IDs are specified). + This field contains no meta-data. (An empty element is returned.) + Use the data provided in SiteDefaults and Category to determine + which categories (if any) support this feature. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the vehicle type to which parts compatibility applies. In the response, it will differentiate + whether the item is for is car, truck, or motorcycle. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines the total number of fine grained item compatibilities + that can be applied to a listing. + <br/><br/> + When you list with parts compatibility, using only the high-level compatibility + search names, such as Year, Make, and Model, the fitment applies to the various + unspecified lower-level compatibility search names and values, such as Trim and + Engine, as well. This means that specifying a single coarsely defined item + compatibility may result in multiple fitments applying to the listing at the + lowest level of granularity. Up to 300 (or whatever maximum is indicated by + <b>MaxItemCompatibility</b>) coarse parts compatibilities can be specified for a given + listing. + <br/><br/> + Alternatively, you can explicitly specify up to 1000 (or whatever maximum is + indicated by <b>MaxGranularFitmentCount</b>) parts compatibilities at + the lowest level of granularity. That is, if you specify your parts compatibilities + using all of the supported compatibility search names (e.g., Year, Make, Model, + Trim, and Engine), you can specify up to 1000 compatibilities. + + + 1000 + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + Specifies whether or not the use of Business Policies Shipping profiles is + enabled. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies whether or not the use of Business Policies Payment profiles is + enabled. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies whether or not the use of Business Policies Return Policy profiles is + enabled. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + After EOL Attributes, VIN will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports VIN. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, VRM will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports VRM. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Seller Provided Title will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports Seller Provided Title. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Deposit will no longer be supported as primary attributes, + rather consumers should use new tags. This feature helps consumers in identifying + if category supports Deposit. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies whether or not the Global Shipping Program (GSP) is enabled. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + This field is returned as an empty element (a boolean value is not returned) if + one or more eBay API-enabled sites support the Boats Parts Compatibility feature. + This field will be returned as long as 'AdditionalCompatibilityEnabled' + is included as a <b>FeatureID</b> value in the call request or no + <b>FeatureID</b> values are passed into the call request. + <br/><br/> + To verify if a specific eBay site supports Boats Parts Compatibility (for most + categories), look for a 'true' value in the + <b>SiteDefaults.AdditionalCompatibilityEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports Boats Parts + Compatibility, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>AdditionalCompatibilityEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + This field is returned as an empty element (a boolean value is not returned) if + one or more eBay API-enabled sites support the Click and Collect feature. + This field will be returned as long as 'PickupDropOffEnabled' + is included as a <b>FeatureID</b> value in the call request or no + <b>FeatureID</b> values are passed into the call request. + <br/><br/> + To verify if a specific eBay site supports the Click and Collect feature (for most + categories), look for a 'true' value in the + <b>SiteDefaults.PickupDropOffEnabled</b> field. + <br/><br/> + To verify if a specific category on a specific eBay site supports the Click and Collect feature, pass in a <b>CategoryID</b> value in the request, and then + look for a 'true' value in the <b>PickupDropOffEnabled</b> field + of the corresponding Category node (match up the <b>CategoryID</b> values + if more than one Category IDs were passed in the request). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + Indicates whether the seller making the request can list with certain features. + A seller's eligibility is determined by their feedback rating. + + + + + + + Indicates whether the seller is eligible to list items with the 'BuyItNow' option. + A value of true means that the seller is eligible; a value of false indicates that + they are not eligible. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the seller is eligible to specify the 'BuyItNow' option for + multiple-item listings. A value of true means that the seller is eligible; a value + of false indicates that they are not eligible. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the seller is eligible to list a fixed-price item with a one-day + listing duration. A value of true means that the seller is eligible; a value of false + indicates that the seller is not eligible. Note that this field only controls user + eligibility. The listing type and category must support this feature for this field to + be applicable. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the seller is eligible to list + multi-variation items. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Indicates whether the seller is eligible to list an auction item with a one day duration on this site. + Limitation: the Adult-Only and Auto Vehicle categories do not support one day auctions, so the seller + cannot list items in these categories as one day auctions even if the seller has the eligibility. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type that lists all possible values that can be passed into the <b>FeatureID</b> field in a <b>GetCategoryFeatures</b> call. The <b>FeatureID</b> field is to used to check if specific listing features are enabled at the site or category level. Multiple <b>FeatureID</b> fields can be used in the request. If no <b>FeatureID</b> fields are used, the call retrieves data for all features defined within this enumerated type. + + + DutchBINEnabled, DigitalDeliveryEnabled, BasicUpgradePack, ExpressEnabled, ExpressPicturesRequired, ExpressConditionRequired, TransactionConfirmationRequestEnabled, StoreInventoryEnabled, MaximumBestOffersAllowed, ClassifiedAdMaximumBestOffersAllowed, ClassifiedAdContactByEmailAvailable, ClassifiedAdPayPerLeadEnabled, CombinedFixedPriceTreatment, PayPalRequiredForStoreOwner, AttributeConversionEnabled, PaymentOptionsGroup, VINSupported, VRMSupported, SellerProvidedTitleSupported, DepositSupported + + + + + + + If this value is specified, supported site-default and category-specific listing durations values for each listing type are returned in the <b>SiteDefaults.ListingDuration</b> and <b>Category.ListingDuration</b> fields of the <b>GetCategoryFeatures</b> response. + <br><br> + <bold>Note:</bold> Listing durations for Local Market listings are not + supported by <b>GetCategoryFeatures</b>. See to the <a href="http://developer.ebay.com/devzone/guides/ebayfeatures/Development/Sites-eBayMotors.html#LocalMarketListings">Local Market Listing</a> + documentation in the Features Guide for valid listing durations for Local Market listings. + + + + + + + If this value is specified, the <b>SiteDefaults.BestOfferEnabled</b> and <b>Category.BestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the Best Offer feature, and which categories allow the Best Offer feature. Best Offers are not available for auction listings. + + + + + + + This value is <b>deprecated</b>, as Dutch-style auctions are no longer available on any eBay sites. + + + + + + + If this value is specified, the <b>SiteDefaults.ShippingTermsRequired</b> and <b>Category.ShippingTermsRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site, and individual categories on that site, require at least one domestic shipping service option (with cost) to be specified before an item is listed. + + + + + + + If this value is specified, the <b>SiteDefaults.UserConsentRequired</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site requires a prospective bidder of an auction item to read and agree to the terms in eBay's privacy policy before bidding on the item. + + + + + + + If this value is specified, the <b>SiteDefaults.HomePageFeaturedEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the featuring of items within a special area of eBay's home page. This is a listing enhancement that requires a fee, and support for this feature varies by site. + + + + + + + If this value is specified, the <b>SiteDefaults.AdFormatEnabled</b> and <b>Category.AdFormatEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Classified Ad listings. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.BestOfferCounterEnabled</b> and <b>Category.BestOfferCounterEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports the Best Offer counter offers, and which categories allow the Best Offer counter offers. Best Offers are not available for auction listings. + + + + + + + If this value is specified, the <b>SiteDefaults.BestOfferAutoDeclineEnabled</b> and <b>Category.BestOfferAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. Best Offers are not available for auction listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ProPackEnabled</b> and <b>Category.ProPackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Pro Pack listing enhancement bundle. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.ValuePackEnabled</b> and <b>Category.ValuePackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Value Pack listing enhancement bundle. The Value Pack bundle includes the Gallery Plus feature, a listing subtitle, and use of a Listing Designer template. + + + + + + + If this value is specified, the <b>SiteDefaults.ProPackPlusEnabled</b> and <b>Category.ProPackPlusEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Pro Pack Plus listing enhancement bundle. The Pro Pack Plus bundle includes the Bold Title, Border, Highlight, Featured, and Gallery features for a discounted price. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketSpecialitySubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a specialty subscription to Local Market for Vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketRegularSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a regular subscription to Local Market for Vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketPremiumSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers with a premium subscription to Local Market for Vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketNonSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Local Market listings for sellers without a subscription to Local Market for Vehicles. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.SellerContactDetailsEnabled</b> and <b>Category.SellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Classified Ad listing. This feature is only applicable to Classified Ad listings. + + + + + + + Reserved for internal or future use. + + + + + + + If this value is specified, the <b>SiteDefaults.MinimumReservePrice</b> and <b>Category.MinimumReservePrice</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require a minimum Reserve Price for auction listings. This feature is only applicable to Auction listings and only if the seller decides to set a Reserve Price for the auction. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the integer values in the <b>LocalListingDistancesRegular</b>, <b>LocalListingDistancesSpecialty</b>, and <b>LocalListingDistancesNonSubscription</b> fields in the <b>GetCategoryFeatures</b> response will indicate the radius (in miles) of the selling area for Local Market Vehicle listings, based on Local Market subscription status of the motor vehicle seller (specialty subscription, regular subscription, or no subscription). + + + + + + + If this value is specified, the <b>SiteDefaults.SkypeMeTransactionalEnabled</b> and <b>Category.SkypeMeTransactionalEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Skype communication between eBay transactional partners (buyer and seller). + + + + + + + If this value is specified, the <b>SiteDefaults.SkypeMeNonTransactionalEnabled</b> and <b>Category.SkypeMeNonTransactionalEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Skype communication between eBay members (buyer and seller) with no transactional relationship. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdPaymentMethodEnabled</b> and <b>Category.ClassifiedAdPaymentMethodEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdShippingMethodEnabled</b> and <b>Category.ClassifiedAdShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdBestOfferEnabled</b> and <b>Category.ClassifiedAdBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Classified Ad listings. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdCounterOfferEnabled</b> and <b>Category.ClassifiedAdCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Classified Ad listings. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdAutoDeclineEnabled</b> and <b>Category.ClassifiedAdAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Classified Ad listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByEmailEnabled</b> and <b>Category.ClassifiedAdContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide a contact email address within a Classified Ad listing. This feature is only applicable to Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByPhoneEnabled</b> and <b>Category.ClassifiedAdContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide a contact phone number within a Classified Ad listing. This feature is only applicable to Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.SafePaymentRequired</b> and <b>Category.SafePaymentRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site, and individual categories on that site, require that the seller set at least one accepted payment method in the listing that is certified by eBay to be a "safe payment method". + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. To verify if the seller's contact information can be shared with prospective buyers in the listing, use the 'SellerContactDetailsEnabled' enumeration value instead. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.ItemSpecificsEnabled</b> and <b>Category.ItemSpecificsEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support custom Item Specifics in listings. + + + + + + + If this value is specified, the <b>SiteDefaults.PaisaPayFullEscrowEnabled</b> and <b>Category.PaisaPayFullEscrowEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories on that site support Paisa Pay Full Escrow as an accepted payment method. This field is only relevant to listings on the eBay India site, which is the only site where Paisa Pay is available. + + + + + + + If this value is specified, the <b>Category.ISBNIdentifierEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not individual categories on the specified site support the ability of a seller to identify a product through an International Standard Book Number (ISBN) value. + + + + + + + If this value is specified, the <b>Category.UPCIdentifierEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not individual categories on the specified site support the ability of a seller to identify a product through a Universal Product Code (UPC) value. + + + + + + + If this value is specified, the <b>Category.EANIdentifierEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not individual categories on the specified site support the ability of a seller to identify a product through a European Article Number (EAN) value. + + + + + + + If this value is specified, the <b>Category.BrandMPNIdentifierEnabled</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not individual categories on the specified site support the ability of a seller to identify a product through a Brand/Manufacturer Part Number (MPN) combination. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdAutoAcceptEnabled</b> and <b>Category.ClassifiedAdAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Classified Ad listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.BestOfferAutoAcceptEnabled</b> and <b>Category.BestOfferAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. Best Offers are not available for auction listings. + + + + + + + If this value is specified, the <b>CrossBorderTradeNorthAmericaEnabled</b>, <b>CrossBorderTradeGBEnabled</b>, and <b>CrossBorderTradeAustraliaEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the International Site Visibility (Cross-Border Trade) feature, and on which sites. With the International Site Visibility feature, the seller is able to create a listing and make this listing available on multiple eBay sites (not just their domestic eBay site). The International Site Visibility feature is discussed more on the <a href="http://pages.ebay.com/help/sell/globalexposure.html">Getting exposure on international sites</a> help topic. + + + + + + + If this value is specified, the <b>SiteDefaults.PayPalBuyerProtectionEnabled</b> and <b>Category.PayPalBuyerProtectionEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories are enabled with PayPal Purchase Protection. Of course, an eligible item must be purchased with PayPal to be eligible for PayPal Purchase Protection. + + + + + + + If this value is specified, the <b>SiteDefaults.BuyerGuaranteeEnabled</b> and <b>Category.BuyerGuaranteeEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories are enabled with the Australian version of the Buyer Protection program. This enumeration value is only applicable to the eBay Australia site. + + + + + + + If this value is specified, the <b>Category.INEscrowWorkflowTimeline</b> fields in the <b>GetCategoryFeatures</b> response will indicate the escrow workflows that will be used for individual categories on the eBay India site. This enumeration value is only applicable to the eBay India site, and only if Paisa Pay Full Escrow is an accepted payment method. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.GalleryFeaturedDurations</b> container in the <b>GetCategoryFeatures</b> response will indicate the listing duration times that the Featured Gallery feature may be enabled for a listing. + + + + + + + If this value is specified, the <b>SiteDefaults.PayPalRequired</b> and <b>Category.PayPalRequired</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require PayPal as one of the accepted payment methods in a listing. This value is not applicable in countries where PayPal is not available. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProAdFormatEnabled</b> and <b>Category.eBayMotorsProAdFormatEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow motor vehicles to be sold through Classified Ads. This value is only applicable for eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByPhoneEnabled</b> and <b>Category.eBayMotorsProContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide contact phone numbers within a Motor Vehicles Classified Ad listing. The <b>Category.eBayMotorsProPhoneCount</b> field indicates how many contact phone numbers are supported in each listing. This feature is only applicable to Motor Vehicles Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByAddressEnabled</b> and <b>Category.eBayMotorsProContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide contact street addresses within a Motor Vehicles Classified Ad listing. The <b>Category.eBayMotorsProStreetCount</b> field indicates how many contact street addresses are supported in each listing. This feature is only applicable to Motor Vehicles Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProCompanyNameEnabled</b> and <b>Category.eBayMotorsProCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide a company name within a Motor Vehicles Classified Ad listing. This feature is only applicable to Motor Vehicles Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProContactByEmailEnabled</b> and <b>Category.eBayMotorsProContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Motors Pro users to provide a contact email address within a Motor Vehicles Classified Ad listing. This feature is only applicable to Motor Vehicles Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProBestOfferEnabled</b> and <b>Category.eBayMotorsProBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Motor Vehicles Classified Ad listings. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProAutoAcceptEnabled</b> and <b>Category.eBayMotorsProAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Motor Vehicles Classified Ad listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProAutoDeclineEnabled</b> and <b>Category.eBayMotorsProAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Motor Vehicles Classified Ad listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProPaymentMethodCheckOutEnabled</b> and <b>Category.eBayMotorsProPaymentMethodCheckOutEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProShippingMethodEnabled</b> and <b>Category.eBayMotorsProShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProCounterOfferEnabled</b> and <b>Category.eBayMotorsProCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Motor Vehicles Classified Ad listings. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.eBayMotorsProSellerContactDetailsEnabled</b> and <b>Category.eBayMotorsProSellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Motor Vehicles Classified Ad listing. This feature is only applicable for Motor Vehicles Classified Ad listings, and is only available to eBay Motors Pro users. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketAdFormatEnabled</b> and <b>Category.LocalMarketAdFormatEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow motor vehicles to be sold through Local Market Classified Ads. Motors Local Market listings are only available to eBay sellers who are Licensed Vehicle Dealers on eBay. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketContactByPhoneEnabled</b> and <b>Category.LocalMarketContactByPhoneEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact phone numbers within a Motors Local Market listing. The <b>Category.LocalMarketPhoneCount</b> field indicates how many contact phone numbers are supported in each listing. This feature is only applicable to Motors Local Market listings. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketContactByAddressEnabled</b> and <b>Category.LocalMarketContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact street addresses within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketCompanyNameEnabled</b> and <b>Category.LocalMarketCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide a company name within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketContactByEmailEnabled</b> and <b>Category.LocalMarketContactByEmailEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Licensed Vehicle Dealers to provide contact email addresses within a Motors Local Market listing. This feature is only applicable to Motors Local Market listings. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketBestOfferEnabled</b> and <b>Category.LocalMarketBestOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer feature for Motors Local Market listings. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketAutoAcceptEnabled</b> and <b>Category.LocalMarketAutoAcceptEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto accept feature for Motors Local Market listings. With the Best Offer auto accept feature, the seller sets a price threshold, and all Best Offers and counter offers at or above this price value are automatically accepted without any seller action. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketAutoDeclineEnabled</b> and <b>Category.LocalMarketAutoDeclineEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Best Offer auto decline feature for Motors Local Market listings. With the Best Offer auto decline feature, the seller sets a price threshold, and all Best Offers and counter offers below this price value are automatically declined without any seller action. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketPaymentMethodCheckOutEnabled</b> and <b>Category.LocalMarketPaymentMethodCheckOutEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not (and when) accepted payment methods are displayed to buyers for the specified eBay site and for individual categories. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketShippingMethodEnabled</b> and <b>Category.LocalMarketShippingMethodEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the display of available shipping methods to buyers. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketCounterOfferEnabled</b> and <b>Category.LocalMarketCounterOfferEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support Best Offer counter offers for Motors Local Market listings. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.LocalMarketSellerContactDetailsEnabled</b> and <b>Category.LocalMarketSellerContactDetailsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow the seller to provide contact information within a Motors Local Market listing. This feature is only applicable for Motors Local Market listings, and is only available to eBay Licensed Vehicle Dealers. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdContactByAddressEnabled</b> and <b>Category.ClassifiedAdContactByAddressEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to provide contact street addresses within a Classified Ad listing. The <b>Category.ClassifiedAdStreetCount</b> field indicates how many street addresses are allowed in each listing. This feature is only applicable to Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.ClassifiedAdCompanyNameEnabled</b> and <b>Category.ClassifiedAdCompanyNameEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to provide a company name within a Classified Ad listing. This feature is only applicable to Classified Ad listings. + + + + + + + If this value is specified, the <b>SiteDefaults.SpecialitySubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a specialty dealer subscription for selling motor vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.RegularSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a regular dealer subscription for selling motor vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.PremiumSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers with a premium dealer subscription for selling motor vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.NonSubscription</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site supports Motors National listings for sellers without a dealer subscription for selling motor vehicles. + + + + + + + If this value is specified, the <b>SiteDefaults.IntangibleEnabled</b> and <b>Category.IntangibleEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to sell intangible items. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.ReviseQuantityAllowed</b> and <b>Category.ReviseQuantityAllowed</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to revise quantity in a multi-quantity, fixed-price listing while the listing is in a semi- or fully-restricted mode (such as when the listing already has sales or when the listing is scheduled to end within 12 hours). This value is only applicable to fixed-price listings. + + + + + + + If this value is specified, the <b>SiteDefaults.RevisePriceAllowed</b> and <b>Category.RevisePriceAllowed</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow sellers to revise the price in a fixed-price listing while the listing is in a semi- or fully-restricted mode (such as when the listing already has sales or when the listing is scheduled to end within 12 hours). This value is only applicable to fixed-price listings. + + + + + + + If this value is specified, the <b>SiteDefaults.StoreOwnerExtendedListingDurationsEnabled</b> and <b>Category.StoreOwnerExtendedListingDurationsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay Store sellers to create fixed-price listings with longer listing durations than sellers without eBay Stores. This value is only applicable to fixed-price listings. + + + + + + + If this value is specified, the <b>SiteDefaults.StoreOwnerExtendedListingDurations</b> container in the <b>GetCategoryFeatures</b> response will indicate the extended listing duration times that eBay Store sellers may set when creating a fixed-price listing. This value is only applicable to fixed-price listings. The site and category must support extended listing durations (<b>StoreOwnerExtendedListingDurationsEnabled</b>=true). + + + + + + + If this value is specified, the <b>SiteDefaults.ReturnPolicyEnabled</b> and <b>Category.ReturnPolicyEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories allow eBay sellers to create a return policy for the listing. + + + + + + + If this value is specified, the <b>SiteDefaults.HandlingTimeEnabled</b> and <b>Category.HandlingTimeEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories require eBay sellers to set a handling time for products sold within the listing. The handling time is the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. The seller's handling time does not include the shipping time (the carrier's transit time). + + + + + + + If this value is specified, the <b>SiteDefaults.PaymentMethod</b> and <b>SiteDefaults.PaymentMethod</b> fields in the <b>GetCategoryFeatures</b> response will indicate the accepted payment methods at the eBay site level and within the individual categories. + + + + + + + If this value is specified, the <b>Category.MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically. At least one available shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold. + + + + + + + If this value is specified, the <b>SiteDefaults.MaxFlatShippingCostCBTExempt</b> boolean field in the <b>GetCategoryFeatures</b> response will indicate whether or not sellers, who sell items to domestic buyers, but are shipping the item from another country, are exempt from the <b>MaxFlatShippingCost</b> threshold. + + + + + + + If this value is specified, the <b>Category.Group1MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 1 shipping service. At least one available Group 1 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold. + + + + + + + If this value is specified, the <b>Category.Group2MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 2 shipping service. At least one available Group 2 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold. + + + + + + + If this value is specified, the <b>Category.Group3MaxFlatShippingCost</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum flat-rate shipping costs that the seller may charge the buyer to ship one item domestically using a Group 3 shipping service. At least one available Group 3 shipping service option has to be under this value. Handling cost (if any) goes toward this maximum cost threshold. + + + + + + + If this value is specified, the <b>SiteDefaults.VariationsEnabled</b> and <b>Category.VariationsEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support multi-variation listings. Variations are items within the same listing that are logically the same product, but differ slightly in size, color, or other aspect. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.FreeGalleryPlusEnabled</b> and <b>Category.FreeGalleryPlusEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support a free Gallery Plus upgrade. The Gallery Plus feature includes the picture zoom option (when you hover the mouse over the picture) and the ability to enlarge the photo by clicking a link. + + + + + + + If this value is specified, the <b>SiteDefaults.FreePicturePackEnabled</b> and <b>Category.FreePicturePackEnabled</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support a free Picture Pack upgrade. The Picture Pack feature is only available for eBay Motors vehicle listings. The Picture Pack feature includes up to 12 supersized photos with the zoom feature enabled for each one. + + + + + + + If this value is specified, the <b>SiteDefaults.ItemCompatibilityEnabled</b> and <b>Category.ItemCompatibilityEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the Parts Compatibility feature, and if so, the mode of compatibility that is used (by application or by specification). The Parts Compatibility feature allows sellers to list their motor vehicles parts and accessories items with parts compatibility name-value pairs specific to motor vehicles, and allows potential buyers to search for these items using parts compatibility search fields. + + + + + + + If this value is specified, the <b>Category.MinCompatibleApplications</b> fields in the <b>GetCategoryFeatures</b> response will indicate the minimum number of compatible applications that must be specified when listing a motor vehicle part or accessory in the given category. + + + + + + + If this value is specified, the <b>Category.MaxCompatibleApplications</b> fields in the <b>GetCategoryFeatures</b> response will indicate the maximum number of compatible applications that can be specified when listing a motor vehicle part or accessory in the given category. + + + + + + + If this value is specified, the <b>Category.ConditionEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate which individual categories support (and even require) the use of <b>ConditionID</b> values to specify the condition of an item within a listing. + + + + + + + If this value is specified, the <b>Category.Condition</b> containers in the <b>GetCategoryFeatures</b> response will include Condition ID values and item conditions like 'Very Good', 'Acceptable', 'Used', etc. for all categories that support the use of Condition ID values. + + + + + + + If this value is specified, the <b>Category.ValueCategory</b> boolean fields in the <b>GetCategoryFeatures</b> response will indicate the categories that are considered by eBay to be 'Value Categories'. 'Value Categories' are generally categories where buyers can find good deals on items. If sellers decide to list within a value category, only this category may be used, and a secondary category is not supported. + + + + + + + If this value is specified, the <b>SiteDefaults.ProductCreationEnabled</b> and <b>Category.ProductCreationEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support (and even require) the use of creating a listing through a product ID and leveraging the defined values/settings of an eBay Catalog product. + + + + + + + If this value is specified, the <b>Category.MaxGranularFitmentCount</b> fields in the <b>GetCategoryFeatures</b> response will indicate how many Parts Compatibility name-value pairs may be passed in for each motor vehicle aspect (Year, Make, and Model) in a motor vehicle parts and accessory listing. granularity. This field is only applicable to motor vehicle parts and accessory listings. + + + + + + + If this value is specified, the <b>Category.CompatibleVehicleType</b> fields in the <b>GetCategoryFeatures</b> response will indicate the type of vehicle that parts compatibility name-value pairs in a listing will be referring to, such as 'cars and trucks', 'all-terrain vehicles (ATV)', 'boats', and 'motorcycles'. This field is only applicable to motor vehicle parts and accessory listings. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>Category.ShippingProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which shipping business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories. + + + + + + + If this value is specified, the <b>Category.PaymentProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which payment business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories. + + + + + + + If this value is specified, the <b>Category.ReturnPolicyProfileCategoryGroup</b> fields in the <b>GetCategoryFeatures</b> response will indicate which return policy business policy category group that each category will inherit as the default category group. Currently, there are only two Business Policies category groups - 'MOTORS_VEHICLE' covers all motor-vehicle related categories, and 'ALL' covers all other categories. + + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + This value is <b>deprecated</b> and should no longer be used. + + + + + + + If this value is specified, the <b>SiteDefaults.GlobalShippingEnabled</b> and <b>Category.GlobalShippingEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate if the eBay site and individual categories support the Global Shipping Program (GSP) as a means for shipping items internationally. The GSP feature is only applicable to shipping items internationally. + + + + + + + + If this value is specified, the <b>SiteDefaults.AdditionalCompatibilityEnabled</b> and <b>Category.AdditionalCompatibilityEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate whether or not the specified eBay site and individual categories support the second-generation Parts Compatibility feature where parts-compatibility name-value pairs can be passed in for boats, motorcycles, and other vehicles instead of just cars and trucks. This feature is only applicable to motor vehicle parts and accessory listings. + + + + + + + If this value is specified, the <b>Category.PickupDropOffEnabled</b> fields in the <b>GetCategoryFeatures</b> response will indicate that items listed in the corresponding category may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. A 'false' value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature. + <br/><br/> + The 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + + + + + + + + Specifies whether a listing feature is enabled for this site and whether it is restricted to a set of sellers. + + + + + + + The listing feature is enabled for the site. + + + + + + + Indicates that Featured First is disabled for the site. + In this case, listings containing Featured First are listed, + but Featured First is dropped and a warning is returned. + + + + + + + The listing feature is restricted to PowerSellers. + + + + + + + The listing feature is restricted to TopRatedSellers. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Specifies whether a listing feature is enabled for this site and whether it is restricted to a set of sellers. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + The listing feature is restricted to PowerSellers. + + + + + + + The listing feature is restricted to TopRatedSellers. + + + + + + + Reserved for internal or future use. + + + + + + + + + + FedEx Rate Options + + + + + + + FedEx Standard List Rates + + + + + + + FedEx Counter Rates + + + + + + + FedEx Discounted Rates + + + + + + + Reserved for internal or future use + + + + + + + + + + Identifies the name and cost of a listing feature that a member pays to eBay (or an eBay + company). These listing feature names, fees, and possible discounts are intended only as + an aid to help estimate the fees for a listing. Use GetAccount for an accurate final fee + breakdown. Returned in AddItemResponseType and related response types. + + + + + + + Name of the listing feature, for identification purposes. + + + + Fees Resulting from Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-Fees.html + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + RelistFixedPriceItem + RelistItem + ReviseInventoryStatus + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Always + + + + + + + + Amount of the fee that eBay will charge the member for the associated listing + feature. + + + + eBay.com Fees + http://pages.ebay.com/help/sell/fees.html + A current schedule of listing features and their associated fees. + + + + Fees Resulting from Listing an Item + http://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ListingFeesType.html + A table listing the type of fees that can be charged when you list an item. + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseInventoryStatus + ReviseItem + ReviseLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Always + + + + + + + + This field exists in the response when the user has selected a feature that + participates in a promotional discount. + <br/><br/> + <span class="tablenote"><b>Note: </b> + Verify calls might not return the PromotionalDiscount fee in the response. + </span> <br/><br/> + + + + Standard selling fees + http://pages.ebay.com/help/sell/fees.html + A current schedule of listing features and their associated fees. + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + RelistFixedPriceItem + ReviseInventoryStatus + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Always + + + + + + + + + + + + Contains one or more stored comments for use as feedback to buyers. + + + + + + + This comment is for use as feedback for buyers. No more than ten (10) + comments can be stored. + + + + SetSellingManagerFeedbackOptions + Yes + + + + + + + + + + + Contains multiple individual feedback detail entries. + + + + + + + Contains a single feedback detail entry. Output only. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + Container consisting of detailed information on a Feedback entry for a specific + order line item. + + + + + + + The eBay User ID of the user who left the feedback. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The Feedback score of the user indicated in <b>CommentingUser</b>. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Textual comment that explains, clarifies, or justifies the Feedback rating specified + in <b>CommentType</b>. + <br><br> + The comment is returned as text in the language that the comment was originally left + in. This comment will still be displayed even if a submitted Feedback entry is + withdrawn. + + + 80 (125 for Taiwan) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Timestamp (in GMT) indicating the date/time that the Feedback entry was submitted + to eBay. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This value indicates the rating of the feedback left by the user identified by + <b>CommentingUser</b>. + <br><br> + A Positive rating increases a user's Feedback score, a Negative rating decreases + a user's Feedback score, and a Neutral rating does not affect a user's Feedback + score. + <br><br> + Sellers cannot leave Neutral or Negative ratings for buyers. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Textual comment that the recipient of the feedback may leave in response or + rebuttal to the feedback. Responses to Feedback comments cannot be submitted or + edited via the API. + + + 80 (125 for Taiwan) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Explanation a user can give to a response. Follow-ups to Feedback comments cannot be + submitted or edited via the API. + + + 80 (125 for Taiwan) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The unique identifier that uniquely identifies the item listing. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the recipient of the Feedback entry is the buyer + or the seller for the corresponding order line item. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Name of the item listing for which feedback was provided. Returned as CDATA. This + value can be returned as part of the Detailed Seller Ratings feature. + Not returned if a listing ended more than 90 days ago. + + + 80 + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The final price for the item, associated with + the currency identified by the <b>CurrencyID</b> attribute of the <b>AmountType</b>. + This value can be returned as part of the Detailed Seller Ratings feature. + Not returned if a listing ended more than 90 days ago. + + + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Unique identifier for the feedback entry. + Returned for a detail level of <b>ReturnAll</b> (if the parent is returned). + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Unique identifier for an eBay order line item for which the + Feedback entry was left. This field is not returned if the Feedback entry was left + for an auction listing, since all auction listings have a <b>TransactionID</b> + value of 0. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Flag used to indicate whether or not eBay replaced the Feedback comment with a + message that the Feedback comment was removed. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Flag used to indicate whether or not eBay replaced the response to the Feedback + comment with a message that the response to the Feedback comment was removed. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Flag used to indicate whether or not eBay replaced the follow-up to the Feedback + comment with a message that the follow-up to the Feedback comment was removed. + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The flag indicates whether or not the Feedback entry will affect the user's Feedback + score. Only feedback left by verified users can count toward the aggregate score of + another user. If a unverified user leaves a Feedback entry, then later + becomes verified, that Feedback entry will still have no affect on the recipient + user's Feedback score. Or, if a user is verified and at some later date changes to + unverified status, the Feedback entry left while the user was verified remains + in effect. + + + true + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + (GetUser) ItemDetails + GetUser.html#Response.User.SiteVerfied + + + + + + + + Flag used to indicate whether or not a Feedback entry was revised (rating was + changed). + + + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. + <br> + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + GetFeedback +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the Feedback details for an order line item, including the eBay User ID + of the user the feedback is intended for, the Feedback rating, and the Feedback comment. + + + + + + + Textual comment that explains, clarifies, or justifies the Feedback rating specified + in <b>CommentType</b>. This field is required in <b>CompleteSale</b> if the + <b>FeedbackInfo</b> container is used. + <br><br> + This comment will still be displayed even if submitted Feedback is withdrawn. + + + 80 + + CompleteSale + Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This value indicates the Feedback rating for the user specified in the + <b>TargetUser</b> field. This field is required in <b>CompleteSale</b> if the + <b>FeedbackInfo</b> container is used. + <br><br> + A Positive rating increases the user's Feedback score, a Negative rating decreases + the user's Feedback score, and a Neutral rating does not affect the user's Feedback + score. eBay users also have the right to withdraw feedback for whatever reason. + <br><br> + Sellers cannot leave Neutral or Negative ratings for buyers. + + + + CompleteSale + Positive + Conditionally + + + GetItemsAwaitingFeedback + Conditionally + FeedbackReceived + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This eBay User ID identifies the recipient user for whom the feedback is being left. + This field is required in <b>CompleteSale</b> if the + <b>FeedbackInfo</b> container is used. + + + + CompleteSale + No + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Container for a set of feedback statistics. Contains zero one or + multiple FeedbackPeriod objects. Output only, for the summary + feedback data returned by GetFeedback. + + + + + + + Contains one feedback statistic giving length of the period being reported + (e.g. last 7 days prior to the call), and total number of feedback entries + (of the type given by the container, e.g. positive feedback) submitted during + the indicated period. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + Contains the data for one type of feedback for one predefined time + period. Parent FeedbackPeriodArrayType object indicates the type of + feedback counted: positive, neutral, negative, or total. Output only, + in the summary feedback data returned by GetFeedback. + + + + + + + Indicates the time period for the feedback count. Returns a value indicating + the number of days prior to the call for which feedback entries of the particular + type are counted. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of the feedback entries received by the user for the time period prior to the + call indicated in PeriodInDays. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Applicable to sites that support the Detailed Seller Ratings feature. + The FeedbackRatingDetailCodeType is the list of areas for detailed seller ratings. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. + + + + + + + Detailed seller rating in the area of "item as described." + + + + + + + Detailed seller rating in the area of "communication." + + + + + + + Detailed seller rating in the area of "shipping time." Inapplicable to + motor vehicle items. + + + + + + + Detailed seller rating in the area of "charges for shipping and handling." + Inapplicable to motor vehicle items. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + The color of a feedback score star visually denotes the + range in which the member's summary feedback score falls. The score + is the net positive feedback minus the net negative feedback left + for the member. + + + + + + + No graphic displayed, feedback score 0-9. + + + + + + + Yellow Star, feedback score 10-49. + + + + + + + Blue Star, feedback score 50-99. + + + + + + + Turquoise Star, feedback score 100-499. + + + + + + + Purple Star, feedback score 500-999. + + + + + + + Red Star, feedback score 1,000-4,999 + + + + + + + Green Star, feedback score 5,000-9,999. + + + + + + + Yellow Shooting Star, feedback score 10,000-24,999. + + + + + + + Turquoise Shooting Star, feedback score 25,000-49,999. + + + + + + + Purple Shooting Star, feedback score 50,000-99,999. + + + + + + + Red Shooting Star, feedback score 100,000-499,999. + + + + + + + Green Shooting Star, feedback score 500,000-999,999. + + + + + + + Silver Shooting Star, feedback score 1,000,000 and above. + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + Used to determine whether the seller meets the minimum feedback + requirements for Express. + + + + + + + + + + + + + + Types of feedback responses. + + + + + + + A reply to feedback left by another user. + + + + + + + A follow-up to a feedback comment left for another user. + + + + + + + Reserved for future use. + + + + + + + + + + These are the various summary periods for which feedback is calculated. + + + + + + + + + Period including the last 30 days from today. + + + + + + + + + Period including the last 52 weeks from today. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Specifies all feedback summary information (except Score). Contains + FeedbackPeriodArrayType objects that each convey feedback counts for positive, + negative, neutral, and total feedback counts - for various time periods each. Also + conveys counts of bid retractions for the predefined time periods. + + + + + + + Bid retractions count, for multiple predefined time periods preceding + the call. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Negative feedback entries count, for multiple predefined time periods preceding + the call. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Neutral feedback entries count, for multiple predefined time periods preceding + the call. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Positive feedback entries count, for multiple predefined time periods + preceding the call. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Total feedback score, for multiple predefined time periods preceding the + call. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Number of neutral comments received from suspended users. Returned if no + detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Total number of negative Feedback comments, including weekly repeats. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Total number of positive Feedback comments, including weekly repeats. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Total number of neutral Feedback comments, including weekly repeats. Returned if no detail level is specified. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Container for information about detailed seller ratings (DSRs) + that buyers have left for a seller. + Sellers have access to the number of ratings they've received, as well as + to the averages of DSRs they've received in each + DSR area (i.e., to the average of ratings in the item-description area, etc.). + The DSR feature is available on the United Kingdom site + and on the following other sites: AU (site ID 15), BEFR (site ID 23), + BENL (site ID 123), FR (site ID 71), IE (site ID 205), IN (site ID 203), + IT (site ID 101), and PL (site ID 212). The DSR feature is available on the other + API-enabled country sites, including the US site (site ID 0). + + + + Detailed Seller Ratings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Feedback.html + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + Container for information about 1 year feedback metric as seller. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + Container for information about 1 year feedback metric as buyer. + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + + + + + These are the codes used to specify the type of feedback/feedbacktype in a single feedback record. Additional information about feedback is available in the + online Help of the eBay website. + + + + + + + Retrieves feedback left by all buyers for this user. + + + + + + + Retrieves feedback left by all sellers for this user. + + + + + + + Retrieves feedback left by all buyers and all sellers for this user. + + + + + + + Feedback left for others. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Identifies a set of one or more fees that a member pays to eBay (or + an eBay company). Instances of this type can hold one or more fees. + + + + + + + Contains the name, fee, and possible discount amount for an item listing feature. + A Fee container is returned for each listing feature, even if the associated cost + (Fee value) is 0. + + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + ReviseInventoryStatus + VerifyRelistItem + Always + + + AddItemFromSellingManagerTemplate + AddSellingManagerTemplate + GetSellingManagerTemplateAutomationRule + GetSellingManagerItemAutomationRule + SetSellingManagerTemplateAutomationRule + SetSellingManagerItemAutomationRule + GetSellingManagerTemplateAutomationRule + DeleteSellingManagerItemAutomationRule + DeleteSellingManagerTemplateAutomationRule + ReviseSellingManagerTemplate + Conditionally + + + + + + + + + + + Ranges for use when offering insurance in <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + orders. + + + + + + + Range is 0.01 to 9.99 + + + + + + + Range is 10.00 to 49.99 + + + + + + + Range is 50.00 to 99.99 + + + + + + + Range is 100.00 to 199.99 + + + + + + + Range is 200.00 to 299.99 + + + + + + + Range is 300.00 or greater + + + + + + + Reserved for internal or future use + + + + + + + + + + A pairing of range and insurance cost. + + + + + + + The price range for the shipment for which the insurance cost is being + specified. This field is no longer applicable to SetUserPreferences or + GetUserPreferences. + + + + GetShippingDiscountProfiles + GetUserPreferences + Conditionally + + + SetShippingDiscountProfiles + SetUserPreferences + No + + + + + + + + The cost of insurance for the specified price range. This field is no longer + applicable to SetUserPreferences or GetUserPreferences. + + + + GetShippingDiscountProfiles + GetUserPreferences + Conditionally + + + SetShippingDiscountProfiles + SetUserPreferences + No + + + + + + + + + + + + Details of an individual discount profile defined by the + user for flat rate shipping. + + + + + + + The type of discount or "rule" that is being used by the profile. + The value corresponding to the selected rule is set in the same-named field + of FlatShippingDiscount.DiscountProfile. All are "variable" rules, as + defined in the documentation on shipping discount profiles. + + + + GetShippingDiscountProfiles + + EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff + + Conditionally + + + SetShippingDiscountProfiles + + EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff + + Conditionally + + + GetItem + GetSellingManagerTemplates + + EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff + +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + Details of this particular flat rate shipping discount profile. If + ModifyActionCode is Modify, all details of the new version of the profile must + be provided. If ModifyActionCode is Delete, DiscountProfileID is required, + MappingDiscountProfileID is optional, and all other fields of DiscountProfile + are ignored. Restrictions of how many profiles you can have for a given + discount rule are discussed in the documentation on shipping discount + profiles. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + + EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff + + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + + + + + This type is deprecated; use <b>SetShippingDiscountProfiles</b> to set Flat Shipping preferences. + + + + + + + + + DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Flat Rate Shipping discount profiles. + + + + + + + + + + + + DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Flat Rate Shipping discount profiles. + + + + + + + + + + + + DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through + SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. + <br><br> + FlatRateInsuranceRangeCost is only valid on the following eBay sites: AU, FR, IT, and IN. + + + + + + + + + + + + DO NOT USE THIS FIELD. Flat Rate Shipping discount profiles are created and + managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to + retrieve Flat Rate Shipping discount profiles. + + + + + + + + + + + + DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through + SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. + <br><br> + InsuranceOption is only valid on the following eBay sites: AU, FR, IT, and IN. + + + + + + + + + + + + + + + This type is deprecated; use <b>SetShippingDiscountProfiles</b> to set Flat Shipping preferences. + + + + + + + + + Charge highest shipping cost for the first item and + X amount for each + additional item. + + + + + + + + + + + Charge highest shipping cost for the first item and deduct X amount from the + shipping cost of each additional item. + + + + + + + + + + + Charge highest shipping cost for the first item and ship each additional item free. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + Defines the feature for free, automatic upgrades for Gallery Plus. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the feature for free, automatic upgrades for Picture Pack. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Specifies how cross-promoted items with gallery images + should be displayed. + + + + + + + Show any items, in no particular order. + + + + + + + Show items with gallery images first, before + other items. + + + + + + + Show only items with gallery images. + + + + + + + Reserved for internal or future use. + + + + + + + + + + The status of gallery image generation. That status will return either a value of 'Success' or + a value that indicates why the gallery image has not been generated. + + + + + + + Gallery Image successfully generated. + + + + + + + Gallery image has not yet been generated. + + + + + + + The URL for the image is not valid. + + + + + + + URL does not start with http:// - That is the only protocol currently supported for pictures. + + + + + + + There is a problem with the file containing the image. + + + + + + + The server containing your image was unavailable when we tried to retrieve it. + + + + + + + We could not find your Gallery image when we went to retrieve it. + + + + + + + The image failed to come across the Internet when we tried to retrieve it. + + + + + + + The file containing your image is not in standard jpeg, bmp, or tif format. + + + + + + + We were not able to process the image. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Indicates which Gallery image enhancements to apply to the listing. + + + + + + + Gallery is supported free on all sites. So this field is useful only for removing an existing feature setting when using <b>RelistItem</b>. + + + + + + + Highlights the listing by randomly placing it at the top of the search results. + When Featured is included in an item listing, the listing also automatically gets the + Gallery and Plus functionality at no extra cost. + <br><br> + <span class="tablenote"><b>Sites That Support Featured:</b> + You can check if a site supports Featured by using the + <b>GeteBayDetails</b> call and passing in <b>ListingFeatureDetails</b> + in the <b>DetailName</b> field. In the response, check the + <b>ListingFeatureDetails</b> container for <b>FeaturedFirst</b>. + </span> <br/><br/> + + + + + + + This feature, which is free on all sites, adds a Gallery image in the search results. A Gallery image is an image that was uploaded and copied to EPS (eBay Picture Service). This copy is stored for a finite period (usually 30 days) until the image is associated with a listing. Once the image is associated with a listing, the period is extended to 90 days after the item's sale_end date and is extended again if the item is relisted or used in subsequent listings. As part of storing a copy, EPS also makes additional sizes available (thumbnail, main image, zoom layer, supersize popup, etc.), which are used by the various Gallery enhancements. + <br/><br/> + All images must comply to the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements.</a> + + + + + + + Adds a Gallery Plus icon to the listing. + <br/><br/> + When Plus is selected in a request that specifies at least two eBay Picture Services (EPS) hosted images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature automatically includes a Gallery Showcase of all the listing's images. + <br><br> + The Gallery Showcase displays when hovering over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400px x 400px) preview image which is usually the first specified PictureURL, as well as up to 11 (64 px x 64 px) selectable thumbnails for the remaining EPS images. Clicking on the preview image displays the item's listing page. + <br/><br/> + If Plus is selected and the request includes only one EPS image or any self-hosted images, the listing includes a Gallery Plus icon that, when hovered over or clicked, displays a large (400px x 400px) preview image of the item. Clicking the image displays the View Item page for that listing. + <br><br> + When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing. + <br><br> + When "Plus" is included in an item listing, the listing also automatically gets the + Gallery functionality at no extra cost. "Gallery" does not need to be specified + separately in the listing. + <br><br> + Listing images that are originally smaller than 400px x 400px are centered in the + preview frame. Images that are originally larger than 400px x 400px are scaled down + to 400px on their longest side (maintaining their original aspect ratio). + <br><br> + Not applicable to eBay Stores Inventory listings. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + Custom Code. + + + + + + + + + + + Electronic check. + + + + + + + + + + + ACH. + + + + + + + + + + + Credit-card. + + + + + + + + + + + Pay balance. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + Used to indicate the listing options. Each of the subscriptions will + have following options, which will define "National" vs "Local" ad format + listing. + + + + + + + Seller can not opt into local exposure. It has to be + national listing. + + + + + + + Seller can have Local listings only. + + + + + + + This will allow national and local listing. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies which bidder information to return. + + + + + + + (in) Returns all bidders for an ended or still-active + listing. It may be used by any user. + + + + + + + (in) Returns all non-winning bidders for ended + listings only. It may be used only by a seller. + + + + + + + (in) Returns all non-winning bidders for an ended listing + who have not yet received a Second Chance Offer and noted + interest in receiving a Second Chance Offer. It may be used + only by a seller. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies the data for a single item and configures the recommendation engines to use + when processing the item with GetItemRecommendations. + + + + + + + The listing flow for which the seller is seeking Listing Analyzer recommendations. + Not applicable to results from other recommendation engines + (i.e., the Suggested Attributes engine or the Product Pricing engine). + The default flow is AddItem. + + + + AddItem + GetItemRecommendations + No + + + + + + + + Contains fields that describe the item for which you are seeking recommendations. <br> + <br> + If the Listing Analyzer recommendation engine is run, the applicable fields are + the same as the fields for AddItem, ReviseItem, or RelistItem + requests, as determined by the value specified in ListingFlow. + The item ID (Item.ItemID) is required when the ListingFlow is ReviseItem or RelistItem, + and it is not applicable when the ListingFlow is AddItem. + All other item fields are optional, even if listed as required for other calls. + However, as some tips are dependent on the properties of the item, and as some properties + have dependencies on other properties, we strongly recommend that you include all the item properties + that will be included in the AddItem, ReviseItem, or RelistItem request. + When the Listing Analyzer engine is run, tips will only be returned for fields that are specfied on the item.<br> + <br> + When the Product Pricing engine is run, pricing data will be based on the catalog product you specify. + + + + GetItemRecommendations + Yes + + + + + + + + A recommendation engine to run. If no engines are specified, all available + recommendation engines will run. Some engines require additional fields, + such as Item.PrimaryCategory.CategoryID, to be specified. + If the ProductPricing engine is specified but Item.ProductListingDetails is not specified, + no Product Pricing engine results are returned. + + + + GetItemRecommendations + No + + + + + + + + One or more keywords to search for when using the Suggested Attributes engine. + Required when SuggestedAttributes is specified as the recommendation engine + (including when no recommendation engines are specified). Only the listing title + is searched. The words "and" and "or" are treated like any other word. + Blank searches are not allowed (and result in a warning). + + + 350 (characters) + + GetItemRecommendations + Conditionally + + + + + + + + Unique key to identify the response that matches this recommendation request container. + Use this key to distinguish between responses when multiple + recommendation containers are specified (i.e., for batch requests). + You define the key. To be useful, each correlation ID should be unique within + the same call. That is, define a different correlation ID for each recommendation + request container. (eBay does not validate the uniqueness of these IDs.) + If specified, the same correlation ID will be returned in the corresponding + recommendation response (or error response). + We recommend that you use this when retrieving recommendations for multiple items at once. + + + + GetItemRecommendations + No + + + + + + + + Specifies the name of the field to remove from a listing. + Applicable when the ListingFlow is ReviseItem or RelistItem. + See ReviseItem and RelistItem for applicable values. + + + + GetItemRecommendations + Conditionally + + + (RelistItem) DeletedField + RelistItem.html#Request.DeletedField + + + (ReviseItem) DeletedField + ReviseItem.html#Request.DeletedField + + + + + + + + If true, the Relationship node is not returned for any + recommendations. Relationship recommendations tell you whether + an Item Specific value has a logical dependency on another + Item Specific.<br> + <br> + For example, in a clothing category, Size Type could be + recommended as a parent of Size, because Size=Small would + mean something different to buyers depending on whether + Size Type=Petite or Size Type=Plus.<br> + <br> + In general, it is a good idea to retrieve and use relationship + recommendations, as this data can help buyers find the items + they want more easily.<br> + <br> + Only applicable when RecommendationEngine=ItemSpecifics. + + + + GetItemRecommendations + false + No + + + + + + + + If true, returns eBay's level of confidence for each + name and value. Some sellers may find this useful when choosing + whether to use eBay's recommendation or their own name or value. + <br> + <br> + Only applicable when RecommendationEngine=ItemSpecifics. + + + + GetItemRecommendations + false + No + + + + + + + + + + + + Returns recommended changes or opportunities for improvement + related to listing data that was passed in a GetItemRecommendations request. + + + + + + + Contains tips returned from the Listing Analyzer recommendation engine, + if this engine was specified in the request (or if no engine was specified). + + + + GetItemRecommendations + Conditionally + + + + + + + + Reserved for future use. + + + + + + + Contains pricing data returned from the Product Pricing engine, + if this engine was specified in the request (or if no engine was specified). + + + + GetItemRecommendations + Conditionally + + + + + + + + Contains attribute suggestions returned from the Suggested Attributes engine, + if this engine was specified in the request. + The results include suggested attributes and values based on the primary category + and a string you specify in the Query field. Suggestions may only be returned when the + Suggested Attributes engine is specified alone. If you request recommendations by using + multiple engines, suggested attribute data might not be returned. If attributes are returned + with multiple values, the values are returned in order of rank (i.e., the value that best meets + eBay's recommendation criteria is returned first). + + + + GetItemRecommendations + Conditionally + + + + + + + + Contains zero or more product titles and IDs returned from the Suggested Attributes engine, + if this engine was specified in the request (or if no engine was specified). + If applicable, use one of the suggested product IDs to list the item with Pre-filled Item Information. + + + + GetItemRecommendations + Conditionally + + + + + + + + Unique key to distinguish between recommendations for each item. + Matches a correlation ID you defined in the request, if any. + + + + GetItemRecommendations + Conditionally + + + + + + + + Contains custom Item Specifics suggestions returned from the custom + Item Specifics recommendation engine, An Item Specific consists of + a name/value pair, and it may be returned as complete (with name and + one or more values) or partial (name only).<br> + <br> + Only returned when RecommendationEngine=ItemSpecifics. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + Returns catalog product details. This information can be displayed + to the seller prior to listing an item with a catalog product. + Only returned when the request includes a valid eBay ProductID or ProductReferenceID (in Item.ProductListingDetails). + + + + GetItemRecommendations + Conditionally + + + + + + + + The recommended title of the item listing. + + + 80 + + GetItemRecommendations + Conditionally + + + + + + + + + + + + Specifies whether a listing feature is available for the site specified in the request. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Each code identifies an optional service that the seller is offering if the buyer + chooses to purchase the item as a gift. + + + + + + + The seller is offering to ship the item via + an express shipping method as explained in the item description. + + + + + + + The seller is offering to ship to the gift recipient + (instead of to the buyer) after payment clears. + + + + + + + The seller is offering to wrap the item (and optionally include a + card) as explained in the item description. + + + + + + + Reserved for internal or future use + + + + + + + + + + Specifies whether the Global Shipping Program (GSP) is enabled are not. The field is + returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Specifies a predefined subset of fields to return. The predefined set of fields + can vary for different calls. Only applicable to certain calls (see request types + that include a GranularityLevel property). For calls that support this filter, see + the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields that are returned for + each level. Only one level can be specified at a time. For GetSellerList, use + DetailLevel or GranularityLevel in a given request, but not both. For + GetSellerList, if GranularityLevel is specified, DetailLevel is ignored. + + + + + + + (in) For each record in the response, retrieves less data than Medium. + See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields + that are returned when this level is specified. + + + + + + + For each record in the response, retrieves more data than Medium. + See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields + that are returned when this level is specified. + + + + + + + For each record in the response, retrieves more data than Coarse and less data + than Fine. See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/eBay-SelectingFields.html">eBay Features Guide</a> for a list of the output fields + that are returned when this level is specified. + + + + + + + + + + + + + + + + About shipping service group 1. + + + + + + + + + + + About shipping service group 2. + + + + + + + + + + + About shipping service group 3. + + + + + + + + + + + How packaging/handling cost is to be determined for <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + orders. + + + + + + + After eBay assigns the highest packaging/handling cost to the first item, the + packaging/handling cost for each additional item is $n. + + + + + + + After eBay assigns the highest packaging/handling cost to the first item, the + packaging/handling cost for each additional item is to be reduced by amount N. + + + + + + + After eBay assigns the highest packaging/handling cost to the first item, the + packaging/handling cost for each additional item is to be reduced by N percent. + + + + + + + The total packaging/handling cost is to be the sum of the + packaging/handling costs of the individual items. + + + + + + + The packaging/handling cost is to be N for the entire order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the feature that specifies whether a handling time (dispatch time) + could be enabled on the site. + + + + + + + + + + + Specifies whether a listing feature is available for the site specified in the request. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + A generic histogram entry type. + + + + + + + For GetProducts, the number of products found in the domain + (characteristic set or attribute set). If a product is mapped + to more than one domain, it will be counted separately for each + domain. (For example, if the same product can be found in both + Children's Books and Fiction Books, the count for both of these + domains will include that product.) + Furthermore, when a product is mapped to more than one domain, + Product.AttributeSetID only returns the most applicable domain, + as determined by eBay. + + + + + + + + + For GetProducts, this is the domain ID (attribute set ID or + characteristic set ID). + + + + + + + For GetProducts, this is the domain name (attribute set name + or characteristic set name). A domain is like a high-level category. + + + + + + + + + HitCounterCodeType - Type declaration to be used by other schema. + Indicates whether a hit counter is used for the item's listing page + and, if so, what type. + + + + + + + No hit counter. The number of page views will not be available. + + + + + + + A basic style hit counter (US only). Non-US sites will return errors if they use HonestyStyle as input, and should use BasicStyle instead. + + + US + + + + + + + A green LED, computer-style hit counter (US only). Non-US sites will return errors if they use GreenLED as input, and should use RetroStyle instead. + + + US + + + + + + + A hidden hit counter (US only). The number of page views will only be available to + the item's seller. For faster "View Item" page loads, use HiddenStyle. + + + US + + + + + + + A basic style hit counter. + + + + + + + A retro, computer-style hit counter. + + + + + + + A hidden hit counter. The number of page views will only be available to + the item's seller. + + + + + + + Reserved for internal or future use + + + + + + + + + + Specifies whether a listing feature is available for the site specified in the request. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines whether Home Page Featured is available on the site. + + + + + + + + + + + Used to indicate whether Default, WorkFlow A or WorkFlow B is applicable for a category. + + + + + + + Default Escrow timelines apply. + + + + + + + Special Escrow timelines for Workflow A applies. + + + + + + + Special Escrow timelines for Workflow B applies. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the escrow workflow version applicable for the given category on the India site, if the category + supports PaisaPayFullEscrow. If this field is present, the corresponding feature applies to the category. + The field is returned as an empty element. + + + + + + + + + + + This type defines the International Standard Book Number (ISBN) feature, and whether + this feature is enabled at the site level. An empty ISBNIdentifierEnabled + field is returned under the FeatureDefinitions container in GetCategoryFeatures + if the feature is applicable to the site and if ISBNIdentifierEnabled is + passed in as a FeatureID (or if no FeatureID is passed in, hence all features are + returned). + + + + + + + + + + + Enumerated type that defines the possible states of a buyer's request for shipment tracking information. + + + + + + + This value indicates that the shipment tracking request is invalid. + + + + + + + This value indicates that the shipment tracking request is not applicable. + + + + + + + This value indicates that the shipment tracking request is pending a response from the buyer. + + + + + + + This value indicates that the shipment tracking request is pending a response from the seller. + + + + + + + This value indicates that a shipment tracking request was closed with a refund issued to the buyer. + + + + + + + This value indicates that a shipment tracking request was closed with no refund issued to the buyer. + + + + + + + This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer. + + + + + + + This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer. + + + + + + + This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, and it is pending a response from eBay Customer Support. + + + + + + + This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, but it was closed with a refund issued to the buyer. + + + + + + + This value indicates that a shipment tracking request was escalated to an eBay Buyer Protection case, but it was closed with no refund issued to the buyer. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains the cost of shipping insurance and other insurance-related information. + + + + + + + Cost of shipping insurance set by the seller. If the buyer bought more than + one of this item, this is the insurance for just a single item. Exception: + for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. + Value should be greater than 0.00 if InsuranceOption is Optional or Required. + For flat shipping only. Optional as input and only allowed if + ChangePaymentInstructions is true. + <br><br> + Valid only on the following sites: AU, FR, and IT + <br /> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerSaleRecord + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellingManagerSaleRecord + Always + + + + + + + + Whether the seller offers shipping insurance and, if so, whether the insurance + is optional or required. Applies to both flat and calculated shipping. + Optional as input and only allowed if ChangePaymentInstructions is true. + <br><br> + Valid only on the following sites: AU, FR, and IT + <br /> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerSaleRecord + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + NotOfferedOnSite + No + + + GetBidderList + GetItemShipping + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellingManagerSaleRecord + Always + + + + + + + + + + + + The seller's requirements regarding whether the buyer pays + for shipping insurance. + + + + + + + The seller offers the buyer the choice of paying + for shipping insurance or not. + + + + + + + The seller requires that the buyer pay for + shipping insurance. + + + + + + + The seller does not offer shipping insurance to the buyer. + + + + + + + The seller is not charging separately for shipping + insurance costs; any insurance is already included in the + base shipping cost. + + + + + + + Shipping insurance is not offered as a separate option on the site + where the item is listed. (Some shipping services, such as + DE_InsuredExpressOrCourier, include insurance as part of the service.) If + another insurance option is specified in the listing request and the site does + not support shipping insurance as a separate option, eBay will reset the + insurance option to this value. At the time of this writing, this option is + only meaningful for the eBay Germany, Austria, and Switzerland sites. + + + + + + + Reserved for internal or future use + + + + + + + + + + The insurance selected by the buyer. + + + + + + + Shipping insurance was not offered. + + + + + + + Shipping insurance was offered but not selected. + + + + + + + Shipping insurance was offered and selected. + + + + + + + Shipping insurance was required. + + + + + + + Shipping insurance was included in Shipping and Handling fee. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates the sites on which a seller is eligible to offer IMCC as a payment method. + + + + + + + Indicates a site on which a seller has a payment gateway account (and thus + a site on which the seller can use the IntegratedMerchantCreditCard payment method). + + + + GetUser + Conditionally + + + + + + + + + + + + Container consisting of shipping costs and other details related to an international + shipping service. If one or more international shipping services are provided, the + seller must specify at least one domestic shipping service as well. + + + + + + + An international shipping service being offered by the seller to ship an item to + a buyer. For a list of valid values, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ShippingServiceDetails</b>. + To view the full list of International shipping service options in the response, + look for the ShippingService fields in the ShippingServiceDetails containers that + contain a InternationalService=true field, as this indicates that the ShippingService + value is an International shipping service option. + The ShippingServiceDetails.ValidForSellingFlow flag must + also be present. Otherwise, that particular shipping service option is no longer + valid and cannot be offered to buyers through a listing. + <br><br> + For flat and calculated shipping. + + + ShippingServiceCodeType + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GeteBayDetails + + + + + + + + + The meaning of this element depends on the call and on whether flat + or calculated shipping has been selected. (For example, it could be the cost + to ship a single item, the cost to ship all items, or the cost to ship just + the first of many items, with ShippingServiceAdditionalCost accounting for the + rest.) When returned by GetItemShipping, it includes the packaging and + handling cost. For flat and calculated shipping. + <br> + <br> + If a shipping service has been specified, GetItem returns the shipping service + cost, even if the cost is zero. Otherwise, cost is not returned. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + Shipping + + + + + + + + + The cost of shipping each additional item beyond the first item. For input, + this is required if the listing is for multiple items. For single-item + listings, it should be zero (or is defaulted to zero if not provided). + For flat shipping only. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This integer value controls the order (relative to other shipping services) in + which the corresponding ShippingService will appear in the View Item and + Checkout page. Sellers can specify up to five international shipping services + (with five InternationalShippingServiceOption containers), so valid values are + 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 + appears at the top. Conversely, a shipping service with a + ShippingServicePriority value of 5 appears at the bottom of a list of five + shipping service options. + <br><br> + This field is applicable to Flat and Calculated shipping. This field is not + applicable to Half.com listings. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + An international location or region to where the item seller will ship the item. + Use <b>GeteBayDetails</b> with <b>DetailName</b> set to + <b>ShippingLocationDetails</b> to determine which locations are valid per site. + In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. + For the AddItem family of calls, this field is required if any + international shipping service is specified. + + + ShippingRegionCodeType, CountryCodeType + + SendInvoice + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + Specifying Locations to Where You Ship + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Locations.html#ShipToLocation + + + + + + + + The insurance cost associated with shipping a single item with this shipping + service. Exception: for GetItemShipping, this is proportional to QuantitySold. If + the item has not yet been sold, insurance information cannot be calculated and the + value is 0.00. For calculated shipping only. + <br><br> + Valid only on the following sites: AU, FR, and IT + <br> + Also applicable to Half.com (for GetOrders). + + + + GetItemShipping + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + SendInvoice + No + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + Shipping + + + + + + + + + The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. + + + 0 + + + GetItemShipping + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The last time of day that an order using the specified shipping service will be accepted by the seller. The cut off time applies and is returned only when the <strong>ShippingService</strong> field contains the name of a qualifying time-sensitive shipping service, such as <code>eBayNowImmediateDelivery</code>. + <br><br> + The cut off time is set by eBay and determined in part by the policies and locations of the seller and the shipping carrier. + + + + GetItemShipping + Conditionally + + + + + + + + + + + + This is used in ReviseInventoryStatus response to provide the set of + fees associated with each unique ItemID.. + + + + + + + The ItemID of the listing being changed. <br> + <br> The ReviseInventoryStatus response includes a separate + set of fees for each item that was successfully revised.<br> + <br> + Use the ItemID to correlate the Fees data with the InventoryStatus data in the response. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + ReviseInventoryStatus + Always + + + + + + + + Contains the data for one fee (such as name and amount). + + + + ReviseInventoryStatus + Always + + + + + + + + + + + + Lightweight type for updating basic inventory status details. + Primarily intended for bulk use cases. + + + + + + + The unique SKU of the item being revised. + A SKU (stock keeping unit) is an identifier defined by a seller. + SKU can only be used to revise an item if you listed the item by + using AddFixedPriceItem or RelistFixedPriceItem, and:<br> + 1) You set Item.InventoryTrackingMethod to SKU at + the time the item was listed; or <br> + 2) You are modifying a multi-variation listing, and the SKU + identifies one of the variations. (In this case, if InventoryTrackingMethod was set to ItemID, then you also need to specify ItemID in the request.)<br> + (These criteria are necessary to + uniquely identify the listing or variation by a SKU.)<br> + <br> + In the ReviseInventoryStatus request, if the listing has + InventoryTrackingMethod set to SKU, then either ItemID or SKU is + required. If both are passed in and they don't refer to the + same listing, eBay ignores SKU and considers only the ItemID.<br> + <br> + If the listing has variations and InventoryTrackingMethod is set + to ItemID, then ItemID and SKU are both required.<br> + <br> + In the response, SKU may be returned as an empty element if + it was not defined on the listing. + + + + ReviseInventoryStatus + Conditionally + + + ReviseInventoryStatus + Always + + + + + + + + The ItemID of a listing being changed. <br> + <br> + In the ReviseInventoryStatus request, either ItemID or SKU is + required. If both are passed in and the SKU does not match, + eBay ignores SKU and considers only the ItemID.<br> + <br> + Please note that the same ItemID can be returned + multiple times in the same response if you revise several + variations from the same multi-variation listing. + + + + ReviseInventoryStatus + Conditionally + + + ReviseInventoryStatus + Always + + + + + + + + Specifies the revised fixed price of the listing (or of a + variation within a multi-variation listing). + If you raise the price of a listing, the recent sales score of + the listing is reset. (Best Match search ranking is based on + buyer activity, and one of the factors affecting search ranking + for fixed-price listings is the recent sales score.)<br> + <br> + Raising a listing's price may also affect the insertion fee + (and therefore the overall listing fee).<br> + <br> + ReviseInventoryStatus requires either StartPrice or Quantity (or both) for each InventoryStatus node in the request. + + + + Insertion Fees + http://pages.ebay.com/help/sell/insertion-fee.html + + + eBay.com Listing Fees + http://pages.ebay.com/help/sell/fees.html + + + ReviseInventoryStatus + Conditionally + + + ReviseInventoryStatus + Always + + + + + + + + Specifies the latest quantity of the listing (or of a variation + within a multi-variation listing).<br> + <br> + <b>For the ReviseInventoryStatus request:</b> + Specify the entire quantity that is currently available for sale. + (Typically, you only pass this in when you need to update + the quantity.)<br> + <br> + ReviseInventoryStatus requires either StartPrice or Quantity + (or you can specify both) for each InventoryStatus node in + the request.<br> + <br> + <b>For the ReviseInventoryStatus response:</b> + This returns a total of the quantity available for sale + plus the quantity already sold. For example, suppose the + listing originally had Quantity=10, and then 8 sold. Now you + restock your inventory, and you pass Quantity=10 in the + ReviseInventoryStatus request. In this case, + ReviseInventoryStatus returns Quantity=18 + (10 available + 8 sold). + To determine the quantity available, use GetItem or GetSellerList, + and subtract SellingStatus.QuantitySold from Quantity. + Or see QuantityAvailable in GetMyeBaySelling.<br> + <br> + It is a good idea to maintain an adequate quantity available for + fixed-price GTC listings to prevent the search rankings from + dropping. Best Match search ranking is based on buyer activity, + and one of the factors affecting search ranking for fixed-price + listings is the recent sales score. Fixed-price items that are + selling the fastest are given a relative lift in search results. + Recent Sales history is tracked with a moving window to ensure it + reflects the most recent activity. Due to he moving window, it is + advantageous to maintain item availability (Quantity-QuantitySold) + for a GTC listing. + + + + ReviseInventoryStatus + Conditionally + + + ReviseInventoryStatus + Always + + + + + + + + + + + + Defines options to track a listing by the eBay item ID or the seller's SKU. + In some calls, elements of this type are only returned in the response when + the value is set to SKU on the item. + + + + + + + + + The seller prefers to track the listing by its eBay item ID. + This is the default for all listings. + + + + + + + The seller prefers to track the listing by their own SKU. + When you track by SKU, it means you can pass your SKU instead of + the eBay item ID in other calls that support SKU as an input field. + If you choose SKU as your tracking preference for a listing, + the value in Item.SKU must be unique across your active listings. + You cannot create new listings with the same Item.SKU value while + the listing is active (that is, until the existing listing with that + SKU has ended). + However, you can use ReviseInventoryStatus to update the quantity + and/or price for the existing SKU as needed. When revising a listing + where the InventoryTrackingMethod was set to SKU, you must pass in both + the InventoryTrackingMethod tag (with the value set to SKU) and the SKU + tag with the SKU value from your original listing. + + + + + + + Reserved for internal or future use + + + + + + + + + + Container for a list of items. Can contain zero, one, or multiple + ItemType objects, each of which conveys the data for one item listing. + + + + + + + Contains the data properties that define one item listing. GetSellerEvents and + GetSellerList only return items if any are available for the seller within the + time window specified in the request.<br> + <br> + Some optional fields are only returned if the seller defined them for the + item. Some fields are only returned under particular conditions specified in + the individual field descriptions. For example, a buyer's contact information + might only be returned if the member who is making the request (as identified + in eBayAuthToken) has an order relationship with that buyer. <br> + <br> + For calls that support detail levels, the set of fields returned is also + controlled by the value of DetailLevel in the request. For some calls, other + parameters in the request can also control the data returned for each item. + For example, GranularityLevel controls the fields to return for each item in + the GetSellerList response. + + + + GetBidderList + Always + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + 3000 + + + GetMyeBayBuying + BestOfferList + BidList + LostList + UserDefinedList + WatchList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + UnsoldList + BidList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + A collection of details about the best offers received for a specific item. Empty if there are no best offers. Includes the buyer and seller messages only if + the ReturnAll detail level is used. + + + + + + + A collection of details about the best offers received for a specific item. Empty if + there are no best offers. Includes the buyer and seller messages only if the ReturnAll + detail level is used. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + All Best Offers for the item according to the filter or Best Offer + ID (or both) used in the input. + For the notification client usage, this response includes a + single Best Offer. + + + + + + + Indicates whether the eBay user is in the Buyer or + Seller role for the corresponding Best Offer. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + All Best Offers for the item according to the filter or + Best Offer ID (or both) used in the input. The buyer and + seller messages are returned only if the detail level is + defined. Includes the buyer and seller message only if + detail level ReturnAll is used. + Only returned if a Best Offer has been made. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The item for which Best Offers are being returned. + Only returned if a Best Offer has been made. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains bidding details information of a user on an item. + + + + + + + The unique identifier of an item listed on the eBay site. + For GetAllBidders, an anonymous user ID is returned. + <br><br> + Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is + bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: + <br><br> + When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". <br> + Note that in this format, the anonymous bidder ID stays the same for every auction. + <br><br> + (GetMyeBayBuying only) when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. + <br><br> + When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, + UserID = Bidder 3. <br> + Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", + not "Bidder 3". + <br><br> + (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". + <br><br> + (GetBestOffers only) - all sites: The last part of the user ID is replaced with asterisks for users that submit best offers on an item. The seller of the item will be able to see the full UserID. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + Conditionally + + + + + + + + Numeric ID for the category that the item belongs to. + + + + GetAllBidders + Conditionally + + + + + + + + The total number of bids the user placed on the item. + + + + GetAllBidders + Conditionally + + + + + + + + The eBay ID of the seller who listed the item. + <br><br> + This will be returned with the anonymous + value "Seller X", where X indicates where the seller falls + in the sequence of sellers that the user has purchased items + from. For example, if the seller is the third seller that + the user has purchased items from, the value "Seller 3" is + returned. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + Conditionally + + + + + + + + The time at which the user placed the last bid on the item. + + + + GetAllBidders + Conditionally + + + + + + + + + + + + Used to indicate whether the parts compatibility feature is enabled for a + category. + + + + + + + Parts Compatibility is not supported for the given category. + + + + + + + Parts Compatibility may be entered by application only for the given category. + Entering parts compatibility by application specifies the assemblies (e.g., a + specific year, make, and model of car) to which the item applies. Parts + compatibility by application can be specified by listing with a catalog + product that supports parts compatibility or by specifying parts compatibility + by application manually (<b + class="con"> Item.ItemCompatibilityList</b>). + + + + + + + Parts Compatibility may be entered by specification only for the given + category. Entering parts compatibility by specification involves specifying + the part's relevant dimensions or characteristics (e.g., Section Width, Aspect + Ratio, Rim Diammeter, Load Index, and Speed Rating values for a tire) using + attributes. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the parts compatibility feature. If the field is present, the + corresponding feature applies to the site. The field is returned as an empty + element (e.g., a boolean value is not returned). + <br><br> + Parts compatibility listings contain information to determine the assemblies with + which a part is compatible. For example, an automotive part or accessory listed + witih parts compatibility can be matched with vehicles (e.g., specific years, + makes, and models) with which the part or accessory can be used. + <br><br> + There are two ways to enter parts compatibility: by application and by + specification. + <ul> + <li> Entering parts compatibility by application specifies the assemblies + (e.g., a specific year, make, and model of car) to which the item applies. This + can be done automatically by listing with a catalog product that supports parts + compatibility, or manually, using <b + class="con">Item.ItemCompatibilityList</b> when listing or revising an + item. </li> + <li>Entering parts compatibility by specification involves specifying the + part's relevant dimensions and characteristics necessary to determine the + assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio, + Rim Diammeter, Load Index, and Speed Rating values for a tire) using + attributes.</li> + </ul> + + + + + + + + + + + A list of compatible applications specified as name and value pairs. Describes an + assembly with which a part is compatible (i.e., compatibility by application). For + example, to specify a part's compatibility with a vehicle, the name would map to + standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The + values would desribe the specific vehicle, such as a 2006 Honda Accord. + + + + + + + Details for an individual compatible application, consisting of the name-value pair and related compatibility notes. When revising or relisting, the <b class="con">Delete</b> field can be used to delete individual compatibility nodes. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For the GetItem call, <strong>Compatibility</strong> includes only compatibility details that were specified manually; that is, they do not correspond to an eBay catalog product. To retrieve compatibility details that <em>do</em> correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call. + </span> + + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + Conditionally + + Product API ProductCompatibilities call reference + http://developer.ebay.com/Devzone/product/CallRef/getProductCompatibilities.html + information about retrieving compatibility details that correspond to eBay catalog products. + + + + + + + + + + Set this value to true to delete or replace all existing parts compatibility information when you revise or relist an item. If set to true, all existing item compatibility nodes are removed from the listing. If new item compatibilities are specified in the request, they replace the removed compatibilities. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> To ensure that buyer expectations are upheld, you cannot delete or replace an item compatibility list if the listing has bids or if the auction ends within 12 hours. + </span> + + + false + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + Conditionally + + + + + + + + + + + + All information corresponding to an individual compatibility by application. + + + + + + + Removes individual parts compatibility nodes from the compatibility list. Set + to true within the compatibility to delete. + <br><br> + This field can only be used when revising an item or template. + <br> + If the listing has bids or ends within 12 hours, you cannot delete item + compatibilities. + + + false + + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + Conditionally + + + + + + + + A name-value pair describing a single compatible application. The + allowed names and values are specific to the primary category in which the + item is listed. For example, when listing in a Parts & Accessories + category, where the applications are vehicles, the allowed names might include + Year, Make, and Model, and the values would correspond to specific vehicles in + eBay's catalog. + <br><br> + The K type vehicle number is supported in the DE, UK, and AU eBay sites to specify + parts compatibility. To use a K type number to specify item compatiblities, + set the Name field to "KType" and set the corresponding Value field to the + K type number. + + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + Product Metadata API Call Reference + http://developer.ebay.com/DevZone/product-metadata/CallRef/index.html + information on retrieving compatibility search names and corresponding values needed to specify compatibility by application manually + + + + GetItem + Conditionally + + + + + + + + The seller may optionally enter any notes pertaining to the compatibility + being specified. Use this field to specify the placement of the part on a + vehicle or the type of vehicle a part fits. + + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + Conditionally + + + + + + + + + + + + Specifies a predefined subset of item conditions. The predefined set of fields + can vary for different calls. + + + + + + + The seller specified the Item Condition as New, or + did not specify a condition. + (Excludes items that the seller listed as Used.) + + + + + + + The seller specified the Item Condition as Used, or + did not specify a condition. + (Excludes items that the seller listed as New.) + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies that you want to display items based + on selling format, such as Buy It Now or Store items. + + + + + + + Show any items, in no particular order. + + + + + + + Show items with a Buy It Now price first. + + + + + + + Show only items with a Buy It Now price. + + + + + + + Used for Store Inventory listings, which are no longer supported on any eBay site. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>PromotionalSaleItemIDArray</b> container, which + consists of an array of listings to which a Promotional Sale applies. + + + + + + + A unique identifier for an item listing. + <br/><br/> + For <b>SetPromotionalSaleListings</b>, the seller passes in the + <b>ItemID</b> value for each listing that he/she wishes to become + part of the Promotional Sale identified by the + <b>PromotionalSaleID</b> value. + <br/><br/> + For <b>GetPromotionalSaleDetails</b>, each listing returned in the + response is a part of the Promotional Sale identified by the + <b>PromotionalSaleID</b> value. + + + + GetPromotionalSaleDetails + Conditionally + + + SetPromotionalSaleListings + No + + + + + + + + + + + + Type that represents the unique identifier for a single item listing. + + + + + + + + + Defines how a list of items should be returned. + + + + + + + Specifies whether or not to include the container in the response. + Set the value to true to return the default set of fields for the + container. Not needed if you set a value for at least one other field + in the container. + <br><br> + If you set DetailLevel to ReturnAll, set Include to false to exclude + the container from the response. + + + + GetMyeBayBuying + GetMyeBaySelling + No + + + + + + + + Specifies the listing type of items in the returned list. + + + + GetMyeBayBuying + BestOfferList + No + Auction, FixedPriceItem, AdType + + + GetMyeBaySelling + ActiveList + No + Auction, FixedPriceItem, AdType + + + + + + + + Specifies the sort order of the result. Default is Ascending. + + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromLostList + DeletedFromWonList + LostList + WatchList + WonList + No + + + GetMyeBaySelling + ActiveList + BidList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList + No + + + GetItemsAwaitingFeedback + No + + + + + + + + Specifies the time period during which an item was won or lost. Similar to the + period drop-down menu in the My eBay user interface. For example, to return + the items won or lost in the last week, specify a DurationInDays of 7. + + + 0 + 60 + + GetMyeBayBuying + BestOfferList + DeletedFromLostList + DeletedFromWonList + LostList + WonList + No + + + GetMyeBaySelling + DeletedFromSoldList + DeletedFromUnsoldList + SoldList + UnsoldList + No + + + + + + + + Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes + in the response. + + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromWonList + DeletedFromLostList + LostList + WatchList + WonList + No + + + GetMyeBaySelling + ActiveList + BidList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList + No + + false + + + + + + + Specifies how to create virtual pages in the returned list. + <br> + Default for EntriesPerPage with GetMyeBayBuying is 200. + + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromLostList + DeletedFromWonList + LostList + WatchList + WonList + No + + + GetMyeBaySelling + ActiveList + BidList + DeleteFromSoldList + DeleteFromUnsoldList + ScheduledList + SoldList + UnsoldList + No + + + + + + + + Filter to reduce the SoldList response based on whether the seller (or eBay) marked the applicable order as Paid and/or Shipped + in My eBay.<br> + <br> + (Sellers can use CompleteSale or the eBay Web site UI to mark an + order as Paid or Shipped in My eBay. Sellers can also specify + PaymentStatus in ReviseCheckoutStatus to mark an order as + Paid or awaiting payment in My eBay.) + + + + GetMyeBaySelling + SoldList + All + No + + + + + + + + + + + + Specifies the details of policy violations if the item was administratively canceled. + The details are the policy ID and the policy text. + + + + + + + Policy ID of the violated policy which resulted in item being administratively canceled. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Brief information of the violated policy which resulted in item being administratively canceled. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + Container for a set of detailed seller ratings about an order line item. + If a seller has detailed ratings, they are displayed + in the Feedback Profile of the seller. + + + + + + + The ItemRatingDetails container is for detailed seller ratings about an order line item. + When buyers leave an overall Feedback rating (positive, neutral, or negative) for + a seller, they also can leave ratings in four areas: item as described, + communication, shipping time, and charges for shipping and handling. Users retrieve + detailed ratings as averages of the ratings left by buyers. + <br><br> + Applicable to sites that support the Detailed Seller Ratings feature. + + + + LeaveFeedback + No + + + + + + + + + + + Applicable to sites that support the Detailed Seller Ratings feature. + The ItemRatingDetailsType contains detailed seller ratings for an order line item in one area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. + + + + + + + The area of a specific detailed seller rating for an order line item. + When buyers leave an overall Feedback rating (positive, neutral, or negative) + for a seller, they also can leave ratings in four areas: item as described, + communication, shipping time, and charges for shipping and handling. + + + + LeaveFeedback + No + + + + + + + + A detailed seller rating for an order line item applied to the area + in the corresponding RatingDetail field. Valid input values are + numerical integers 1 though 5. + + + + LeaveFeedback + No + + + + + + + + + + + + Specifies how items should be sorted. + + + + + + + Sort items by ending time, with items ending last first. + + + + + + + Sort items by ending time, with items ending soonest first. + + + + + + + Sort items by price, with the highest price first. + + + + + + + Sort items by price, with the lowest price first. + + + + + + + Sort items by listing time, with newly listed items first. + + + + + + + Sort items in a randomly selected order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Indicates the field and direction (ascending or + descending) by which to sort a returned list of items. + + + ClassifiedAdPayPerLeadFee, ClassifiedAdPayPerLeadFeeDescending + + + + + + + Sort by Item ID (ascending). + + + + + + + Sort by price (ascending). + + + + + + + Sort by start price (ascending). + + + + + + + Sort by item title (ascending). + + + + + + + Sort by number of bids on the item (ascending). + + + + + + + Sort by quantity (ascending). + + + + + + + Sort by listing start time (ascending). + + + + + + + Sort by listing end time (ascending). + + + + + + + Sort by the seller's user ID, in alphabetical order. + + + + + + + Sort by the time left for the item's listing, + in ascending order: active items, good-til-cancelled items, + and completed items. + + + + + + + Sort by listing duration (ascending). + + + + + + + Sort by listing type (ascending). + + + + + + + Sort by current price (ascending). + + + + + + + Sort by reserve price (ascending). + + + + + + + Sort by maximum bid price (ascending). + + + + + + + Sort by number of bidders (ascending). + + + + + + + Sort by the user ID of the highest bidder (ascending). + + + + + + + Sort by the user ID of the buyer (ascending). + + + + + + + Sort by the buyer's postal code (ascending). + + + + + + + Sort by the buyer's email address, in alphabetical order. + + + + + + + Sort by the seller's email address, in alphabetical order. + + + + + + + Sort by total price (ascending). + + + + + + + Sort by the number of items being watched (ascending). The WatchCount of an item is the number of watches that buyers have placed on an item using their eBay accounts. + + + + + + + Sort by the number of Best Offers (ascending). + + + + + + + Sort by the number of questions (ascending). + + + + + + + Sort by the cost indicated for shipping (ascending). + + + + + + + Sort by type of feedback received, positive, negative, or neutral. + In ascending order - negative, neutral, positive. + + + + + + + Sort by type of feedback received, positive, negative, or neutral. + In ascending order - negative, neutral, positive. + + + + + + + Sort by user ID, in alphabetical order. + + + + + + + Sort by the number of items sold (ascending). + + + + + + + Sort items with Best Offers first. + + + + + + + Sort by the number of items available (ascending). + + + + + + + Sort by the number of items purchased (ascending). + + + + + + + Sort by the platform on which the item was won (eBay items last). + + + + + + + Sort by the platform on which the item was sold (eBay items last). + + + + + + + Sort by the duration of the listing (descending). + + + + + + + Sort by the listing type (descending). + + + + + + + Sort by the current price of the listed item (descending). + + + + + + + Sort by the listing's reserve price (descending). + + + + + + + Sort by the highest bid on the item (descending). + + + + + + + Sort by number of bidders (descending). + + + + + + + Sort by the user ID of the highest bidder (descending). + + + + + + + Sort by the user ID of the buyer, in reverse + alphabetical order. + + + + + + + Sort by the buyer's postal code, in descending + order. + + + + + + + Sort by the buyer's email address, in + reverse alphabetical order. + + + + + + + Sort by the seller's email address, + in reverse alphabetical order. + + + + + + + Sort by the total price of the order, (descending). + + + + + + + Sort by watch count (descending). + + + + + + + Sort by number of questions (descending). + + + + + + + Sort by the cost of shipping (descending). + + + + + + + Sort by type of feedback received, positive, negative, or neutral. + In descending order - positive, neutral, negative. + + + + + + + Sort by type of feedback received, positive, negative, or neutral. + In descending order - positive, neutral, negative. + + + + + + + Sort by user ID, in descending order. + + + + + + + Sort by the number of items sold, in descending order. + + + + + + + Sort items by the number of Best Offers on an item, in descending order. + + + + + + + Sort items by the number there are available, in descending order. + + + + + + + Sort items by the number that have been purchased, in descending order. + + + + + + + Sort items with Best Offers last. + + + + + + + Sort by Item ID (descending). + + + + + + + Sort by price (descending). + + + + + + + Sort by start price (descending). + + + + + + + Sort by item title (descending). + + + + + + + Sort by number of bids on the item (descending). + + + + + + + Sort by the quantity of items sold (descending). + + + + + + + Sort by listing start time (descending). + + + + + + + Sort by listing end time (descending). + + + + + + + Sort by seller user ID, in reverse alphabetical order. + + + + + + + Sort by time left on the listing, in descending + order: completed items, good-til-cancelled items, + and active items. + + + + + + + Sort by the platform on which the item was won. + + + + + + + Sort by the platform on which the item was sold. + + + + + + + Sort by the lead (emails) count (ascending). + + + + + + + Sort by the new lead (new emails) count (ascending). + + + + + + + Sort by the lead count (descending). + + + + + + + Sort by the new contact count (descending). + + + + + + + The pay-per-lead feature is no longer available, so this value is no longer + applicable. + + + + + + + The pay-per-lead feature is no longer available, so this value is no longer + applicable. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details about custom Item Specifics validation rules. + + + + + + + The maximum number of custom Item Specifics allowed + when you list an item. Also the maximum returned per category in + GetCategorySpecifics and GetItemRecommendations. + + + + Item.ItemSpecifics in AddItem + AddItem.html#Request.Item.ItemSpecifics + + + ItemSpecifics in GetCategorySpecifics + GetCategorySpecifics.html#Request.CategorySpecific.ItemSpecifics + + + ItemSpecifics in GetItemRecommendations + GetItemRecommendations.html#Request.GetRecommendationsRequestContainer.Item.ItemSpecifics + + + GeteBayDetails + Conditionally + + + + + + + + The maximum number of values returned for each custom Item Specific + in GetCategorySpecifics and GetItemRecommendations. + + + + ItemSpecifics in GetCategorySpecifics + GetCategorySpecifics.html#Request.CategorySpecific.ItemSpecifics + + + ItemSpecifics in GetItemRecommendations + GetItemRecommendations.html#Request.GetRecommendationsRequestContainer.Item.ItemSpecifics + + + GeteBayDetails + Conditionally + + + + + + + + The maximum number of characters the site supports per custom + Item Specific value. + + + + Item.ItemSpecifics in AddItem + AddItem.html#Request.Item.ItemSpecifics + + + ItemSpecifics in GetCategorySpecifics + GetCategorySpecifics.html#Request.CategorySpecific.ItemSpecifics + + + ItemSpecifics in GetItemRecommendations + GetItemRecommendations.html#Request.GetRecommendationsRequestContainer.Item.ItemSpecifics + + + GeteBayDetails + Conditionally + + + + + + + + The maximum number of characters the site supports per custom + Item Specific name. + + + + Item.ItemSpecifics in AddItem + AddItem.html#Request.Item.ItemSpecifics + + + ItemSpecifics in GetCategorySpecifics + GetCategorySpecifics.html#Request.CategorySpecific.ItemSpecifics + + + ItemSpecifics in GetItemRecommendations + GetItemRecommendations.html#Request.GetRecommendationsRequestContainer.Item.ItemSpecifics + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. This timestamp can be used to determine + if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Defines the system source for an Item Specific. + + + + + + + The Item Specific was originally stored with custom + Item Specifics fields. (For example, the seller used + the ItemSpecifics node in AddItem.) + This is the default setting if Source isn't returned. + + + + + + + The Item Specific was originally stored with eBay's + system-defined (ID-based) attributes format. (For example, + the seller used the AttributeSetArray node in AddItem + at a time when the category supported Attributes.) + + + + + + + The Item Specific is prefilled from a product catalog. (For example, + the seller used ExternalProductID or ProductID in AddItem.) + + + + + + + Reserved for future use. + + + + + + + + + + Used to indicate whether custom Item Specifics are enabled for a category. + + + + + + + The custom Item Specifics feature is disabled for the category. + + + + + + + The custom Item Specifics feature is enabled for the category. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the Item Specific feature. If the field is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + Details about items involved in the summary for the specified time period. + + + + + + + Number of items involved in the summary. + + + + + + + Total value associated with the items in this summary. + + + + + + + + + + Container of ItemTransactionIDs. + + + + + + + An ItemID-TransactionID container. + Note: OrderID is not returned when the GetOrderTransactions request includes + ItemTransactionID, even if the transaction is part of an order. + To get the OrderID for a transaction, call GetItemTransaction with + IncludeContainingOrder = true. + + + + GetOrderTransactions + Conditionally + + + + + + + + + + + This container is designed to return all order line items related to specific + multiple-item, fixed-price listings. Additionally, a SKU filter can be used to + return all order line items related to a specific product or variation of an + item. + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. Unless an + <b>OrderLineItemID</b> or <b>SKU</b> value is specified in the same node, this field is + required for each <b>ItemTransactionID</b> node included in the request. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetOrderTransactions + Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). The + <b>TransactionID</b> should match the <b>ItemID</b> specified in each <b>ItemTransactionID</b> + node included in the request. Optionally, an <b>OrderLineItemID</b> value can + substitute for the <b>ItemID</b>/<b>TransactionID</b> pair. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetOrderTransactions + Conditionally + + + + + + + + A SKU (stock keeping unit) is a unique identifier defined and used by the + seller to identify a product or variation of an item. A listing can have + multiple SKUs and it is possible that the same SKU can exist in multiple + listings. Unless an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair is + specified in the same node, this field is required for each + <b>ItemTransactionID</b> node included in the request. To retrieve order line items + associated with a SKU, the <b>InventoryTrackingMethod</b> field must be set to SKU. + The <b>InventoryTrackingMethod</b> field is set through <b>AddFixedPriceItem</b> or + <b>RelistFixedPriceItem</b>. + + + 50 + + GetOrderTransactions + Conditionally + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. If an <b>OrderLineItemID</b> is included in a + <b>ItemTransactionID</b> node in the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> + fields are not required and are ignored if they are included in the request. + <br> + + + 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) + + GetOrderTransactions + Conditionally + + + + + + + + + + + + Contains the data defining one item. A seller populates an object of + this type at listing time with the definition of a new item. A seller + also uses an object of this type to relist or revise an item. Calls + that retrieve item data (such as the <b>GetSellerList</b> call) return an object of + this type, filled with the item's data. Some fields are applicable both + to eBay listings and Half.com listings. Some fields are only applicable to eBay listings, + and others are only applicable to Half.com listings. + + + + + + + Returns custom, application-specific data associated with the item. + The data you specify is stored by eBay with the item for your own + reference, but it is not used by eBay in any way. Use + <b>ApplicationData</b> to store special information for yourself, such as + a part number. For a SKU in an eBay.com listing, use the SKU + element instead. To remove this value when revising or relisting an + item, use <b>DeletedField</b>. + <br> + <br> + Not applicable to Half.com; use <b>SellerInventoryID</b> instead. + + + 32 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + half + + + + + + + No longer applicable to any categories. + + + + + + + + + + This container is used to specify one or more item attributes for a Half.com listing. This + container is not applicable for eBay listings. + <br><br> + You can use <b>ReviseItem</b> to modify attribute values for Half.com + listings. + <br><br> + Half.com listing attributes are not returned in <b>GetItem</b>. + + + + AddItem + AddItems + VerifyAddItem + Conditionally + + + ReviseItem + + No + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + Half.com + ../../../../../guides/ebayfeatures/Development/Sites-Half.html + + + + + + + + No longer applicable to any category. + + + + + + + + + + To create a requirement that a buyer pays immediately (through PayPal or PaisaPay) for an + auction (Buy It Now only) or fixed-price item, the seller can include and set the + <b>AutoPay</b> field to 'true' for an Add/Revise/Relist API + call. If the seller does not want to create an immediate payment item, this field + is either omitted, or included and set to 'false'. + <br> + <br> + If this feature is enabled for a listing, the buyer must pay immediately for the + item through PayPal or PaisaPay (India site only), and the buyer's funds are transferred instantly to the + seller's PayPal or PaisaPay account. The seller's item will remain available for purchase + by other buyers until the buyer actually completes the payment. + <br> + <br> + In order for a seller to apply an immediate payment requirement for an item, the + following must be true: + <ul> + <li>seller must have a Premier or Business PayPal account (or PaisaPay for India sellers);</li> + <li>the Buy It Now price (if applicable) cannot be higher than $10,000 USD;</li> + <li>the listing site supports PayPal (or PaisaPay for India site) payments;</li> + <li>the category supports PayPal (or PaisaPay for India site) payments;</li> + <li>the listing type is fixed-price or auction (with Buy It Now option).</li> + </ul> + + To successfully enable the immediate payment requirement, the seller must also + perform the following actions through the API call: + <ul> + <li>seller must provide a valid <b>Item.PayPalEmailAddress</b> value (not required for India site);</li> + + <li>seller must offer PayPal as the only payment method, or for the India site, one or more of the three supported PaisaPay payment methods;</li> + + <li>seller must specify all related costs to the buyer, since the buyer + will not be able to use the Buyer Request Total feature in an immediate payment + listing; these costs include flat-rate shipping costs for each domestic and + international shipping service offered, package handling costs, and any shipping surcharges;</li> + + <li>seller must include and set the <b>PromotionalShippingDiscount</b> + field to true if a promotional shipping discount is being applied to the + listing;</li> + + <li>seller must include the <b>ShippingDiscountProfileID</b> and + reference a valid flat or calculated Shipping Discount Profile ID if a flat or + calculated shipping rule is being applied to the listing.</li> + </ul> + + In the Trading API calls that return the <b>AutoPay</b> field, be + aware that the field's appearance in the output does not necessarily indicate that + the immediate payment feature was successfully enabled/used for the active or + ended listing, but only that the seller attempted to enable (by including and + setting <b>AutoPay</b> to 'true' in the request) the immediate payment + feature for the listing. + + <br> + To discover if a category supports immediate payment for an item, use + <b>GetCategories</b> and look for the appearance of + the <b>AutoPayEnabled</b> boolean field in the output for that category + (identified by <b>CategoryID</b>). <b>AutoPayEnabled</b> is + returned as an empty element if the category supports immediate payment, and is + not returned at all if the category does not support immediate payment. + <br> + <br> + Not applicable to Half.com. + + + + false + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Specifying a Payment Method + ../../../../guides/ebayfeatures/Development/Listing-PaymentMethod.html + + + Requiring Immediate Payment of a Vehicle Deposit + ../../../../guides/ebayfeatures/Development/Sites-eBayMotors.html#RequiringImmediatePaymentofaVehicleDepos + + + + + + + + This container is used by the seller to specify amounts and due dates for deposits and + full payment on motor vehicle listings. + <br> + <br> + The <b>PaymentDetails</b> container and its child fields are only applicable to vehicle listings + on eBay Motors (US and CA). + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Payment Methods for Motors + ../../../../guides/ebayfeatures/Development/Sites-eBayMotors.html#PaymentMethodsforMotors + + + + + + + + This container consists of information about the buyer's bidding history on a + single auction item. + <br><br> + Not applicable to Half.com. + + + + GetMyeBayBuying + BidList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + If this field is included and set to 'true' for a motor vehicle listing on the Germany site, the seller's motor vehicle listing will also appear on + the <b>mobile.de</b> partner site. This field is only applicable to the eBay Germany site and only applicable when listing a motor vehicle on that site. If this field is used in any other situation, it is ignored. + <br> + <br> + Listing on the <b>mobile.de</b> is considered a listing upgrade so the seller will be charged a listing upgrade fee. + <br> + <br> + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ItemReturnDescription, none, ReturnAll
+ Conditionally + + + Cross-Promoting Vehicles on the Mobile.de Site + ../../../../guides/ebayfeatures/Development/Sites-eBayMotors.html#CrossPromotingVehiclesontheMobiledeSite + + + + + + + + Flag to indicate an item's eligibility for the PayPal Purchase Protection + program. This field is only returned if 'true'. If this field is not returned, the item is not eligible for PayPal Purchase Protection. For more information on + items that are eligible for PayPal Purchase Protection, see the + <a href="http://pages.ebay.com/help/buy/paypal-buyer-protection.html#paypal">PayPal Purchase Protection</a> help page. + <br> + <br> + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + Miscellaneous Item Field Differences + ../../../../guides/ebayfeatures/Development/IntlDiffs-Misc.html + + + + + + + + For auction listings, the Buy It Now feature allows a user to purchase the item at a Buy + It Now price and end the auction immediately. Use this field to specify the Buy It Now + price. Including and specifying a <b>BuyItNowPrice</b> value enables the + Buy It Now feature for the auction listing. + <br><br> + There is a minimum percentage value that the Buy It Now price must be set above + the Start Price. This minimum percentage value varies by site. To see the valid values + for your site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ListingStartPriceDetails</b>, + and then look for the <b>ListingStartPriceDetails.MinBuyItNowPricePercent</b> field in the response. + If this value is 40.0 (percent), that means that your Buy It Now price on + your auction listing must exceed the Start Price by 40 percent to be + valid. + <br><br> + This feature is not applicable to fixed-price listings, Ad Format listings, or Half.com + listings. + <br><br> + Once an auction has bids (and the high bid exceeds the Reserve Price, + if specified), the listing is no longer eligible for Buy It Now (with some + exceptions noted below). However, calls like <b>GetItem</b> + still return the <b>BuyItNowPrice</b> that the seller originally set for the + listing. Use the <b>GetItem</b> call and look for the inclusion of the + <b>Item.ListingDetails.BuyItNowAvailable</b> flag in the output to determine + whether the item can still be purchased using Buy It Now. You can also view the + <b>Item.SellingStatus.BidCount</b> value in other item retrieval + calls to determine whether an auction with Buy It Now has bids or not. + <br><br> + There might be price limits imposed for Buy It Now items, subject to the + seller's PayPal account or the payment method used. Such limits cannot be + determined via the eBay API and are not covered in eBay's API documentation + because they can vary for each user. + <br><br> + To remove this value when revising or relisting an item, use <b>DeletedField</b>. + + + 16 + + Seller Limits + ../../../../guides/ebayfeatures/Development/Listing-Policies.html#SellerLimits + + + GeteBayDetails.html + GeteBayDetails + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WatchList + BestOfferList + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + Revising US eBay Motors Listings + ../../../../guides/ebayfeatures/Development/Listings-Revising.html#RevisingUSeBayMotorsListings + + + + + + + + Controls how eBay handles cases in which an Category ID specified in + <b>PrimaryCategory</b> and/or <b>SecondaryCategory</b> no longer + exists in the current category structure: If you pass a value of 'true' in + <b>CategoryMappingAllowed</b>, eBay will look up the current category ID that + is mapped to the same category and use the new Category ID for the listing (if any). The + new Category ID will be returned in the response as <b>CategoryID</b> (for + the primary category) or <b>Category2ID</b> (for the secondary category). If + <b>CategoryMappingAllowed</b> is not set or contains a value of 'false' (the + default), an error will be returned if a specified Category ID no longer exists. + <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + Mapping Old Category IDs to Current IDs + ../../../../guides/ebayfeatures/Development/Categories-DataMaintenance.html#MappingOldCategoryIDstoCurrentIDs + + + + + + + + + Identifies a Giving Works listing and the benefiting nonprofit charity + organization selected by the charity seller (if any). If specified, the + seller must also accept PayPal as a payment method for the item (see + <b>Item.PaymentMethods</b>). + <br><br> + When you revise an item, you can add a charity to a non-charity listing, but + you cannot remove or change the charity designation. The rules for adding a + charity to a listing depend on the listing type. For an auction listing, you + can revise an item to add a charity if there are more than 12 hours left for + the listing (whether or not the item has bids). For a fixed-price listing, + you can revise an item to add a charity if there are more than 12 hours left + for the listing, and the item has not been sold. + <br><br> + When you relist an item, use <b>DeletedField</b> to remove charity + information. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Miscellaneous Item Field Differences + ../../../../guides/ebayfeatures/Development/IntlDiffs-Misc.html + + + ../../../../guides/ebayfeatures/Development/Feature-NonprofitSupport.html + Working with Listings that Benefit Nonprofits + + + + + + + + A two-letter code that represents the country in which the item is located. This field is required in Add/Revise/Relist/Verify listing calls and it is always returned in <b>GetItem</b> and other "Get" calls that retrieve the <b>Item</b> object. If the <b>Country</b> is not provided in a Add/Revise/Relist/Verify listing call, its value will default to the seller's registration country. + <br><br> + To see the list of currently supported country + codes, and the English names associated with each code (e.g., KY="Cayman Islands"), + call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>CountryDetails</b>, + and then look for <b>CountryDetails.Country</b> fields in the response. + <br><br> + Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the + codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO + codes in the eBay list. + <br/><br/> + In addition to specifying the country in an Add/Revise/Relist/Verify listing call, the seller must also specify either a geographical region in the <b>Item.Location</b> field or a postal code in the <b>Item.PostalCode</b> field. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The CountryCodeType list is only a subset of all supported country codes, so to ensure that you are seeing the latest list, you should make a <b>GeteBayDetails</b> call as explained above. + </span> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + VerifyAddItem + Yes + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse
+ Conditionally + + + GetItemRecommendations + Conditionally + + + RelistItem + ReviseItem + RelistFixedPriceItem + ReviseFixedPriceItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + Item.Location + #Request.Item.Location + + + Item.PostalCode + #Request.Item.PostalCode + + + ../../../../guides/ebayfeatures/Development/Listing-AnItem.html#RequiredInformationforeBayListings + Required Information for eBay Listings + + + + + + + + This container is no longer supported as eBay Store Cross Promotions are no + longer supported by the Trading API. + <br><br> + Container for cross-promoted items related to a specific item ID. + The items are either upsell or cross-sell, according to the promotion + method passed in the request. + Not applicable to Half.com. + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Currency associated with the item's price information. 3-letter ISO 4217 + currency code that corresponds to the site specified in the listing + request. Also applicable as input to <b>AddItem</b> and related calls when you list + items to Half.com (specify USD). You cannot modify a listing's currency when + you revise or relist an item. + <br><br> + To see the list of currently supported currency codes, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>CurrencyDetails</b>, and then look + for the CurrencyDetails.Currency fields in the response. + + + + INR, CAD, CNY, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, TWD, GBP + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + Yes + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + Field Differences for eBay Sites + ../../../../guides/ebayfeatures/Development/IntlDiffs-Fields.html + + + + + + + + This field is used by the seller to provide a description of the item. + In listing requests, you can submit your description + using CDATA if you want to use HTML or XML-reserved characters in the + description. An error is returned if this contains malicious JavaScript + content. (For more information on eBay's HTML and JavaScript policy, see the + <a href="http://pages.ebay.com/help/policies/listing-javascript.html">HTML and JavaScript policy</a> + help topic.) + <br><br> + Embedding pictures in the description (by using IMG tags) is strongly discouraged. The recommended process is to specify the image URLs using <b>PictureURL</b> in the <b>AddItem</b> or <b>AddFixedPriceItem</b> calls. You can specify up to 12 self-hosted or eBay Picture Services hosted URLs at no cost. + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>. + </span> + + <br> + This field is required for all listings except when creating a listing using an eBay catalog product (<b>Item.ProductListingDetails</b> container). + + <br> + <span class="tablenote"><b>Note:</b> + In addition to including notes on flaws or wear and tear on an used item in the + <b>Item.Description</b>, and including a <b>ConditionID</b> + value, you can provide additional information about the condition of your used item + through the <b>Item.ConditionDescription</b> string field. + </span> + + <br> + For GetItem</b>: <b>Item.Description</b> + can be empty when <b>IncludePrefilledItemInformation</b> is set to 'true' and + the seller did not write their own description. <b>Item.Description</b> doesn't return pre-filled descriptions from catalogs. + The eBay site shows the catalog product description (if any) in the + product details section of a listing. + To retrieve a URL for the catalog product details page, + see <b>DetailsURL</b> in <b>FindProducts</b> in the + Shopping API. + <br><br> + Not applicable to Half.com. (For Half.com, use <b>AttributeArray.Attribute</b> with + the <b>attributeLabel</b> attribute set to 'Notes' to specify a brief description or note to the buyer.) + + + 500000 (some sites may allow more, but the exact number may vary) + + AddFixedPriceItem + AddItem + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + IncludePrefilledItemInformation + #Request.Item.ProductListingDetails.IncludePrefilledItemInformation + + + + AddItems + Conditionally + + IncludePrefilledItemInformation + AddItems.html#Request.AddItemRequestContainer.Item.ProductListingDetails.IncludePrefilledItemInformation + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Always + + IncludePrefilledItemInformation + #Response.Item.ProductListingDetails.IncludePrefilledItemInformation + + + DetailsURL in FindProducts (Shopping API) + FindProducts.html#Response.Product.DetailsURL + + + + + + + + + This field is applicable if you are modifying the item description. The value + selected for this field will determine if the new text entered into the <b> + Item.Description</b> field is added before (Prepend) or after (Append) the + current text in the item description, or if the new text completely replaces the + current text in the item description. + + + + ReviseItem + ReviseSellingManagerTemplate + ReviseFixedPriceItem + No + + + + + + + + The distance used in a proximity search distance calculation. + <br> + <br> + Not applicable to Half.com. + + + + + + + + + + If turned on at listing time, this flag allows the seller to offer one or more gift + services to buyers, and a generic gift icon displays next to the listing's title in Search + and View Item pages. <b>GiftIcon</b> must be included at listing time and + set to '1' to be able to use one or more <b>GiftServices</b> + options. The value of '1' indicates that this feature is on, and the value of '0' + indicates that the feature is off. + <br><br> + Gift Services are only available on the following eBay sites: + <ul> + <li>Belgium (Dutch)</li> + <li>Belgium (French)</li> + <li>France</li> + <li>Italy</li> + <li>Netherlands</li> + <li>Poland</li> + <li>Spain</li> + </ul> + + To verify if Gift Services are enabled for an eBay site, call , call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ListingFeatureDetails</b>. + Then look for GiftIcon=Enabled under the ListingFeatureDetails container in the response. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + + + + + + This field allows the seller to offer optional gift services to the buyer. To offer + one or more gift services to the buyer through an Add/Revise/Relist API call, the seller + must also include the GiftIcon field and set that flag to 'true'. + <br><br> + Gift Services are only available on the following eBay sites: + <ul> + <li>Belgium (Dutch)</li> + <li>Belgium (French)</li> + <li>France</li> + <li>Italy</li> + <li>Netherlands</li> + <li>Poland</li> + <li>Spain</li> + </ul> + <br> + This field is only returned in GetItem (and other calls that retrieve Item object) + if it is set for the listing. + <br> + To verify if Gift Services are enabled for an eBay site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ListingFeatureDetails</b>. + Then look for GiftIcon=Enabled under the + ListingFeatureDetails container in the response. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + + + + + + Indicates whether an optional hit counter is displayed on the item's listing + page and, if so, what type. See HitCounterCodeType for specific values. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Always + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The ID that uniquely identifies the item listing. The ID is generated + by eBay after an item is listed. You cannot choose or revise this + value.<br> + <br> + Also applicable to Half.com. For Half.com, you can specify either ItemID or + SellerInventoryID in a ReviseItem request to uniquely identify the + listing.<br> + <br> + In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and + TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated + with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.)<br> + <br> + In GetItemRecommendations, the item ID is required when the value of + ListingFlow is ReviseItem or RelistItem, but it is not applicable when the + value of ListingFlow is AddItem.<br> + <span class="tablenote"><b>Note:</b> Although we represent + item IDs as strings in the schema, we recommend you store them as 64-bit + signed integers. If you choose to store item IDs as strings, allocate at + least 19 characters (assuming decimal digits are used) to hold them. eBay + will increase the size of IDs over time. Your code should be prepared to + handle IDs of up to 19 digits. For more information about item IDs, see <a + href="https://ebaydts.com/eBayKBDetails?KBid=468">Common + FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base.</span> + + + 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddOrder + GetBestOffers + RelistItem + ReviseItem + + ReviseLiveAuctionItem + VerifyRelistItem + Yes + + + RelistFixedPriceItem + ReviseFixedPriceItem + GetItemRecommendations + Conditionally + + + GetBidderList + GetDispute + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback + GetMemberMessages + Conditionally + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Various details about a listing, some of which are calculated or + derived after the item is listed. These include the start and end + time, converted (localized) prices, and certain flags that indicate + whether the seller specified fields whose values are not visible to + the requesting user. For GetMyeBayBuying, returned as a self-closed + element if no listings meet the request criteria. + <br><br> + Not applicable to Half.com. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + GetBidderList + GetDispute + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback + GetMemberMessages + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + + + + + + Contains the detail data for the Listing Designer theme and template (if either + are used), which can optionally be used to enhance the appearance of the + description area of an item's description. See ListingDesignerType for its + child elements. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Describes the number of days the seller wants the listing to be active (available + for bidding/buying). The duration specifies the seller's initial intent at listing + time. The end time for a listing is calculated by adding the duration to the item's + start time. If the listing ends early, the value of the listing duration does not + change. When a listing's duration is changed, any related fees (e.g., 10-day fee) + may be debited or credited (as applicable). + <br><br> + The valid choice of values depends on the listing format (see Item.ListingType). For + a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll + and look for ListingDurations information. To set a duration of 1 day, the seller + must have a Feedback score of at least 10. + <br><br> + When you revise a listing, the duration cannot be reduced if it will result in + ending the listing within 24 hours of the current date-time. You are only allowed to + increase the duration of the listing if fewer than 2 hours have passed since you + initially listed the item and the listing has no bids. You can decrease the value of + this field only if the listing has no bids (or no items have sold) and the listing + does not end within 12 hours. + <br><br> + Required for Half.com (but only specify GTC). + + + ListingDurationCodeType + + GetCategoryFeatures + GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations + + + Fees per Site + ../../../../guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + VerifyAddItem + Yes + + + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ScheduledList + UnsoldList + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field can be used by the seller to activate one or more listing upgrades for a + listing, such as a Bold Title, a Subtitle, or a Value Pack bundle. A ListingEnhancement + field is required for each listing upgrade that the seller wants to activate. + There is a small fee associated with each listing upgrade. + See the + <a href="http://pages.ebay.com/help/sell/ia/promoting_your_item.html">Listing Upgrades</a> help page + for more information on the available listing upgrades. + <br><br> + The listing upgrades that are available vary by site and by the seller's account + status. To discover which listing upgrades are available, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ListingFeatureDetails</b> + and pass in the appropriate SiteID value. Then look for the ListingFeatureDetails + container in the response. Listing upgrades will either be listed as 'Enabled' or + 'Disabled'. + <br><br> + GetItem (and other calls that retrieve Items) will only return this field if one + or more listing upgrades are set for the listing. + <br><br> + You cannot remove listing upgrades when you revise a listing. When you + relist an item, use DeletedField to remove a listing upgrade. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + + + + + + The format of the listing the seller wants to use, such as auction style + or fixed price.<br> + <br> + Optional for eBay.com listings (defaults to auction style) in AddItem and + VerifyAddItem. Do not specify ListingType for eBay.com listings in + ReviseItem. (You can't modify the listing type of an active eBay + listing.<br> + <br> + Required for Half.com listings (and the value must be Half) in AddItem, + VerifyAddItem, and ReviseItem. If you don't specify Half when revising + Half.com listings, ReviseItem won't use the correct logic and you may + get strange errors (or unwanted side effects in the listing, even if no + errors are returned). + <br><br> + + + + FixedPriceItem + AddFixedPriceItem + Conditionally + + + Unknown, Live, Auction, PersonalOffer, Shopping, StoresFixedPrice + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + ReviseItem + Half + half + Conditionally + + + GetBidderList + Unknown, Auction, Half, PersonalOffer, StoresFixedPrice + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Unknown, Auction, Half, StoresFixedPrice + Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Unknown, Auction, Half, PersonalOffer, Shopping, StoresFixedPrice + Conditionally + + + GetItemTransactions + GetSellerTransactions + Unknown, Auction, Half, Shopping, StoresFixedPrice +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetOrderTransactions + Unknown, Auction, Half, Shopping, StoresFixedPrice +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetMyeBayBuying + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Unknown, Auction, Half, StoresFixedPrice + Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Unknown, Auction, Half, StoresFixedPrice + Conditionally + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Unknown, Auction, Half, Shopping, StoresFixedPrice + Conditionally + + + Different Ways of Selling + http://pages.ebay.com/help/sell/ia/formats.html + + + Listing Types (Formats) + ../../../../guides/ebayfeatures/Basics/eBay-BuildingBlocks.html#ListingTypes + + + GetCategoryFeatures + GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations + + + Fees per Site + ../../../../guides/ebayfeatures/Development/IntlDiffs-Fees.html + + + + + + + + Indicates the geographical location of the item (along with Country) to be displayed on eBay listing pages. When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. + <br><br> + If you do not specify <strong>Location</strong>, you must specify <strong>Item.PostalCode</strong>. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> If you specify both <strong>Location</strong> and <strong>PostalCode</strong>, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. + </span> + For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. + <br><br> + Also applicable as input to AddItem and related calls when you list items to Half.com. + + + 45 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Item.Country + #Request.Item.Country + + + Item.PostalCode + #Request.Item.PostalCode + + + + + + + + A lot is a set of two or more similar items included in a single listing that must be + purchased together in a single order line item. The Item.LotSize value is the number of + items in the lot. This field is required if two or more items are including in one listing. + <br><br> + Lots can be used for auction and fixed price listings. Lot items can be listed + only in lot-enabled categories. Call GetCategories to determine if a category supports + lots. If the returned CategoryArray.Category.LSD (LotSize Disabled) value is true, + the category does not support lots. + <br><br> + Not applicable to Half.com. + + + 100000 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Not currently operational. + + + + + + + Not currently operational. + + + + + + + Identifies the payment method (such as PayPal) that the seller will accept + when the buyer pays for the item. For the AddItem family of calls, at least + one payment method is required. + <br><br> + Use <b>GetCategoryFeatures</b> to determine the payment methods that are allowed for a + category on a site. For example, the response data of <b>GetCategoryFeatures</b> will + show that on the US site, most categories only allow electronic payments. Also + use <b>GetCategoryFeatures</b> to determine the default payment method for a site (see + <b>SiteDefaults.PaymentMethod</b>). If a seller does not include at least one payment + method in a Add/Revise/RelistItem API call, the default payment method is used + for the listing. + <br><br> + Do not use <b>GeteBayDetails</b> to determine the payment methods for a site. + <br><br> + If you specify multiple <b>PaymentMethods</b> fields, the repeating fields must be + contiguous. For example, you can specify <b>PayPalEmailAddress</b> after a list of + repeating <b>PaymentMethods</b> fields, but not between them:<br> + <br> + &lt;PaymentMethods&gt;VisaMC&lt;/PaymentMethods&gt;<br> + &lt;PaymentMethods&gt;PayPal&lt;/PaymentMethods&gt;<br> + &lt;PayPalEmailAddress&gt;mypaypalemail@ebay.com&lt;/PayPalEmailAddress&gt;<br><br> + In general, if you separate repeating instances of a field, the results will + be unpredictable. This rule applies to all repeating fields + (maxOccurs="unbounded" or greater than 1) in the schema. See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Basics/Call-APISchema.html#OverviewoftheAPISchema">Overview of the Schema</a>" for more information. + + <br><br> + This field is not applicable to eBay Real Estate Ad format, + Classified Ad format, or Half.com listings. + <br> + <br> + <b>For ReviseItem and RelistItem only:</b> + A listing must have at least one valid payment method. + When you revise or relist an item and you specify a payment method + that is invalid for the target site, eBay ignores the + invalid payment method, applies the other valid + changes, and returns a warning to indicate that the + invalid payment method was ignored. If multiple payment methods were + invalid, the warning indicates that they were all ignored. + If you modify the listing so that it includes no valid + payment methods, an error is returned. This situation could occur when + the seller removes all valid payment methods or when all + the payment methods specified for the item are no longer valid + on the target site. + + + + Determining the Payment Methods Allowed for a Category + ../../../../guides/ebayfeatures/Development/Listing-PaymentMethod.html#DeterminingthePaymentMethodsAllowedforaC + + + Listing an Item + ../../../../guides/ebayfeatures/Development/Listing-AnItem.html + + + (SetUserPreferences) SellerPaymentPreferences + SetUserPreferences.html#Request.SellerPaymentPreferences + + + ../../../../guides/ebayfeatures/Basics/Call-APISchema.html + Overview of the API Schema + + + GeteBayDetails.html + GeteBayDetails + + + PayUponInvoice + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItemRecommendations + ReviseSellingManagerTemplate + IntegratedMerchantCreditCard + Conditionally + + + GetBidderList + IntegratedMerchantCreditCard,DirectDebit,CreditCard + Conditionally + + + GetItems + GetSellingManagerTemplates + IntegratedMerchantCreditCard + Conditionally + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ IntegratedMerchantCreditCard + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ IntegratedMerchantCreditCard + Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ IntegratedMerchantCreditCard + Conditionally + + + + + + + + Valid PayPal email address for the PayPal account that the seller will use + if they offer PayPal as a payment method for the listing. eBay uses this to + identify the correct PayPal account when the buyer pays via PayPal during + the checkout process. (As a seller can have more than one PayPal account, + you cannot necessarily rely on PayPal account data returned from GetUser for + details about the account associated with the PayPal email address that the + seller specifies.)<br> + <br> + Required if seller has chosen PayPal as a payment method (PaymentMethods) + for the listing.<br> + <br> + For digital listings, the seller needs to use an email address that is + associated with a PayPal Premier or PayPal business account. <br> + <br> + <b>For ReviseItem and RelistItem only:</b> To remove this value + when you revise or relist an item, use DeletedField. When you revise a + listing, if the listing has bids (or items have been sold) or it ends within + 12 hours, you can add PayPalEmailAddress, but you cannot remove + it.<br> + <br> + Not applicable to eBay Motors listings. + <br> + Not applicable to Half.com. + + + + Listing an Item + ../../../../guides/ebayfeatures/Development/Listing-AnItem.html + + + (SetUserPreferences) SellerPaymentPreferences + SetUserPreferences.html#Request.SellerPaymentPreferences + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Category ID for the first (or only) category in which the item is + listed (or will be listed, if the item is new). A number of listing + features have dependencies on the primary category. We have pointed + out a few of the notable dependencies below. See the descriptions + of the fields you are using to determine whether the feature you're + supporting depends on the listing's primary category.<br> + <br> + <b>For the AddItem family of calls:</b> + Use calls like GetCategories and GetCategoryFeatures to determine valid + values for the site on which you are listing (see the eBay Web Services + Guide for information on working with categories). Also see + Item.CategoryMappingAllowed and + Item.CategoryBasedAttributesPrefill.<br> + <br> + If you list with a catalog product, eBay may drop the + primary category you specify and use the category that is associated with the product instead, if different.<br> + <br> + Not applicable to Half.com.<br> + <br> + <b>For ReviseItem only:</b> When revising a listing, + you can change the primary category only if an item + has no bids (or no items have sold) and the listing does not end + within 12 hours. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. + </span> + If you change the listing category, any Item Specifics (attributes) that + were previously specified may be dropped from the listing if they aren't + valid for the new category. See Item.AttributeSetArray. For the eBay US + site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details.<br> + <br> + You cannot change the meta-categories for vehicles (i.e., you cannot change + a truck to a motorcycle), but you can change the leaf category (e.g., change + one motorcycle subcategory to another motorcycle subcategory). See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Categories.html">eBay Features Guide</a> + for additional information. International sites (such as the + eBay Germany site) have similar rules for revising vehicle categories. <br> + <br> + When you list an event ticket on the US site, you must specify the + Event Tickets category as the primary category. Also, when revising + a listing, you cannot change the primary category from another + category to the Event Tickets category. (You need to specify the + Event Tickets category when you initially list the item.)<br> + <br> + <b>For GetItemRecommendations only:</b> + For GetItemRecommendations, use this value to control the category that + is searched for recommendations. Specify the category in which + the item will be listed. + + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + Yes + + + GetItemRecommendations + Conditionally + + + RelistItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Applying Categories + ../../../../guides/ebayfeatures/Development/Categories.html + + + Listing US and CA eBay Motors Items + ../../../../guides/ebayfeatures/Development/Sites-eBayMotors.html#ListingUSandCAeBayMotorsItems + + + (RelistItem) GalleryType + RelistItem.html#Request.Item.PictureDetails.GalleryType + + + + + + + + The <b>PrivateListing</b> boolean field can be used by the seller in the + Add/Relist/Revise family of calls to obscure item title, item ID, and item price from + post-order Feedback comments left by buyers. Typically, it is not advisable that + sellers use the Private Listing feature, but using this feature may be appropriate for + sellers listing in Adults Only categories, or for high-priced and/or celebrity items. + <br> + <br> + For <b>GetItem</b>, order retrieval calls, and other calls that retrieve + the Item object, the <b>PrivateListing</b> field is only returned if + 'true'. + <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Specifies stock product information to include in a listing. + Only applicable when listing items with product details. + See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/index.html">eBay Features Guide</a> for information on listing with product details.<br> + <br> + As ProductID and ProductReferenceID are defined by eBay, they + provide the most reliable means to identify a product. + If you use one of the other industry identifiers (e.g., UPC), + eBay attempts to find a matching product on your behalf and use + it in the listing. If no match is found, you can try using + FindProducts in the Shopping API to determine a ProductReferenceID.<br> + <br> + When you specify ProductListingDetails, you must specify at + least one of the available identifiers (e.g., UPC). If you specify + more than one (such as UPC and BrandMPN), eBay uses the first one + that matches a product in eBay's catalog system. (This may be useful + if you aren't sure which identifier is more likely to result in a + match.)<br> + <br> + When you specify TicketListingDetails, you must specify the + Event Tickets category as the primary category. + For other product identifiers: If you list in two categories and + the primary and secondary categories are both catalog-enabled, + this product identifier should correspond to the primary + category (not the secondary category). + If only one category is catalog-enabled, the product identifier + should correspond to the catalog-enabled category. + + <br> <br> + <span class="tablenote"><b>Note:</b> + As a general rule, the primary category is required. + However, if you have trouble finding a catalog-enabled + category, you may be able to omit the primary category (except for + event tickets). If you do, eBay will attempt to determine an + appropriate category based on the product ID (if we find a + matching product). + When you specify a category that corresponds to the product, your category is used. + </span> + + If we don't find a match in our catalogs, + we will list the item in the primary category you specified, + without product details. We will not pre-fill the listing's + item specifics in this case, and the identifier won't be surfaced in + View Item or returned in GetItem. However, it will still be indexed + for search on eBay, and it will be searchable by more + third-party natural search engines. As this can help buyers find + your listing more easily, we strongly recommend that you always + use ProductListingDetails to pass in these values. + (This product indexing behavior + is only available if you use UPC, ISBN, EAN, or GTIN in + ProductListingDetails. It is not available if you use + ExternalProductID, and it may not be + available if you exclusively use Item Specifics.)<br> + + <br> + Either Item.ExternalProductID or Item.ProductListingDetails can be + specified in an AddItem request, but not both. + (ExternalProductID is no longer recommended.) <br> + + <b>For ReviseItem and RelistItem only:</b> If a + listing includes product details and you + change a category, the rules for continuing to include product details depend + on whether or not the new category is mapped to a + characteristic set associated with the same product ID. When you revise a + listing, if it has bids or it ends within 12 hours, you cannot change the + product ID and you cannot remove existing product data. However, you can + change or add preferences such as IncludeStockPhotoURL, + UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all + catalog data when you revise or relist an item, specify + Item.ProductListingDetails in DeletedField and don't pass + ProductListingDetails in the request.<br> + <br> + + <b>For GetMyeBayBuying only:</b> When products have been added to a buyer's Wish List, the product information is returned in ItemArray.Item.ProductListingDetails within the UserDefinedList node. Products can be added to a buyer's Wish List only. Does not apply to any other user-defined list. The ProductListingDetails node is not included for items in the Wish List. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItemRecommendations + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying + UserDefinedList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The value indicates the quantity of items available for purchase in the listing. + This field is required for all auction listings and for non-variation, fixed-price + listings. For auction listings, this value is always '1'. For a non-variation, + fixed-price listing, the <b>Item.Quantity</b> value indicates the + number of identical items the seller has available for purchase in the listing. + <br><br> + You can set the <b>Quantity</b> to 0 (zero) and keep the listing active if you set + <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference</a> to 'true'. + <br><br> + <b>For AddFixedPriceItem, VerifyAddFixedPriceItem, RelistFixedPriceItem, and + ReviseFixedPriceItem:</b> in a multi-variation, fixed-price listing, the + <b>Item.Quantity</b> should not be used; instead, the quantity of + each variation is specified in the <b>Variation.Variation.Quantity</b> + field instead. See the <a href=" + http://pages.ebay.com/help/sell/listing-variations.html">Creating a listing with + variations</a> eBay Help page for more information on variations. + <br><br> + <b>For RelistItem, RelistFixedPriceItem, and VerifyRelistItem:</b> + Previously in <b>RelistItem</b>, <b>RelistFixedPriceItem</b>, and <b>VerifyRelistItem</b> the <b>Quantity</b> field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the quantity that was really still available for purchase and it was often out of synch with the <b>QuantityAvailable</b> value that is returned with the <b>GetMyeBaySelling</b> call. As of March 13, 2014, this behavior has been changed in the following manner: + <ul> + <li>For a listing that has ended with an available quantity greater than zero, the <b>Quantity</b> value of the newly relisted item is set to the actual <b>QuantityAvailable</b> value (see the <b>GetMyeBaySelling</b> call) when the previous listing ended. </li> + <li>For listings that ended with an available quantity of zero, the relisted item will retain the <b>Quantity</b> value that was passed in at creation time of the previous listing. </li> + </ul> + So, if you are relisting an item that had an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the <b>Quantity</b> field of a relist call. Alternatively, you can update the correct quantity available by using a <b>ReviseInventoryStatus</b> call and passing in a <b>Quantity</b> value. + <br> <br> + When eBay auto-renews a GTC listing (ListingDuration=GTC) + on your behalf, eBay relists with correct quantity available. + <br><br> + <span class="tablenote"><b>Note:</b> + There are seller limits on the US site for users who registered after October 2010. + Seller limits control the quantity of items and/or the total value + of the item(s) in the listing. (The <b>GetMyeBaySelling</b> call + returns the remaining item quantity and remaining total value under the limits for + the seller, if any such limits exist for the seller). If a call to add an item or + revise an item would result in the exceeding of these limits, the add item or + revise item call will fail. For auction listings, the total value limit applies to + the start price, not the final sale amount. For more information, see the link to + Seller Limits below. + </span> + <br> + <b>For GetSellerEvents:</b> Quantity is only returned + for listings where item quantity is greater than 1. + <br><br> + <b>For GetItem and related calls:</b> + This is the total of the number of items available for sale plus the quantity + already sold. To determine the number of items available, subtract + SellingStatus.QuantitySold from this value. Even for items that supported Dutch + auctions, where one of several items can be purchased during the auction, this + number does not change. + <br><br> + <b>For order line item calls with variations:</b> + In GetItemTransactions, Item.Quantity is the same as GetItem (the + total quantity across all variations). In GetSellerTransactions, + Transaction.Item.Quantity is the total quantity of the applicable + variation (quantity available plus quantity sold). + <br> + <br> + <b>For GetDispute:</b> Quantity is + the number of items being raised in the dispute. + <br> + <br> + <b>For SetCart:</b> This input is required only when the parent container is submitted. + <br><br> + Also applicable to Half.com (valid range 1 to 1000). + You can revise this field for Half.com listings. + <br><br> + <span class="tablenote"><b>Note:</b> + The number in the <b>Quantity</b> field represents the current quantity of items that are available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of items available through each local fulfillment method. In the case where a listing is only offering the item through a local fulfillment method, this value should default to '0', and the <b>Item.IgnoreQuantity</b> will also be returned as 'True'. + </span> + + + + Seller Limits + ../../../../guides/ebayfeatures/Development/Listing-Policies.html#SellerLimits + + + Selecting a Selling Format + http://pages.ebay.com/help/sell/formats.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItemRecommendations + ReviseItem + ReviseSellingManagerTemplate + No + + + GetBidderList + GetDispute + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A note a user makes on an item in their My eBay account. The note is prefaced with + the words My Note. For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not + GetItem) return this field, and only if you pass IncludeNotes in the request. Only + visible to the user who created the note. + <br><br> + Not supported as input in ReviseItem. Use SetUserNotes instead. + <br><br> + <b>For GetMyeBayBuying</b> In WatchList, notes for variations are only + returned at the Item level, not the variation level. They are only set if you + specified ItemID (if no purchases) or ItemID and VariationSpecifics (if there are + purchases) in SetUserNotes (or selected the equivalent in the My eBay UI on the + site). + <br><br> + In WonList, notes for variations are only returned at the Item level, not the + variation level. They are only set if you specified ItemID and TransactionID in + SetUserNotes (or selected the equivalent in the My eBay UI on the site). + <br><br> + Not applicable to Half.com (instead, use + Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.) + + + + AddFixedPriceItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetMyeBayBuying + GetMyeBaySelling + Conditionally + + + + + + + + No longer used by any site. + + + + + + + + + + Applicable only to re-listing an item. If true, creates a link in the item's + old listing for the item that points to the new relist page, which + accommodates users who might still look for the item under its old item ID. + Not applicable to Half.com. + + + + RelistItem + No + + + RelistFixedPriceItem + No + + + + + + + + The lowest price at which the seller is willing to sell the item. (StartPrice + must be lower than ReservePrice.) Not all categories support a reserve price. + See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Categories.html#ApplyingCategories">Applying Categories</a>. In calls that retrieve item data, ReservePrice + only has a non-zero value for listings with a reserve price and where the user + requesting the item data is also the item's seller. Not applicable to fixed- + price items or ad format listings.<br> + <br> + You can remove the reserve price of a US eBay Motors listing if the category allows + it, the current reserve price has not been met, and the reserve price is at least + $2.00 more than the current high bid. In this case, if the item has bids, the reserve + price is set to $1.00 over the current high bid. The next bid meets the reserve and + wins. See the Fees Overview on the eBay Web site for information about fee credits + that may be available when the reserve price is removed for a Motors listing. See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Listings-Revising.html#RevisingUSeBayMotorsListings">Revising US eBay Motors Listings</a> for validation rules when revising US Motors listings.<br> + <br> + The relisted item cannot have a reserve price if the original listing didn't have one. If + the original listing had a reserve price, the relisted item's reserve price can't be + greater than that of the original listing. + <br> + <br> + Not applicable to Half.com. + + + 16 + + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + Revising US eBay Motors Listings + ../../../../guides/ebayfeatures/Development/Listings-Revising.html#RevisingUSeBayMotorsListings + + + Reserve Price (eBay Web site help) + http://pages.ebay.com/help/sell/reserve.html + + + Fees Overview (eBay Web site help) + http://pages.ebay.com/help/sell/fees.html + + + + + + + + An output value only, indicates whether an item has been revised + since the listing became active and, if so, which among a subset of + properties have been changed by the revision. + <br><br> + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + Allows the user to specify the time that the listing becomes active on eBay. + To schedule the listing start time, specify a time in the future in GMT + format. In GetItem and related calls, the scheduled time is returned in + StartTime. For ReviseItem, you can modify this value if the currently + scheduled start time is in the future. + <br><br> + When you schedule a start time, the start time is randomized within 15-minute + intervals. Randomized start times applies to the following sites: + <br> + <code>AT, BEFR, BENL, CH, DE, ES, FR, IE, IT, NL, PL, UK</code> + <br><br> + Also see the following article in the Knowledge Base: <a href= + "https://ebaydts.com/eBayKBDetails?KBid=1473" + >Why scheduled time is sometimes getting reset</a>. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + + + + + + ID for second category in which the item is listed (also see + Item.PrimaryCategory). + <br><br> + <b>For the AddItem family of calls:</b> Listing an item in + a second category is optional. Also see Item.CategoryMappingAllowed + and Item.CategoryBasedAttributesPrefill. <br> + <br> + Not applicable to Half.com. <br> + <br> + You cannot list US eBay Motors vehicles in two categories. However, you can + list Parts & Accessories in two categories. The Final Value Fee is based + on the primary category in which the item is listed. Furthermore, you can + list the same item in an eBay Motors Parts & Accessories category and in + an eligible eBay category, as long as the primary category is associated + with the site on which you are listing. That is, the two categories can be a + mix of Motors Parts & Accessories and eBay site categories. (Real + Estate, Mature Audience (adult), and Business & Industrial categories + are not eligible for listing in two categories in this manner.) For example, + if you list on Motors, the primary category could be 6750 (eBay Motors > + Parts & Accessories > Apparel & Merchandise > Motorcycle > + Jackets & Leathers), and the secondary category could be 57988 (eBay + > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). + If you list on the main eBay site, the primary category could be 57988 and + the secondary category could be 6750. <br> + <br> + If eBay has designated a category as a value category + (see ValueCategory in GetCategoryFeatures), items in that category + cannot be listed in two categories. + For example, if your AddItem request + includes a primary or secondary category that is a value category, then eBay drops SecondaryCategory and lists + the item with only the PrimaryCategory you selected. + Also, if the listing request includes item specifics + (in ItemSpecifics or AttributeSetArray) that are associated with SecondaryCategory, eBay drops those values when we drop SecondaryCategory. (The same logic is used if you revise an existing + listing to add a secondary category or to change one of the categories: If either the primary or secondary category is a value category, eBay drops the secondary category from your request.)<br> + <br> + To remove this value when relisting an item, use DeletedField. + <br><br> + <b>For ReviseItem only:</b> When revising a listing, you + can add or change the secondary category only if the listing has no + bids (or no items have sold) and it does not end within 12 hours. If you + change the secondary category, any corresponding Item Specifics (attributes) + that were previously specified may be dropped from the listing if they + aren't valid for the category. See Item.AttributeSetArray. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For some large merchants, there are no limitations on when the primary or secondary listing categories for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. + </span> + When you revise an item, you can change the secondary category from a Motors + Parts & Accessories category to an eBay category or vice versa if the + listing has no bids (or no items have sold) and it does not end within 12 + hours. <br> + <br> + <b>For GetItemRecommendations only:</b> + For GetItemRecommendations, use this to control the category that will be + searched for recommendations. Specify the category in which the item will be + listed. + + + 10 + + Applying Categories + ../../../../guides/ebayfeatures/Development/Categories.html + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + ID for a second category that eBay added as a free promotion. You cannot add + this yourself. Only returned if the item was listed in a single category and + eBay added a free second category. + <br><br> + Not applicable to Half.com. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Container for information about this listing's seller. + <br> + <br> + Not applicable to Half.com. + <br><br> + Returned by GetItemsAwaitingFeedback if Buyer is making the request. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + AddItem + AddItems + AddSellingManagerTemplate + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + Conditionally + + + + + + + + Various details about the current status of the listing, such as the current + number of bids and the current high bidder. + <br><br> + Not applicable to Half.com. + + + + GetBidderList + GetDispute + Always + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetMemberMessages + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The shipping-related details for an order, including flat and + calculated shipping costs and shipping insurance costs.<br> + <br> + New users who list their first items in selected categories on the US site + must specify at least one domestic shipping service. This applies to a + category if GetCategoryFeatures returns true for + Category.ShippingTermsRequired.<br> + <br> + For Fixed Price listings, a seller can revise all shipping details of the + listing (except for sales tax and for shipping type of Freight) for all + unsold items. This applies to both domestic and international shipping. + Checkout is not affected for those who bought items prior to the seller's + shipping changes--the shipping details that were in effect at the time of + purchase are used for that buyer at the time of checkout.<br/> + <br/> + <span class="tablenote"> + <strong>IMPORTANT:</strong> To avoid loss of shipping details when revising a listing, you must include all <strong>ShippingDetails</strong> fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. + </span> + <br> + Shipping details are not applicable to Real Estate listings and Half.com. + <br><br> + <b>GetMyeBayBuying, GetMyeBaySelling</b>: ShippingDetails is not returned + (with a request version 677 or higher) if (a) the item is marked as + local pickup only with a cost of 0 or (b) ShipToLocation is None. (With a + request version lower than 677, ShippingDetails is returned.) + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromLostList + DeletedFromWonList + WatchList + WonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + Determining Shipping Costs for a Listing + ../../../../guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + Revising a Listing + ../../../../guides/ebayfeatures/Development/Listings-Revising.html + restrictions on changing item properties with ReviseItem + + + + + + + + An international location or region to which the seller is willing to ship, + regardless of shipping service. The country of the listing site is added by + eBay. Use <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ShippingLocationDetails</b> + to determine which international locations are valid for the site. In the + <b>GeteBayDetails</b> response, look for the <b>ShippingLocationDetails.ShippingLocation</b> fields. + <br><br> + For Add/Revise/Relist calls: + <ul> + <li>If you only wish to ship to domestic locations, include one <b>ShipToLocations</b> field and set its value to the listing site (such as 'UK' OR 'US').</li> + <li>If you wish to ship to multiple continents, regions, and countries around the world, but wish to exclude some continents/regions/countries, include one <b>ShipToLocations</b> field and set its value to 'Worldwide', and then use multiple <b>ExcludeShipToLocation</b> fields to exclude those continents/regions/countries you don't wish to ship to.</li> + <li>If you don't wish to ship at all (local pickup only), include one <b>ShipToLocations</b> field and set its value to 'None'.</li> + </ul> + ReviseItem and ReviseFixedPriceItem can be used to add additional <b>ShipToLocations</b> values. + <br><br> + For <b>GetItem</b>, <b>GetSellerList</b>, and other 'Get' calls, the returned <b>Item.ShipToLocations</b> values will include the <b>ShipToLocations</b> values specified in any <b>InternationalShippingServiceOption</b> containers. + <br><br> + If you have specified a region to which you will ship (such as Asia), you can + use <b>ExcludeShipToLocation</b> to exclude certain countries within that region to + where you will not ship (such as Afghanistan). + <br><br> + Not applicable to Half.com. + + + length of longest name in ShippingRegionCodeType and CountryCodeType + ShippingRegionCodeType, CountryCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + ../../../../guides/ebayfeatures/Development/Shipping-Locations.html#ShipToLocation + ShipToLocations + + + GeteBayDetails.html + GeteBayDetails + + + + + + + + The name of the site on which the item is listed. The listing site affects + the business logic and validation rules that are applied to the request, + which in turn affect the values that are returned in the response, as well + as values that appear on the eBay Web site. For example, the listing site + can affect the validation of Category in listing requests, international + business seller requirements, the values of converted (localized) prices in + responses, the item-related time stamps that are displayed on the eBay Web + site, the visibility of the item in some types of searches, and other + information. In some cases, the rules are determined by a combination of + the site, the user's registration address, and other information. You + cannot change the site when you revise a listing.<br> + <br> + When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the + numeric site ID that you specify in the request URL (for the SOAP API) or + the X-EBAY- API-SITEID header (for the XML API).<br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + GetItemRecommendations + RelistFixedPriceItem + RelistItem + VerifyAddItem + VerifyRelistItem + + Yes + + + AddSellingManagerTemplate + No + + + GetBidderList + GetDispute + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + The US and International eBay Sites + ../../../../guides/ebayfeatures/Basics/eBay-SitesEnvironments.html#TheUSandInternationaleBaySites + + + Specifying the Target Site + ../../../../guides/ebayfeatures/Basics/Call-StandardCallData.html#SpecifyingtheTargetSite + + + Field Differences for eBay Sites + ../../../../guides/ebayfeatures/Development/IntlDiffs-Fields.html + + + + + + + + This value indicates the starting price of the item when it is listed for the + first time, or when it is revised or relisted. + <br><br> + <b>For auction listings:</b> competitive bidding starts at this + value. Once at least one bid has been placed, <b>StartPrice</b> remains the same but + <b>CurrentPrice</b> is increased to the amount of the current highest bid. If + <b>ReservePrice</b> is also specified, the value of + <b>StartPrice</b> must be lower than the value of + <b>ReservePrice</b>. + <br><br> + <b>For fixed-price listings: </b> + This is the fixed-price at which a buyer may purchase the item. + <br><br> + For both auction and fixed-price listings, there is a minimum value that may be + specified as a <b>StartPrice</b> value. These minimum values vary per + site. To retrieve these minimum values for a site, call <b>GeteBayDetails</b> + passing in your <b>SiteID</b> value as a header, and using + <b>ListingStartPriceDetails</b> as a <b>DetailName</b> + value. In the <b>GeteBayDetails</b> response, look for the + <b>ListingStartPriceDetails.StartPrice</b> fields for the 'Chinese' + and 'FixedPriceItem' listing types. + <br><br> + <span class="tablenote"><b>Note:</b> + There are seller limits on the US site for users who registered after October 2010. + Seller limits control the quantity of items and/or the total value + of the item(s) in the listing. (The <b>GetMyeBaySelling</b> call + returns the remaining item quantity and remaining total value under the limits for + the seller, if any such limits exist for the seller). If a call to add an item or + revise an item would result in the exceeding of these limits, the add item or + revise item call will fail. For auction listings, the total value limit applies to + the start price, not the final sale amount. For more information, see the link to + Seller Limits below. + </span> + <b>GetMyeBaySelling</b> does not return <b>Item.StartPrice</b> + for fixed-price items; it returns <b>Item.SellingStatus.CurrentPrice</b>. + <br><br> + <b>For AddFixedPriceItem and VerifyAddFixedPriceItem:</b> + Required when no variations are specified. If variations are specified, + use <b>Variation.StartPrice</b> for each variation instead. + <br> + <br> + Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise + this field for Half.com listings. + + + + Seller Limits + ../../../../guides/ebayfeatures/Development/Listing-Policies.html#SellerLimits + + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddItem + Yes + + + GetItemRecommendations + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + RelistItem + VerifyRelistItem + No + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetMyeBayBuying + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + + + + + + Contains information related to the item in the context of a seller's eBay + Store. Applicable for auction and fixed-price listings listed by eBay Stores sellers.<br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Subtitle to use in addition to the title. Provides more keywords when buyers + search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML + characters will be interpreted literally as plain text.) If you pass any + value, this feature is applied (with applicable fees).<br> + <br> + Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, + and "other vehicle" categories or to listings in CA eBay Motors passenger + vehicle and motorcycle categories. For eBay Motors categories that do + not support this field, use Item Specifics (AttributeSetArray) to specify the + vehicle subtitle.<br> + <br> + When you revise a item, you can add, change, or remove the + subtitle.<br> + <br> + Not applicable to Half.com. + + + 55 + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseLiveAuctionItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + AddFixedPriceItem + VerifyAddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + No + + + GetMyeBayBuying + BestOfferList + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + Removing/Changing a Field When Relisting an Item + ../../../../guides/ebayfeatures/Development/Listings-RelistingItems.html#RemovingaFieldWhenRelistinganItem + + + (RelistItem) DeletedField + RelistItem.html#Request.DeletedField + + + Specifying a Subtitle for a Motors Vehicle Listing + ../../../../guides/ebayfeatures/Development/Sites-eBayMotors.html#SpecifyingaSubtitleforaMotorsVehicleList + + + + + + + + Time left before the listing ends. + The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). + See <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Basics/DataTypes.html">Data Types</a> for information about this format. + For ended listings, the time left is PT0S (zero seconds). + Not applicable to Half.com. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetMyeBayBuying + BestOfferList + BidList + SecondChanceOffer + WatchList + Conditionally +
DetailLevel: none, ReturnAll
+ + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Name of the item as it appears in the listing or search results. Title is + required for most items. This field is only optional if you leverage Pre-filled + Item Information by using the Item.ProductListingDetails or + Item.ExternalProductID containers. + <br><br> + You cannot use HTML or JavaScript in the Title. + (HTML characters will be + interpreted literally as plain text.) + <br><br> + <b>For the AddItem family of calls</b>: Not applicable to Half.com. <br> + <br> + <b>For ReviseItem and ReviseFixedPriceItem</b> + You can only add or change the item title if the listing has no + bids (for auctions) or sales (for fixed-price listings) and + the listing does not end within 12 hours. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For some large merchants, there are no limitations on when the Item Title for a fixed-price listing can be revised, even when the listing has had transactions or is set to end within 12 hours. + </span> + <b>For GetItemRecommendations</b>: More keywords in the + title usually result in more relevant Listing Analyzer + recommendations. + + + 80 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + Conditionally + + + RelistItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetItemsAwaitingFeedback + GetMemberMessages + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + GetDispute + Always + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Universally unique constraint tag. Use UUID to ensure that you only list a + particular item once, particularly if you are listing many items at once. If + you add an item and do not get a response, resend the request with the same + UUID. If the item was successfully listed the first time, you will receive + an error message for trying to use a UUID that you have already used. The + error will also include the item ID for the duplicated item and a boolean + value indicating whether the duplicate UUID was sent by the same application. + <br><br> + We recommend you use Item.UUID with calls that add item objects (for example, AddItem + and RelistItem). For calls that modify an existing item, such as ReviseItem, use + InvocationID instead. + <br><br> + The UUID can only contain digits from 0-9 and letters from A-F and must be + 32 characters long. The UUID value must be unique across all item listings + on all sites. + <br><br> + Also applicable as input to AddItem and related calls when you list + items to Half.com. + + + 32 + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + VerifyAddItem + VerifyRelistItem + + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Container for eBay's VAT features. A business seller can choose to + offer an item exclusively to bidders and buyers that also represent businesses. + Only applicable when the item is listed in a B2B-enabled category (on a site + that supports B2B business features).<br> + <br> + <span class="tablenote"><strong>Note:</strong> + The India site (Global ID 203) does not accept VAT values in item listings. If you + submit an item to the India site with a VAT value, eBay generates a warning message + that indicates the listing was accepted, but the VAT value was removed. To include + the VAT, relist the item with a Price value that includes the VAT. Sellers are + solely responsible for compliance relating to tax legislation in India. + </span> + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Working with Business Features and VAT + ../../../../guides/ebayfeatures/Development/Sites-IntlDiffsVATB2B.html + + + Business Feature Field Differences + ../../../../guides/ebayfeatures/Development/IntlDiffs-B2BFields.html + + + + + + + + The seller is on vacation (as determined by the seller has chosen + to add a message to listed items while on vacation. + <br><br> + Not applicable to Half.com. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The number of watches placed on this item from buyers' My eBay accounts. + Specify IncludeWatchCount as true in the request. + Returned by GetMyeBaySelling only if greater than 0. + <br> + <br> + Not applicable to Half.com. + + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBaySelling + Conditionally + + + + + + + + The number of page views for the item. This number is calculated by eBay and + cannot be set via the API. Returned if the hit counter type is BasicStyle, + RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the + requestor is the item's seller. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + If true: all buyer requirements (from <b>Item.BuyerRequirementDetails</b> + or Buyer requirements preferences in My eBay) are ignored. + <br> + <br> + If false (or omitted): <b>Item.BuyerRequirementDetails</b> or Buyer + requirements preferences are used, with <b>Item.BuyerRequirementDetails</b> + having the higher precedence. + + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + <b>For Add/Revise/Relist/Verify calls:</b> This container is used to + enable the Best Offer feature on a listing. The Best Offer feature is not + available for auction listings. + <br> + <br> + For <b>GetItem</b> and other calls that retrieve item data, this + container will include the status (<b>GetMyeBayBuying</b> only) and + dollar amount of the latest Best Offer on a fixed-price listing, and the number of + Best Offers received for the fixed-price listing. + <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + Conditionally +
DetailLevel: none, ReturnAll
+ + + GetMyeBaySelling + ActiveList + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + True if eBay provided a central location as a result of the user + not specifying a location. This typically occurs when the seller + specifies PostalCode without Location. + <br> + <br> + Not applicable to Half.com. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Deprecated. + + + + + + + + + + + Indicates whether the seller's tax table is to be used when applying and + calculating sales tax for an order line item. A sales tax table can be + created programmatically using the SetTaxTable call, or it can be created + manually in My eBay's Selling Preferences. If UseTaxTable is set to true, + the values contained in the seller's sales tax table will supersede the + values contained in the Item.ShippingDetails.SalesTax container (if + included in the request).<br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + ../../../../guides/ebayfeatures/Development/Feature-SalesTax.html#UsingTaxTables + Using Tax Tables + + + + + + + + This flag is no longer used. + + + + + + + + + + + Applicable for listings in vehicle categories on the US eBay Motors site and + eBay Canada site. (No business effect if specified for other categories or + sites, as the Web site will not display the information to buyers.) If true, + the buyer is responsible for vehicle pickup or shipping. If false, specify + vehicle shipping arrangements in the item description. Default is true. (The + description can also include vehicle shipping arrangements when this value is + true.) If the item has bids or ends within 12 hours, you cannot modify this + flag. Do not specify ShippingDetails.ShippingServiceOptions + for vehicle listings. + <br><br> + If true and the listing is on the US eBay Motors site, and you want the + listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA. + If true and the listing is on the eBay Canada site , and you want your listing + to be visible on the US eBay Motors site, set Item.ShipToLocations to US. + <br><br> + Not applicable to Half.com. + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This feature is no longer supported. + + + + + + + + + + + Returns a note from eBay displayed below items in the user's My + eBay account. + <br> + <br> + Not applicable to Half.com. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + UnsoldList + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + Specifies the number of questions buyers have posted about the + item. Returned only if greater than 0. + <br> + <br> + Not applicable to Half.com. + + + + GetMyeBaySelling + Conditionally + + + + + + + + Whether or not the item is a relisted item. This value is + determined by eBay and cannot be set. Only returned if the + item was relisted. + <br><br> + Note that when an item is relisted and is given a new + ItemID, the original item shows Relisted = true, but the new + item does NOT show Relisted = true. In this context, the new + item is a new listing, not a "Relisted" one. + + + + GetMyeBaySelling + Conditionally + UnsoldList + + + + + + + + Specifies how many of a certain item are available.<br> + <br> + Not applicable to Half.com. + + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A SKU (stock keeping unit) is an identifier defined by a seller. + Some sellers use SKUs to track complex flows of products + and information on the client side. + A seller can specify a SKU when listing an item with AddItem + and related calls. eBay preserves the SKU on the item, enabling you + to obtain it before and after an order line item is created. + (SKU is recommended as an alternative to ApplicationData.)<br> + <br> + A SKU is not required to be unique, when you track listings by + their ItemID (the default tracking method). A seller can specify a + particular SKU on one item or on multiple items. + Different sellers can use the same SKUs.<br> + <br> + If you want to use SKU instead of ItemID as a unique identifier + (such as when retrieving items and orders), you can set + Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and + related calls. In this case, the SKU must be + unique across your (the seller's) active listings. + Note that if you relist the item, you must reset + Item.InventoryTrackingMethod to SKU; otherwise the relisted + item will default to ItemID as the tracking method. <br> + <br> + If both ItemID and SKU are specified in item-retrieval and + order-retrieval calls that support the use of SKU as a unique + identifier, the ItemID value takes precedence and is used to + identify the listing.<br> + <br> + For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. + If InventoryTrackingMethod is ItemID, an ItemID is also required. + When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. <br> + <br> + <span class="tablenote"><b>Note:</b> + The eBay Web site UI cannot identify listings by SKU. For example, + My eBay pages and Search pages all identify listings by item ID. + When a buyer contacts you via eBay's messaging functionality, eBay + uses the item ID as the identifier. Buyer-focused APIs (like the + Shopping API) also do not support SKU as an identifier. + </span> + <b>For revising and relisting only:</b> + To remove a SKU when you revise or relist an item, use DeletedField. + (You cannot remove a SKU when Item.InventoryTrackingMethod is set + to SKU.)<br> + <br> + For GetMyeBaySelling, this is only returned if set. + <br> + Not applicable to Half.com. + + + 50 + + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBaySelling + Conditionally + + + eBay Merchant Data API + AddFixedPriceItem and ReviseFixedPriceItem + http://developer.ebay.com/DevZone/merchant-data/CallRef/index.html + + + + + + + + If this field is included in the request and set to 'true', eBay will auto-fill some + of a listing's Item Specifics values based on the listing's category (or + categories). Auto-filling Item Specifics based on a category is not the same as + using Pre-filled Item Information based on a catalog product (see + <b>ProductListingDetails</b>). If you set + <b>CategoryBasedAttributesPrefill</b> to 'true', it is recommended that + you also include and set the <b>Item.CategoryMappingAllowed</b> value to + 'true', so you can be assured that your item will pick up the Item Specifics values + from the correct category (categories). This field will be ignored if the category + does not support auto-filling attributes. + <br> + <br> + If you also pass in Item Specifics through the <b>Item.ItemSpecifics</b> + container in the request, these values will override + any auto-filled values for the same Item Specifics. Once you have overridden the + value of an auto-filled Item Specifics for a given listing, eBay will not auto-fill + it on subsequent <b>ReviseItem</b> requests (even if you remove the + overridden value from the Item Specific in the <b>ItemSpecifics</b> + container). + <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + + + + + + Container for values that indicate whether a listing uses the Buy It Now feature, + whether a listing is no more than one day old, and whether a listing has an image + associated with it. + <br><br> + Not applicable to Half.com. + + + + + + + + + Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. + <br/><br/> + eBay derives a geographical location from the postal code to display on eBay listing pages. If you do not specify <strong>PostalCode</strong>, you must specify <strong>Item.Location</strong>. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> If you specify both <strong>PostalCode</strong> and <strong>Location</strong>, and eBay can determine a location that corresponds to the postal code, the postal code-derived location will be used for the listing. + </span> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + Item.Country + #Request.Item.Country + + + Item.Location + #Request.Item.Location + + + + + + + + Indicates whether details about shipping costs and arrangements are + specified in the item description. + <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + ../../../../guides/ebayfeatures/Development/Shipping-TypesCosts.html#SearchResultsandShippingCosts + Search Results and Shipping Costs + + + + + + + + <b>This field is deprecated.. + </b> New applications should use ProductListingDetails instead. + + + + + + + + + + Unique identifier for a Half.com item. Must be an alphanumeric value (with no + symbols) that is unique across the seller's active (unsold) inventory on + Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in + a ReviseItem request to uniquely identify the listing. Only returned from + GetOrders if the seller specified a value when the item was listed. You cannot + revise this field. + <br><br> + Not applicable to eBay.com listings. + + + 100 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + No + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Contains the data for a picture associated with an item. With the exception of + eBay Motors vehicle listings, you can add up to 12, either eBay Picture Services (EPS) hosted or self-hosted, pictures free of charge. It is required that all listings have at least one picture. + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>. + </span> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Yes + + + GetBidderList + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + SecondChanceOffer + WatchList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none,ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + Introduction to Pictures in Listings + ../../../../guides/ebayfeatures/Development/Pictures-Intro.html + + + + + + + + Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the carrier's transit time). + <br><br> + <b>For the AddItem family of calls:</b> Required for listings in certain categories when certain shipping services (with delivery) are offered. See HandlingTimeEnabled in GetCategoryFeatures. The seller sets this field to a positive integer value indicating the number of days. For a list of allowed values on each eBay site, use <b>GeteBayDetails</b> with <b>DetailName</b> set to <code>DispatchTimeMaxDetails</code>. (Typical values are 0, 1, 2, 3, 4, 5, 10, 15, or 20, but this can vary by site and these may change over time.) + <br><br> + <b>For ReviseItem and ReviseFixedPriceItem:</b> If a shipping business policy is being used for the listing, and the maximum dispatch time is set in this shipping business policy, setting the <b>DispatchTimeMax</b> value in a revise call will have no effect, as the value set in the shipping business policy will override this value. So, to revise the listing with a new maximum dispatch time, the change must be made in the shipping business policy before the revise call is made. The business policy can be changed in My eBay or through a <b>setSellerProfile</b> call of the Business Policies Management API. + <br><br> + Valid for flat and calculated shipping. Does not apply when there is no shipping, when it is local pickup only or when it is freight shipping. For example, when <strong>ShippingService</strong>=<code>Pickup</code> or <strong>ShipToLocations</strong>=<code>None</code>, then <b>DispatchTimeMax</b> is not required. + <br/><br/> + A <b>DispatchTimeMax</b> value of <code>0</code> indicates <em>same day handling</em> for an item. In this case, the seller's shipping commitment depends on the <em>order cut off time</em> set in the seller's user preferences. This defaults to 2:00 PM local time on most sites, which can be overridden by using <strong>SetUserPreferences</strong> to set <strong>DispatchCutoffTimePreference.CutoffTime</strong> for the eBay site on which the item is listed. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays). + <br/><br/> + + <span class="tablenote"> + <strong>Note:</strong> If a same day shipping carrier is selected, and the carrier delivers on one or both weekend days, sellers on the eBay US site are assumed to be open for business on the same days, and those days will be used when calculating total shipping time. + </span> + + With Add, Relist, Revise and Verify calls, if you wish to indicate that a listing with flat or calculated shipping has no handling time commitment, submit <b>Item.DispatchTimeMax</b> as an empty field. + <br/><br/> + + <span class="tablenote"> + <b>Note:</b> To receive a Top-Rated Plus seal for their listing, Top-Rated Sellers must offer same day or 1-day handling (<b>DispatchTimeMax</b>=<code>0</code> or <b>DispatchTimeMax</b>=<code>1</code>) and accept returns (<b>ReturnPolicy.ReturnsAcceptedOption=ReturnsAccepted</b>). Top-Rated listings qualify for the greatest average boost in Best Match and the 20 percent Final Value Fee discount. For more information on changes to eBay's Top-rated seller program, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page. + </span> + + <b>For ReviseItem only:</b> If the listing has bids or sales and it ends within 12 hours, you can't change this value. If the listing is a GTC listing that has sales or ends within 12 hours (one or the other, but not both), you can add or change this value. If the listing has no bids or sales and more than 12 hours remain before the listing ends, you can add or change the dispatch (handling) time. + <br><br> + <b>For GetItem:</b> GetItem returns DispatchTimeMax only when shipping service options are specified for the item and the seller specified a dispatch time. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GeteBayDetails.html + GeteBayDetails + + + (GetCategoryFeatures) SiteDefaults.HandlingTimeEnabled + GetCategoryFeatures.html#Response.SiteDefaults.HandlingTimeEnabled + + + Same Day Handling + ../../../../guides/ebayfeatures/Development/Shipping-Services.html#SameDayHandling + + + + + + + + Specifies that Skype-related information is included with an item listing, + including, for example, Skype Voice. Skype-related information provides + buttons that enable potential buyers to contact sellers through Skype. + Information about Skype is available at www.Skype.com. If all of the + prerequisites for adding Skype buttons to listings are met (see the <http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/CRM-Communications.html#EnablingCommunicationThroughSkype">Enabling Communication Through Skype</a>), you can make communication through Skype available in + listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are + specified. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The Skype name of the seller. Requires that SkypeEnabled is set to true. + Available if the seller has a Skype account and has linked it (on the eBay + site) with his or her eBay account. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the Skype contact option that the seller and buyer can use to communicate + about the listing. For Skype communication to be possible, the + <b>SkypeEnabled</b> flag must be included and set to 'true'. + The seller must also have a Skype account that is linked with his or her eBay + account. + <br><br> + More than one Skype contact option may be specified. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Indicates, when true, that an item is available by Best Offer. + + + + + + + + + + Indicates, when true, that an item is available locally. + + + + + + + + + + Deprecated. + + + + + + + + + + + Container consisting of the ProStores store name and user name. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contact information for sellers using the Classified Ad format for eBay + Motors vehicles categories. To remove seller contact information when + revising or relisting an item, use DeletedField. The seller contact details + for the primary and secondary phone numbers cannot be deleted + individually. + <br><br> + To provide City, State, and Zip code information in + SellerContactDetails use the following field:<br> + Item.SellerContactDetails.Street2 + <br><br> + To delete the secondary phone number, for example, you must delete all of + the secondary phone fields:<br> + Item.SellerContactDetails.Phone2AreaOrCityCode<br> + Item.SellerContactDetails.Phone2CountryCode<br> + Item.SellerContactDetails.Phone2CountryPrefix<br> + Item.SellerContactDetails.Phone2LocalNumber + + + + Classified Ad Listings + ../../../../guides/ebayfeatures/Development/Specialty-ClassifiedAds.html + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The number of questions asked about this item. Applies to eBay Motors Pro + applications only. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Some listings on the eBay platform originate from eBay affiliates. + Depending on the relationship the affiliate has with eBay, there are times + when the affiliate retains ownership of the listing. When this occurs + the representation of the listing on eBay is considered a proxy item. Proxy + items can only be edited using API requests from the applications that + originally listed them. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, + ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Extended contact information for sellers using the Classified Ad format. + Specifies the days and hours when the seller can be contacted. + To remove seller contact information when revising or relisting an item, use + DeletedField. + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Specifies the number of leads (emails) buyers have posted about the item. + You must be the seller of the item to retrieve the lead count. + + + + GetMyeBaySelling + ActiveList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Specifies the number of new leads (unanswered emails) buyers have posted + about the item. + + + + GetMyeBaySelling + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A list of Item Specific name and value pairs that the + seller specified for the item.<br> + <br> + Item Specifics describe well-known aspects of an + item or product in a standard way, to help buyers find that + type of item or product more easily. + or example, "Publication Year" is a typical aspect of books, + and "Megapixels" is a typical aspect of digital cameras.<br> + <br> + In the AddItem family of calls, use Item.ItemSpecifics to specify + custom Item Specifics.<br> + <br> + To determine which categories support custom Item Specifics, use + GetCategoryFeatures.<br> + <br> + To retrieve recommended Item Specifics, use GetCategorySpecifics.<br> + <br> + With GetItem, this is only returned when you specify + IncludeItemSpecifics in the request (and the seller included + custom Item Specifics in their listing).<br> + <br> + <b>For ReviseItem only:</b> When you revise a listing, + if the listing has bids and ends within 12 hours, you cannot change or + add Item Specifics. If the listing has bids but ends in more + than 12 hours, you cannot change existing Item Specifics, but you can + add Item Specifics that were not previously specified.<br> + <br> + To delete all Item Specifics when you revise or relist, specify + Item.ItemSpecifics in DeletedField and don't pass ItemSpecifics in the + request.<br> + <br> + <span class="tablenote"><b>Note:</b> + To specify an item's condition, use the ConditionID field + instead of a condition item specific. + Use GetCategoryFeatures to see which categories support + ConditionID and to get a list of valid condition IDs. + (If you specify ConditionID and you also specify + Condition as a custom item specific, eBay drops the condition + item specific.) + </span> + + + + Working with Custom Item Specifics + ../../../../guides/ebayfeatures/Development/ItemSpecifics.html + + + Seller Central: Changes to Item Specifics + http://pages.ebay.com/sellerinformation/news/itemspecific.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddSellingManagerTemplate + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + GroupCategoryID is returned if there is a value of + BestMatchCategoryGroup in the Order field for the GetSearchResults + call. However, the results depend on the items and groups + requested. + <br> + <br> + The Best Match algorithm will try to evenly fit the items and + return groups of 'Best Matching' Categories. A 'category group' can + be a parent category that contains the best-matching items from + several of its subcategories. Within each category group, items + will be also sorted by best match. The only condition when you may + not get a GroupCategoryID returned at all is when the request is + for one group and there is more than one category that has matching + items. Very rarely, the same item will appear once in the group for + its primary category and once in another group for its secondary + category, in the same result set. Also very occasionally, a Store + Inventory Item can appear in the results before a regular listing. + + + + + + + + + + The pay-per-lead feature is no longer available, and this field is scheduled to + be removed from the WSDL. + + + + + + + + + + + Bid groups are only applicable to the Bid Assistant feature, which is a + feature that has been retired. This field is scheduled to be removed + from ItemType. + + + + + + + + + + + Container consisting of details related to whether or not the + item is eligible for buyer protection and which of the buyer protection + programs will cover the item. This container is not returned if the item is not + eligible for eBay or PayPal buyer protection. + + + + GetItem + GetSellingManagerTemplates + Conditionally + + + + + + + + Indicates a specific type of lead generation format listing, such as + classified ad or local market Best Offer listing. Only applicable when + ListingType=LeadGeneration. + <br><br> + <span class="tablenote"><b>Note:</b> + ListingSubtype2 replaces the deprecated ListingSubtype field. + If both are specified in a request, ListingSubtype2 takes precedence. + </span> + + + + About Local Market Listings + http://pages.ebay.com/help/sell/motors-selling-locally.html + + + Advertising with Classified Ads + http://pages.ebay.com/help/sell/f-ad.html + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the seller allows the bidder to request mechanical + inspection services from RAC. This is only used for the Car category in listings on the UK site. + + + false + + GetItem + GetSellingManagerTemplates + Conditionally + + + + + + + + Specifies whether the following Business Seller fields have been updated for + the item specified in the request: First Name, Last Name, Fax, Email + Address, Additional Contact Information, Trade Registration Number, VAT + Identification Number. + + + + ReviseItem + ReviseSellingManagerTemplate + No + + + + + + + + Flag to indicate whether the item's Return Policy has been updated + as part of the revised listing. + + + + ReviseItem + ReviseSellingManagerTemplate + No + + + + + + + + Specifies the details of policy violations if the item was administratively + canceled. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + + + + + + + + This field is used by sellers who want their listing to be returned in the search + results for other eBay sites. This feature is currently only supported by the US, UK, + eBay Canada, and eBay Ireland sites. See <a href=" + http://pages.ebay.com/help/sell/globalexposure.html">Getting exposure on + international sites</a> for full requirements on using this feature. There is a + small listing fee for each country specified as a Cross Border Trade country. + <br><br> + US listings that offer shipping to Canada, North America, or worldwide are + automatically returned on eBay.ca at no extra charge, so US listings that offer + shipping to these locations do not need to specify Canada as a Cross Border Trade + country. + + + + Making Listings Available by Default on Another Site + ../../../../guides/ebayfeatures/Development/Feature-MultipleSiteListing.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + Returns the seller's information (in a business card format) + if the seller's SellerBusinessCodeType is set to 'Commercial'. + This is only applicable for sites where Business Seller options + are supported. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection + coverage, offered for the item at the time of purchase. Details of coverage + are in the following sections of the View Item page: the Buy Safely section + and the Payment Details section. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, + ReturnAll
+ Conditionally + + + + + + + + When this container is present in an AddItem or AddFixedPriceItem call, all + buyer requirements for the resulting listing are set by this container. + Furthermore, individual buyer requirements cannot be modified or added when + including this container in a ReviseItem call. The ReviseItem call needs to + provide the entire set of buyer requirements to modify or add any of the + requirements. Unless otherwise specified, most buyer requirements are only + returned if the caller is the seller. All global My eBay Buyer Requirements + are overridden by the contents of this container. This means that buyer + requirements set in My eBay cannot be combined with buyer requirements + included in this container. <br> + <br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + Selecting Buyer Requirements (eBay Web site help) + http://pages.ebay.com/help/sell/buyer-requirements.html + + + + + + + + Container that describes the seller's return policy. Most categories on most + eBay sites require the seller to include a return policy through the + ReturnPolicy container. + <br> + <br> + <b>For the AddItem family of calls:</b> Required for + most categories on most sites. Use ReturnPolicyEnabled + in GetCategoryFeatures to determine which categories require this + field. To determine which ReturnPolicy fields can be used on each site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>. + <br> <br> + eBay India (IN), Australia (AU), and US eBay Motors + Parts and Accessories categories typically support but do not + require a return policy. (However, we strongly recommend that + you specify a clear return policy whenever possible.)<br> + <br> + <b>For ReviseItem only:</b> If the listing has bids or + sales and it ends within 12 hours, you can't change the return policy + details. If the listing is a GTC listing that has sales or ends within 12 + hours (one or the other, but not both), you can add a return policy to the + GTC listing (but you can't change return policy details if already present). + If the listing has no bids or sales and more than 12 hours remain before the + listing ends, you can add or change the return policy. When you revise your + return policy, you only need to specify the fields you want to add or + change. You don't need to specify all the other ReturnPolicy fields again. + The other fields will retain their existing settings.<br> + <br> + <b>For the GetItem family of calls:</b> Only returned if the + site you sent the request to supports the seller's return policy. Typically, + the return policy details are only returned when the request is sent to the + listing site. + + + + MoneyBack + AddFixedPriceItem + AddItem + AddItems + AddLiveAuctionItem + AddSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + Conditionally + + + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + RelistFixedPriceItem + RelistItem + VerifyRelistItem + MoneyBack + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, + ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Offering a Clear Return Policy + ../../../../guides/ebayfeatures/Development/Feature-ReturnPolicy.html + + + (GetCategoryFeatures) Category.ReturnPolicyEnabled + categories that require a return policy + GetCategoryFeatures.html#Response.Category.ReturnPolicyEnabled + + + (GeteBayDetails) ReturnPolicyDetails + return policy fields that each site reports + GeteBayDetails.html#Response.ReturnPolicyDetails + + + + + + + + Enables you to view the sites on which an item can be purchased, + based on the payment methods offered for the item. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + Indicates whether you prefer to track your eBay listings by + eBay Item ID or by your own SKU. <br> + <br> + If you want to use SKU instead of ItemID as a unique identifier + (such as when retrieving items and orders), you can set + Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and + related calls. In this case, the SKU must be + unique across your (the seller's) active listings. + Note that if you relist the item, you must reset + Item.InventoryTrackingMethod to SKU; otherwise the relisted + item will default to ItemID as the tracking method. <br> + <br> + If both ItemID and SKU are specified in item-retrieval and + order-retrieval calls that support the use of SKU as a unique + identifier, the ItemID value takes precedence and is used to + identify the listing.<br> + <b>For GetItem and related calls</b>: + Only returned when the value is SKU; not returned when the value is ItemID. + Not applicable to Half.com. + + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + No + ItemID + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, + ReturnAll
+ Conditionally + + + eBay Merchant Data API + AddFixedPriceItem and ReviseFixedPriceItem + http://developer.ebay.com/DevZone/merchant-data/CallRef/index.html + + + + + + + + Indicates whether the item can be paid for through a payment gateway + (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then + integrated merchant credit card (IMCC) is enabled for credit cards because + the seller has a payment gateway account. Therefore, if + IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC + is returned for an item, then on checkout, an online credit-card payment is + processed through a payment gateway account. A payment gateway account is + used by sellers to accept online credit cards (Visa, MasterCard, American + Express, and Discover). + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, + ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItems + GetSellingManagerTemplates + GetSellingManagerSoldListings + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Variations are multiple similar (but not identical) items in a + single fixed-price listing. For example, a T-shirt listing + could contain multiple items of the same brand + that vary by color and size (like "Blue, Large" and + "Black, Medium"). Each variation specifies a combination of one of + these colors and sizes. Each variation can have a different + quantity and price. You can buy multiple items from one + variation at the same time. (That is, one order line item can contain + multiple items from a single variation.) <br> + <br> + If you list in two categories, both categories must support + listing with variations. See VariationsEnabled in + GetCategoryFeatures to determine applicable categories.<br> + <br> + <b>For ReviseFixedPriceItem and + RelistFixedPriceItem:</b> Once a listing has been submitted with variations, + you can't delete all the variations when you revise or relist the listing (because + it would be considered a different listing). However, you can delete or replace individual variations as needed to match your current inventory. If a variation has + no purchases, use the Variation.Delete field to delete the variation. If it has + inventory, set the Quantity to 0.<br> + <br> + As a best practice, if you want to revise multiple variations in + the same listing at the same time (i.e, within a very short period), + use a single ReviseFixedPriceItem request and include all the + variation revisions in the same request. If your application design + requires you to revise each variation individually, then avoid using + multiple parallel threads. Instead, use a serial, synchronous + process. That is, wait until each revision has been + processed by eBay before submitting the next revision request for + another variation in the same listing.<br> + <br> + <b>For GetItem and related calls</b> Only returned + when a listing has variations. + <br><br> + <b>For GetSellerList:</b> Only returned when a listing + has variations, IncludeVariations was set to true in the request, + the DetailLevel was set to ReturnAll, and an applicable pagination + value and time range were specified.<br> + <br> + <b>For GetItemTransactions</b> Only returned in Item + when a listing has variations and IncludeVariations was set to true + in the request. (Also see Variation returned in Transaction for + information about which variation was actually purchased.) + <br> + <br> + <b>For GetSellerEvents, GetMyeBayBuying, and GetMyeBaySelling:</b> Only returned + when a listing has variations and HideVariations was set to false + or not specified in the request. + + + + Configuring Variations for a Listing + ../../../../guides/ebayfeatures/Development/Variations-Configuring.html + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + No + + Using Multi-Variation Listings + ../../../../guides/ebayfeatures/Development/Variations.html + + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + A list of parts compatibility information specified as name and value pairs. Describes an assembly with which a part is compatible (i.e., compatibility by application). For example, to specify a part's compatibility with a vehicle, the name (search name) would map to standard vehicle characteristics (e.g., Year, Make, Model, Trim, and Engine). The values would desribe the specific vehicle, such as a 2006 Honda Accord. Use the Product Metadata API to retrieve valid search names and corresponding values. + <br><br> + <b>For the AddItem family of calls:</b> Use this for specifying parts compatibility by application manually. This can only be used in categories that support parts compatibility by application. Use <b class="con">GetCategoryFeatures</b> with the "CompatibilityEnabled" feature ID to determine which categories support parts compatibility by application. + <br><br> + <span class="tablenote"><b>Note:</b> Only valid parts compatibility name-value pairs will be added to the listing. Any invalid parts compatibility combinations will be reported in the long error message in the response errors with a severity of Warning.</span> + <b>For ReviseFixedPriceItem and ReviseItem:</b> When you revise a listing, if the listing has bids and/or ends within 12 hours, item compatibilities cannot be deleted. You may add item compatibilities at any time. + <br><br> + <b>For GetItem:</b> <b + class="con">ItemCompatibilityList</b> is returned only if: + <br/> + <ul> + <li>The seller included item compatibility in the listing.</li> + <li>The item compatibility details were specified manually; that is, they do not correspond to an eBay catalog product. (To retrieve compatibility details that <em>do</em> correspond to eBay catalog products, use the eBay Product API's getProductCompatibilities call.)</li> + <li><b class="con">IncludeItemCompatibilityList</b> is set to true in the <b class="con">GetItem</b> request.</li> + </ul> + + + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + Specifying Parts Compatibility in Listings + ../../../../guides/ebayfeatures/Development/CompatibleParts.html + + + Product Metadata API Call Reference + http://developer.ebay.com/DevZone/product-metadata/CallRef/index.html + information about retrieving compatibility search names and corresponding values needed to specify compatibility by application manually. + + + + GetItem + Conditionally + + Product API ProductCompatibilities call reference + http://developer.ebay.com/Devzone/product/CallRef/getProductCompatibilities.html + information about retrieving compatibility details that correspond to eBay catalog products. + + + + + + + + + Indicates the number of compatible applications specified for the given item. + Applies to items listed with fitment by application only (either manually or + with a catalog product that supports compatibility). + <br><br> + Not returned if the item has no specified compatible applications. Not + returned if <b class="con">IncludeItemCompatibilityList</b> is + specified in the request. + <br><br> + To retrieve the list of compatibility information, set <b class="con"> + IncludeItemCompatibilityList</b> to "true" in the request. + + + + GetItem + Conditionally + + + + + + + + The numeric ID (e.g., 1000) for the item condition. + Sellers should also clarify the item's condition in their + own item description. + <br><br> + <span class="tablenote"><b>Note:</b> + In addition to including notes on flaws or wear and tear on an used item in the + <b>Item.Description</b>, and including a <b>ConditionID</b> + value, you can provide additional information about the condition of your used item + through the <b>Item.ConditionDescription</b> string field. + </span> + <br> + <b>For the AddItem family of calls:</b> + Use GetCategoryFeatures for details about which categories support + (or require) ConditionID, plus policies and help on choosing the + right condition for the item (to reduce disputes). <br> + <br> + Please note the following behavior if you pass a ConditionID value + that is not valid for the category: If ConditionID is disabled + (or not applicable) for the category, the item is listed with no + condition. If ConditionID is enabled or required for the category, the listing + request fails.<br> + <br> + If you are listing in two categories, the primary category determines which + condition model (ConditionID or item specifics) and which condition values + can be used. <br> + <br> + US eBay Motors Parts & Accessories and vehicle categories require ConditionID for new + listings and re-listings. + <br> + <br> + Not applicable to Half.com in listing requests (e.g., AddItem). + However, ConditionID could be returned in responses for + Half.com listings that are available to or sold on the + eBay site (as appropriate for the corresponding eBay category).<br> + <br> + <b>For Revise/Relist calls:</b> In most cases, you can add or modify + ConditionID when you revise or relist. + If GetCategoryFeatures returns ConditionEnabled=Required for the + listing's category, you cannot remove ConditionID from the listing.<br> + <br> + If an auction has bids or ends within 12 hours, you cannot remove or + change its condition, and you cannot replace a condition + attribute or custom item specific with ConditionID. In this case, + you will still be able to modify other fields that are normally + editable, even if ConditionID is not present.<br> + <br> + In most cases, you can add or modify ConditionID for multi-quantity + fixed price listings. (If a multi-quantity fixed price listing has + revision restrictions imposed by other choices the seller has made + in the listing, you might not be able to remove or change the + condition.)<br> + <br> + If you revise or relist a GTC listing that only has a condition + attribute or custom item specific, you need to specify ConditionID + (if the category requires it). ReviseInventoryStatus also fails + if you attempt to revise listings that are missing ConditionID. + (This rule does not apply during auto-renewal of a GTC listing. + It only applies when you perform an action on the listing.) <br> + <br> + <b>For GetItem and GetSellerList:</b> Only returned when the seller + specified ConditionID in their listing. Also returns + a localized display name.<br> + <br> + <span class="tablenote"><b>Note:</b> + For most categories, eBay does not convert item condition data in + the older AttributeSetArray, LookupAttributeArray, or ItemSpecifics + format to this format in older listings or when you revise or + relist items. + This means GTC listings and older ended or sold listings + may still return the item condition in these other fields even after + new listings only support ConditionID.<br> + <br> + There are a few categories in which automatic mapping does occur, + where the old and newer conditions are identical. See the "Automatic Mapping" + tab in the Item Condition Look-up Table link below for details.<br> + <br> + Also, if you specified ConditionID but the category also supports + condition in item specifics, you may receive a + "Dropped condition from Item specifics" warning. + You can ignore this warning as long as you used ConditionID. + </span> + + + + Specifying an Item's Condition + ../../../../guides/ebayfeatures/Development/Desc-ItemCondition.html + + + ConditionValues in GetCategoryFeatures + GetCategoryFeatures.html#Response.Category.ConditionValues + + + Item Condition Look-up Table (and Automatic Mapping) + http://pages.ebay.com/sellerinformation/news/itemconditionlookup.html + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + + + This string field is used by the seller to more clearly describe the condition of items that are not brand new. + <br><br> + The <b>ConditionDescription</b> field is available for all categories, including categories where the condition type is not applicable (e.g., Antiques). This field is applicable for all item conditions except "New", "Brand New", "New with tags", and "New in box". If <b>ConditionDescription</b> is used with these conditions (Condition IDs 1000-1499), eBay will simply ignore this field if included, and eBay will return a warning message to the user. + <br><br> + This field should only be used to further clarify the condition of the used item. For example, "The right leg of the chair has a small scratch, and on the seat back there is a light blue stain about the shape and size of a coin." It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the item. Make sure that the condition type (<b>Item.ConditionID</b>), condition description, item description (<b>Item.Description</b>), and the listing's pictures do not contradict one another. + + <br><br> + <span class="tablenote"> + <strong>Note:</strong> The <b>ConditionDescription</b> field is optional For Add/Revise/Relist API calls. <br> + <b>ConditionDescription</b> is currently supported on the eBay US and US eBay Motors (0), UK (3), CA (2), CAFR (210), AU (15), AT (16), BEFR (23), BENL (123), FR (71), DE (77), IT (101), NL (146), ES (186), CH (193), IE (205) and PL (212) sites. + </span> + The <b>ConditionDescription</b> field is returned by <b>GetItem</b> (and other related calls that return the Item object) if a condition description is specified in the listing. + + + 1000 + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddSellingManagerTemplate + AddItems + VerifyAddFixedPriceItem + VerifyAddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetSellerList + Conditionally +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Fine, Medium
+ + + GetItem + GetItems + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ + + + + + + + + + The human-readable label for the item condition. + Display names are localized for the site on + which they're listed (not necessarily the site on which + they're viewed).<br> + <br> + Most categories use the same display name for the + same condition ID. Some categories may override the display name + based on buyer expectations for items in the category. + For example, condition ID 1000 could be called + "New" in one category and "New with tags" in another.<br> + <br> + Behind the scenes, eBay's search engine uses the ID + (not the display name) to determine whether items are + new, used, or refurbished.<br> + <br> + Only returned when the seller specified ConditionID in their + listing. + + + 50 + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Tax exception category code. This is to be used only + by sellers who have opted into sales tax being calculated + by a sales tax calculation vendor. If you are interested + in becoming a tax calculation vendor partner with eBay, + contact developer-relations@ebay.com. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddFixedPriceItem + VerifyAddItem + Conditionally + + + GetItem +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the type of message that will be returned describing the quantity + available for the item. + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + The quantity threshold above which the seller prefers not to show the actual + quantity available. Returned when the quantity available is greater than the + value of quantity threshold. Currently, 10 is the only available value for + this threshold. + + + 10 + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Reserved for future use. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price + (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site. + <br /> <br /> + Discount pricing is available to qualified sellers (and their associated developers) who + participate in the Discount Pricing Program. Once qualified, sellers receive a + "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation + items. Sellers should contact their account manager or Customer Service to + see if they qualify for the Strikethrough Pricing program. + <br><br> + As a seller listing Discount Price items, you are required to maintain records of your discount + pricing in the event you are called upon to substantiate your item pricing. The following + link details your legal obligations when you utilize Discount Pricing to sell items: <a href= + "http://pages.ebay.com/help/sell/strike-through.html">Strikethrough Pricing Requirements + </a> + <br><br> + <b>For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and + VerifyAddFixedPriceItem:</b> + If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. + + + + Displaying Discount Pricing Information to Buyers + ../../../../guides/ebayfeatures/Development/Items-Retrieving.html#DisplayingDiscountPricingInformationtoBu + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item. This is like using ProductListingDetails to list an item. Applies only to catalog-enabled categories. + <br><br> + This feature is available to a small subset of eBay-selected sellers. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + No + + Item.ProductListingDetails + #Request.Item.ProductListingDetails + + + + + + + + + A descriptive free-text title for a US or CA eBay Motors vehicle + listing. This title appears below eBay's pre-filled listing title + on the View Item page (not at the top of the View Item page). + It's also appended to the listing title in search results + (like a subtitle) on the US eBay Motors site. + Keywords in this title help buyers find or distinguish + your listing.<br> + <br> + Applicable to listings in US eBay Motors Cars and Trucks, + Motorcycle, and some of the Powersport, Boats and RV campers + categories; or to Cars and Trucks listings on CA eBay Motors.<br> + <br> + This replaces the older US and Canada eBay Motors Subtitle attribute + (attribute ID 10246).<br> + <br> + Not applicable to Half.com. + + + 80 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + No + + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellingManagerTemplates + Conditionally + + + + + + + + Vehicle Identification Number, which is a unique serial number + for a motor vehicle.<br> + <br> + Applicable to listings in US eBay Motors Cars and Trucks (6001), + Motorcycles (6024), Commercial Trucks (63732), + RVs and Campers (50054), ATVs (6723), Snowmobiles (42595), + and UTVs (173665); + and to Cars and Trucks listings in CA, CAFR and AU eBay Motors. + For vehicle categories that do not use VIN, + call GetCategorySpecifics to determine applicable + custom item specifics (such as "Hull ID Number" for Boats). + <br> + <br> + For the US, CA, and CAFR eBay Motors sites, required for cars and + trucks from model year 1981 and later. (The US developed national standards for VIN values in 1981.)<br> + <br> + For the eBay Australia site, required for vehicles from model year + 1989 or later. For the eBay Australia site, only appears on the View Item page if you also specify the date of first registration in the listing's item specifics. + <br> + <br> + Appears in the VIN field in the Item Specifics section of eBay's + View Item page.<br> + <br> + Not applicable to Half.com. + + + 17 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddFixedPriceItem + VerifyAddItem + Conditionally + + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellingManagerTemplates + Conditionally + + + + + + + + Link to the Vehicle History Report for the vehicle whose VIN was + specified in Item.VIN. If no vehicle history report is available, eBay may instead show a plain-text copy of the VIN.<br> + <br> + Applicable to listings in US eBay Motors Cars and Trucks, Motorcycle, and some Powersport, Boats and RV campers categories; + and to Cars and Trucks listings in CA, CAFR and AU eBay Motors.<br> + <br> + For the eBay Australia site, only appears on the View Item page if + you specify Item.VIN and you also specify the date of + first registration in the listing's item specifics.<br> + <br> + Not applicable to Half.com. + + + 2056 + ComingSoon + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Vehicle Registration Mark, which is a unique identifier for + a motor vehicle.<br> + <br> + Applicable to listings in UK eBay Motors Cars and Trucks, + Motorcycle, and some Powersport categories.<br> + <br> + Appears as a VRM field in the Item Specifics section of eBay's + View Item page. On the View Item page, the VRM value is masked + (i.e., only a portion of the value is shown to users). + In the GetItem response, the VRM is only returned if the + call is made by the seller (i.e., the AuthToken is associated + with the vehicle's seller).<br> + <br> + Not applicable to Half.com. + + + 7 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + VerifyAddItem + No + + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellingManagerTemplates + Conditionally + + + + + + + + Link to the Vehicle History Report for the vehicle whose VRM was + specified in Item.VRM. The report is visible to all users. + If no vehicle history report is available, eBay may instead show a + plain-text copy of the masked VRM.<br> + <br> + Applicable to listings in UK eBay Motors Cars and Trucks, Motorcycle, and some Powersport categories.<br> + <br> + Not applicable to Half.com. + + + 2056 + ComingSoon + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This container is used to set the minimum number of event tickets that should + remain available after a buyer makes a purchase. This functionality allows the + seller to avoid the possibility of being left with just one event ticket after + a sale. + <br><br> + This container can be used when adding, revising, or relisting event tickets, and + it will only be returned in <b>GetItem</b> if set for the listing. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + No + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + Root container consisting of references to one or more Business Policies profiles. + Exactly one Payment Profile, one Shipping Profile, and one Return Policy Profile + may be applied to the listing. + + + 6 + + AddFixedPriceItem + AddItem + AddItems + VerifyAddFixedPriceItem + VerifyAddItem + AddSellingManagerTemplate + No + + + RelistFixedPriceItem + RelistItem + VerifyRelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + No + + + GetItem + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + GetSellerList + Conditionally + + + + + + + + This container is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the <b>SellerProfiles.SellerShippingProfile.ShippingProfileID</b> field. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. + <br/><br/> + A <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container is required for each domestic and/or international shipping service that is defined in the <b>domesticShippingPolicyInfoService</b> and <b>intlShippingPolicyInfoService</b> containers of the Business Policies shipping profile. + <br/><br/> + Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile. + <br/><br/> + <strong>For Revise and Relist calls:</strong> To delete all shipping service cost overrides when you revise or relist, specify <code>Item.ShippingServiceCostOverrideList</code> in <strong>DeletedField</strong>, and don't pass <strong>ShippingServiceCostOverrideList</strong> in the request. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellerList + GetSellingManagerTemplates + Conditionally + + + + + + + + Container consisting of dimension and size details related to a shipping package in + which an item will be sent. The information in this container is applicable if the + seller is using calculated shipping or flat rate shipping using shipping rate tables + with weight surcharges. This container is only returned in the "Get" calls if specified + for the item. + + + 6 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + AddSellingManagerTemplate + VerifyAddFixedPriceItem + Conditionally + + + RelistFixedPriceItem + RelistItem + VerifyRelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + GetSellerList + Conditionally + + + + + + + + This field is only applicable to the US, UK, and Germany sites, and will only be returned if the seller qualifies as a Top-Rated Seller. The current requirements for US sellers to + qualify as Top-Rated Sellers are summarized below. The requirements on the UK and Germany sites are different. To see those requirements, see the UK or Germany customer support/help pages. + <ul> + <li>100 or more selling transactions over the last 12-month period</li> + <li>One thousand dollars or more in sales to US buyers over the last 12-month period</li> + <li>Shipment tracking information provided to buyer within handling time + for at least 90 percent of their listings</li> + <li>Two percent or less of transactions with one or more defects over the current evaluation period</li> + <li>Less than one percent of eBay Buyer Protection and/or PayPal Purchase Protection cases can end without seller resolution</li> + </ul> + <br/><br/> + If this flag is returned for a listing, it indicates that the listing meets the new + requirements for a Top-Rated Listing. The following must be offered by a US seller for the listing to become a Top-Rated Listing on the US site: + <ul> + <li>14-day (or longer) return policy with Money Back option</li> + <li>Same-day or 1 business day handling time</li> + </ul> + <br/><br/> + The <b>Top-Rated Plus</b> seal appears on the View Item + page for all Top-Rated Listings. US Top-Rated Sellers get a + 20 percent discount on their FVF for all listings that qualify as Top-Rated Listings. + <br/><br/> + See eBay's <a href="http://pages.ebay.com/sellerinformation/sellingresources/toprated.html">Top Rated Seller Resource Center</a> for more information about how to qualify as a Top-Rated Seller. + + + + GetItem + GetItems + Conditionally + + + + + + + + This container is used by the seller to restrict the quantity of items that may be + purchased by one buyer during the duration of a fixed-price listing (single or + multi-variation). This is an optional container that can be used with an Add, + Revise, or Relist call. + <br/><br/> + This container is not applicable to auction listings. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + No + + + RelistFixedPriceItem + RelistItem + VerifyRelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + This value sets the minimum price threshold for a seller's product price in a fixed-price + listing. Regardless of the product price on eBay Value Box or Amazon listings, the seller's + product price will not be reduced lower than this dollar value. + <br/><br/> + This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic + pricing rule is assigned to the listing's product. + + + + ReviseItem + ReviseFixedPriceItem + No + + + + + + + + This value sets the maximum price threshold for a seller's product price in a fixed-price + listing. Regardless of the product price on Amazon or eBay Value Box, the seller's product + price will not be raised higher than this dollar value. + <br/><br/> + This value is only applicable to sellers using the Dynamic Pricing API, and if a dynamic + pricing rule is assigned to the listing's product. If this field is not specified through + the Dynamic Pricing API, an eBay system-level threshold is used to avoid any undesirable + results. + + + + ReviseItem + ReviseFixedPriceItem + No + + + + + + + + If true, sellers can offer eBay's Global Shipping Program when listing the specified item. + + + + GetItem +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contains information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the <strong>UnitInfo</strong> data and the item's listed price to calculate and display the per-unit price on eBay EU sites. + <br/><br/> + With GetItem, this container is returned only when you provide <strong>IncludeItemSpecifics</strong> in the request and set it to <code>true</code>. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This information is currently required only for EU business sellers, and only for listings with a Buy It Now option. + </span> + + + + GetItem + GetItems + Conditionally + + + + + + + + The eBay Item ID of the current item's parent (original) listing. Only a relisted + item will have a parent item, so this field will only be returned if the current + item is a relisted item. + + + + GetItem + GetItems +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This field is not returned by any Trading API calls, and will be deprecated soon. + + + + + + + + + + + If this field is returned in <b>GetItem</b> as 'true', the auction + listing is being hidden from search on the eBay site. This field is not returned + if 'false'. + <br/><br/> + To see the reason why the auction listing is being hidden from search, take a look + at the value returned in the <b>ReasonHideFromSearch</b> field. + Currently, only auction listings that have been determined to be duplicate listings + with zero bids are hidden from search, but there may be other reasons to hide + auction listings from search in the future. + <br/><br/> + Is it possible that a previously hidden listing will be resurfaced in search if the + original auction listing or other duplicate listings get bids or are purchased + through Buy It Now. + <br/><br/> + It is also possible that eBay will administratively end duplicate auction listings + with zero bids. If this occurs, the listing fee will be credited back to the + seller's account, and the value returned in the + <b>AccountDetailsEntryType</b> field of the <b>GetAccount</b> + API call will be <b>CreditAuctionEndEarly</b>. + <br/><br/> + This field is associated with eBay Duplicate Listings Policy, which has taken + effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. + Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this + policy. For more information, read + <a href="http://pages.ebay.com/help/policies/listing-multi.html">eBay's Duplicate Listings Policy</a> help page. + + + + GetItem + GetItems + Conditionally + + + + + + + + The enumeration value in this field indicates why the auction listing is being + hidden from search on the eBay site. This field is only returned if the + <b>HideFromSearch</b> field is returned as 'true' in the + <b>GetItem</b> response. + <br/><br/> + Currently, only auction listings that have been determined to be duplicate listings + with zero bids are hidden from search, but there may be other reasons to hide + auction listings from search in the future. + <br/><br/> + This field is associated with eBay Duplicate Listings Policy, which has taken + effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. + Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this + policy. For more information, read + <a href="http://pages.ebay.com/help/policies/listing-multi.html">eBay's Duplicate Listings Policy</a> help page. + + + + GetItem + GetItems + Conditionally + + + + + + + + If this field is included and set to 'true' in the request of an + Add/Revise/Relist/Verify API call, the call response will include any listing + recommendations that will help the seller improve the quality of the listing. The + type of listing recommendations include the following: + <ul> + <li>eTRS - this recommendation type advises the seller that the listing + is not meeting a specific Top-Rated Plus listing requirement, such as same-day or 1-day handling or a 14-day (or longer) Money Back Return Policy;</li> + <li>ItemSpecifics - this recommendation type advises the seller that the + listing is missing one or more required or recommended Item Specifics name/value pairs;</li> + <li>Picture - this recommendation type advises the seller that a specific + picture in the listing is not meeting a specific picture quality requirement. + For more information see, <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>; + </li> + <li>Price - this recommendation type provides a recommended price and/or a recommended price range for auction and fixed-price listings. These price recommendation values are based on similar items that have recently sold on eBay. Along with pricing recommendations, a recommended listing format (auction vs. fixed-price) is also returned. This recommendation type is currently only supported on the US, UK, and DE sites; </li> + <li>Title - this recommendation type provides guidance on forming an effective listing title. The Listing Recommendation API will suggest that the listing title is missing valuable keywords, missing recommended Item Specifics, or has keywords that should not be there since it misrepresents the item. The keywords or Item Specifics are called out in the response. This recommendation type is currently only supported on the US, UK, DE, and AU sites; and </li> + <li>FnF - this recommendation type advises the seller to offer fast handling (same-day handling or handling time of 1 day) and/or a free shipping option in order to qualify the listing for a Fast 'N Free badge. </li> + </ul> + + + false + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + No + + + + + + + + This container is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup via the <b>EligibleForPickupInStore</b> boolean field. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. + <br/><br/> + In a future release, a fulfillment duration element will be added to this container and will be used to determine when the item will be ready for pickup in a store (immediately, two hours after sale, two days after sale, etc.). + <br/><br/> + This container is returned in <b>GetSellerList</b> if In-Store Pickup is set for the listing. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + No + + + GetSellerList + Conditionally + + + GetItem + Conditionally + + + + + + + + This field is used in Add/Revise/Relist calls to enable the listing for eBay Now delivery. To enable the listing for eBay Now delivery, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the eBay Now delivery feature to list an item that is eligible for eBay Now delivery. This field will be ignored if the seller is not eligible to list eBay Now products. + <br/><br/> + This field will be returned as 'true' in <b>GetSellerList</b> if the item is enabled for eBay Now delivery. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This boolean field will be returned as 'true' if the item is available for eBay Now delivery. However, buyers should realize that they must be in an area where eBay Now delivery is available. As of April 2014, eBay Now has been launched on the San Francisco Penisula (from San Francisco to San Jose), in Chigago, in Dallas, and in the New York City boroughs of Manhattan, Brooklyn, and Queens. + + + + GetItem + Conditionally + + + + + + + + This field will only be returned (as 'True') in the case where items in a listing are only available to buyers through a local fulfillment method such as In-Store Pickup, eBay Now, or Click and Collect. And if a listing is truly a "local fulfillment" listing only, the value in the <b>Item.Quantity</b> field (for single-variation listings) or the <b>Variation.Quantity</b> field (for multi-variation listings) will default to '0' even though the quantity available is technically not zero, since items in the listing are still available through one or more local fulfillment methods. + + + + GetItem + Conditionally + + + + + + + + This boolean field will be returned as 'true' if the item is available for "Click and Collect". The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. UK and Australia buyers should realize that they must be in an area where "Click and Collect" is available. This field is not returned if 'false'. + + + + + + + + + + + + + This field will be returned as 'true' in <b>GetItem</b> if the item is eligible for "Click and Collect". The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. A UK or Australian seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". This field is not returned if 'false'. + + + + GetItem + Conditionally + + + + + + + + With Live Auctions, online bidders compete real-time against other bidders who are actually on-site at the auction house event. Unlike traditional eBay auction listings, buyers must register for Live Auction events before being able to bid. + <br/><br/> + To set up, revise, or relist an auction event item through the Add/Revise/Relist calls, the seller would include and specify the following fields as follows: + <ul> + <li><b>Item.LiveAuction</b>: include this field and set it to 'true'.</li> + <li><b>Item.ListingType</b>: include this field and set it to 'Chinese' (auction).</li> + <li><b>Item.ListingDuration</b>: include this field and set its value to '3, '5', '7', or '10' (days). In this case, the listing duration will be the number of days in which interested eBay users can register for the auction event. The actual duration is controlled by the auction house that is hosting the event. </li>\ + <li><b>Item.ScheduleTime</b>: include this field and set its value to the actual start date and time of the event auction. </li> + <li><b>Item.PaymentMethods</b>: include only one <b>PaymentMethods</b> value and set it to 'PaymentSeeDescription'. </li> + <li><b>Item.ShippingDetails.ShippingType</b>: include this field and set it to 'Flat'. </li> + <li><b>Item.ShippingDetails.ShippingServiceOptions.ShippingService</b>: include this field and set its value to 'Pickup'. </li> + <li><b>Item.ReturnPolicy.ReturnsAcceptedOption</b>: include this field and set its value to 'ReturnsNotAccepted'. </li> + </ul> + <br/><br/> + This field will be returned as 'true' if item is part of a Live Auction event. + <br/><br/> + Live Auctions are only available on the US site. For more information on Live Auctions, see the <a href="http://pages.ebay.com/help/buy/live-auctions.html">Participating in live auction events</a> help topic. + + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + Conditionally + + + + + + + + + + + + FixedPriceExcludeStoreInventory, ExcludeStoreInventory, AllItemTypes, AllFixedPriceItemTypes, AdFormat + + + Enumerated type containing values that provide more information on the type of + filtering the buyer used when setting up a Saved Search in My eBay. + + + + + + + When setting up filtering for the Saved Search, the buyer was only looking for + auction items (with or without the Buy It Now option), so only selected the <b>Auction</b> checkbox in the + <b>Format</b> dialog box. When this filter is used in a Saved Search, + fixed-price items and classified ad listings are not retrieved for the buyer. + + + + + + + When setting up filtering for the Saved Search, the buyer was looking for all + fixed-price items and auction items with Buy It Now available, so only selected the + <b>Buy It Now</b> checkbox in the <b>Format</b> dialog box. + When this filter is used in a Saved Search, auction items (without the Buy It Now + option) and classified ad listings are not retrieved for the buyer. + + + + + + + When setting up filtering for the Saved Search, the buyer was looking for all + items closely associated with the search term, so selected all buying formats + (Auction, Buy It Now, and Classified Ads). All items are retrieved for the buyer, + including auction items (with or without the Buy It Now option), fixed-price + items, and classified ad listings. + + + + + + + When setting up filtering for the Saved Search, the buyer was only looking for + items sold by sellers with eBay stores, so selected the + <b>Sellers with eBay stores</b> checkbox in the + <b>Seller</b> dialog box. When this filter is used in a Saved Search, + only items for sale in an eBay store are retrieved for the buyer. + + + + + + + + Excludes listings that have listing type set to StoresFixedPrice. + Excludes listings that have listing type set to AdType. + Excludes auction listings in which BuyItNowEnabled is false. + + + + + + + + Excludes listings that have listing type set to StoresFixedPrice. + + + + + + + + Retrieves listings whether or not listing type is set to StoresFixedPrice; + include auction items. + + + + + + + + Retrieves fixed-price items. + Whether StoresFixedPrice items are retrieved does not depend on the site default. + The StoresFixedPrice items are retrieved after the basic fixed price items. + Items are retrieved whether or not listing type is set to StoresFixedPrice. + Does not retrieve items for which listing type is AdType. + Does not retrieve auction items for which BuyItNowEnabled is false. + + + + + + + Reserved for internal or future use. + + + + + + + When setting up filtering for the Saved Search, the buyer was only looking for + classified ad listings, so only selected the <b>Classified ads</b> checkbox in the + <b>Format</b> dialog box. When this filter is used in a Saved Search, + auction (with or without the Buy It Now option) and fixed-price items + are not retrieved for the buyer. + + + + + + + + Restricts listings to return only items that have the Ad Format feature. + + + + + + + + + + + This event is not functional. + + + + + + + + + This event is not functional. Array of items ended. + + + + + + + This event is not functional. Indicates to seller whether the items ended are eligible for + Relist or not. + + + + + + + This event is not functional. Seller numeric ID. + + + + + + + + + + + + This type is deprecated as the <b>GetProduct*</b> calls are no longer available. + + + + + + + + + + + + The label to display when presenting the attribute to a user + (e.g., "Title" or "Manufacturer"). <br> + <br> + The label is defined for the product, and is therefore not + necessarily the same as the label that is defined in the characteristic set + returned by another call like GetAttributesCS.<br> + <br> + <b>For GetProductSearchPage</b>: If the attribute's label is "Keyword", + it means you can enter the attribute's ID and a string value in the + SearchAttributes node of GetProductSearchResults, + and then eBay will search for the string against one or more attributes in the catalog. + For example, for strollers, GetProductSearchPage only returns a Keyword attribute + instead of separate Brand, Product Type, and Model attributes (for the US site). + So, you can use the single Keyword attribute to search against all of those attributes.<br> + <br> + + + + + + + + + + + + + + If true, the label name is visible on the eBay site. If false, the label is not visible. + Usage of this information is optional. You are not required to display labels in + the same manner as eBay. + + + + + + + + + + + + + This type provides information about one order line item in a Global Shipping package. The package can contain multiple units of a given order line item. + + + + + + + The number of units of the order line item in this package; this is required for customs. The seller must ensure that this matches the quantity of the order line item enclosed in the package. + <br/><br/> + This value must be a positive integer, and it can't be greater than the quantity of this item specified in the original transaction. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The Country of Manufacture for the order line item; this is required for customs. This should identify the country in which more than 50% of the value of the item was created. + <br/><br/> + This value must conform to the ISO 3166 two-letter country code standard. + To see the list of currently supported codes, and the English names associated with each code + (e.g., KY="Cayman Islands"), call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>CountryDetails</b>. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The item description of the order line item, based on its <strong>ItemID</strong>. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + Unique identifier for the eBay item listing of the order line item. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. Unless an <b>OrderLineItemID</b> or <b>SKU</b> value is specified in the same node, this field is required for each <b>ItemTransactionID</b> node included in the request. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). The <b>TransactionID</b> should match the <b>ItemID</b> specified in each <b>ItemTransactionID</b> node included in the request. Optionally, an <b>OrderLineItemID</b> value can substitute for the <b>ItemID</b>/<b>TransactionID</b> pair. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + + + + + Contains results returned from the Listing Analyzer recommendation engine. + + + + + + + A collection of tips returned from the Listing Analyzer recommendation engine. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + + ProStores listing level preferences. + + + + + + + The name of the ProStores store. + To remove this value when revising or relisting an item, use DeletedField. + + + 200 + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The user name of the ProStores store. + To remove this value when revising or relisting an item, use DeletedField. + + + 200 + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains the IDs for the Listing Designer theme and template (if either are + used) associated with an item, which can optionally be used to enhance the + appearance of the item's description. Cannot be used with Photo Display. + + + + + + + Identifies the Layout template to use when displaying the + item's description. Call GetDescriptionTemplates for valid IDs. + Set to false in GetDescriptionTemplates (or do not specify + LayoutID) to get the standard layout. If a Listing Designer + layout is used (except standard layout), PhotoDisplayType must + be false (or not be specified). + When relisting an item, LayoutID is removed from the listing if you specify + ListingDesignerType without LayoutID. Alternatively, to remove this value + when revising or relisting an item, use DeletedField. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Always + + + + + + + + If true, indicates that the item's picture will be enlarged to fit description + of the item. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + ID for the Listing Designer theme template to use when + displaying the item's description. + When relisting, if you specify ListingDesignerType without + ThemeID, ThemeID is removed from the listing. Alternatively, to remove + this value when revising or relisting an item, use DeletedField. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Always + + + + + + + + + + + + Various details about a listing. Some of the details are calculated or derived after + an item is listed. The details in this type include the start and end time and + the converted (localized) prices. The details in this type also include + input values applicable to the Best Offer feature. + Additional details in this type include flags indicating if a seller + specified fields whose values are not visible to the requesting user. + + + + + + + If true, the item is listed in a Mature category. Users must accept + the Mature Category agreement on the eBay site to retrieve + items listed in Mature categories. (Users do not need to sign + this agreement to be able to list items in Mature Categories.) + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + + + + + + Applicable for Real Estate auctions only. If true, buyers and sellers + are expected to follow through on the sale. If false, bids for the + Real Estate auction are only expressions of interest. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + + + + + + This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at + listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, + a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This + preferance is enabled by default if PayPal is one of the payment methods. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + Checkout + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Checkouts.html + + + + + + + + Converted value of the BuyItNowPrice in the currency of + the site that returned this response. + For active items, refresh this value every 24 hours to + pick up the current conversion rates. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + GetMyeBayBuying + SecondChanceOffer + BestOfferList + BidList + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + Converted value of the StartPrice in the currency of + the site that returned this response. + For active items, refresh this value every 24 hours to + pick up the current conversion rates.<br> + <br> + In multi-variation listings, this value matches the lowest-priced + variation that is still available for sale. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetMyeBayBuying + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + Converted value of the ReservePrice in the currency of the + site that returned this response. Only returned for listings with + a reserve price when the requesting user is the listing's seller. + For active items, refresh this value every 24 hours to + pick up the current conversion rates. + Not applicable to Fixed Price listings. + + + + GetBidderList + Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + If true, the seller specified a value in ReservePrice. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Medium, Fine
+ Conditionally + + + + + + + + Indicates the new item ID for a re-listed item. When an item is + re-listed, the item ID for the new item is added to the + old listing, so buyers can navigate to + the new listing. This value only appears when the old listing is + retrieved. The RelistedItemID of the original item should reflect the last relist. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The item ID for the original listing from which a second chance offer + is made. This value is only returned when the data for the second chance + offer listing is retrieved. + Output only. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The StartTime value returned by non-search calls such as + GetItem is the time stamp (in GMT) for when + the item was listed. + + + + GetBidderList + GetDispute + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetMemberMessages + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Time stamp (in GMT) when the listing is scheduled to end + (calculated based on the values of StartTime and ListingDuration) + or the actual end time if the item has ended. + + + + GetBidderList + GetDispute + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback + GetMemberMessages + Conditionally + + + GetMyeBayBuying + BidList + LostList + SecondChanceOffer + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList + DeletedFromSoldList + DeletedFromUnsoldList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The URL of the Web page where a user can view the listing. + On the US site, this is called the "View Item" page. + If you enabled affiliate tracking in a search-related call + (for example, if you used the AffiliateTrackingDetails container + in an applicable call), ViewItemURL contains + a string that includes affiliate tracking information + (see the <a href= + "https://www.ebaypartnernetwork.com" target="_blank">eBay Partner Network</a>). + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the item has any unanswered questions. Use + GetMemberMessages to retrieve unanswered questions for the item if this flag + indicates that there are any. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the item has any publicly displayed messages. Use + GetMemberMessages to retrieve public messages for the item if this flag + indicates that there are any. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This flag indicates whether the Buy It Now feature is available for an auction listing. + As a general rule, once an auction listing has bids (and the high bid exceeds the + reserve price, if any), the Buy It Now feature becomes disabled for the listing. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Type of seller account. This value is not returned for most sites. + This value is not returned for the German site + (site ID 77) or US eBay Motors site (site ID 0). + + + + + + + + + + Specifies the minimum acceptable Best Offer price. If a buyer + submits a Best Offer that is below this value, the offer is automatically + declined by the seller. Applies only to items listed in categories that + support the Best Offer Auto-Decline feature. Best Offer must be enabled + for the item, and only the seller who listed the item can see this value. For a <b>ReviseItem</b> or <b>ReviseFixedPriceItem</b> call on US eBay Motors site, prior use of a minimum Best Offer price on eBay.com is ignored. + To remove this value when revising or relisting an item, use DeletedField. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Specifies the message sent from the seller to the buyer when a + submitted Best Offer is automatically declined by the seller. A Best Offer + is automatically declined if it does not meet the minimum acceptable best + offer price specified by the seller with MinimumBestOfferPrice. Applies only + to items listed in categories that support the Best Offer Auto-Decline + feature. Best Offer must be enabled for the item. + To remove this value when revising or relisting an item, use DeletedField. + + + + + + + + + + + + + + Specifies a distance (in miles) used as the radius of the area about the + supplied postal code that constitutes the local market. Use + GetCategoryFeatures to determine the local listing distances supported by + a given site, category, and Local Market subscription level. + + + + AddItem + AddItems + AddSellingManagerTemplate + AddFixedPriceItem + GetItemRecommendations + Conditionally + + + + + + + + Indicates the item ID of the original item listing from which a + Transaction Confirmation Request (TCR) was created. This value is only + returned when the data for a TCR is retrieved. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + + + + + + This URL takes you to the same View Item page as ViewItemURL, + but this URL is optimized to support natural search. + That is, this URL is designed to make items on eBay easier to find via + popular Internet search engines. The URL includes the item title along with other optimizations. To + note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes + to "QQ", and "=" (equals sign) optimizes to "Z". + <br><br> + If you are an eBAy affiliate, use this URL to promote your affiliate + information. + <br><br> + <span class="tablenote"><b>Note:</b> + This URL may include additional query parameters that don't appear in ViewItemURL + and vice versa. You should not modify the query syntax. For example, eBay won't + recognize the URL if you change QQ to ?. + </span> + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The pay-per-lead feature is no longer available, and this field is scheduled to + be removed from the WSDL. + + + + + + + + + + + The price at which Best Offers are automatically accepted. Similar in use to + MinimumBestOfferPrice. If a buyer submits a Best Offer that is above this value, the + offer is automatically accepted by the seller. Applies only to items listed in + categories that support the BestOfferAutoAcceptPrice feature. Best Offer must be + enabled for the item, and only the seller who listed the item will see + BestOfferAutoAcceptPrice in a call response. On the US eBay Motors site (site ID + 0), you cannot use the API to add a minimum Best Offer price. For a ReviseItem call + on US eBay Motors, prior use of a minimum Best Offer price on eBay.com is ignored. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This field is only returned if the item was ended early (before listing duration expired) by the seller (through an API call or on the Web site). The value in this field indicates the seller's reason for ending the + listing early. + + + + GetItem + Conditionally + + + + + + + + + + + + This enumerated type contains the list of values that can be used by the seller to set + the duration (number of days or Good 'Til Cancelled) of a listing. + <br><br> + Listing durations available to the seller may vary based on the site, category, listing + type, and the seller's selling profile, so it is a best practice for the seller to call + <b>GetCategoryFeatures</b> with <b>ListingDurations</b> + included as a <b>FeatureID</b> value in the call request. The + <b>GetCategoryFeatures</b> response will include the complete list + of listing duration values that can be used for the various listing types. + + + + + + + This value is used to set the duration of the listing to one day. A one-day listing + duration is typically only available to sellers with a Feedback score of 10 or + higher, so sellers with a Feedback score of less than 10 may be restricted from + using a one-day listing duration. The seller can call + <b>GetCategoryFeatures</b> with <b>ListingDurations</b> + included as a <b>FeatureID</b> value in the call request to see if the + one-day listing duration is available. + <br><br> + A one-day listing duration is generally applicable to an auction listing or to a + Real Estate Classified Ad. + + + + + + + This value is used to set the duration of the listing to three days. + <br><br> + A three-day listing duration is applicable to most listing types. + + + + + + + This value is used to set the duration of the listing to five days. + <br><br> + A five-day listing duration is applicable to most listing types. + + + + + + + This value is used to set the duration of the listing to seven days. + <br><br> + A seven-day listing duration is applicable to most listing types. + + + + + + + This value is used to set the duration of the listing to 10 days. + <br><br> + A 10-day listing duration is applicable to most listing types. + + + + + + + This value is used to set the duration of the listing to 14 days. + <br><br> + A 14-day listing duration is typically only applicable to Classified Ad listings + in specific categories. + + + + + + + This value is used to set the duration of the listing to 21 days. + <br><br> + A 21-day listing duration is typically only applicable to eBay Motors Local + Market vehicle listings, a listing type that is only available to eBay Motors + Dealers. + + + + + + + This value is used to set the duration of the listing to 30 days. + <br><br> + A 30-day listing duration is typically available for fixed-price listing, Classified Ad + listings, and Real Estate auction listings. + + + + + + + This value is used to set the duration of the listing to 60 days. + <br><br> + A 60-day listing duration is typically only applicable to Classified Ad listings + in specific categories. + + + + + + + This value is used to set the duration of the listing to 90 days. + <br><br> + A 90-day listing duration is generally only applicable to a Real Estate Classified + Ad. + + + + + + + This value is used to set the duration of the listing to 120 days. + <br><br> + An 120-day listing duration is typically only applicable to Classified Ad listings + in specific categories. + + + + + + + This value is used to set the duration of the listing to "Good 'Til Cancelled". This + option is available for fixed-price and Classified Ad listings. "Good 'Til + Cancelled" fixed-price listings will be relisted automatically every 30 days until + all inventory is sold out (e.g., <b>Item.Quantity</b>=0 in a + single-variation fixed-price listing, or all occurences of + <b>Item.Variations.Variation.Quantity</b>=0 in a multi-variation + fixed-price listing), or the seller ends the fixed-price listing. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + A container node for a set of durations that apply to a certain listing type. + + + + + + + Specifies the length of time an auction can be open, in days. The allowed durations + vary according to the type of listing. The value GTC means Good Til Canceled. + + + ListingDurationCodeType + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + Identifies the type of listing to which the set of durations applies. The durationSetID value corresponds to the listing types returned in Category.ListingDuration (also in the call response). + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + A container node for sets of durations, each set describing the durations allowed for + one listing type. + + + + + + + Contains the duration periods that apply to a certain listing type. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + The current version of the feature. Some features (for example, ShippingTermsRequired) + do not have version numbers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + Identifies the type of listing as an attribute on the ListingDuration node. + + + + + + + + The type of listing a set of durations describes. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Unknown, Auction, Half + Conditionally + + + + + + + + + + + + This enumerated type contains the list of values that can be used by the seller to set + the duration of a Featured Gallery in a fixed-price listing. Once set for a listing, the + Featured Gallery duration can be increased from 'Days_7' to 'Lifetime' (throughout + life of listing), but the duration cannot be decreased from 'Lifetime' to 'Days_7'. + + + Days_7, Lifetime + + + + + + This value sets the Featured Gallery duration to one day. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to two days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to three days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to four days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to five days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to six days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to seven days. If a + listing has a Featured Gallery duration of seven days, it is possible to revise that + item and set the Featured Gallery duration to 'Lifetime' (throughout + life of listing) ( + + + + + This value sets the Featured Gallery duration to eight days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to nine days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 10 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 11 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 12 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 13 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 14 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 15 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 16 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 17 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 18 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 19 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 20 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 21 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 22 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 23 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 24 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 25 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 26 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 27 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 28 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 29 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 30 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 31 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 32 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 33 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 34 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 35 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 36 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 37 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 38 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 39 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 40 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 41 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 42 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 43 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 44 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 45 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 46 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 47 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 48 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 49 days. This + value is deprecated. + + + + + This value sets the Featured Gallery duration to 50 days. This + value is deprecated. + + + + + + This duration enables the Featured Gallery feature for the life of the listing. Once the + Featured Gallery duration is set to 'Lifetime' for a listing, it cannot be changed. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Defines the Listing Enhancement Duration feature. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + A container node for a set of durations that apply to a certain listing enhancements. + + + + + + + Specifies a length of time that a listing enhancement can be used for a listing. + The value Lifetime means the listing enhancment occurs for the lifetime of the listing. + Instances of durations other than Lifetime can be purchased multiple times + while the listing is active. + + + ListingEnhancementDurationCodeType + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining all listing upgrades that may be available to the seller when listing an + item. The listing upgrades that are available vary by site and by the seller's + account status. To discover which listing upgrades are available, + call GeteBayDetails, pass in the appropriate SiteID value and set the DetailName input + filter to 'ListingFeatureDetails', and then look for the ListingFeatureDetails container + in the response. Listing upgrades will either be listed as 'Enabled' or 'Disabled'. + + + + + + + If specified, the seller wants to add a border around the listing's pictures. Applicable listing fees apply. + <br> + <br> + <span class="tablenote"><b>Note:</b> + The Picture Border feature is no longer available on the US site. + </span> + <br> + + + + + + + If specified, the seller wants the title for the item's listing to + be in boldface type. Applicable listing fees apply. + Does not affect the item subtitle (Item.SubTitle), if any. + Not applicable to eBay Motors. + + + + + + + Listing is a "Featured Plus" item. The item will display + prominently in the Featured Items section of its category list, and it will + stand out on search results pages. It will also display in the regular, non- + featured item list. Only available to users with a Feedback rating of 10 or + greater. + + + + + + + Listing is highlighted in a different color in lists. + + + + + + + Listing will have a chance to rotate into a special display + on eBay's Home page. Your item is very likely to show up on the Home page, + although eBay does not guarantee that your item will be highlighted + in this way. This is the highest level of visibility on eBay. + <br><br> + Not applicable for eBay Motors. In order to feature the listing + on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See + GalleryTypeCodeType for more information. + + + + + + + Listing is using ProPackBundle (a feature pack). + Applies only to vehicle listings on eBay Motors (US and Canada), and + to the Parts and Accessories category in the eBay Motors US site. + Contains the BoldTitle, Border, Featured and Highlight features. + + + + + + + No longer applicable to any site. + + + + + + + Listing is using ValuePack bundle (a feature pack), + which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. + <br><br> + Whenever ValuePackBundle is + selected in a request, the Value Pack bundle is + automatically upgraded to the Gallery Plus feature at no extra cost (see + Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus). + The Gallery Plus upgrade will display on all + sites and categories that support ValuePackBundle. + + + + + + + Support for this feature varies by site and category. + A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), + which combines the features of BoldTitle, Border, Highlight, Featured (which + is equivalent to a GalleryType value of Featured), and + Gallery, for a discounted price. + Note that if, for example, in AddItem, if you use ProPackPlusBundle and + a GalleryType value of Gallery, then the resulting item will have a GalleryType + value of Featured. + + + + + + + Reserved for internal or future use. + + + + + + + + eBay Listing Enhancements Codes + + + + + Code List Agency - eBay, Inc. + + + + + Code List Version - 1.0 + + + + + + + Details about feature availability for the site. + + + + + + + Defines the availability of the BoldTitle feature for the site. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of the Picture Border feature for the site. + <br> + <br> + <span class="tablenote"><b>Note:</b> + The Picture Border feature is no longer available on the US site. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of the Highlight feature for the site. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of the Gift Icon feature for the site. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of the HomePageFeatured feature for the site. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of FeaturedFirst for the site. + If FeaturedFirst is available for a site, then this field also + is used to determine if FeaturedFirst is available only for + PowerSellers, or only for top-rated sellers. + If you make a GeteBayDetails call to site 0 (US eBay Motors), + the value returned only applies to the Parts and Accessories category. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of FeaturedPlus for site, including whether it is only available for + certain seller groups such as PowerSeller or TopRatedSeller. + + + + GeteBayDetails + Conditionally + + + + + + + + Defines the availability of ProPack for the site. + If ProPack is available for a site, this field also is used to determine if ProPack is + available only for PowerSellers, or only for top-rated sellers. + If you make a GeteBayDetails call tto site 0 (US eBay Motors), + the value returned only applies to the Parts and Accessories category. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the current version of details. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + ListingFlowCodeType - Type declaration to be used by other schema. + Identifies the listing flows on the eBay Web site for use with calls like + GetItemRecommendations. + + + + + + + (in) AddItem (Sell Your Item) listing flow. + + + + + + + (in) ReviseItem (Revise Your Item) listing flow. + + + + + + + (in) RelistItem listing flow. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>Recommendation</b> container(s) that are + conditionally returned in all Add/Revise/Relist/Verify API calls. + Each <b>Recommendation</b> container provides a message to the seller on + how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping. + <br><br> + One or more <b>Recommendation</b> containers can be returned for each + listing. + + + + + + + This value indicates the specific type of listing recommendation being provided to + the seller. Possible values include the following: + <ul> + <li>eTRS - this recommendation type advises the seller that the listing + is not meeting a specific Top-Rated listing requirement, such as same-day or 1-day handling or a 14-day (or longer) Money Back Return Policy;</li> + <li>ItemSpecifics - this recommendation type advises the seller that the + listing is missing a required or recommended Item Specifics name/value pair;</li> + <li>Picture - this recommendation type advises the seller that a specific + picture in the listing is not meeting a specific picture qualityrequirement;</li> + <li>Price - this recommendation type provides a recommended price and/or a recommended price range for auction and fixed-price listings. These price recommendation values are based on similar items that have recently sold on eBay. Along with pricing recommendations, a recommended listing format (auction vs. fixed-price) is also returned. This recommendation type is currently only supported on the US, UK, and DE sites; </li> + <li>Title - this recommendation type provides guidance on forming an effective listing title, and will suggest valuable keywords or recommended Item Specifics that the listing title is missing. This recommendation type will also call out keywords that do not accurately describe the item. The keywords or Item Specifics are called out in the response. This recommendation type is currently only supported on the US, UK, DE, and AU sites; and</li> + <li>FnF - this recommendation type advises the seller to offer expedited shipping for the item (same-day shipping or handling time of 1 day) and/or offer at least one free shipping service option.</li> + </ul> + + + 128 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This value indicates the group that a specific listing recommendation belongs to. + There may be multiple groups for each listing recommendation type. For example, + two groups of the <b>eTRS</b> listing recommendation type are + 'SHIPPING' and 'RETURNS'. + + + 256 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + The <b>FieldName</b> value will vary based on the recommendation type. The <b>FieldName</b> values for each recommendation type are summarized below: + <br><br> + For <b>eTRS</b> listing recommendations, the <b>FieldName</b> value will indicate the specific Trading API field that the seller needs to update to bring the listing up to top-rated listing standards. For example, if the <b>Recommendation.Type</b> value is 'eTRS' and the <b>Recommendation.Group</b> value is 'SHIPPING', the <b>FieldName</b> value may be 'DispatchTimeMax'. If the seller is returned a listing recommendation like this, it would most likely indicate that the seller must reduce the handling time (<b>DispatchTimeMax</b> value) in the listing to '0' (same-day shipping) or '1' (one-day handling time) in order for the listing to qualify as a top-rated listing and receive a Top Rated Plus seal in View Item and Search Results pages. + <br><br> + For an <b>ItemSpecifics</b> listing recommendation, the <b>FieldName</b> value will be the name of the recommended Item Specific. If the seller gets a <b>ItemSpecifics</b> listing recommendation, the seller will perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the recommended Item Specific (with one or more values) through the <b>ItemSpecifics.NameValueList</b> container. If available, eBay will also return recommended Item Specific value(s) through the <b>Recommendation.Value</b> field. + <br><br> + For a <b>Picture</b> listing recommendation, the <b>FieldName</b> value will be the URL of the image that needs to be brought up to picture quality standards. If the seller gets a <b>Picture</b> listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the URL of the image through the <b>PictureURL</b> field in the <b>PictureDetails</b> container. + <br><br> + If the seller gets a <b>Picture</b> listing recommendation for this image in the listing, the seller will need to make the required picture quality update, and then perform a <b>ReviseItem</b>/<b>ReviseFixedPriceItem</b> call, passing in the URL of the image through the <b>PictureURL</b> field in the <b>PictureDetails</b> container. + <br><br> + For a <b>Price</b> listing recommendation, the <b>FieldName</b> value will be one of the following: + <ul> + <li><b>BuyItNowPrice</b>: the recommended price for an item in a fixed-price listing or for the "Buy It Now" price in an auction listing; this value will be shown in the <b>Recommendation.Value</b> field. Upon getting a <b>BuyItNowPrice</b> recommendation, the seller may consider revising their listing with a price matching or closer to the recommended price.</li> + <li><b>ListingType</b>: this value is returned if a different listing type (auction vs. fixed-price) is being suggested for the item. Upon getting a <b>ListingType</b> recommendation, the seller may consider the recommended listing type the next time they list a similar item.</li> + <li><b>StartPrice</b>: the recommended starting bid price for an item in an auction listing; this value will be shown in the <b>Recommendation.Value</b> field. Upon getting a <b>StartPrice</b> recommendation, the seller may consider the recommended starting bid price the next time they list a similar item.</li> + </ul> + Two other pricing recommendations, <b>BuyItNowPriceRange</b> and <b>StartPriceRange</b>, are supported in the Listing Recommendation API, but are not yet supported by the Trading API. + <br><br> + For a <b>Title</b> listing recommendation, the <b>FieldName</b> value will be 'Title' for any of the three use cases - missing keywords, missing Item Specifics, or inaccurate keywords. Upon getting a <b>Title</b> recommendation, the seller may consider the <b>Title</b> recommendation (adding keywords, adding Item Specifics, removing inaccurate keywords) the next time they list a similar item. + <br><br> + For an <b>FnF</b> listing recommendation, either one or two <b>recommendation</b> containers will be returned, based on whether a listing needs fast handling (same-day handling or handling time of 1 day), at least one free shipping service, or both. These two <b>fieldName</b> values are described below: + <ul> + <li><strong>shipsWithinDays</strong>: this <strong>fieldName</strong> value is returned if the seller needs to implement fast handling (same-day handling or a handling time of 1 day). To implement fast handling, the seller will perform a <strong>ReviseItem</strong>/<strong>ReviseFixedPriceItem</strong> call, passing a value of '0' or '1' into the <strong>DispatchTimeMax</strong> field.</li> + <li><strong>shippingServiceCost</strong>: this <strong>fieldName</strong> value is returned if the seller needs to offer a free shipping service option in the listing. To add a free shipping service option, the seller will perform a <strong>ReviseItem</strong>/<strong>ReviseFixedPriceItem</strong> call, passing in one or more <b>ShippingDetails.ShippingServiceOptions</b> containers where the shipping service is free (<b>ShippingServiceOptions.FreeShipping</b> boolean value set to 'true').</li> + </ul> + <br><br> + This <b>FieldName</b> field is always returned with each <b>Recommendation</b> container. + + + 256 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This code value provides a generic, "human-friendly" message summarizing what is wrong with the listing, or how it can be improved. These values include: + <ul> + <li>FIELD_VALUE_INCORRECT</li> + <li>FIELD_VALUE_RECOMMENDATION</li> + <li>MANDATED_FIELD_VALUE_MISSING</li> + <li>MANDATORY_STANDARDS_NOT_MET</li> + <li>RECOMMENDED_FIELD_VALUE_MISSING</li> + <li>RECOMMENDED_FIELD_VALUE_TO_REMOVE</li> + <li>RECOMMENDED_STANDARDS_NOT_MET</li> + </ul> + This field is always returned with each <b>recommendation</b> container. + + + 128 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + The <b>Value</b> field is only applicable for <b>ItemSpecifics</b>, <b>Pricing</b>, and <b>Title</b> listing recommendation types, and it is only returned for these recommendation types. + <br><br> + For the <b>ItemSpecifics</b> recommendation type, the value in the <b>Value</b> field is a recommended value for the recommended Item Specific name found in the <b>Recommendation.FieldName</b> field. Each Item Specific name can have more than one recommended value, so it is possible to have multiple <b>Recommendation.Value</b> fields for that recommendation. It is also possible that a recommended Item Specific name will have no recommended values, hence no <b>Recommendation.FieldName</b> values are returned. + <br><br> + For the <b>Pricing</b> recommendation type, the value in the <b>Value</b> field is either: + <ul> + <li>a recommended value for the starting bid price (if <b>Recommendation.FieldName</b> value is 'StartPrice');</li> + <li>a recommended value for a fixed-price item (if <b>Recommendation.FieldName</b> value is 'BuyItNowPrice'); or</li> + <li>a recommended value for the listing type (if <b>Recommendation.FieldName</b> value is 'ListingType'). </li> + </ul> + For the <b>Title</b> recommendation type, the value in the <b>value</b> field is either: + <ul> + <li>a recommended keyword to include in the listing Title (if <b>Recommendation.Code</b> value is 'RECOMMENDED_FIELD_VALUE_MISSING');</li> + <li>a recommended keyword to remove (to maintain accuracy) in the listing Title (if <b>Recommendation.Code</b> value is 'RECOMMENDED_FIELD_VALUE_TO_REMOVE');</li> + <li>a recommended Item Specific to include in the listing Title (if <b>Recommendation.Code</b> value is 'FIELD_VALUE_RECOMMENDATION');</li> + </ul> + Each <b>Title</b> recommendation can have more than one keyword or Item Specific value, so it is possible to have multiple <b>Recommendation.Value</b> fields for that recommendation. + + + 128 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This textual message is the detailed description of a specific action that a seller can take to improve the quality of the listing, or bring it up to Picture or eTRS standards. For some recommendations, the fields may be revised on an active listing through a <b>ReviseItem</b> or <b>ReviseFixedPriceItem</b> call of the Trading API. For other recommendations, it may not be possible to revise the fields on an active listing. + <br><br> + This field is returned in the <b>Recommendation</b> container when available/applicable. + + + 4000 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This container contains price guidance information, which includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items. This container is only returned for price recommendations and when the pricing data is available. + <br><br> + A <b>Metadata</b> container is returned for each price guidance parameter that is applicable/available for the pricing recommendation. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Type defining the <b>ListingRecommendations</b> container that is + conditionally returned in all Add/Revise/Relist/Verify API calls. A + <b>ListingRecommendations</b> container consists of one or + more <b>Recommendation</b> containers, and each + <b>Recommendation</b> container provides a message to the seller on how a + listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping. + <br><br> + The <b>ListingRecommendations</b> container is only returned if the + <b>IncludeRecommendations</b> flag is included and set to 'true' in the + API call request. + + + + + + + Each <b>Recommendation</b> container provides a message to the seller on how a listing can be improved or brought up to standard in regards to top-rated seller/listing requirements, mandated or recommended Item Specifics, picture quality requirements, pricing and/or listing format recommendations, recommended keywords and/or Item Specifics in a Title, and/or a recommendation to use Fast 'N Free shipping. <br><br> One or more <b>Recommendation</b> containers can be returned for each listing. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Type defining the <b>ListingStartPriceDetails</b> container returned in + <b>GeteBayDetails</b>. The <b>ListingStartPriceDetails</b> + container lists the minimum start price for auction listings, the minimum sale price + for fixed-price listings, and the minimum percentage value that a Buy It Now price for + an auction listing must be above the minimum start price for that same listing. + <br><br> + The <b>ListingStartPriceDetails</b> container is returned if + <b>ListingStartPriceDetails</b> is included as a <b>DetailName</b> + filter in the request, or if no lt;b>DetailName</b> filters are used in the request. + + + + + + + This value is a string description of the listing type for which the pricing data + is intended, such as "Pricing for the auction-like listings". + + + + GeteBayDetails + Conditionally + + + + + + + + This value indicates the listing type of the listing, and is a value defined in + <b>ListingTypeCodeType</b> enumerated type. The only possible values for + this field are 'Chinese' (auction listing) and 'FixedPriceItem'. + + + Chinese, FixedPriceItem + + GeteBayDetails + Conditionally + + + + + + + + For auction listings, the <b>StartPrice</b> indicates the lowest dollar + value that can be set for the item's Starting bid. + <br><br> + For fixed-price listings, the <b>StartPrice</b> indicates the lowest + dollar value that can be set for the item's sale price. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be used to + determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the + details were last updated. This timestamp can be used to determine + if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + This field is only returned and applicable for auction listings. + <br><br> + This float value indicates the minimum percentage value that a Buy It Now price for + an auction listing must be above the Starting bid price for that same listing. + <br><br> + On the US eBay Motors site (Site ID 0), this field only applies to the Parts and + Accessories categories. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Specifies an active or ended listing's status in eBay's processing + workflow. If a listing ends with a sale (or sales), eBay needs to + update the sale details (e.g., total price and buyer/high bidder) + and the final value fee. This processing can take several minutes. + If you retrieve a sold item and no details about the buyer/high + bidder are returned or no final value fee is available, use this + listing status information to determine whether eBay has finished + processing the listing. + + + + + + + The listing is still active or the listing has ended with + a sale but eBay has not completed processing the sale details + (e.g., total price and high bidder). A multi-item listing is + considered active until all items have winning bids or + purchases or the listing ends with at least one winning bid or + purchase. If the listing has ended with a sale but this Active + status is returned, please allow several minutes for eBay to + finish processing the listing. + + + + + + + The listing has ended. If the listing ended with a sale, + eBay has completed processing of the sale. All sale information + returned from eBay (e.g., total price and high bidder) should be + considered accurate and complete. However, the final value fee is + not yet available. + + + + + + + The listing has closed and eBay has completed processing the sale. All + sale information returned from eBay (e.g., total price and high bidder) should + be considered accurate and complete. Although the Final Value Fee (FVF) for + FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions + and GetItemTransactions, all other listing types (excluding Buy It Now + purchases) require the listing status to be Completed before the Final Value + Fee is returned. + + + + + + + Reserved for internal or future use. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Indicates a specific type of lead generation format listing (within the classified and localmarketbestofferonly subtypes, which include the general ClassifiedAd and LocalMarketBestOfferOnly subtype). + + + + + + + + + General classified ad listing subtype. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This value indicates a classified ad (or digital download) listing on <strong>ebay.com</strong> websites, not on <strong>ebayclassifieds.com</strong>. The ebayclassifieds.com site is not supported by the Trading API. For information about other differences between these two sites, see <a href="http://pages.ebay.com/help/sell/classified.html">Advertising with classified ads on eBay and eBay Classifieds</a>. + </span> + + + + + + + General LocalMarketBestOfferOnly listing subtype. + + + + + + + Reserved for internal or future use + + + + + + + + + + (out) Contains a list of tips on improving a listing's details, if any. + + + + + + + An individual tip on improving a listing's details. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + (out) Identifies the item field that the tip relates to. + + + + + + + Identifier associated with the item field. Primarily for internal use. This value may change over time. + + + + GetItemRecommendations + Conditionally + + + + + + + + Related text that appears near a field or at the top of the section within which + the field appears in the selling flow. + + + 125 + + GetItemRecommendations + Conditionally + + + + + + + + A label used to preface the current value of a field. For example, + "Current value" would be the CurrentValueText in "Current value: 25". + If no label exists, this element is not returned. + + + 50 + + GetItemRecommendations + Conditionally + + + + + + + + Current value of the field (in the listing or in the candidate item) or meta-data about the value. + For example, if the tip is recommending a longer item title, the CurrentFieldValue might specify + the current length of the title. If no current value is available, this information is not returned. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + + Contains the message portion of a listing tip that is returned by the Listing Analyzer engine. + + + + + + + Identifier for the tip message. Primarily for internal use. This value may change over time. + + + + GetItemRecommendations + Conditionally + + + + + + + + Brief version of the tip message. + + + 125 + + GetItemRecommendations + Conditionally + + + + + + + + Detailed version of the tip message. + + + 125 + + GetItemRecommendations + Conditionally + + + + + + + + Path part of a URL for a "Learn More" link that points to a relevant eBay Web site online help page. + The path is relative to http://pages.ebay.XX, where XX is the 2-letter site code + (e.g., http://pages.ebay.de for the eBay Germany site). Applications should append the + URL to the appropriate path for the user's site. + + + 125 + + GetItemRecommendations + Conditionally + + + + + + + + + + + + A tip on improving a listing's details. Tips are returned from the Listing Analyzer engine. + + + + + + + Identifier for the tip. Primarily for internal use. This value may change over time. + + + + GetItemRecommendations + Conditionally + + + + + + + + The rank of the tip. All tips are ranked by importance. Ranking varies for each site. + The rank is always greater than 0. + + + + GetItemRecommendations + Conditionally + + + + + + + + The tip's message content. + + + + GetItemRecommendations + Conditionally + + + + + + + + The item field that is associated with the tip. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + + + + The date time when the transaction occur. + + + + FeeSettlementReport + Always + + + + + + + + Item id of the transaction. + + + + FeeSettlementReport + Always + + + + + + + + The title of the item listing. + <br><br> + <span class="tablenote"><b>Note:</b> + The maximum length of an eBay Item Title is increasing to 80 characters in + Version 735. + </span> + + + 55 + + FeeSettlementReport + Always + + + + + + + + Serial number for this item, only applicable for motors. + + + + FeeSettlementReport + Conditionally + + + + + + + + Notes for this transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + Description of the category used. + + + + FeeSettlementReport + Always + + + + + + + + Site description for the site where the listing occurred. + + + + FeeSettlementReport + Always + + + + + + + + Fee Amount for a certain Fee type. + + + + FeeSettlementReport + Always + + + + + + + + + + + + Specifies the selling format used for a listing. + + + StoresFixedPrice, Dutch, Live, Express + + + + + + + Unknown or undefined auction type. Applicable to + user preferences and other informational use cases. + + + + + + + Single-quantity online auction format. + A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, + although Buy It Now may be offered as long as no bids have been placed. + Online auctions are listed on eBay.com, and they are also listed in + the seller's eBay Store if the seller is a Store owner. + + + + + + + This value is no longer applicable. + + + + + + + + This value is no longer applicable. + + + + + + + + An optional input parameter used with GetMyeBaySelling. When used in + the request, returns items of competitive-bid auctions. + + + + + + + Advertisement to solicit inquiries on listings such as real estate. Permits + no bidding on that item, service, or property. To express interest, a buyer + fills in a contact form that eBay forwards to the seller as a lead. This + format does not enable buyers and sellers to transact online through eBay, + and eBay Feedback is not available for ad format listings. + + + + + + + This value is no longer applicable. + + + + + + + + Second chance offer made to a non-winning bidder on an ended listing. + A seller can make an offer to a non-winning bidder when either the winning bidder + has failed to pay for an item or the seller has a duplicate of the item. + A seller can create a Second Chance Offer immediately after a listing ends and up to + 60 days after the end of the listing. eBay does not charge an Insertion Fee, + but if the bidder accepts the offer, the regular Final Value Fee is charged. + In the case of an Unpaid Item, the seller should ensure that everything has + been done to resolve the issue with the winning bidder before sending a + Second Chance Offer to another bidder. See the Unpaid Items Process for details. + Make sure you're aware of other rules and restrictions surrounding Second Chance Offers. + Use AddSecondChanceItem to submit Second Chance Offers. + Listed on eBay, but does not appear when browsing or searching listings. + + + + + + + A basic fixed-price item format. Bids do not occur. + The quantity of items is one or more. + <br><br> + Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that + is available for auctions). + <br><br> + Sellers must meet certain feedback requirements and/or be ID Verified to use this format. + See <a href="http://developer.ebay.com/DevZone/feedback/Concepts/FeedbackAPIGuide.html">eBay Features Guide</a> + for more information. + <br><br> + Fixed-price listings are listed on eBay.com, and they are listed in + the seller's eBay Store if the seller is a Store owner. + Stores fixed price items will be treated as basic + fixed-price items. Permitted durations of 30 days + and GTC are now available for store and non-store subscribers (in addition + to the existing durations of 3, 5, 7, and 10 days). + + + + + + + Half.com listing (item is listed on Half.com, not on eBay). + You must be a registered Half.com seller to use this format. + + + + Half.com + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-Half.html + + + + + + + + Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). + + + + + + + This value is no longer applicable. + + + + + + + + Reserved for internal or future use. You can ignore Shopping.com items in your results. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the LocalListingDistancesNonSubscription feature. This feature displays all the supported local + listing distances for items listed by sellers who have not subscribed to either Local Market for Vehicles + or Local Market for Specialty Vehicles. + + + + + + + + + + + Defines the LocalListingDistancesRegular feature. This feature displays all the supported local listing + distances for items listed by sellers subscribed to Local Market for Vehicles. + + + + + + + + + + + Defines the LocalListingDistancesSpecialty feature. This feature displays the supported local listing + distances for items listed by sellers subscribed to Local Market for Specialty Vehicles. + + + + + + + + + + + Defines the AdFormatEnabled feature. If the field is present, the corresponding feature applies to the category. This field is returned as an empty element (e.g., a boolean value is not returned). + Added for Local Market users. + + + + + + + + + + + Indicates whether automatic accept of best offers is allowed for this category. + Returned only if this category overrides the site default. + Added for Local market users. + + + + + + + + + + + Indicates whether automatic decline of best offers is allowed for this category. + Returned only if this category overrides the site default. + Added for Local market users. + + + + + + + + + + + Indicates whether Contact Seller is enabled for Classified Ads. + Added for Local Market users. + + + + + + + + + + + Indicates whether the category supports the use of the company name to contact + the seller for Classified Ad format listings. Added for Local Market users. + + + + + + + + + + + Indicates whether the category supports using an address when + contacting the seller for Classified Ad format listings. + Added for Local Market users. + + + + + + + + + + + Indicates whether the category supports the use of email to contact the + seller for Classified Ad format listings.Added for Local market users. + + + + + + + + + + + Indicates whether the category supports using the telephone + as a contact method. + Added for Local Market users. + + + + + + + + + + + Indicates whether counter offers are allowed on best offers for this category. + Returned only if this category overrides the site default. + Added for Local Market users. + + + + + + + + + + + Defines the LocalMarketNonSubscription feature. If the field is present, + the corresponding feature applies to the category. The field is returned + as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Indicates whether the category supports the use of payment method checkOut + for Classified Ad format listings. Added for Local market users. + + + + + + + + + + + Indicates which phone option the category supports when contacting + the seller about listings in Classified Ad format. + Added for Local Market users. + + + + + + + + + + + Defines the LocalMarketPremiumSubscription feature. If this field is + present, the corresponding feature applies to the category. The field + is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the LocalMarketRegularSubscription feature. If this field + is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not + returned). A subscription for Local Market for Vehicles will be + returned by GetUser if a dealer has subscribed to any of the following + Local Market Regular sub-types: Vehicles Regular Six Months, + Vehicles Regular Special Promotion, Vehicles Regular Multistore + Level S, Vehicles Regular Multistore Level M, or Vehicles Regular + Multistore Level L. Each of these sub-types has a separate discount + and billing cycle. + + + + + + + + + + + Defines the SellerContactDetailsEnabled feature. If the field is + present, the category allows retrieval of seller-level contact + information. The field is returned as an empty element + (e.g., a boolean value is not returned). + Added for Local Market users. + + + + + + + + + + + Indicates if shipping options are available for Classified Ad + format listings in the category. + Added for Local Market users. + + + + + + + + + + + Defines the LocalMarketSpecialitySubscription feature. If this field + is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Indicates which address option the category supports for Classified Ad + format listings. + Added for Local Market users. + + + + + + + + + + + Contains data for filtering a search by proximity. + + + + + + + The maximum distance from the specified postal code to search for items. + + + + + + + + + + The postal code to use as the basis for the proximity search. + + + + + + + + + + + + + + This enumerated type is used by <b>OrderType</b> and <b>TransactionType</b> to indicate which logistics plan was selected by the buyer at the order or order line item level. Currently, this type is only supporting the "Click and Collect" use case, but more logistics plan types may be added in the future. + + + + + + + This value indicates that the buyer has selected "Click and Collect" as the logistics plan. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type is deprecated because this type is not used by any call. + + + + + + + + + The PayPal Winning Bidder Notice logo. + + + + + + + + + + + The seller's eBay Store logo. + + + + + + + + + + + A custom logo specified in LogoURL. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + This type is deprecated because attributes are deprecated. + + + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + + + + + This type is deprecated because attributes are deprecated. + + + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + + + No longer applicable to any category. + + + + + + + + + + + + + + + This type is deprecated because it is not used by any call. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Describes an individual mark-up or mark-down event. eBay will automatically + mark an application as down if attempts to deliver a notification fail + repeatedly. eBay may mark an application down manually under certain + circumstances. + + + + + + + Whether the application has been marked up or marked down. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Time when the application was marked up or marked down. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Describes how the application was marked down, automatically or + manually. When an application is automatically marked down, eBay will + ping the application periodically, and if communication is restored, eBay + will automatically mark the application up. If your application is marked + down manually, you must contact eBay Developer Support to get your + application marked up. A Reason is not provided for mark up events. + + + + GetNotificationsUsage + Conditionally + + + + + + + + + + + + Valid application status codes, either MarkUp (application was marked up, + communication is restored) or MarkDown (application was marked down, no + communication). + + + + + + + (out) Status indicating the application was or is marked up. + + + + + + + (out) Status indicating the application was marked down. + + + + + + + (out) Reserved for future internal or external use. + + + + + + + + + + List of objects representing markup or markdown events for a given application + and time period. If no time period is specified in the request, the information + for only one day (24 hours before the time the call is made to the time the call + is made) is included. The maximum time period is allowed is 3 days (72 hours + before the call is made to the time the call is made). + + + + + + + Details for a MarkDown or MarkUp event. + + + + GetNotificationsUsage + Conditionally + + + + + + + + + + + Max Flat Shipping Cost ... CBT Exempt. See Shipping docs. + + + + + + + + + + + Max Flat Shipping Cost + + + + + + + + + + + Defines the total number of fine grained item compatibilities that can be applied + to a listing (a maximum of 1000). + + + + + + + + + + + Defines the maximum limit on compatible applications as part of the parts + compatibility feature. If the field is present, the corresponding feature applies + to the site. The field is returned as an empty element (e.g., a boolean value is + not returned). + <br><br> + Parts compatibility listings contain information to determine the assemblies with + which a part is compatible. For example, an automotive part or accessory listed + witih parts compatibility can be matched with vehicles (e.g., specific years, + makes, and models) with which the part or accessory can be used. + <br><br> + There are two ways to enter parts compatibility: by application and by + specification. + <ul> + <li> Entering parts compatibility by application specifies the assemblies + (e.g., a specific year, make, and model of car) to which the item applies. This can + be done automatically by listing with a catalog product that supports parts + compatibility, or manually, using <b + class="con">Item.ItemCompatibilityList</b> when listing or revising an + item. </li> + <li>Entering parts compatibility by specification involves specifying the + part's relevant dimensions and characteristics necessary to determine the + assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio, + Rim Diammeter, Load Index, and Speed Rating values for a tire) using + attributes.</li> + </ul> + + + + + + + + + + The maximum number of policy violations and the durations that can be designated by sellers at this site. This is applicable only to sellers. + + + + + The number of policy violation that can be used to limit buyers at the site. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + The policy violation duration(s) supported by the site. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type defining the <b>MaximumBuyerPolicyViolations</b> container, which is + used by the seller as a mechanism to block prospective buyers who have buyer policy + violations on their account exceeding the value set in the <b>Count</b> + field during a specified time period (set in the <b>Period</b> field). + + + + + + + This integer value sets the maximum number of buyer policy violations that a prospective buyer + is allowed to have during a specified time period + (<b>MaximumBuyerPolicyViolations.Period</b>) before being blocked from + buying/bidding on the item. + <br><br> + To retrieve a list of allowed values for this field, the seller should call + <b>GeteBayDetails</b>, including <b>BuyerRequirementDetails</b> in + the <b>DetailName</b> field of the request, and then look for the + <b>BuyerRequirementDetails.MaximumBuyerPolicyViolations.NumberOfPolicyViolations.Count</b> + fields in the response. + + + + + 4 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + 4, 5, 6, 7 + No + + + GetBidderList + GetSellerList + 4, 5, 6, 7 + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ 4, 5, 6, 7 + Conditionally + + + + + + + + This enumerated value defines the length of time over which a prospective buyer's + buyer policy violations will be counted. If the prospective buyer's number of buyer policy + violations during this defined period exceeds the value set in the <b>Count</b> + field, that prospective buyer is blocked from buying/bidding on the item. + <br/><br/> + If the <b>Count</b> value is 2, and the specified <b>Period</b> + is 'Days_30' (counting back 30 days from the present day), any prospective buyer that has + had three or more buyer policy violations is blocked from buying/bidding on the item. + + + + + Days_30 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Days_30, Days_180 + No + + + GetBidderList + GetSellerList + Days_30, Days_180 + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Days_30, Days_180 + Conditionally + + + + + + + + + + + A means of limiting unpaying or low feedback bidders. + + + + + The maximum number of items allowed for this buyer. + + + + GeteBayDetails + Conditionally + + + + + + + The Minimum Feedback Score required for a buyer who wants to purchase this item. + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Container for items bid. + + + + + + + This field is conditionally required if the <b>MaximumItemRequirements</b> + container is used. + <br/><br/> + The value of this field specifies the maximum number of items a prospective buyer can + purchase from the seller during a 10-day period. The prospective buyer will be blocked + from bidding/buying once this value is reached. + To see the valid values for your site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>, + and then look for the BuyerRequirementDetails.MaximumItemRequirements.MaximumItemCount fields. + As of December 2014, the valid values + for the US site are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 25, 50, 75, and 100. + <br/><br/> + If the <b>MaximumItemRequirements.MinimumFeedbackScore</b> field is also + specified, the <b>MaximumItemCount</b> limit will only apply to those + prospective buyers who don't meet the specified Minimum Feedback Score threshold. + + + + + + Buyers Who May Bid on Several of My Items and Not Pay + http://pages.ebay.com/help/sell/contextual/understand-buyer-requirement.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This is an optional field that is ignored if a <b>MaximumItemCount</b> + value has not been provided. + <br><br> + If this field is used, a prospective buyer is blocked from bidding/buying if they have + reached or exceeded the <b>MaximumItemCount</b> and their feedback score + is less than the value of this field. To see the valid values for your site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>, + and then look for the BuyerRequirementDetails.MaximumItemRequirements.MinimumFeedbackScore fields. + As of December 2014, the valid values for the US site are: 0, 1, 2, 3, 4, and 5. + + + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + Type defining the <b>MaximumUnpaidItemStrikesCount</b> container that is returned + in the <b>GeteBayDetails</b> response. The <b>MaximumUnpaidItemStrikesCount</b> + container consists of multiple <b>Count</b> fields with values that can be + used in the <b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.Count</b> + field when using the Trading API to add, revise, or relist an item. + <br><br> + The <b>Item.MaximumUnpaidItemStrikesInfo</b> container in Add/Revise/Relist + API calls is used to block buyers with unpaid item strikes equal to or exceeding + the specified <b>Count</b> value during the specified <b>Period</b> + value from buying/bidding on the item. + + + + GeteBayDetails + Conditionally + + + + + + + + Each value returned in each <b>MaximumUnpaidItemStrikesCount.Count</b> field + can be used in the <b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.Count</b> + field when using the Trading API to add, revise, or relist an item. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + [Selling] Defined time period for maximum unpaid items. + + + + GeteBayDetails + Conditionally + + + + + + + + The period is the number of days (last 60 days, last 180 days, etc.) + during which the buyer's unpaid item strikes are calculated. + This is applicable only to sellers. + + + + GeteBayDetails + Conditionally + + + + + + + + The description of the period, such as 'month', 'quarter', or 'half a year'. + The data in this field can be used as a label in your application's display. + This is applicable only to sellers. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + Details of a buyer's maximum unpaid item strikes in a pre-defined time period. This is applicable only to sellers. + + + + + The number of the maximum unpaid item strikes. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + Range of time used to determine maximum unpaid item count. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type defining the <b>MaximumUnpaidItemStrikesInfo</b> container, which is + used by the seller as a mechanism to block prospective buyers who have unpaid item + strikes on their account exceeding the value set in the <b>Count</b> + field during a specified time period (set in the <b>Period</b> field). + + + + + + + This integer value sets the maximum number of unpaid item strikes that a prospective buyer + is allowed to have during a specified time period + (<b>MaximumUnpaidItemStrikesInfo.Period</b>) before being blocked from + buying/bidding on the item. + <br><br> + To retrieve a list of allowed values for this field, the seller should call + <b>GeteBayDetails</b>, including <b>BuyerRequirementDetails</b> in + the <b>DetailName</b> field of the request, and then look for the + <b>BuyerRequirementDetails.MaximumUnpaidItemStrikesInfo.MaximumUnpaidItemStrikesCount.Count</b> + fields in the response. + + + + + 2 + + AddItem + AddFixedPriceItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + 2, 3, 4, 5 + Conditionally + + + GetBidderList + GetSellerList + 2, 3, 4, 5 + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ 2, 3, 4, 5 + Conditionally + + + + + + + + This enumerated value defines the length of time over which a prospective buyer's + unpaid item strikes will be counted. If the prospective buyer's number of unpaid item + strikes during this defined period exceeds the value set in the <b>Count</b> + field, that prospective buyer is blocked from buying/bidding on the item. + <br/><br/> + If the <b>Count</b> value is 2, and the specified <b>Period</b> + is 'Days_30' (counting back 30 days from the present day), any prospective buyer that has + had three or more unpaid item strikes is blocked from buying/bidding on the item. + + + + + Days_30 + + AddItem + AddFixedPriceItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Days_30, Days_180, Days_360 + Conditionally + + + GetBidderList + GetSellerList + Days_30, Days_180, Days_360 + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Days_30, Days_180, Days_360 + Conditionally + + + + + + + + + + + + Container for messages. Returned for GetMemberMessages if messages that meet the request criteria exist. + + + + + + + Information about individual messages. Returned if the parent container is returned. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + GetMemberMessages + Conditionally + + + + + + + + + + + Container for message metadata. + + + + + + + The item about which the question was asked. Returned if the parent container is returned. + + + + GetMemberMessages + Conditionally + + + + + + + + Contains all the information about the question being asked. Returned if the + parent container is returned. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + GetMemberMessages + Conditionally + + + + + + + + An answer to the question. Returned if the parent container is returned. + <br/><br/> + For GetAdFormatLeads, returned if the seller responded to the + lead's question. Contains the body of the seller's response + message. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + GetMemberMessages + Conditionally + + + + + + + + Status of the message. Returned if the parent container is returned. + + + + GetMemberMessages + Conditionally + + + + + + + + Date the message was created. Returned if the parent container is returned. + + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Date the message was last modified. Returned if the parent container is returned. + + + + GetMemberMessages + Conditionally + + + + + + + + Media details stored as part of the message. + + + + GetMemberMessages + Conditionally + + + + + + + + + + + + Container for individual message information. + + + + + + + Type of message being retrieved. Note that some message + types can only be created via the eBay Web site. + + + + GetMemberMessages + Conditionally + + + + + + + + Context of the question (e.g. Shipping, General). + + + + AddMemberMessageAAQToPartner + Yes + + + GetMemberMessages + Conditionally + + + + + + + + Indicates if a copy of the messages is to be emailed + to the sender. If omitted, this defaults to whatever + the user set in preferences. + + + omitted + + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + AddMemberMessagesAAQToBidder + No + + + + + + + + Indicates if the sender's email address + from the recipient is to be hidden. If omitted, this defaults to whatever + the user set in preferences--or on site policy, which + determines whether or not this field is recognized. + <br><br> <span class="tablenote"><b>Note:</b> + This tag is no longer operational. + </span> + + + + + + + + + + Indicates if the member message is viewable in the item listing. + + + + AddMemberMessageRTQ + No + + + GetMemberMessages + Conditionally + + + + + + + + The eBay user ID of the person who asked the question or sent + the message. + + + + GetMemberMessages + Conditionally + + + + + + + + SenderEmail contains the static email address of an eBay member, + used within the "reply to" + email address when the eBay member sends a message. + (Each eBay member is assigned a static alias. The alias is + used within a static email address.) + SenderEmail is returned if MessageType is AskSellerQuestion. + SenderEmail is also returned in the AskSellerQuestion notification. + The following functionality of this field has been deprecated: + return of a dynamic email address. + + + + GetMemberMessages + Conditionally + + + + + + + + Recipient's eBay user ID. For + AddMemberMessagesAAQToBidder, it must be the seller of an + item, that item's bidder, or a user who has made an + offer on that item using Best Offer. Note: maxOccurs is a shared schema + element and needs to be unbounded for AddMemberMessagesAAQToBidder. + For AddMemberMessageRTQ, this field is mandatory if ItemID is not in the request. + For all other uses, there can only be one RecipientID. + + + + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + AddMemberMessagesAAQToBidder + Yes + + + AddMemberMessageRTQ + GetMemberMessages + Conditionally + + + + + + + + Subject of this email message. + + + + GetMemberMessages + Conditionally + + + AddMemberMessageAAQToPartner + Yes + + + + + + + + Content of the message is input into this string field. HTML formatting is not + allowed in the body of the message. If plain HTML is used, an error occurs and the + message will not go through. If encoded HTML is used, the message may go through but + the formatting will not be successful, and the recipient of the message will just + see the HTML formatting tags. + + + + 2000 + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + Yes + + + 1000 + AddMemberMessagesAAQToBidder + Yes + + + GetAdFormatLeads +
DetailLevel: ReturnAll
+ Conditionally + + + 4000 + GetMemberMessages + Conditionally + + + + + + + + ID that uniquely identifies a message for a given user. + <br><br> + This value is not the same as the value used for the + GetMyMessages MessageID. However, this MessageID value can be + used as the GetMyMessages ExternalID. + + + + GetMemberMessages + Conditionally + + + + + + + + ID number of the question to which this message is responding. + + + + AddMemberMessageRTQ + Yes + + + + + + + + Media details attached to the message. + + + + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + AddMemberMessageCEM + AddMemberMessageAAQToSeller + No + + + GetMemberMessages + Conditionally + + + + + + + + + + + + DefaultTheme, StoreTheme, CustomCode + + + This type is deprecated because Cross Promotions are no longer supported in the APIs. + + + + + + + + + Uses the default eBay theme for cross-promotion widgets. + + + + + + + + + + + Uses the store theme for cross-promotion widgets. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + OptIn, OptOut, CustomCode + + + This type is deprecated because Cross Promotions are no longer supported in the APIs. + + + + + + + + + Seller allows item cross-promotion. + + + + + + + + + + + Seller does not allow item cross-promotion. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + Contains details about the current status of a listing. These + values are computed by eBay and cannot be specified at listing time. + + + + + + + Total number of items sold in the variation (across the + variation's lifetime). To determine the quantity sold + for the order line item, use OrderLineItem.QuantitySold. + + + + SoldReport + Always + + + + + + + + + + + + This type defines the details about one specific variation. + + + + + + + Stock Keeping Unit that serves as the seller's unique + identifier for items within the same variation. + You can use the variation's SKU instead of the + variation specifics to revise a variation and to + keep track of your eBay inventory.<br> + <br> + Many merchants assign a SKU to an item of a specific type, + size, and color. This way, they can keep track of how many + products of each type, size, and color are selling, and + they can re-stock their shelves or update the variation + quantity on eBay according to customer demand. <br> + <br> + Only returned if the seller specified a SKU for the + variation. + + + + ActiveInventoryReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + The fixed price of all items identified by this variation. + For example, a "Blue, Large" variation price could be USD 10.00, + and a "Black, Medium" variation price could be USD 5.00.<br> + <br> + + + + ActiveInventoryReport + Conditionally + + + SoldReport + Always + + + + + + + + <b>For ActiveInventoryReport:</b> + The number of items available for sale that are associated + with this variation.<br> + <br> + <b>For SoldReport:</b> + The total number of items associated with the variation + (including the quantity sold). To calculate the quantity + available for sale, subtract the variation's + QuantitySold from this value. + + + + ActiveInventoryReport + Always + + + SoldReport + Always + + + + + + + + A list of name/value pairs that uniquely identify the + variation within the listing. All variations specify + the same set of names, and each variation provides a + unique combination of values for those + names. For example, if the items vary by color and size, + then every variation specifies Color and Size as names, + and no two variations specify the same combination of + color and size values.<br> + <br> + If a variation has no SKU, use the variation specifics + as a unique ID to revise the variation and to keep + track of your eBay inventory. + + + + ActiveInventoryReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + Contains the variation's quantity sold. + Always returned when variations are present. + + + + SoldReport + Always + + + + + + + + + + + + Variations are multiple similar (but not identical) items in a + single fixed-price (or Store Inventory Format) listing. + For example, a single listing could contain multiple items of the + same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). + Each variation can have its own quantity and price. For example, a listing could + include 10 "Blue, Large" variations and 20 "Black, Medium" variations. + + + + + + + Contains data that distinguishes one variation from + another. + For example, if the items vary by color and size, + each Variation node specifies a combination of one of + those colors and sizes. Always returned when variations + are present. + + + + ActiveInventoryReport + Conditionally + + + + + + + + + + + + Container for the image file that is to be sent in a message, which lets sellers share photos in messages using the API. + The photo must be uploaded by the seller or buyer to + <a href="http://developer.ebay.com/devzone/xml/docs/reference/ebay/uploadsitehostedpictures.html">Zoom/EPS (eBay Picture Services)</a> + using a separate API call or the web flow. After the image is on the eBay server, you can + use <b>AddMemberMessage</b> calls to pass the URL of the image in a message. The + uploaded images will be available as part of the email as a thumbnail image. + Clicking on the thumbnail, opens a larger version of the image in a filmstrip. + The image name will be displayed on the title of the filmstrip component. + These uploaded images will also be returned as <b>MessageMediaType</b> arrays in the + <b>GetMemberMessages</b> and <b>GetMyMessages</b> API response. It doesn't matter if an image was uploaded using the web flow or using the API, it can be accessed using either the web flow or the API and web. + + + + + + + URL of an image to be included in a message. + The image must be uploaded to + <a href="http://developer.ebay.com/devzone/xml/docs/reference/ebay/uploadsitehostedpictures.html">Zoom/EPS + (eBay Picture Services)</a> + using a separate API call or the web flow. This URL will be + validated and if it doesn't exist, the request will fail. + + + 200 + + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + Conditionally + + + GetMemberMessages + GetMyMessages + Conditionally + + + + + + + + The name of the image. This will be displayed on the flimstrip. + + + 100 + + AddMemberMessageAAQToPartner + AddMemberMessageRTQ + Conditionally + + + GetMemberMessages + GetMyMessages + Conditionally + + + + + + + + + + + + + + The question has been answered at least once. + + + + + + + The question has not yet been answered. + + + + + + + Reserved for future or internal use. + + + + + + + + + + + + Member to Member message initiated by bidder/potential bidder + to a seller of a particular item. + + + + + + + Member to Member message initiated as a response + to an Ask A Question message. + + + + + + + Member to Member message initiated by any eBay member + to another eBay member. + + + + + + + Member message between order partners within 90 days + after creation of the order. + + + + + + + Member to Member message initiated as a response + to a Contact eBay Member message. + + + + Reserved + + + + + + + + Member to Member message initiated by any eBay member + to another eBay member who has posted on a community forum + within the past 7 days. + + + + Reserved + + + + + + + + Reserved for future or internal use. + + + + + + + All message types. + + + + + + + Member to Member message initiated by sellers to their + bidders during an active listing. + + + + Reserved + + + + + + + + Member message initiated after eBay receives an email sent by an + eBay member's email client to another eBay member. + + + + + + + Indicates that an inquiry has been sent to the seller regarding the + corresponding classified ad listing. + + + + + + + Indicates that a best offer has been made on the seller's corresponding + classified ad listing. This message type is only applicable to Classified + categories that allow the Best Offer feature, such as motor vehicles. + + + + + + + + + + This type is used by the <b>Metadata</b> container to provide price guidance information, which includes the minimum and maximum recommended prices for the item, which are based on recent sales of similar items. + + + + + + + The name of the price guidance parameter is returned in this field. Any of the following price guidance parameters may be returned in a <b>Metadata</b> container: + <ul> + <li><b>AppliesTo</b>: this parameter indicates the type of listing that the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> values pertain to. The corresponding <b>value</b> values that can be returned with the <b>AppliesTo</b> parameter is 'Auction' and 'FixedPrice'. </li> + <li><b>Currency</b>: this parameter indicates the type of currency being used for the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> values. The currency values (returned in corresponding <b>value</b> field) are based on the currency codes defined in the <a href="http://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217 - Currency Codes</a> standard. </li> + <li><b>MaxRecommendedValue</b>: this parameter indicates the upper end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters. A dollar value is returned in the corresponding <b>value</b> field. </li> + <li><b>MinRecommendedValue</b>: this parameter indicates the lower end of the recommended price range for the item. Based on the recent sales of similar items, eBay recommends a price range through the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters. A dollar value is returned in the corresponding <b>value</b> field. </li> + <li><b>SimilarItems</b>: this parameter and its corresponding <b>value</b> values indicates which eBay item listings were used to determine the <b>MinRecommendedValue</b> and <b>MaxRecommendedValue</b> values. The values returned in the <b>value</b> fields are Item IDs.</li> + </ul> + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + The corresponding value(s) for the price guidance parameter (returned in <b>Name</b> field of the same <b>Metadata</b> container. For the <b>AppliesTo</b> parameter, this value will either be 'Auction' or 'FixedPrice'. For the <b>Currency</b> parameter, this value will be a three-digit representation of a currency (as defined in the <a href="http://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO 4217 - Currency Codes</a> standard). For the <b>MaxRecommendedValue</b> and <b>MinRecommendedValue</b> parameters, this value will be a dollar value. For the <b>SimilarItems</b> parameters, this value will be an Item ID value, and it's possible that numerous Item IDs will be returned. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Defines the minimum requirement for compatible applications as part of the parts + compatibility feature. If the field is present, the corresponding feature applies + to the site. The field is returned as an empty element (e.g., a boolean value is + not returned). + <br><br> + Parts compatibility listings contain information to determine the assemblies with + which a part is compatible. For example, an automotive part or accessory listed + witih parts compatibility can be matched with vehicles (e.g., specific years, + makes, and models) with which the part or accessory can be used. + <br><br> + There are two ways to enter parts compatibility: by application and by + specification. + <ul> + <li> Entering parts compatibility by application specifies the assemblies + (e.g., a specific year, make, and model of car) to which the item applies. This can + be done automatically by listing with a catalog product that supports parts + compatibility, or manually, using <b + class="con">Item.ItemCompatibilityList</b> when listing or revising an + item. </li> + <li>Entering parts compatibility by specification involves specifying the + part's relevant dimensions and characteristics necessary to determine the + assemblies with which the part is compatible (e.g., Section Width, Aspect Ratio, + Rim Diammeter, Load Index, and Speed Rating values for a tire) using + attributes.</li> + </ul> + + + + + + + + + + + Defines how the buyer is to view the discounted price for MAP items. If a seller offers an item + for less than the specified MinimumAdvertisedPrice, the discounted price of the item cannot be + displayed on the page containing the item. Use this field to specify how the buyer is to + view the discounted item price. This is applicable for MAP items only. + + + + + + + PreCheckout specifies that the buyer must click a link (or a button) to navigate to a separate + page (or window) that displays the discount price. eBay displays the discounted item price in + a pop-up window. + + + + + + + DuringCheckout specifies that the discounted price must be shown on the eBay checkout + flow page. + + + + + + + None means the discount price is not shown via either PreCheckout nor DuringCheckout. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>MinimumFeedbackScore</b> container that is returned in + <b>GeteBayDetails</b>. The <b>MinimumFeedbackScore</b> container + consists of the values that can be used in the + <b>BuyerRequirementDetails.MinimumFeedbackScore</b> field when listing an + item through an Add/Revise/Relist API call. The Feedback Score for a potential buyer + must be greater than or equal to the specified value, or that buyer is blocked from + buying the item. + <br/><br/> + For the <b>MinimumFeedbackScore</b> + container to appear in the <b>GeteBayDetails</b> response, + <b>BuyerRequirementDetails</b> must be one of the values passed into the + <b>DetailName</b> field in the <b>GeteBayDetails</b> request + (or, no <b>DetailName</b> filters should be used). + + + + + + + Each value that is returned in this field can be used in the + <b>BuyerRequirementDetails.MinimumFeedbackScore</b> field when listing + an item through an Add/Revise/Relist API call. The Feedback Score for a potential + buyer must be greater than or equal to the specified value, or that buyer is blocked from + buying the item. + <br/><br/> + One or more <b>FeedbackScore</b> fields are always returned with the + <b>MinimumFeedbackScore</b> container. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Defines the Minimum Reserve Price feature. If the field is present, the feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + This enumeration type is no longer used. + + + + + + + This value indicates that the buyer paid more than the required amount. + + + + + + + This value indicates that the buyer paid less than the required amount. + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + This enumerated type defines the values that can be used when adding, modiying, or + deleting a shipping discount profile (through the <b>ModifyActionCode</b> + field in <b>SetShippingDiscountProfiles</b>), or when adding, modiying, or + deleting a promotional sale (through the <b>Action</b> + field in <b>SetPromotionalSale</b>), or when adding or removing one or more + listings from the promotional sale (through the <b>Action</b> + field in <b>SetPromotionalSaleListings</b>). + <br/><br/> + For <b>SetPromotionalSaleListings</b>, the specified action ('Add' or + 'Delete') will apply to all listings specified in the <b>PromotionalSaleItemIDArray</b> + container. A promotional sale can also be applied to all listings of a specified + category (using <b>CategoryID</b> in the + <b>SetPromotionalSaleListings</b> request). However, an entire category + of listings cannot be removed from a promotional sale. In other words, the + <b>Action </b> field cannot be set to 'Delete' if a + <b>CategoryID</b> is specified. + + + + + + + For <b>SetPromotionalSale</b>, this value is used in the request to + create a new promotional sale. + <br/><br/> + For <b>SetPromotionalSaleListings</b>, this value is used in the request + to apply an existing promotional sale to one or more active items or to an entire + category of active items. + <br/><br/> + For <b>SetShippingDiscounts</b>, this value is used in the request + to create a new shipping discount profile. + + + + + + + For <b>SetPromotionalSale</b>, this value is used in the request to + delete an existing promotional sale. + <br/><br/> + For <b>SetPromotionalSaleListings</b>, this value is used in the request + to remove one or more active items from an existing promotional sale. This value + cannot be used if a <b>CategoryID</b> is specified in the request. + <br/><br/> + For <b>SetShippingDiscounts</b>, this value is used in the request + to delete an existing shipping discount profile. + + + + + + + For <b>SetPromotionalSale</b>, this value is used in the request to + modify an existing promotional sale. + <br/><br/> + For <b>SetShippingDiscounts</b>, this value is used in the request + to modify an existing shipping discount profile. + + + + + + + Reserved for future use. + + + + + + + + + + A list of one or more ModifyName containers. Each ModifyName container has Name and NewName elements. + + + + + + + Container for the current and new name of a variation specific. + <br><br> + You cannot change the name of required item specifics. Call GetCategoryFeatures to determine which names are required. + + + + RelistFixedPriceItem + ReviseFixedPriceItem + No + + 5 + + + + + + + + + + Defines the details about one specific trait name. + + + + + + + The current name (e.g., Material) of a variation specific + in the active listing. If specified, NewName must also be specified. + + + 40 + + ReviseFixedPriceItem + RelistFixedPriceItem + Conditionally + + + + + + + + The new name (e.g., Fabric) of the variation specific you are + modifying.<br> + <br> + If specified, Name must also be specified. <br> + <br> + Also specify the new name (and omit the original name) in + VariationSpecificsSet.<br> + <br> + After this change is made, GetItem only shows the new name in VariationSpecfiics.<br> + <br> + Note that variations that were sold while they used the old name will also be changed to use the new name in eBay's system. (This may change in the future.)<br> + <br> + If you are making other changes to a variation (such as adding new + values or pictures), use consistent names to avoid unexpected + results. For example, specify the same new name to identify the + variation specific in VariationSpecifics and Pictures, (in addition to adding the new name here in ModifyNameList). + + + 40 + + RelistFixedPriceItem + ReviseFixedPriceItem + Conditionally + + + + + + + + + + + + Defines the Motors Local Market feature. If the Motors Local Market field is present, the corresponding feature applies to the Motors Local Market category. The field is returned as an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + This type provides information about the shipping service, cost, address, and delivery estimates for the domestic leg of a Global Shipping Program shipment. + + + + + + + Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains shipping address information for the domestic leg of a Global Shipping Program shipment. This container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The minimum number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The maximum guaranteed number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type provides information about the domestic leg of a Global Shipping Program shipment. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The <strong>LogisticsProviderShipmentToBuyer</strong> field is reserved for the exclusive use of the international shipping provider. + </span> + + + + + + + Contains information about the domestic leg of a Global Shipping Programn shipment, including the seller-selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Reserved for use by the international shipping provider. + + + + + + + + + + + + + + This type specifies the shipping service and cost of the domestic leg of a Global Shipping Program shipment. + + + + + + + The shipping service specified for the domestic leg of a Global Shipping Program shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total shipping cost of the domestic leg of a Global Shipping Program shipment. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + + This container will be deprecated in an upcoming release. + This field formerly + contained the data for one alert. + + + + + + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + This field is deprecated. + + + + + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + + The alert has not been resolved. If the alert requires user action, an unresolved status + means that the user did not take action on the alert. If the alert does not require user + action, an unresolved status means that the alert has not been read. Note that an + unresolved alert can not be deleted. + + + + + + + + + + + The alert was resolved by auto resolution, for example, + by expiring after a certain date. + + + + + + + + + + + The alert was resolved by user. If the alert requires user action, resolved status + means that the user took the necessary action on the alert. If the alert does not require user + action, resolved status means that the alert was read by the user. + + + + + + + + + + + + + + + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + Contains a list of up to 10 external message IDs. + + + + + + + Currently available on the US site. A message ID that uniquely identifies a message + for a given user. If provided at the time of message creation, this ID can be used + to retrieve messages, and will take precedence over the message ID. A total of 10 + message IDs can be specified. + + + + GetMyMessages + No + + + + + + + + + + + Type defining the <b>ExternalMessageID</b> field used in + <b>GetMyMessages</b> to identify a specific eBay message to retrieve. + Up to 10 <b>ExternalMessageID</b> values can be specified in one API call. + The <b>ExternalMessageIDs</b> container is only available for use on the + eBay US site (SiteID 0). + + + + + + + + + MyMessagesFolderOperationCodeType - Indicates the type of + operation to perform on a specified My Messsages folder. + Operations cannot be performed on the Inbox or Sent folders. + + + + + + + If a folder has been removed, restores the specified folder + in My Messages. Because you cannot remove the Inbox and Sent folders, + they can also not be restored. Requires FolderName as input. + <br><br> + Use Display to create a new custom folder. If you specify a FolderName + that has not be removed, a new My Messages folder is created. + + + + + + + Renames a specified folder. Inbox and Sent folders cannot be + renamed. To rename a folder, use FolderID to indicate the + folder to rename, and FolderName to indicate the new name. + + + + + + + Removes a specified folder. Inbox and Sent folders cannot be + removed. Removing a folder that is not empty returns an + error. Requires FolderID as input. + + + + + + + Reserved for future or internal use. + + + + + + + + + + Summary details for a specified My Messages folder. + + + + + + + An ID that uniquely identifies a My Messages + folder. Always returned for detail level + ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The name of a specified My Messages folder. For + GetMyMessages, Inbox (FolderID = 0) and Sent (FolderID = 1) + are not returned. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + This field has been deprecated, starting with the 685 release. Alerts are now + synonymous with Flagged messages, and are added to the + Summary.FlaggedMessageCount value. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The number of new messages in a given folder. + Always returned for detail level ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + This field has been deprecated, starting with the 685 release. Alerts are now + synonymous with Flagged messages, and are added to the + Summary.FlaggedMessageCount value. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of messages in a given + folder. Always returned for detail level + ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of new high priority messages that a given user has. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of high priority messages that a given user has. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + + + + + + Details relating to a My Messages folder. + + + + + + + An ID that uniquely identifies a My Messages folder. + + + + GetMyMessages + Conditionally + Alerts + Messages +
DetailLevel: ReturnHeaders, ReturnMessages
+ + + + + + + + The name of a specified My Messages folder. + + + + + + + + + + + This type is deprecated because <b>MyMessagesAlert*</b> are deprecated. + + + + + + + + + The date and time a user forwarded a message. + + + + + + + + + + + + Encoding used to forward a message. + + + + + + + + + + + + + + + Contains a list of message data. + + + + + + + Contains the data for one message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + + + + Contains a list of up to 10 MessageID values. + + + + + + + An ID that uniquely identifies a message for a given user. + + + + DeleteMyMessages + Conditionally + + + GetMyMessages + Conditionally + + + ReviseMyMessages + Conditionally + + + + + + + + + + + Type defining the <b>MessageID</b> field used in + <b>GetMyMessages</b>, <b>ReviseMyMessages</b>, and + <b>DeleteMyMessages</b> to identify a specific eBay message to retrieve, + revise, or delete, respectively. Up to 10 <b>MessageID</b> values can be + specified in one API call. + + + + + + + + + Container for the message information for each message specified in + MessageIDs. The amount and type of information returned varies based on + the requested detail level. + + + + + + + Display name of the eBay user that sent the message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Displayable user ID of the recipient. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Displayable name of the user or eBay + application to which the message is sent. Only + returned for M2M, and if a value exists. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Subject of the message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + ID that uniquely identifies a message for a given user. + <br/> + <br/> + This value is not the same as the value used for the + GetMemberMessages MessageID. Use the GetMemberMessages value + (used as the GetMyMessages ExternalID) instead. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + ID used by an external application to uniquely identify a + message. Returned only when specified by the external + application on message creation. + <br><br> + This value is equivalent to the value used for MessageID in + GetMemberMessages. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Content type of the body text. The three acceptable values + are "TEXT", "HTML", and "XML" (Note: This is case sensitive). + + + + + + + + Contains the message content, and + can contain a threaded message. + This field can contain plain text or HTML, + depending on the format of the original message. + The API does not check the email-format preferences + in My Messages on the eBay Web site. + + + + 2 megabytes in size + GetMyMessages +
DetailLevel: ReturnMessages
+ Conditionally + + + + + + + + Indicates if the message is displayed with a flag in the seller's + My Messages mailbox on eBay. + It is strongly recommended that the seller act on the message by the + specified date (or within 60 days, if not specified). + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Indicates if a message has been viewed by a given user. Note that retrieving + a message with the API does not mark it as read. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Date and time that a message was created by the sender. + + + + + + + + Date and time that a message was received by My Messages and stored in a + database for the recipient. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Date and time at which a message expires. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Unique item ID. Not returned + for messages that haven't been associated with a specific item. + + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + GetMyMessages +
DetailLevel: ReturnHeaders
+ Conditionally + + + + + + + + Details relating to the response to a message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Details relating to the forwarding of a + message. Only returned if the message is forwarded. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Details relating to a My Messages folder. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Message body in plain text format. The message body is displayed in plain text + even if the eBay user's Preferred Email Format preference on My eBay is set to HTML. + Graphics and text formatting are dropped if the eBay user's preference is set to + HTML. + + + + GetMyMessages +
DetailLevel: ReturnMessages
+ Conditionally + + + + + + + + Type of message being retrieved through GetMyMessages. This is available only on + the US site. + + + + GetMyMessages + Conditionally + + + + + + + + Specifies an active or ended listing's status in eBay's processing workflow. + If a listing ends with a sale (or sales), eBay needs to update the sale + details (e.g., total price and buyer/high bidder) and the final value fee. + This processing can take several minutes. If you retrieve a sold item and no + details about the buyer/high bidder are returned or no final value fee is + available, use this listing status information to determine whether eBay has + finished processing the listing. + <br><br> <span class="tablenote"><b>Note:</b> + For GetMyMessages, the listing status reflects the status of the listing at the time + the question was created. The listing status for this call must not match the listing + status returned by other calls (such as GetItemTransactions). This is returned only if + Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned + in the Sandbox environment. + </span> + + + + GetMyMessages + Conditionally + ComingSoon + + + + + + + + Currently available only on the US site. Context of the question (e.g. Shipping, General). + Corresponds to the message subject. Applies if Messages.Message.MessageType is AskSellerQuestion. + + + + GetMyMessages + Conditionally + ComingSoon + + + + + + + + Indicates if there has been a reply to the message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + Indicates if this message is marked as a high-priority message. + + + + GetMyMessages + Conditionally + + + + + + + + Date and time for the ended item. + + + + GetMyMessages + Conditionally + + + + + + + + Title of the item listing. + + + 55 + + GetMyMessages + Conditionally + + + + + + + + Media details stored as part of the message. + + + + GetMyMessages +
DetailLevel: ReturnHeaders, ReturnMessages
+ Conditionally + + + + + + + + + + + + Details relating to the response to a message. + + + + + + + Whether a message can be responded + to. To respond to a message, use the URL + in ResponseURL. You may need to log into the eBay + Web site to complete the response. + + + + GetMyMessages + Conditionally + Alerts + Messages +
DetailLevel: ReturnHeaders, ReturnMessages
+ + + + + + + + A URL that the recipient must visit to respond to a + message. Responding may require logging + into the eBay Web site. + + + + GetMyMessages + Conditionally + Alerts +
DetailLevel: ReturnMessages
+ + + GetMyMessages + Conditionally + Messages +
DetailLevel: ReturnHeaders, ReturnMessages
+ + + + + + + + The date and time the user responded to a + message + + + + + + + + + + + + Summary data for a given user's alerts and messages. + This includes the numbers of new alerts and messages, + unresolved alerts, flagged messages, and total alerts + and messages. + + + + + + + Folder summary for each folder. Always + returned for detail level ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + This field has been deprecated, starting with the 685 release. Alerts are now + synonymous with Flagged messages, and are added to the + Summary.FlaggedMessageCount value. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The number of new messages that a given user has. Always returned for detail level ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The number of alerts that are not yet + resolved. Always returned for detail level + ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The number of messages that have been flagged. + Always returned for detail level ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + This field has been deprecated, starting with the 685 release. Alerts are now + synonymous with Flagged messages, and are added to the + Summary.FlaggedMessageCount value. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of messages for a given user. + Always returned for detail level ReturnSummary. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of new high priority messages that a given user has. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + The total number of high priority messages that a given user has. + + + + GetMyMessages +
DetailLevel: ReturnSummary
+ Conditionally + + + + + + + + + + + A list of favorite searches a user has saved on the My eBay page. + + + + + + + The total number of favorite searches saved. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A favorite search the user has saved, with a name and a search query. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>FavoriteSearch</b> container returned in + <b>GetMyeBayBuying</b>. The <b>FavoriteSearch</b> container + consists of options and filtering used in a buyer's Saved Search on My eBay, and is + only returned in <b>GetMyeBayBuying</b> if the <b>FavoriteSearches</b> + container is included the request, and if there is at least one Saved Search for + the buyer. + + + + + + + The name of the buyer's Saved Search on My eBay. The name defaults to the user's + original search string, or the user has the option of modifying the name of the + Saved Search. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This is the URL of the buyer's Saved Search on My eBay. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This string is the original search string of the buyer's Saved Search on My eBay. + This is the string that the user input into the search field. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This is the unique identifier (Category ID) of the category in which the user was + searching for the item for the Saved Search. Specifying a category in a query + restricts the search to a specific category. If the Saved Search is not restricted + to a specific category, the <b>CategoryID</b> field will not appear + in the request. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This enumeration value indicates the "Sort by" value that the user specified in the + Saved Search. Some of the ways buyers can sort items include by Best Match + (generally, the default), item price, item price + shipping, listing end time, and + item distance (relative to the buyer's shipping address). Available sort values + may vary for each search, but below is the complete set of values that may be + returned in this field. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The <b>SortOrder</b> value works in conjunction with the + <b>ItemSort</b> value, and indicates whether Saved Search results are returned + in ascending (low to high values) or descending (high to low values) order. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The <b>EndTimeFrom</b> and <b>EndTimeFrom</b> values indicates that + a date range has been specified in the Saved Search. Only listings ending during + the date range defined with the <b>EndTimeFrom</b> and + <b>EndTimeFrom</b> values are retrieved in the search results. + <br/><br/> + The <b>EndTimeFrom</b> value indicates the beginning of the date range. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The appearance of <b>EndTimeFrom</b> and <b>EndTimeFrom</b> + values in the response indicates that a date range has been specified in the Saved + Search. Only listings ending during the date range defined with the + <b>EndTimeFrom</b> and <b>EndTimeFrom</b> values are + retrieved in the search results. + <br/><br/> + The <b>EndTimeTo</b> value indicates the ending of the date range. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The appearance of a <b>MaxDistance</b> value in the response indicates + that a proximity (Items near me) filter has been specified in the Saved Search. + <br/><br/> + The <b>MaxDistance</b> value is the maximum distance (in miles) away + from the buyer's postal code (specified or default) that an item may be + located (based on the <b>PostalCode</b> value returned in the + <b>FavoriteSearch</b> container). In a Saved Search, a buyer can + supply a postal code or can base that postal code on a major city. If neither one + of these methods for selecting a postal code is used, the postal code defaults to + the buyer's primary shipping address. Only items located within the + <b>MaxDistance</b> value are returned in the search results. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The <b>PostalCode</b> value is either the postal code for the buyer's + primary shipping address, or it is the postal code specified through the proximity + (Items near me) filter of a Saved Search. In a Saved Search, a buyer can supply a + postal code or can base that postal code on a major city. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Enumerated value that provides more information on the type of listing type + filtering the buyer used when setting up a Saved Search in My eBay. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The appearance of a <b>PriceMax</b> value indicates that a maximum price + filter has been specified in the Saved Search. Only listings with an item price at + or below the <b>PriceMax</b> value are retrieved in the search results. + <br/><br/> + <b>PriceMax</b> can be used in conjunction with + <b>PriceMin</b> in a Saved Search to specify a price range. Only + listings with item prices within this price range are retrieved in the search + results. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The appearance of a <b>PriceMin</b> value indicates that a minimum price + filter has been specified in the Saved Search. Only listings with an item price at + or above the <b>PriceMin</b> value are retrieved in the search results. + <br/><br/> + <b>PriceMin</b> can be used in conjunction with + <b>PriceMax</b> in a Saved Search to specify a price range. Only + listings with item prices within this price range are retrieved in the search + results. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The appearance of a <b>Currency</b> value indicates that a currency + filter has been specified in the Saved Search. Only listings with the specified + <b>Currency</b> value are retrieved in the search results. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The BidCountMax value in a My eBay Favorite Search. The BidCountMax limits the search + results to items with a maximum number of bids. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The BidCountMin value in a My eBay Favorite Search. The BidCountMin limits the + results of a search to items with a maximum number of bids. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The SearchFlag value in a My eBay Favorite Search. The SearchFlag allows you to + specify whether you want to include charity listings, free-shipping listings, and + listings with other features in your search. + + + + GetMyeBayBuying + DigitalDelivery +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The PaymentMethod value in a My eBay Favorite Search. The PaymentMethod limits the + search results to items that accept a specific payment method or methods. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The PreferredLocation value of a My eBay Favorite Search. The PreferredLocation + specifies the criteria for filtering search results by site, where site is determined + by the site ID in the request. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The SellerID value in a My eBay Favorite Search. The SellerID is the eBay ID of a + specific seller. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The SellerIDExclude value in a My eBay Favorite Search. The SellerIDExclude limits + the search results to exclude items sold by a specific seller or by specific sellers. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The ItemsAvailableTo value in a My eBay Favorite Search. ItemsAvailableTo limits the + result set to just those items available to the specified country. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The ItemsLocatedIn value in a My eBay Favorite Search. ItemsLocatedIn limits the + result set to just those items located in the specified country. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The SellerBusinessType value in a My eBay Favorite Search. The SellerBusinessType + limits the search results to those of a particular seller business type such as + commercial or private. SellerBusinessType is only available for sites that have + business seller features enabled. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The Condition value in a My eBay Favorite Search. Condition limits the results to new + or used items, plus items that have no condition specified. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The Quantity value in a My eBay Favorite Search. The Quantity limits the search + results to listings that offer a certain number of items matching the query. The + Quantity field is used with QuantityOperator to specify that you are seeking listings + with quantities greater than, equal to, or less than the value you specify in + Quantity. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The Quantity Operator value in a My eBay Favorite Search. The Quantity Operator + limits the results to listings with quantities greater than, equal to, or less than + the value you specify in Quantity. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + A list of favorite sellers the user has saved on the My eBay page. + + + + + + + The total number of favorite sellers saved. + + + 100 + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A favorite seller the user has saved, with a user ID and store name. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Characteristics of the My eBay Favorite Seller. + + + + + + + The favorite seller's eBay user ID. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The name of the store owned by the favorite seller, if applicable. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + A list of possible My eBay Second Chance Offers. + + + + + + + The total number of My eBay Second Chance Offers available. + + + + + + + A Second Chance Offer item. + + + + + + + + + + + Specifies how to return the result list for My eBay features such as saved + searches, favorite sellers, and second chance offers. + + + + + + + Specifies whether or not to include the container in the response. + Set the value to true to return the default set of fields for the + container. Not needed if you set a value for at least one other field + in the container. + <br><br> + If you set DetailLevel to ReturnAll, set Include to false to exclude + the container from the response. + + + + GetMyeBayBuying + No + + + + + + + + Specifies whether or not to include the item count in the response. + Set the value to true to return the default set of fields for the + container. Not needed if you set a value for at least one other field + in the container. + <br><br> + If you set DetailLevel to ReturnAll, set Include to false to exclude + the container from the response. + + + + GetMyeBayBuying + No + + + + + + + + This field is not supported. + + + + + + + + Specifies whether or not to include FavoriteSellerCount in the response. + Set the value to true to return the default set of fields for the + container. Not needed if you set a value for at least one other field + in the container. + <br><br> + If you set DetailLevel to ReturnAll, set Include to false to exclude + the container from the response. + + + + GetMyeBayBuying + No + + + + + + + + Specifies the sort order of the result. Default is Ascending. + + + + GetMyeBayBuying + No + + + + + + + + Specifies the maximum number of items in the returned list. + If not specified, returns all items in the list. + + + + GetMyeBayBuying + No + + + + + + + + Specifies that only the user defined list whose name matches + the given name should be in the returned list. If the user does + not have a matching record, no data is returned. If this + element is omitted, the information for all records is returned. + For use only within the UserDefinedLists element. + + + + GetMyeBayBuying + FavoriteSearches + FavoriteSellers + SecondChanceOffer + No + + + + + + + + Specify true to return the full user defined list contents in + the response's UserDefinedList containers. A value of + false means only a summary of the user defined list will be + returned. The default value is false. + + + + GetMyeBayBuying + FavoriteSearches + FavoriteSellers + SecondChanceOffer + No + + + + + + + + + + + + Contains summary information about the items the seller is selling. + + + + + + + The number of currently active auctions that will sell. That + is, there is at least one bidder, and any reserve price has + been met. Equivalent to the "Will Sell" value in My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of currently active auctions for a given + seller. Note that this does not include listings that are + FixedPriceItem or StoresFixedPrice. Equivalent to the + "Auction Quantity" value in My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of bids made on the seller's active listings. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + For all items that the seller has for sale, the total + selling values of those items having bids and where the + Reserve price is met (if a Reserve price is specified). + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of items that the seller has sold in the + past 31 days. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total monetary value of the items the seller has sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The average duration, in days, of all items sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of Classified Ad listings listed by the + seller. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of leads from the seller's classified + ad listings. Number indicates the total number of emails + received for the listings + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of offers received on active Classified + Ad listings. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The total number of Classified Ad listings that have an + associated lead. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + The quantity of items that this seller can list. This number refers to the total quantity of items in all listings. + For example, if the seller's limit was a quantity of 100, this could be 100 listings of one item each, or one listing with a quantity of 100 items. + The seller will be unable to list additional items or quantities of items for sale in excess of this number for the + current month unless the seller requests an increase from eBay using the "Request higher selling limits" link in the All Selling section + of My eBay. (Under "Selling Limits".) Notice that the amount limit (see AmountLimitRemaining) may be reached + before the quantity limit is reached. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + Listing Policies + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-Policies.html#SellerLimits + + + + + + + + The total value of the items listed price that this seller can list. This amount is the total of the prices + specified upon listing. For example, for fixed price listings, this is the total of the fixed price amounts. + For auction listings, this is the total of the starting prices. + The seller will be unable to list an item if the amount of the item's fixed price or starting price (for auctions) + exceeds the amount limit. + This is part of the seller limit, which can be increased by requesting an increase from eBay using the + "Request higher selling limits" link in the All Selling section + of My eBay. (Under "Selling Limits".) Notice that the quantity limit (see QuantityLimitRemaining) may be reached + before the amount limit is reached. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + Listing Policies + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-Policies.html#SellerLimits + + + + + + + + + + + + Defines details about recommended names and values for custom Item Specifics. + + + + + + + A recommended Item Specific name. + Always returned when NameRecommendation is returned. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + Constraints that eBay places on this Item Specific. + Always returned when NameRecommendation is returned. + As a general rule, AddItem and related calls will not be blocked + if you don't use eBay's recommendations, except where specified + in this documentation. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + A recommended value (if any) for the Item Specific name. + Only returned when a recommended value is available in the system.<br> + <br> + If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then + all of its value recommendations are returned. + If it has no dependencies, then the maximum number of + value recommendations that can be returned is limited by the number + you specified in MaxValuesPerName. + + + + MaxValuesPerName + #Request.MaxValuesPerName + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + A page on the eBay Web site with context-specific help tips that + provide useful information about this Item Specific. + Only returned when an applicable page is available in the system. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + Reserved for future use. + + + + + + + + + + Help-text defines the purpose of the tag. + The help text will be shown only when it is available for the particular tag + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + + + + + A list of one or more valid names and corresponding values. Currently + used for Item Specifics and Variations. + + + + + + + <b>For the AddItem family of calls:</b> + Contains the name and value(s) for an Item Specific. + Only required when the ItemSpecifics container is + specified.<br> + <br> + <b>For the AddFixedPriceItem family of calls:</b> + The same NameValueList schema is used for the + ItemSpecifics node, the VariationSpecifics node, and the + VariationSpecifcsSet node.<br> + <br> + If the listing has varations, any name that you use in the + VariationSpecifics and VariationSpecificsSet nodes can't be used + in the ItemSpecifics node.<br> + <br> + When you list with Item Variations:<br> + a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics + node.<br> + b) Specify up to five VariationSpecifics in each Variation + node. <br> + c) Specify all applicable names with all their supported values in + the VariationSpecificSet node. <br> + <br> + See the Variation sample in the + AddFixedPriceItem call reference for examples.<br> + <br> + <b>For PlaceOffer:</b> Required if the item being + purchased includes Item Variations. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + ItemSpecifics + Conditionally + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Variations + Conditionally + 2 + 5 + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + AddToWatchList + RemoveFromWatchList + Conditionally + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + GetItemRecommendations + Conditionally + + + GetItem + No + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Variation + Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + PlaceOffer + Conditionally + + + SetUserNotes + No + + + GetItemTransactions + Conditionally + + + ActiveInventoryReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + + + + A name and corresponding value (a name/value pair). + + + + + + + A name in a name/value pair.<br> + <br> + <b>For the AddItem and AddFixedPriceItem families of + calls:</b> In the Item.ItemSpecifics context, this can be any + name that the seller wants to use. However, to help buyers find + items more easily, it is a good idea to try to use a recommended + name when possible (see GetCategorySpecifics or + GetItemRecommendations). + You can't specify the same name twice within the same listing.<br> + <br> + <b>For the AddFixedPriceItem family of calls:</b> + In the VariationSpecifics context, this can be any name that + the seller wants to use, unless the VariationsEnabled flag + is false for the name in the GetCategorySpecifics response. + For example, for some categories eBay may recommend that you only + use "Brand" as a shared name at the Item level, not in variations.<br> + <br> + <b>For GetCategorySpecifics and GetItemRecommendations:</b> + This is a recommended (popular) name to use for items in the + specified category (e.g., "Brand" might be recommended, + not "Manufacturer"). + </span> + <br> + <br> + <b>For PlaceOffer:</b> Required if the item being + purchased includes Item Variations. + + + 40 + + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyAddItem + VerifyRelistItem + No + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + AddToWatchList + RemoveFromWatchList + Conditionally + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + GetItemRecommendations + Conditionally + + + GetItem + No + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + PlaceOffer + Conditionally + + + SetUserNotes + No + + + ActiveInventoryReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + A value associated with the name.<br> + <br> + <b>For the AddItem family of calls:</b> + If you specify multiple values for Item Specifics, + eBay only stores the first one, + unless GetCategorySpecifics or GetItemRecommendations indicates + that the corresponding name supports multiple values.<br> + <br> + <b>For the AddFixedPriceItem family of calls:</b> + If you specify multiple values for Item Specifics or + Variation Specifics, + eBay only stores the first one, + unless GetCategorySpecifics or GetItemRecommendations indicates + that the corresponding name supports multiple values.<br> + <br> + In VariationSpecificSet, you typically specify multiple + Value fields for each name. For example, if Name=Size, + you would specify all size values that you wan to offer in the + listing.<br> + <br> + <b>For GetCategorySpecifics and GetItemRecommendations:</b> The most highly recommended values are returned first. For these calls, + Value is only returned when recommended values are available.<br> + <br> + <b>For PlaceOffer:</b> Required if the item being + purchased includes Item Variations. + + + 50 + + AddItem + AddItemFromSellingManagerTemplate + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyAddItem + VerifyRelistItem + No + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddToWatchList + RemoveFromWatchList + Conditionally + 50 + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + 50 + + + GetItemRecommendations + Conditionally + 50 + + + GetItem + No + 50 + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ 50 + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + 50 + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + PlaceOffer + Conditionally + + + SetUserNotes + No + + + ActiveInventoryReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + The origin of this Item Specific. Only returned if the source is not + custom Item Specifics. + + + + GetItem +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Variation + Conditionally + + + + + + + + + + + + Information about a parent name-value pair. Currently used to indicate + relationships between Item Specifics. + + + + + + + The name of another Item Specific that the current value depends on. + For example, in a clothing category, "Size Type" could be recommended + as a parent of Size. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + The value of another Item Specific that the current value depends on. + For example, in a clothing category, if "Size Type" is the ParentName, + then "Petite" could be recommended as a parent value for Size=Medium. + + + + GetCategorySpecifics + GetItemRecommendations + ValueRecommendation + Conditionally + + + + + + + + + + + + Type defining the <b>NonProfitAddress</b> container, which consists of the + address (including latitude and longitude) of a nonprofit charity organization. + + + + + + + The street address of a nonprofit charity organization. + + + 512 + + SetCharities + Yes + + + GetCharities + Always + + + + + + + + The second line (if needed) of a nonprofit charity organization. This field is often + used for a suite number, floor number, or P.O. Box. + + + 512 + + SetCharities + No + + + GetCharities + Conditionally + + + + + + + + The city in which a nonprofit charity organization is located. + + + 128 + + SetCharities + Yes + + + GetCharities + Always + + + + + + + + The state in which a nonprofit charity organization is located. + + + 128 + + SetCharities + Yes + + + GetCharities + Always + + + + + + + + The zip code of a nonprofit charity organization. + + + 12 + + SetCharities + Yes + + + GetCharities + Always + + + + + + + + The latitude value of a nonprofit charity organization. Latitude and longitude + coordinates pinpoint the location of the organization relative to the earth, and are + useful for search purposes. The <b>Latitude</b> and <b>Longitude</b> + fields are only returned in <b>GetCharities</b> if set by the organization. + + + -90 + 90 + + SetCharities + No + + + GetCharities + Conditionally + + + + + + + + The longitude value of a nonprofit charity organization. Latitude and longitude + coordinates pinpoint the location of the organization relative to the earth, and are + useful for search purposes. The <b>Latitude</b> and <b>Longitude</b> + fields are only returned in <b>GetCharities</b> if set by the organization. + + -180 + 180 + + SetCharities + No + + + GetCharities + Conditionally + + + + + + + + Enumeration value that indicates whether or not a nonprofit charity organization is + registered with eBay Giving Works. See the <a href="http://pages.ebay.com/help/sell/nonprofit.html#certify">Certifying your + organization with MissionFish</a> help topic for more information on registering with + MissionFish and the benefits that come with being a registered eBay Giving Works + organization. + + + + SetCharities + Yes + + + GetCharities + Always + + + + + + + + + + + Enumerated type that indicates whether or not a nonprofit charity organization is + registered with eBay Giving Works. See the <a href="http://pages.ebay.com/help/sell/nonprofit.html#certify">Certifying your organization with MissionFish</a> + help topic for more information on registering with MissionFish and the benefits that come + with being a registered eBay Giving Works organization. + + + + + + + This value indicates that the address contained in the <b>NonProfitAddress</b> + container is for a non-registered charity organization. + + + + + + + This value indicates that the address contained in the <b>NonProfitAddress</b> + container is for a charity organization registered with eBay Giving Works. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + This is for FSBO. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + + + + The date time when the transaction occur. + + + + FeeSettlementReport + Conditionally + + + + + + + + The description for this transaction purpose etc. + + + + FeeSettlementReport + Conditionally + + + + + + + + Notes for this transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + Original charge time if this is an adjustment transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + Start time of the transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + End time of the transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + Fee Amount for a certain Fee type. + + + + FeeSettlementReport + Conditionally + + + + + + + + + + + + Valid notification status codes + + + + + + + Reserved for future internal or external use + + + + + + + Status indicating the notification was delivered + + + + + + + Status indicating the notification was failed + + + + + + + Status indicating the notification was rejected + + + + + + + Status indicating the notification was marked down + + + + + + + + + + Returns information about notifications sent to the given application + for the given ItemID. It will only be returned if ItemID was specified in the + input parameters. + + + + + + + List of notifications, if there are any, for the given ItemID and given + time period. + + + + GetNotificationsUsage + Conditionally + + + + + + + + + + + Information about a single notification. Notification information includes + the reference ID, notification type, current status, time delivered, error code, + and error message for the notification. If notification details are included in + the response, all of the detail fields are returned. + + + + + + + Returns the destination address for the notification. This is the value set + using SetNotificationPreferences. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Reference identifier for the notification. + + + + + + + Date and time when this notification will be removed from the + eBay system. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the notification type. Possible values include: AskSellerQuestion, + AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction, + Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived, + MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute, + UPISellerOpenedDispute, and UPISellerRespondedToDispute. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the total number of retries for the given notification. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the notification status. Possible values include Delivered, + Failed, Rejected, and MarkedDown. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the time when the notification is scheduled for retry. + This won't be included if the DeliveryStatus is Delivered. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the time when the notification was delivered. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the error message. + + + + GetNotificationsUsage + Conditionally + + + + + + + + Returns the delivery URL name for the notification. This is the value set + using SetNotificationPreferences. + + + + GetNotificationsUsage + Conditionally + + + + + + + + + + + + A list of NotificationEnable entries. Each entry specifies + one notification and whether it is enabled. + + + + + + + Specifies one notification or alert event and whether it is + enabled or disabled. Returned if previously set. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + Specifies a notification event and whether the + notification is enabled or disabled. + + + + + + + The name of the notification event. + + + + GetNotificationPreferences + FeedbackForSeller + Conditionally + + + SetNotificationPreferences + None, FeedbackForSeller + No + + + + + + + + Whether the event is enabled or disabled. + + + + GetNotificationPreferences + Conditionally + + + SetNotificationPreferences + No + + + + + + + + + + + + Defines all property names that can be used. + + + + + + + Property name for WatchedItemEndingSoon events, enabling a user to specify a time in minutes + before the end of the listing. Acceptable values: 5, 10, 15, 30, 60, 75, and 180. For example, + to receive a WatchedItemEndingSoon notification 30 minutes before the item listing ends, + specify 30. + + + + + + + Reserved for future use. + + + + + + + + + + Defines properties associated with a particular event. + + + + + + + The name of the notification event. + + + + GetNotificationPreferences + ItemsCanceled + Conditionally + + + SetNotificationPreferences + ItemsCanceled + No + + + + + + + + Specify property name associated with an particular event. + + + + GetNotificationPreferences + Conditionally + + + SetNotificationPreferences + No + + + + + + + + Specifies the value for the property. + + + + GetNotificationPreferences + Conditionally + + + SetNotificationPreferences + No + + + + + + + + + + + + Valid notification status codes + + + + + + + Status indicating the notification is newly created + + + + + + + Status indicating the notification was failed + + + + + + + Status indicating the end user application is marked down + + + + + + + Status indicating the notification is pending + + + + + + + Status indicating the notification is failed pending + + + + + + + Status indicating the notification is marked down pending + + + + + + + Status indicating the notification was successfully delivered + + + + + + + Status indicating the notification was unable to deliver + + + + + + + Status indicating the notification was rejected + + + + + + + Status indicating the notification was cancelled + + + + + + + Reserved for future internal or external use + + + + + + + + + + Enumerated type that contains the complete list of platform notifications that + can be sent out to subscribed users, servers, or applications. Some notifications are + only sent to buyers or sellers, and some are sent to both buyers and sellers. + + + FeedbackForSeller, MyMessagesAlertHeader, MyMessagesAlert, Checkout, ThirdPartyCartCheckout, ItemAddedToBidGroup, ItemRemovedFromBidGroup, AddToWatchList, PlaceOffer, RemoveFromWatchList, AddToBidGroup, RemoveFromBidGroup, ItemsCanceled, ReadyToShip, ReadyForPayout, UnmatchedPaymentReceived, RefundSuccess, RefundFailure + + + + + + + This notification is for internal or future use. + + + + + + + This notification is sent to a subscribed buyer when another buyer has outbid + (placed a higher maximum bid) the subscribed buyer on an auction listing, and + the subscribed buyer is no longer the current high bidder. + <br><br> + This notification is only applicable for auction listings. + + + + + + + This notification is sent to all subscribed bidders of an auction item and to + the subscribed seller of the auction item as soon as the auction listing ends + with or without a winning bidder. This notification will also be sent to + subscribed bidders and the subscribed seller if a buyer ends the auction as a + result of using the auction listing's Buy It Now feature. + <br><br> + This notification is only applicable for auction listings. + + + + + + + This notification is sent to the subscribed seller when the winning bidder + or buyer has paid for the auction or fixed-price item and completed the checkout process. + <br><br> + For multiple line item orders, an <b>AuctionCheckoutComplete</b> notification is only generated for one of the line items in the order. In this case, the seller would look for the containing order number for the line item in the <b>Transaction.ContainingOrder.OrderID</b> field, and then make a <b>GetOrders</b> call (using the container order ID as an input filter) to retrieve complete information for the order. + + + + + + + This notification is sent to a subscribed seller when a buyer/winning bidder + is requesting a total price before paying for the item. + <br><br> + This notification is applicable for auction listings and for fixed-price listings + that do not require immediate payment. + + + + + + + This notification is sent to a subsribed buyer or seller when that buyer or seller + has left Feedback for the other party in the order, or has received Feedback from + the other party in the order. + <br><br> + This notification is applicable for all listing types and orders. + + + + + + + This notification is deprecated. + <br><br> + Use the <b>Feedback</b> notification instead. + + + + + + + + + + This notification is sent to a subscribed seller each time a buyer purchases an item in a multiple-quantity, fixed-price listing. In the case of a single-quantity, fixed-price listing, the 'ItemSold' notification will be sent to the seller instead of 'FixedPriceTransaction'. + <br><br> + This notification is only applicable for multiple-quantity, fixed-price listings. + + + + + + + This notification is sent to a subscribed buyer who was unsuccessful in winning an auction item, but who is now receiving a Second Chance Offer from the seller of the original item. A seller may send a Second Chance Offer to a potential buyer if that seller was unable to complete the sale with the winning bidder or if that seller has duplicate items for sale. + <br><br> + This notification is only applicable for auction listings. + + + + + + + This notification is sent to a subscribed seller when an eBay user has used the Ask a question feature on the seller's active listing. An eBay user does not have to be an active bidder on an auction listing to ask a seller a question. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed seller each time one of the subscribed seller's items is listed or relisted. This notification is also triggered when the Unpaid Item Assistant mechanism relists an item for the seller. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed seller when one of the subscribed seller's items is revised. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed seller each time a buyer responds to an Unpaid Item or Cancel Transaction case that the subscribed seller has opened up against the buyer. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed buyer if a seller opens up an Unpaid Item or Cancel Transaction case against the subscribed buyer. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed buyer each time a seller responds to an Item Not Received or (Item) Significantly Not As Described case that the subscribed buyer has opened up against the seller. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to the subscribed buyer and seller if the seller closes an Unpaid Item or Cancel Transaction case against the buyer. + <br><br> + This notification is applicable to auction and fixed-priced listings. + + + + + + + This notification is sent to a subscribed seller if a potential buyer has made a best offer on a Best Offer-enabled fixed-price or Classified Ad listing. + <br><br> + This notification is applicable to fixed-priced, Classified Ad, and eBay Motors Local Market listings. + + + + + + + This field was deprecated in 685, and is no longer returned. It was replaced with MyMessagesHighPriorityMessageHeader. SetNotificationPreferences requests for MyMessagesAlertHeader using versions lower than 685 will result in an informational warning. Such requests using versions 685 and higher will return an error response. + + + + + + + This field was deprecated in 685, and is no longer returned. It was replaced with MyMessagesHighPriorityMessage. SetNotificationPreferences requests for MyMessagesAlert using versions lower than 685 will result in an informational warning. Such requests using versions 685 and higher will return an error response. + + + + + + + This notification is sent to a subscribed user or application when a message from eBay is sent to the user's My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed user or application when a message from eBay is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessageseBayMessageHeader and MyMessageseBayMessage cannot be subscribed to at the same time or specified in the same call. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed user or application when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnHeaders. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed user or application when a member to member (M2M) message is sent to My Messages. This notification type sends a GetMyMessages response at a detail level of ReturnMessages. MyMessagesM2MMessageHeader and MyMessagesM2MMessage cannot be subscribed to at the same time or specified in the same call. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed seller or application when a buyer opens up an Item Not Received case against the subscribed seller. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribed seller or application when a buyer responds to an Item Not Received case opened against the subscribed seller. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribed seller or application when a buyer closes an Item Not Received case opened against the subscribed seller. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribed buyer or application when a seller responds to an Item Not Received case opened by the subscribed buyer against that seller. + <br><br> + Applies to Buyers. + + + + + + + This notification is deprecated as it is applicable to eBay Express functionality, which no longer exists. + + + + + + + This notification is sent to a subscribed buyer or application when the listing of the watched item is about to end. This notification has a + <b>TimeLeft</b> property that allows the buyer to specify when the notification is sent based on how much time is left before the listing ends. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to all subscribed parties of interest when a listing ends in one of the following two ways: + <ul> + <li>An auction listing ends without a winning bidder. </li> + <li>A fixed-price listing ends with no sales</li> + </ul> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to the subscribed seller and subscribed potential buyers if eBay has administratively ended a listing for whatever reason. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to the subscribed seller each time a seller's single-quantity, fixed-price listing ends with a sale. In the case of a multiple-quantity, fixed-price listing, the 'FixedPriceTransaction' notification will be sent to the seller instead of 'ItemSold'. + <br><br> + Applies to Sellers. This notification is only applicable for single-quantity, fixed-price listings. + + + + + + + This notification is sent to the subscribed seller when the seller has + successfully extended the duration of a listing. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to the subscribed user if the user has successfully + changed their eBay User ID. + + + + + + + This notification is sent to the subscribed user if the user has successfully + changed their email address associated with their eBay account. + <br><br> + This notification is only available for SMS on the UK and Germany sites, and not + applicable to Platform Notifications. + + + + + + + This notification is sent to the subscribed user if the user has successfully + changed their eBay password. + <br><br> + This notification is only available for SMS on the UK and Germany sites, and not + applicable to Platform Notifications. + + + + + + + This notification is sent to the subscribed user if the user has successfully + changed their password hint associated with their eBay account. + <br><br> + This notification is only available for SMS on the UK and Germany sites, and not + applicable to Platform Notifications. + + + + + + + This notification is sent to the subscribed seller if the seller has successfully + updated the payment information associated with their eBay account. + <br><br> + This notification is only available for SMS on the UK and Germany sites, and not + applicable to Platform Notifications. + + + + + + + This notification is sent to the subscribed user if the user's account has been + suspended. + <br><br> + This notification is only available for SMS on the UK and Germany sites, and not + applicable to Platform Notifications. + + + + + + + An informational alert about account activity. + A user can subscribe to receive an account activity summary via SMS. + The user can specify the period (time range) for the account summary and can + select how often the summary is to be sent. It is not triggered by an event + but rather by an eBay daemon process that monitors a schedule database. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is deprecated since it is tied to eBay Express functionality, + which no longer exists. + + + + + + + + + + This notification is sent to a subscribed seller when the seller has successfully + revised an item by adding a charity that will receive a percentage of the + proceeds for any sales. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribed buyer when the user adds an item to + the Watch List. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribed buyer when the user removes an item + from the Watch List. + <br><br> + Applies to Buyers. + + + + + + + This notification is deprecated as the Bid Assistant feature is no longer + available. + <br><br> + Applies to Buyers. + + + + + + + This notification is deprecated as the Bid Assistant feature is no longer + available. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribed buyer or seller when that buyer or seller + has left Feedback for the other party in the order. + <br><br> + This notification is applicable for all listing types and orders. + + + + + + + This notification is sent to a subscribed buyer or seller when that buyer or + seller has received Feedback from the other party in the order. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed buyer or seller when the user's + Feedback Star level changes. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed buyer when the buyer places a bid for + on an auction item. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribed seller each time the seller receives a + bid for an auction item. + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribed buyer when the buyer has won an auction + item due to having the highest bid when the auction listing closed. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribed buyer when the buyer has lost an auction + item due to not having the highest bid when the auction listing closed. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribing seller when an auction listing ends + with no winning bidder or when a fixed-price listing ends with no sale(s). + <br><br> + Applies to Sellers. + + + + + + + This notification is sent to a subscribing buyer when a seller makes a counter + offer to the buyer's best offer. This notification is applicable to Best + Offer-enabled fixed-price or Classified Ad listings. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribing buyer if a seller rejects the buyer's + best offer on an item opted into the Best Offer feature by the seller. This + notification is also sent to the buyer if the buyer rejects a seller's + counter offer. + <br><br> + Applies to Buyers. + + + + + + + This notification is sent to a subscribing buyer who successfully places a best + offer on an item opted into the Best Offer feature by a seller. + <br><br> + Applies to Buyers. + + + + + + + An informational alert sent to a user when an item is added to her or his watch list. DO NOT USE. This notification was REMOVED in 549. + + + + + + + An informational alert sent to a user when he or she places an offer for an item. DO NOT USE. This notification was REMOVED in 549. + + + + + + + An informational alert sent to a user when an item is removed from her or his watch list. DO NOT USE. This notification was REMOVED in 549. + + + + + + + An informational alert sent to a user when when an item is added to her or his bid group. DO NOT USE. This notification was REMOVED in 549. + + + + + + + An informational alert sent to a user when an item is removed from her or his bid group. DO NOT USE. This notification was REMOVED in 549. + + + + + + + This event is not functional. + + + + + + + This notification is sent to a subscribed user if their eBay user token (required + to make Trading API calls) has been revoked. + <br><br> + Applies to both Buyers and Sellers. + + + + + + + This notification is sent to a subscribed seller when a Bulk Data Exchange job completes. + <br><br> + Applies to Sellers. + + + + + + + Reserved for future use. + + + + + + + This notification is sent to a subscribed buyer or seller when an item is marked as + shipped by the seller. + <br><br> + Applies to Sellers and Buyers. + + + + + + + This notification is sent to a subscribed buyer or seller when an item is marked as + paid by the seller. + <br><br> + Applies to Sellers and Buyers. + + + + + + + This notification is sent to a subscribing buyer or seller (or application) + when a response to the eBP case is due from the call user. When a eBP case is + opened, this notification is only sent to the seller involved in the case and + not the buyer. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a response to the eBP case is due from the other party in the case. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when an eBP case is escalated. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when the decision of an eBP case is appealed. + + + + + + + This notification is sent to the subscribed seller (or application) when + payment (to eBay or buyer) is due. + + + + + + + This notification is sent to the subscribed seller (or application) when + payment (to eBay or buyer) is processed. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when an appeal of an eBP case decision has been closed. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when an eBP case has been closed. + + + + + + + This notification is sent to the subscribed buyer or seller when a High Priority + Message (priority 1 or 2) is sent to My Messages. Only High Priority Message + will be sent back as part of the Notification payload. This notification type + sends a GetMyMessages response at a detail level of ReturnMessages. + + + + + + + This notification is sent to the subscribed buyer or seller + when a High Priority Message (priority 1 or 2) is sent to My Messages. Only + High Priority Messages will be sent back as part of the notification + payload. This notification type sends a GetMyMessages response at a detail level + of ReturnHeaders. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when an eBP case has been put on hold by eBay Customer Service. + + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This notification is sent to the subscribed buyer (or application) when a listing + that the buyer has bid on is about to end. This notification has a + <b>TimeLeft</b> property that allows the buyer to specify when the + notification is sent based on how much time is left before the listing ends. + + + + + + + This notification is sent to the subscribed buyer (or application) when the + listing for an unpurchased item in the buyer's cart is about to end. This notification + has a <b>TimeLeft</b> property that allows the buyer to specify when + the notification is sent based on how much time is left before the listing ends. + <br><br> + This notification is for future use. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a return is created. + + + + + + + This notification is sent to the subscribed seller (or application) + when a return is waiting for Seller information like RMA and Return Address. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when Seller information like RMA and Return Address is overdue. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a return is shipped. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a return is delivered. + + + + + + + This notification is sent to the subscribed seller (or application) + when refund is overdue on a return. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a return is closed. + + + + + + + This notification is sent to the subscribed buyer or seller (or application) + when a return is escalated. + + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This notification is sent to a subscribed buyer (or application) when that buyer has yet to pay for their order. + + + + + + + This notification is sent to a subscribed merchant (or application) when an eBay Now order has been picked up from the store by an eBay Now valet for delivery to the buyer. + + + + + + + This notification is sent to a subscribed merchant (or application) when an eBay Now order has been canceled. The reason for an eBay Now order cancellation can be found by retrieving the order through the <b>GetOrders</b> and looking for the <b>Order.CancelReason</b> value. + + + + + + + This notification is sent to a subscribed buyer or seller (or application) when a member-to-member (M2M) message is either deleted or marked as read in the InBox. + + + + + + + + + + + (out) A template for an SMS notification message. + + + + + + + + + + + + (out) The SMS message. + + + + + Conditionally + + + + + + + + (out) The EIAS userId. + + + + + + + + + + + + + + + The schema options for Platform Notifications. + + + + + + + New Schema format (used by the new schema XML API and SOAP API). + + + + + + + Reserved for internal or future use + + + + + + + + + + Defines roles for platform notifications. + + + + + + + (in) Specifies that you want to set or return application-level + preferences. Default value. + + + + + + + (in) Specifies that you want to set or return user-level preferences. + + + + + + + (in) Specifies that you want to set or return user data-level preferences. + + + + + + + (in) Specifies that you want to set or return event-level preferences. + + + + + + + Reserved for future use + + + + + + + + + + Summary information about notifications delivered, failed, errors, queued for + a given application ID and time period. + + + + + + + Returns the number of notifications delivered successfully during the given + time period. + + + + GetNotificationsUsage + Always + + + + + + + + Returns the number of new notifications that were queued during + the given time period. + + + + GetNotificationsUsage + Always + + + + + + + + Returns the number of pending notifications in the queue during + the given time period. + + + + GetNotificationsUsage + Always + + + + + + + + Returns the number of notifications that permanently failed during + the given time period. + + + + GetNotificationsUsage + Always + + + + + + + + Returns the number of notifications for which there were delivery errors + during the given time period. + + + + GetNotificationsUsage + Always + + + + + + + + + + + + User data related to notifications. + + + + + + + User data related to SMS notifications. SMS is currently reserved for future use. + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + User account activity summary alert delivery schedule. + Returned if PreferenceLevel is set to UserData in + GetNotificationPreferences. + See "Working with Platform Notifications" for instructions on + "Informational Alerts". + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + An application subscribing to notifications can include an XML-compliant + string, not to exceed 256 characters, which will be returned in the + notification payload. The string can contain user-specific information to + identify a particular user. Any sensitive information should be passed with due + caution and proper encryption. + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + Type defining the <b>NumberOfPolicyViolations</b> container that is returned + in the <b>GeteBayDetails</b> response. The <b>NumberOfPolicyViolations</b> + container consists of multiple <b>Count</b> fields with values that can be + used in the <b>BuyerRequirementDetails.MaximumBuyerPolicyViolations.Count</b> + field when using the Trading API to add, revise, or relist an item. + <br><br> + The <b>Item.MaximumBuyerPolicyViolations</b> container in Add/Revise/Relist + API calls is used to block buyers with buyer policy violations equal to or exceeding + the specified <b>Count</b> value during the specified <b>Period</b> + value from buying/bidding on the item. + + + + GeteBayDetails + Conditionally + + + + + + + + Each value returned in each <b>NumberOfPolicyViolations.Count</b> field + can be used in the <b>BuyerRequirementDetails.MaximumBuyerPolicyViolations.Count</b> + field when using the Trading API to add, revise, or relist an item. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Container for a list of offers. May contain zero, one, or multiple + OfferType objects, each of which represents one offer extended by + a user on a listing. + + + + + + + Contains the data for one offer. This includes: data for the user making the + offer, the amount of the offer, the quantity of items being bought from the + listing, the type of offer being made, and more. + + + + GetAllBidders + GetHighBidders + Conditionally + + + + + + + + + + + Contains information pertaining to an offer made on an item listing and + the current bidding or purchase state of the listing. + + + + + + + Indicates the type of offer being made on the specified listing. + If the item is Best Offer enabled and the buyer + makes a Best Offer (or a counter offer), then after + the <b>PlaceOffer</b> call, + the buyer can get the status of the Best Offer + (and of a possible seller-counter-offer, etc.) + using the <b>GetBestOffers</b> call. See the + <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-BestOffer.html">eBay Features Guide</a> + for information about best-offer enabled items and about <b>GetBestOffers</b>. + + + + GetAllBidders + + Always + + + PlaceOffer + Bid, Purchase, Accept, Counter, Decline, Offer + Yes + + + + + + + + Three-digit currency code for the currency used for the auction. Valid values can + be viewed in the <b>CurrencyCodeType</b> code list. + + + + + GetAllBidders + + Always + + + + + + + + The unique identifier of an item listed on the eBay site. + Returned by eBay when the item is created. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + + + + + + Amount of the offer placed. For auction listings, the amount + bid on the item (subject to outbid by other buyers). For fixed-price + listings, the fixed sale price at which the item is purchased. For + auction listings with an active Buy It Now option, this amount + will be either the Buy It Now price for purchase or the amount of a bid, + depending on the offer type (as specified in <b>Action</b>). For <b>PlaceOffer</b>, + the <b>CurrencyID</b> attribute is ignored if provided. Regarding Value-Added Tax (VAT): + Even if VAT applies, you do not need to add VAT to the <b>MaxBid</b> value. + If VAT applies to the listing, the seller can specify a VAT percent value + when they list the item. + + + + GetAllBidders + + Always + + + PlaceOffer + Yes + + + + + + + + Specifies the number of items from the specified listing the user + tendering the offer intends to purchase, bid on, or make a Best Offer on. + For auctions, the value may not + exceed one. For multi-item listings, must be greater than zero and not + exceeding the number of items offered for sale in the listing. + + + + GetAllBidders + + Always + + + PlaceOffer + Yes + + + + + + + + Indicates the user's preference to accept second chance offers. If true, + the user is willing to be the recipient of second chance offers. + + + + GetAllBidders + Always + + + + + + + + Unique ID identifying the currency in which the localized offer amounts are + expressed. + + + + GetAllBidders + + Always + + + + + + + + Date and time the offer or bid was placed. + + + + GetAllBidders + + Always + + + + + + + + Amount the highest bidder has bid on the item. Applicable to only + auction listings where there is progressive bidding + and winning bidders are determined based on the highest bid. + + + + GetAllBidders + Always + + + + + + + + Localized amount for the item's current price. + + + + GetAllBidders + + Conditionally + + + + + + + + The unique identifier of the order line item (transaction). An order line item + is created when a winning bidder commits to purchasing an + item. + + + 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.) + + + + + + + Bidder information. See the schema documentation for <b>UserType</b> for details + on its properties and their meanings. + + + + GetAllBidders + + Always + + + + + + + + If true, confirms that the bidder read and agrees to eBay's + privacy policy. Applies if the subject item is in a category + that requires user consent. If user consent (that is, + confirmation that a bidder read and agrees to eBay's privacy + policy) is required for a category that the subject item is in, + this value must be true for a bid to occur. + + + + PlaceOffer + No + + + + + + + + Total number of offers the user has made on the item. + + + + + + + A message from the buyer to the seller. Applies if the buyer + is using <b>PlaceOffer</b> to perform a best-offer-related + action (Best Offer, counter offer, etc.). + + + + PlaceOffer + No + + + + + + + + The ID of a Best Offer on an item. Must be specified as input to <b>PlaceOffer</b> only if a + buyer is accepting or declining a seller's counter offer (and is not required for a + buyer's offer or counter offer). + + + + PlaceOffer + No + + + + + + + + Maximum bid placed by the user making the call. + + + + GetAllBidders + Conditionally + + + + + + + + + + + + An array of Orders. + + + + + + + Also applicable to Half.com. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + Contains information about the sold item, such as: order id, buyer information, + shipping information, order creation time, payment cleared time, tax amount, + insurance cost, and total cost. + + + + + + + + + + A unique identifier for a single or multiple line item order. When a buyer + purchases multiple items from the same listing, each item purchased will have an Order Line + Item ID and all items in that purchase will have the same Order ID. + <br><br> + OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and + TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen + is the Transaction ID. The Transaction field in the Trading API is a container that can include + many types of transaction information. + <br><br> + See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> + for more information. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The buyer's eBay User ID. + + + + SoldReport + Always + + + + + + + + Displays the first name of the buyer (from their eBay user account). + + + + SoldReport + Always + + + + + + + + Displays the last name of the buyer (from their eBay user account). + + + + SoldReport + Always + + + + + + + + Displays the email address of the buyer (from their eBay user account). + Used for off-eBay communication. + + + + SoldReport + Always + + + + + + + + Buyer's primary phone number. This may return a value of "Invalid Request" if you + are not authorized to see the buyer's phone number. + <br> + <br> + Also applicable to Half.com (for GetOrders). + + + + SoldReport + Always + + + + + + + + Displays the buyer's recipient name for shipping (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. + <br><br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the buyer's street name (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. + <br/><br/> + For Global Shipping Program orders, this returns the first line of the domestic street address of the international shipping provider. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the second line of a buyer's street name (if one exists in the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. + <br/><br/> + For Global Shipping Program orders, this returns the second line of the domestic street address of the international shipping provider. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the buyer's city name (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page. + <br/><br/> + For Global Shipping Program orders, this returns the city name of the domestic address of the international shipping provider. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the buyer's state or province name (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. + <br/><br/> + For Global Shipping Program orders, this returns the state of the domestic address of the international shipping provider. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returnedonly if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the buyer's postal code or zip code (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been cleared. + <br/><br/> + For Global Shipping Program orders, this returns the postal code of the international shipping provider's domestic address. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + + SoldReport + Conditionally + + + + + + + + Displays the buyer's <a href="http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm">ISO 3166</a> country code (from the shipping address on their eBay user account). + <br/><br/> + Returned only if payment has been marked as sent. + <br/><br/> + For Global Shipping Program orders, this returns the country code of the international shipping provider's domestic address. + <br> + <br> + <span class="tablenote"> <strong>Note:</strong> This field is returned only if the <strong>downloadRequestFilter.soldReportFilter</strong> field is set in the corresponding <strong>startDownloadJob</strong> call of the Bulk Data Exchange API. In that filter, the user can decide whether to always retrieve shipping address information, or retrieve this information only when payment has been cleared. </span> + + + CountryCodeType + + SoldReport + Conditionally + + + + + + + + Name of the shipping service for display purposes. + <br><br> + Note that this value can change for aesthetic purposes, whereas + the <b class="con">ShippingServiceToken</b> will not. + Therefore, for all practical purposes, use <b class="con">ShippingServiceToken</b> + when programmatically reading and processing. + <br/><br/> + For Global Shipping Program orders, this returns only the name of the shipping service used for the domestic leg of the shipment. + + + + SoldReport + Always + + + ShippingServiceToken + #Response.OrderDetails.ShippingServiceToken + + + + + + + + The date and time that the payment was acknowledged. + <br/><br/> + Returned only if payment has been cleared. If a buyer has completed checkout using PayPal, the payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page. + + + + SoldReport + Conditionally + + + FeeSettlementReport + Always + + + + + + + + The eBay site that the buyer used when paying for the item(s). + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The date and time that the order was created. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + Amount seller charged to buyer, not amount of fees that seller owes eBay. + + + + FeeSettlementReport + Always + + + + + + + + Calculated tax fee based on the sale price and the sales tax at the seller's location. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + For <strong>FeeSettlementReport</strong>, <strong>ShippingCost</strong> returns the total shipping cost for all order line items with a shipping type of Flat, plus the total shipping cost based on item weight, buyer's postal code, and shipping service for all order line items with a shipping type of Calculated. + <br/><br/> + For <strong>SoldReport</strong>, the value returned by <strong>ShippingCost</strong> depends on the timing and the type of shipping involved: + <br/><br/> + <strong>Before Buyer Payment</strong> + <br/> + For an order line item with a shipping type of Calculated, <strong>ShippingCost</strong> = 0 (the calculated shipping cost is unknown). For an order line item with a shipping type of Flat, <strong>ShippingCost</strong> contains the seller-specified flat shipping cost for the order line item. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> If a buyer buys multiple items from one seller, the seller can combine all the items into an order while sending the invoice, and specify a custom shipping cost independent of the shipping costs for the individual line items. + </span> + <strong>After Buyer Payment</strong> + <br/> + <strong>ShippingCost</strong> contains the total shipping cost for the order, which can include any combination of order line items with Calculated shipping and order line items with Flat shipping. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For Global Shipping Program orders, the amount returned by <strong>ShippingCost</strong> applies only to the domestic leg of the shipment. + </span> + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The total cost for the order. This includes the following costs: + <ul> + <li><b>purchase price for all line items in order</b>: for non-variation items, the purchase price for each order line item is calculated by multiplying the <b>SalePrice</b> value by <b>QuantitySold</b>. For multi-variation items, this cost is calculated by multiplying the <b>Variation.Price</b> value by <b>Variation.QuantitySold</b>. </li> + <li><b>shipping cost for all line items in order</b>: indicated in the <b>OrderDetails.ShippingCost</b> field. For Global Shipping Program orders, the amount returned by <strong>ShippingCost</strong> applies only to the domestic leg of the shipment.</li> + <li><b>shipping insurance cost for all line items in order</b>: indicated in the <b>OrderDetails.InsuranceCost</b> + field.</li> + <li><b>sales tax for all line items in order</b>: indicated in the <b>OrderDetails.TaxAmount</b> + field.</li> + </ul> + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + For users of the Selling Manager or Selling Manager Pro tools only. If you are not + using Selling Manager or Selling Manager Pro, this field will not be returned in your response. + <br><br> + Unique identifier for the record, assigned by eBay. An example of a recordId: + 1111:222:333:444:x. + + + + SoldReport + Conditionally + + + + + + + + Contains the data for each line item in the order. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + Static anonymous email address of the buyer for eBay intermediated + member-to-memmber emails. Messaging calls in the Trading API, such as <b + class="con">GetMemeberMessages</b> will also use this static email + address. + <br><br> + The email address is in the form <code> + &lt;alias&gt;@members.ebay.&lt;SiteDomain&gt;</code>. + Each eBay member is assigned a static alias, which is the first part of the + email address. The &lt;SiteDomain&gt; value is based on the buyer's + registered site. For example, the email address ends in + <code>@members.ebay.de</code> for a buyer registered on the eBay + Germany site. The &lt;SiteDomain&gt; value can be + used to help identify the user's language. If the buyer changes his registered + site, then the value of &lt;SiteDomain&gt; will change accordingly. + + + + SoldReport + Always + + + BuyerEmail + #Response.OrderDetails.BuyerEmail + + + + + + + + Value used for the shipping service. For a list of valid values, + call <strong>GeteBayDetails</strong> with <strong>DetailName</strong> set to <code>ShippingServiceDetails</code>. + <br/><br/> + For Global Shipping Program orders, this identifies only the shipping service used for the domestic leg of the shipment. + <br><br> + <strong>Related fields:</strong> + <br> + Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in <strong>AddFixedPriceItem</strong> + <br> + Item.ShippingDetails.ShippingServiceOptions.ShippingService in <strong>AddFixedPriceItem</strong> + + + + SoldReport + Always + + + + + + + + The current checkout status of the order. + + + + SoldReport + Always + + + + + + + + This field indicates the type and/or status of a payment hold on the item. + + + + SoldReport + Always + + + + + + + + Container consisting of details for the electronic payment of an eBay order line item. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned after payment for the order line item has occurred. + + + + SoldReport + Conditionally + + + + + + + +Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. + +Example: "Reference #1234567890123456" + + + + SoldReport + Conditionally + + + + + + + + Container consisting of an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. + <br/><br/> + This container is always returned prior to order payment if the seller created/revised/relisted the item with the In-Store Pickup option available to buyers. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Sellers who are eligible for the In-Store Pickup feature can start listing items in Production with the In Store Pickup option beginning in late September 2013. However, in the meantime, merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + SoldReport + Conditionally + + + + + + + + Container consisting of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant). + <br/><br/> + This container is only returned when the buyer has selected the In-Store Pickup option and has paid for the order. All fields in the <strong>PickupMethodSelected</strong> container are static, except for the <strong>PickupStatus</strong> field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Sellers who are eligible for the In-Store Pickup feature can start listing items in Production with the In-Store Pickup option beginning in late September 2013. However, in the meantime, merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + + + + SoldReport + Conditionally + + + + + + + + + + + + Type defining the <b>OrderIDArray</b> container, which consists of an array of order IDs. These order IDs specify the single and multiple line item orders to retrieve. + + + + + + + A unique identifier for an eBay order. For a single line item order, this value is actually the <b>OrderLineItemID</b> value, which is a concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two values, such as '121124971073-1094989827002' for a fixed-price listing, or '121124971074-0' for an auction listing. For a multiple line item order (known as a Combined Invoice order), the <b>OrderID</b> value is created by eBay when the buyer/seller combines multiple line items into one order, and the buyer makes one payment for all line items from the same seller. "Combined Invoice" orders are created through the Web flow, or when the buyer or seller creates a "Combined Invoice" order by using the <a href="AddOrder.html">AddOrder</a> call. An example of "Combined Invoice" order ID is '155643809010'. + <br><br> + If one or more <b>OrderID</b> values are used, all other input filters are ignored. + <br><br> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions + Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + + + + A unique identifier for an order. + + + + GetSellingManagerEmailLog + No + + + + + + + + + + Contains the line item information for each order. + + + + + + + Specifics for the sale data for a single SKU or item. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + + + + Specifics for the sale data for a single SKU or item. + + + + + + + An ID that uniquely identifies each line item within an order. If the buyer only + purchased one item, there will be one Order ID and one Order Line Item ID. If a + buyer purchases multiple items, there will be one Order ID and multiple Order Line Item IDs. + <br><br> + OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and + TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen + is the Transaction ID. The Transaction field in the Trading API is a container that can include + many types of order line item (transaction) information. + <br><br> + See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> + for more information. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The date time when the transaction occur. + + + + FeeSettlementReport + Always + + + + + + + + Applicable for adjustment, the original transaction occurs date time. + + + + FeeSettlementReport + Conditionally + + + + + + + + The ID that uniquely identifies the item listing. The ID is generated by eBay after an + item is listed. You cannot choose or revise this value. + <br> + Also applicable to Half.com. + + + + FeeSettlementReport + Always + + + + + + + + The title of the item listing. + + + 80 + + FeeSettlementReport + SoldReport + Always + + + + + + + + Serial number for this item, only applicable for motors. + + + + FeeSettlementReport + Conditionally + + + + + + + + Stock Keeping Unit that serves as a unique identifier for an item. Many + merchants assign a SKU number to an item of a specific type, size, and + color. This way, they can keep track of how many products of each type, + size, and color are selling, and they can re-stock their shelves according + to customer demand. You can use SKU numbers to add Fixed Price Items and to + keep track of your eBay inventory, instead of (or in addition to) the Item + ID. + + + + SoldReport + Always + + + FeeSettlementReport + Conditionally + + + + + + + + Description of the category used. + + + + FeeSettlementReport + Always + + + + + + + + Site description for the site where the listing occurred. + + + + FeeSettlementReport + Always + + + + + + + + The number of items sold to a specific buyer within a single order line item + (transaction). + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + Price of the item. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + Calculated tax fee based on the sale price and the sales tax at the buyer's location. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + For <strong>FeeSettlementReport</strong>, depending on the shipping type assigned to the order line item, <strong>ShippingCost</strong> returns either the seller-specified Flat shipping cost, or the Calculated shipping cost based on item weight, buyer's postal code, and shipping service. + <br/><br/> + For <strong>SoldReport</strong>, the value returned by <strong>ShippingCost</strong> depends on the shipping type of the order line item. For an order line item with a shipping type of Calculated, <strong>ShippingCost</strong> = 0 (the calculated shipping cost per item is unknown, even after payment). For an order line item with a shipping type of Flat, <strong>ShippingCost</strong> contains the seller-specified flat shipping cost for the order line item. The value of <strong>ShippingCost</strong> does not reflect discounts applied with a promotional shipping rule. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Although the shipping cost per order line item with Calculated shipping type is not normally available in <strong>SoldReport</strong>, it is included in the total shipping cost at the order level (OrderDetails.<strong>ShippingCost</strong>) after buyer payment. It is also returned per order line item in OrderLineItem.<strong>ActualShippingCost</strong> for orders that apply a promotional shipping rule. + </span> + <br/> + For Global Shipping Program orders, the amount returned by <strong>ShippingCost</strong> applies only to the domestic leg of the shipment. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The total cost for the order line item. This includes the following costs: + <ul> + <li><b>purchase price</b>: for non-variation items, this cost is + calculated by multiplying the <b>SalePrice</b> value by <b>QuantitySold</b>. For multi-variation items, this cost is calculated by multiplying the + <b>Variation.Price</b> value by <b>Variation.QuantitySold</b>. </li> + <li><b>shipping cost</b>: indicated in the <b>ShippingCost</b> + field. For Global Shipping Program orders, the amount returned by <strong>ShippingCost</strong> applies only to the domestic leg of the shipment.</li> + <li><b>shipping insurance cost</b>: indicated in the <b>InsuranceCost</b> field.</li> + <li><b>sales tax</b>: indicated in the <b>TaxAmount</b> + field.</li> + </ul> + <span class="tablenote"><b>Note:</b> + If multiple order line items between the same buyer and seller have been combined + into a Combined Payment order, the <b>OrderLineItem.TotalCost</b> value + returned for each order line item reflects the amount paid for the Combined Payment + order and not for the individual order line item. + </span> + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The date and time that the payment was acknowledged. + Only returned for SoldReport if payment has been marked as received. + + + + SoldReport + Conditionally + + + FeeSettlementReport + Conditionally + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + eBay site where the seller is registered. + + + + SoldReport + Always + + + FeeSettlementReport + Always + + + + + + + + The date and time that the item was sold. + + + + FeeSettlementReport + Always + + + + + + + + Notes for this transaction. + + + + FeeSettlementReport + Conditionally + + + + + + + + Second description of the item sold. + + + + FeeSettlementReport + Always + + + + + + + + Description of the fee type. + + + + FeeSettlementReport + Always + + + + + + + + Fee Amount for a certain Fee type. + + + + FeeSettlementReport + Always + + + + + + + + For users of the Selling Manager or Selling Manager Pro tools only. If you are not + using Selling Manager or Selling Manager Pro, this field will not be returned in your response. + <br><br> + Unique identifier for the record, assigned by eBay. An example of a recordId: + 1111:222:333:444:x. + + + + SoldReport + Conditionally + + + + + + + + If payment has been marked as sent (on the Buyer's MyeBay page), this field + returns the transaction number assigned to the payment event by the eBay + application. Sellers might use this field to determine when they can ship an + item. This field is only included in the response after the Buyer has completed + checkout. This field will not be returned to new DE and AT sellers who are + subject to the new payment process that begins in late August 2011. + <br><br> + If a buyer has completed checkout using PayPal, the Payment is automatically marked + as sent, and the BuyerPaymentTransactionNumber will be the same number as the PayPal + External Transaction ID. Otherwise, the buyer must mark the item as paid manually on + the MyeBay page. + + + + SoldReport + Conditionally + + + + + + + + Variations are multiple similar (but not identical) items in one + fixed-price listing. For example, a clothing listing can + contain items of the same brand that vary by color and size. + Each variation specifies a combination of one of these + colors and sizes. Each variation can have a different + quantity and price. Only returned if the order line item is for + a variation. + + + + SoldReport + Conditionally + + + + + + + + A tax exception category code. This is returned only if set + for the listing. + + + + SoldReport + Conditionally + + + + + + + + Details about taxes applicable to this order line item (transaction). + Returned only if enabled for the account. + (Otherwise see OrderLineItem.TaxAmount.) + + + + SoldReport + Conditionally + + + + + + + + Container consisting of status details of an order line item, + including payment information. Several of these fields change values during + the checkout flow. See <b>TransactionStatusType</b> for its child elements. + <br><br> + For <b>SoldReport</b>, only the + <b>PaymentHoldStatus</b> child element is returned. The + fields indicating the status of the order are actually found in the + <b>OrderDetails.CheckoutStatus</b> container. + <br><br> + Not applicable to Half.com. + + + + SoldReport + Always + + + + + + + + The actual shipping cost for the order line item. This field is returned only if a seller-defined promotional shipping rule is applied to the order, and only after payment is made by the buyer. For more information about promotional shipping rules, see the <a href="http://pages.ebay.com/help/pay/shipping-discounts.html#promo" target="_blank">Offering shipping discounts help page</a>. + + + + SoldReport + Conditionally + + + + + + + + Unpaid Item Details. + + + + SoldReport + Conditionally + + + + + + + + + + + + + + + + + + + + + + + Enumerated type that defines the possible values for order states. + + + + + + + This value indicates that the cart is active. The 'Active' state is the only order state in which order line items can still be added, removed, or updated in the cart. + + + + + + + This value indicates that the cart is inactive. + + + + + + + This value indicates that the order is completed. + + + + + + + This value indicates that the cart was cancelled. + + + + + + + This value indicates that the Half.com order was shipped. This value is only applicable for Half.com orders. + + + + + + + This value indicates that the order is in default status. + + + + + + + This value indicates that the cart was authenticated. + + + + + + + This value indicates that processing of the buyer's cart has been initiated, but is not yet complete. + + + + + + + This value indicates that the cart is invalid, or no longer exists. + + + + + + + Reserved for internal or future use. + + + + + + + This value is passed into the <b>OrderStatus</b> of <b>GetOrders</b> to retrieve order in all states. This is the default value. + + + + + + + This value indicates the order is in a 'CancelPending' state, which + means that the cancellation of the order has been initiated, but not + completed. Once the order cancellation is complete, the <b> + OrderStatus</b> value will change to 'Completed'. + + + + + + + + + + + + All applicable sold listings, regardless of + their Paid or Shipped status. + + + + + + + Sold listings that have not yet been marked as + Paid in My eBay. + + + + + + + Sold listings that have not yet been marked as + Shipped in My eBay. + + + + + + + Sold listings that have been marked as + Paid and Shipped in My eBay. + + + + + + + Reserved for future or internal use. + + + + + + + + + + Contains a list of orders, transactions, or both, each of OrderTransactionType. + + + + + + + The individual order or transaction. + + + + GetMyeBayBuying + Conditionally + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + Contains an order or a transaction. A transaction is the sale of one or + more items from a seller's listing to a buyer. An order combines two or more transactions + into a single payment. + + + + + + + Contains the information describing an order. + + + + GetMyeBayBuying + Conditionally + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains the information describing a transaction. + + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + There are single line item and multiple line item orders. A single + payment is made for both order types. + <br> + <br> + We strongly recommend that you avoid mixing digital and non-digital listings in + the same <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + order. + + + + + + + A unique identifier for an eBay order. For a single line item order, this value is actually the <b>OrderLineItemID</b> value, which is a concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two values, such as '121124971073-1094989827002' for a fixed-price listing, or '121124971074-0' for an auction listing. For a multiple line item order (known as a Combined Invoice order), the <b>OrderID</b> value is created by eBay when the buyer/seller combines multiple line items into one order, and the buyer makes one payment for all line items from the same seller. "Combined Invoice" orders are created through the Web flow, or when the buyer or seller creates a "Combined Invoice" order by using the <a href="AddOrder.html">AddOrder</a> call. An example of "Combined Invoice" order ID is '155643809010'. + <br><br> + An <b>OrderID</b> value overrides an <b>OrderLineItemID</b> value or an + <b>ItemID/TransactionID</b> pair if these fields are also specified in the same request. + <br><br> + Also applicable to Half.com (for <b>GetOrders</b>). + + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + + + + + + This enumeration value indicates the current status of the order. + + + All + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates the dollar amount by which the buyer has adjusted the order + total. Adjustments to order costs may include shipping and handling, shipping + insurance, buyer discounts, or added services. A positive amount indicates the + amount is an extra charge being paid to the seller by the buyer. A negative + value indicates this amount is a credit given to the buyer by the seller. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + AddOrder + + + + + + + This value indicates the total amount of the order. This amount includes the + sale price of each line item, shipping and handling charges, shipping insurance + (if offered and selected by the buyer), additional services, and any applied + sales tax. This value is returned after the buyer has completed checkout (the + <b>CheckoutStatus.Status</b> output field reads 'Complete'). + <br><br> + <span class="tablenote"><strong>Note:</strong> + For auction listings on North American sites and on eBay Motors Parts and + Accessories, the <b>AmountPaid</b> value minus any applied sales tax is the amount + subject to the final value fee calculation. The sales tax amount is returned in + the <b>ShippingDetails.SalesTax.SalesTaxAmount</b> field. For more information on how + final value fees are calculated, see the + <a href="http://pages.ebay.com/help/sell/fvf.html">final value fees</a> help + page. + </span> + <br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This value indicates the shipping discount experienced by the buyer as a result + of creating a Combined Invoice order. This value is returned as 0.00 for single + line item orders. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Container consisting of details related to the current checkout status of the + order. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Container consisting of all shipping-related details for an order, including + domestic and international shipping service options, shipment tracking + information, and shipping insurance information. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + AddOrder + No + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + ShippingServiceOptions, ShippingType + + + + + + + + This value indicates whether a Combined Invoice order was created by the buyer + or by the seller. This field is only returned for Combined Invoice orders. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + Yes + + + + + + + + Timestamp that indicates the date and time that the order was created. For + single line item orders, this value is the same as <b>CreatedDate</b> in the + <b>Transaction</b> container. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + This field indicates a payment method available to the buyer to pay for the + order. There will be a <b>PaymentMethods</b> field for each payment method available to the buyer. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + AddOrder + Yes + CreditCard, DirectDebit + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + No + + + + + + + + Container holding the shipping address of the buyer involved in the order. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Container consisting of details about the domestic or international shipping + service selected by the buyer. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> If one or more <strong>OrderID</strong> values are used in the call request, the "Combined Invoice" Order ID value must be specified for multiple line item orders to ensure that the shipping service and cost information is accurate. If the individual <strong>OrderLineItemID</strong> values for each line item are specified in the <strong>OrderID</strong> field instead, the shipping service and cost information will not be accurate. + </span> + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + The <b>Total</b> amount equals the <b>Subtotal</b> value plus the shipping/handling, shipping insurance, and sales tax costs. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + AddOrder + Yes + + + + + + + + Container consisting of payment details for an eBay order. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned after payment for the order has occurred. + <br/><br/> + For orders in which the seller's funds are being held by PayPal, the <b>PaymentHoldDetails</b> container and <b>PaymentHoldStatus</b> field will be returned instead of the <b>ExternalTransaction</b> container. + <br><br> + <span class="tablenote"> + <strong>Note:</strong> In an upcoming release, <strong>ExternalTransaction</strong> will be replaced by the more versatile <strong>MonetaryDetails</strong> container, so you are encouraged to start using <strong>MonetaryDetails</strong> now. + </span> + Not applicable to Half.com. + + + + GetOrderTransactions + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Container consisting of one or more line items that comprise an order. The data for + an order line item is stored in the <b>Transaction</b> container. For + the <b>AddOrder</b> call, there will always be at least two order line + items in the container, but no more than 40. + <br><br> + We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same Combined Invoice order. (In the future, <b>AddOrder</b> may enforce this recommendation.) + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + AddOrder + Yes + + + + + + + + eBay user ID of the order's buyer. + <br><br> + Not applicable to Half.com. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Timestamp indicating the date and time of order payment. This field is not + returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds. + <br><br> + This time is specified in GMT (not Pacific time). + See <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/DataTypes.html#ConvertingBetweenUTCGMTandLocalTime"> eBay Features Guide</a> + for information about converting between GMT and other time zones. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped. Note that sellers have the ability to set the shipped time up to three calendar days in the future. + <br><br> + This time is specified in GMT (not Pacisfic time). + See <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/DataTypes.html"> eBay Features Guide</a> + for information about converting between GMT and other time zones. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the item can be paid for through a payment gateway (Payflow) account. If <b>IntegratedMerchantCreditCardEnabled</b> is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if <b>IntegratedMerchantCreditCardEnabled</b> is true, and 'AmEx', 'Discover', or 'VisaMC' is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Reserved for future use. + + + + + + + + + + This field is returned if the buyer left a message for the seller during + checkout. + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Unique identifier for the user that does not change when the eBay user name + is changed. Use when an application needs to associate a new eBay user name + with the corresponding eBay user. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that + bidder, and to the seller of an item that the user is bidding on. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + + This field indicates the type and/or status of a payment hold on the item. + + + + GetOrders +
DetailLevel: none
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This container consists of information related to the payment hold + on the order, including the reason why the buyer's payment for the order is + being held, the expected release date of the funds into the seller's + account, and possible action(s) the seller can take to expedite the payout + of funds into their account. This container is only returned if PayPal + has placed a payment hold on the order. + <br><br> + An American seller (selling on US or US Motors sites) and a Canadian + seller (selling on CA and CA- FR sites) may be subject to PayPal payment + holds (that last from three to 21 days) if that seller is new to selling + on eBay or is classified as a "Below Standard" seller. For other reasons + why a seller's funds may be held by PayPal, see the + <b>PaymentHoldReason</b> field. + + + + GetOrders +
DetailLevel: none
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Amount of the refund issued to the buyer. This field is only returned if the buyer has received a refund from the seller. + + + + GetMyeBaySelling + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This string value indicates the result of a seller's refund to the buyer. Its value are 'Success', 'Failure' or 'Pending'. This field is only returned if the buyer has received a refund from the seller, or is due to receive a refund. + + + + GetMyeBaySelling + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Container consisting of one or more refunds for Half.com orders. This container is returned only if a refund + to a Half.com buyer has occurred. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + If <strong>IsMultilegShipping</strong> is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the seller has specified InternationalPriorityShipping as the default international shipping service in the listings of all the items in the shipment. + <br/><br/> + If <strong>IsMultilegShipping</strong> is false, the order or transaction doesn't use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains details about the domestic leg of a Global Shipping Program shipment. + <br/><br/> + This information is not returned if <strong>IsMultilegShipping</strong> is false. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains information about how funds exchanged for an order are allocated to payees. + <br/><br/> + For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> In an upcoming release, <strong>MonetaryDetails</strong> will replace the <strong>ExternalTransaction</strong> container, so you are encouraged to start using <strong>MonetaryDetails</strong> now. + </span> + + + + GetOrders +
DetailLevel:ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:ReturnAll
+ Conditionally + + + + + + + + Container consisting of an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. + <br/><br/> + For <strong>GetOrders</strong> and <strong>GetOrderTransactions</strong>, this container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Container consisting of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant). + <br/><br/> + This container is only returned when the buyer has selected the In-Store Pickup option and has paid for the order. All fields in the <strong>PickupMethodSelected</strong> container are static, except for the <strong>PickupStatus</strong> field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This is the eBay user ID of the order's seller. + <br><br> + Not applicable to Half.com. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This is a unique identifier for the seller that does not change when the eBay user name is changed. This is useful when an application needs to associate a new eBay user name with the corresponding eBay user. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This value indicates the reason why the eBay order was cancelled. This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled. Cancel reasons that may show up in this field include 'BuyerCancelOrder', 'OutOfStock', 'ValetUnavailable', or 'BuyerNoShow'. 'BuyerCancelOrder' will be the returned value for non-eBay Now orders that are cancelled by the buyer through My eBay. 'OutOfStock' will be the returned value for eBay orders that are cancelled by the seller due to the item being out-of-stock. All other values besides these two values are specific to eBay Now orders. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Currently, the <b>CancelReason</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future. + </span> + + + CancelReasonCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The detailed reason for the cancellation of an eBay order. This field is only returned if it is available when a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Currently, the <b>CancelReasonDetails</b> field is being returned under the <b>Order</b> container and under the <b>CancelDetail</b> container. However, there are plans to deprecate this field from <b>OrderType</b> in the future. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This container consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates which type of <em>logistics plan</em> has been selected for the current order by the buyer. A logistics plan categorizes the means by which a package is transported from the seller to the buyer. It is characterized by the type of location where the buyer will take possession of the package, the type and number of carriers involved, and the timing of sending and delivery. A given logistics plan type helps to determine which shipping types, carriers and services the seller can use. + <br/><br/> + This field is returned only if it has a value. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Currently, <strong>LogisticsPlanType</strong> has only one applicable value: <code>PickUpDropOff</code>, which is a service available for orders sent and delivered within the UK. When buyers select <code>PickUpDropOff</code>, the order is sent to a contracted third party location, where it is held for pickup by the buyer. + </span> + + + LogisticsPlanCodeType + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer. + <br/><br/> + It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site. + <br/><br/> + On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout. + <br/><br/> + This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A <strong>BuyerTaxIdentifier</strong> container will be returned for each tax ID that is associated with the buyer's account. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The ability for Italian and Spanish sellers to require the buyer's tax ID at checkout is in the ramp up stage. + </span> + + + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + This container is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the German site. + + + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A unique identifier for an eBay order. Unlike the <b>OrderID</b> field, the format for this field is the same for both single and multiple line item orders. <b>ExtendedOrderID</b> values will be used to identify orders in the After Sale APIs that are scheduled to be released at the end of 2014. For Trading API Get calls, <b>OrderID</b> values should still be used. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains a paginated list of items. + + + + + + + Contains a list of Item types. + + + + GetMyeBayBuying + BidList + BestOfferList + LostList + WatchList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + UnsoldList + BidList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Provides information about the list, including number of pages and number + of entries. + + + + GetMyeBayBuying + BidList + LostList + WatchList + WonList + BestOfferList + DeletedFromLostList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + ScheduledList + SoldList + UnsoldList + BidList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains a paginated list of orders. + + + + + + + Contains the list of orders. + + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Specifies information about the list, including number of pages and + number of entries. + + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains a paginated list of order line items. + + + + + + + Contains a list of Transaction objects. Returned as an + empty tag if no applicable order line items exist. + + + + GetItemsAwaitingFeedback + Always + + + + + + + + Provides information about the list of order line items, + including number of pages and number of entries. + + + + GetItemsAwaitingFeedback + Always + + + + + + + + + + + Shows the pagination of data returned by call requests. + Pagination of returned data is not needed nor + supported for every Trading API call. See the documentation for + individual calls to determine whether pagination is + supported, required, or desirable. + + + + + + + Indicates the total number of pages of data that could be returned by repeated + requests. Returned with a value of 0 if no pages are available. + + + + GetSellingManagerSoldListings + No + + + GetAccount + GetItemsAwaitingFeedback + GetMemberMessages + GetSellerPayments + GetWantItNowSearchResults + Always + + + GetFeedback + Always +
DetailLevel: none, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetLiveAuctionBidders + GetSellingManagerSoldListings + GetVeROReportStatus + Conditionally + + + GetMyeBayBuying + BidList + BestOfferList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetUserDisputes +
DetailLevel: ReturnSummary, ReturnAll, none
+ Always + + + GetSellingManagerInventory + Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates the total number of entries that could be returned by repeated + call requests. Returned with a value of 0 if no entries are available. + + + + GetSellingManagerSoldListings + No + + + GetItemsAwaitingFeedback + GetLiveAuctionBidders + GetMemberMessages + GetSellerPayments + GetWantItNowSearchResults + Always + + + GetFeedback + Always +
DetailLevel: none, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetAccount + Always + + + GetSellingManagerSoldListings + GetLiveAuctionBidders + GetVeROReportStatus + Conditionally + + + GetMyeBayBuying + BidList + BestOfferList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellingManagerInventory + Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Specifies the payment status of an order, as + seen by the buyer and seller. + + + + + + + The buyer has not completed checkout, but has not paid through PayPal or + PaisaPay (but please also see the documentation for PaymentHoldStatus and its applicable values). + The buyer might have paid using another method, but the payment + might not have been received or cleared. + Important: Please see the documentation for PaymentHoldStatus and its applicable values. + PaymentHoldStatus contains the current status of a hold on a PayPal payment. + + + + + + + The buyer has not completed the checkout process and so has not made payment. + + + + + + + The buyer has made a PayPal payment, but the seller has not yet received it. + + + + + + + The buyer has made a PayPal payment, and the payment is complete. + But please also see the documentation for PaymentHoldStatus and its applicable values. + PaymentHoldStatus contains the current status of a hold on a PayPal payment. + + + + + + + The order is marked as paid by either buyer or seller. + + + + + + + The buyer has made an escrow payment, but the seller has not yet received it. + + + + + + + The buyer has made an escrow payment, and the seller has received payment. + + + + + + + The buyer has made an escrow payment, but has cancelled the payment. + + + + + + + The buyer has paid with PaisaPay, but the payment is still being processed. + The seller has not yet received payment. + + + + + + + The buyer has paid with PaisaPay, and the payment is complete. + + + + + + + The buyer has made a payment other than PayPal, escrow, or PaisaPay, but the + payment is still being processed. + + + + + + + Payment Pending With PaisaPay Escrow + + + + + + + Paid With PaisaPay Escrow + + + + + + + Paisa Pay Not Paid + + + + + + + Refunded + + + + + + + WaitingForCODPayment + + + + + + + PaidCOD + + + + + + + Reserved for future use. + + + + + + + Paid + + + + + + + + + + This type defines the PaisaPayEscrow payment feature. If the field is present, the PaisaPayEscrow payment feature applies to the category. The field is returned as an empty element, the boolean value is not returned. + + + + + + + + + + + PayPal account level. + + + + + + + Account unverified + + + + + + + Account international unverified + + + + + + + Account verified + + + + + + + Account international verified + + + + + + + Account trusted + + + + + + + + + Reserved for internal or future use + + + + + + + + + + PayPal account status. + + + + + + + Account is active. + + + + + + + Account is closed. + + + + + + + Account is highly restricted. + + + + + + + Account restriction is low. + + + + + + + Account is locked. + + + + + + + Reserved for internal or future use + + + + + + + + + + + + + PayPal account type. + + + + + + + Personal account. + + + + + + + Premier account. + + + + + + + Business account. + + + + + + + + + Reserved for internal or future use + + + + + + + + + + Defines the PayPalBuyerProtection feature. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the PayPal Required feature. If the field is + present, the corresponding feature applies to the category. The field is returned + as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Type defining the <b>PaymentDetails</b> container, which is used by the seller to + specify amounts and due dates for deposits and full payment on motor vehicle listings. + + + + + + + This integer value indicates the number of hours that a buyer has (after he/she commits to + buy) to make a deposit to the seller as a down payment on a motor vehicle. Valid values are + '24', '48' (default), and '72'. + <br/><br/> + The deposit amount is specified in the <b>DepositAmount</b> field. If not + specified, the <b>DepositAmount</b> value defaults to 0.0, in which case, a + deposit on the vehicle is not required. + + + 24 + 72 + 48 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This integer value indicates the number of days that a buyer has (after he/she commits to + buy) to make full payment to the seller and close the remaining balance on a motor vehicle. + Valid values are '3', '7' (default), '10', and '14'. + <br/><br/> + In order for a buyer to make a full payment on an US or CA motor vehicle, at least one of + the following <b>PaymentMethods</b> values must be specified for the + listing: + <ul> + <li>CashInPerson</li> + <li>LoanCheck</li> + <li>MOCC (money order or cashier's check)</li> + <li>PaymentSeeDescription (indicates to prospective buyers that payment instructions + are in the item's description</li> + <li>PersonalCheck</li> + </ul> + + + 3 + 14 + 7 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This dollar value indicates the amount of the deposit that a buyer must make on a purchased + motor vehicle (eBay Motors US and CA). The deposit amount can be as high as $2,000.00. If not + specified, this value defaults to '0.0'. If the seller is requiring that the buyer put down + a deposit on the vehicle, the seller must include and set the <b>DepositType</b> + field to 'OtherMethod' and specify an HoursToDeposit value. + If specified, then also specify <b>HoursToDeposit</b> + <br> + <br> + Deposits can only be paid using PayPal, so if <b>DepositAmount</b> is + specified (and not '0.0'), then the listing must offer + 'PayPal' as a payment method (in addition to the payment methods + offered for the full payment). Unlike other listings, PayPal is not + automatically added to a Motors listing even if the seller has a + PayPal preference set in My eBay. The seller also needs to have a + linked PayPal account in order to require a deposit.<br> + <br> + The deposit amount appears in the shipping, payment details and return policy section of the + View Item page.<br> + <br> + <b>For ReviseItem and related calls</b>: If the listing + has no bids, the seller can add or lower a deposit; and they can + increase the deposit if the listing doesn't require Immediate Payment. + The seller can also remove the Immediate Payment option (if any). + If the listing has bids, the seller can only lower an existing + deposit; but not add or increase a deposit. The seller can't remove + Immediate Payment when a listing with a deposit has bids. + + + 0.0 + 2000.0 + 0.0 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This field applies to eBay Motors (US and CA) vehicles listings. If the seller is requiring + that the buyer make a deposit on the vehicle, the <b>DepositType</b> value must be + included and set to 'OtherMethod'. Otherwise, specify 'None' (or don't pass in <b>DepositType</b>). + + + None + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + This type defines the <b>PaymentHoldDetails</b> container, which + consists of information related to the payment hold on the order, including the + reason why the buyer's payment for the order is being held, the expected + release date of the funds into the seller's account, and possible action(s) the + seller can take to expedite the payout of funds into their account. + + + + + + + Timestamp that indicates the expected date in which eBay/PayPal will + distribute the funds to the seller's account. This is not a firm date and + is subject to change. This field is only returned after checkout is complete and if the <b>PaymentHoldStatus</b> indicates a hold has been placed on payment. + + + + GetOrders +
DetailLevel: none
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none,ReturnAll
+ Conditionally + + + + + + + + Container consisting of one or more <b>RequiredSellerAction</b> fields. + <b>RequiredSellerAction</b> fields provide possible actions that a seller can take to + expedite the release of funds into their account. + + + + GetOrders +
DetailLevel: none
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none,ReturnAll
+ Conditionally + + + + + + + + Integer value that indicates the number of possible actions that a seller + can take to possibly expedite the release of funds into their account. This + value should equal the number of <b>RequiredSellerAction</b> + fields contained in the <b>RequiredSellerActionArray</b> + container. + + + + GetOrders +
DetailLevel: none
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Enumerated value that indicates why the buyer's payment for the order is + being held by PayPal instead of being distributed to the seller's account. + A seller's funds for an order can be held by PayPal for as little as three + days after the buyer receives the order, but the hold can be up to 21 days + based on the scenario, and in some cases, the seller's lack of action in + helping to expedite the release of funds. + + + + GetOrders +
DetailLevel: none
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none,ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type that contains all possible reasons why the buyer's payment for + the order is being held by PayPal instead of being distributed to the seller's + account. A seller's funds for an order can be held by PayPal for as little as + three days after the buyer receives the order, but the hold can be up to 21 + days based on the scenario, and in some cases, the seller's lack of action in + helping to expedite the release of funds. + + + SellerIsOnBlackList, None + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because the seller is new to selling on eBay. Sellers are + considered "new" until they have met all three criteria below: + <ul> + <li>More than 90 days have passed since first successful sale</li> + <li>More than 25 domestic sales</li> + <li>More than $250.00 in total sales</li> + </ul> + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because the seller has been classified as a Below Standard + seller. + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because an eBay Buyer Protection case has been filed against + the order. If this value is returned, the seller can expedite the release + of PayPal funds into their account by resolving the eBay Buyer Protection + case, as indicated by a value of 'ResolveeBPCase' returned in a + <b>PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction</b> + field. + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because the seller has recently been reinstated as an active eBay + seller after their account went through a suspension/restricted period. + <br/><br/> + After a seller's account is suspended and then reinstated, that seller is + treated as a new seller, and must meet the same requirements that a new + seller must meet to get beyong the "New Seller" status. + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because the seller is classified as a casual seller on eBay. + + + + + + + This value indicates that the buyer's payment for the order is being held + by PayPal because the seller's PayPal account (identified in + <b>Transaction.PayPalEmailAddress</b>) is new and is not + fully set up to receive funds. + + + + + + + This value indicates that the reason for the buyer's payment for the order + being held by PayPal is not known. + + + + + + + This value is reserved for internal or future use. + + + + + + + This value is returned if the reason for the buyer's payment for the order + being held by PayPal cannot be classified by any of the other enumeration + values. + + + + + + + This value is reserved for internal or future use. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Enumerated type that contains the list of possible values that can be returned + in the PaymentHoldStatus container. + + + ReleaseFailed + + + + + + + This value indicates a possible issue with a buyer. If this value is returned, + the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid + in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field + is returned as PaidWithPayPal in GetMyeBayBuying. + + + + + + + This value indicates a possible issue with a seller. If this value is returned, + the TransactionArray.Transaction.SellerPaidStatus field is returned as + PaidWithPayPal in GetMyeBaySelling, and the + TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal + in GetMyeBayBuying. + + + + + + + This value indicates that a payment hold on the item has been released. + + + + + + + This value indicates that there is no payment hold on the item. + + + + + + + This value indicates that there is a "new seller hold" on the item. PayPal + may hold payments to a new seller for up to 21 days. + Sellers are + considered "new" until they have met all three criteria below: + <ul> + <li>More than 90 days have passed since first successful sale</li> + <li>More than 25 domestic sales</li> + <li>More than $250.00 in total sales</li> + </ul> + + + + + + + This value indicates that there is a payment hold on the item. + + + + + + + This value indicates that the process for the release of funds for the + order has been initiated. + + + + + + + This value indicates that the funds are available in the seller's PayPal + account. + + + + + + + This value is no longer used. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Contains details payment information + + + + + + + Contains payment information + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + + This type contains information about the way a buyer payment is allocated for a specified order. + + + + + + + Contains information about the funds allocated to one payee from a buyer payment for a specified order. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This enumerated type indicates the type of payment instructions included in the shipping package. + + + + + + + This enumeration value indicates that payment instructions were included in the shipping package for the 'Pay Upon Invoice' order. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the Payment Method feature. If the field is + present, the corresponding feature applies to the category. The field is returned + as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Used for specifying items for which a specific payment method or methods are accepted. + + + + + + + PayPal payment method. + + + + + + + PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). + + + + + + + Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). + + + + + + + + + + + + + PaisaPayEscrowEMI (Equal Monthly Installments) payment method. The PaisaPayEscrowEMI payment method is only for the India site (site ID 203). + + + + + + + + + + This type is deprecated; use + <b>GetCategoryFeatures</b> with <b>PaymentMethods</b> as a + <b>FeatureID</b> value in the request. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This enumerated type is not used. + + + + + + + This value indicates that the new eBay payment process is enabled for this category. + + + + + + + This value indicates that non-standard payments is enabled for this category. + + + + + + + This value indicates that the new eBay payment process is excluded for this category. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + The PaymentOptionsGroupEnabled field is returned in the GetCategoryFeature response if the Payment Options Group feature + applies to the category. The field is returned as an empty element. The Payment Options Group feature is only applicable to + DE and AT listings. + + + + + + + + + + + Type defining the values that can be returned in the <b>eBayPaymentStatus</b> + field of order management calls. These values indicate the current status of the buyer's + payment for an order. + + + + + + + This value indicates that the buyer's payment for the order has cleared. A + <b>CheckoutStatus.eBayPaymentStatus</b> value of 'NoPaymentFailure' + and a <b>CheckoutStatus.Status</b> value of 'Complete' indicates that + checkout is complete. + + + + + + + This value indicates that the buyer's eCheck bounced. This value is only applicable + if the seller accepts eChecks as a form of payment. + + + + + + + This value indicates that the buyer's payment via a credit card failed. This value + is only applicable if the seller accepts credit cards as a form of payment. + + + + + + + This value indicates that the seller reported the buyer's payment as failed. + + + + + + + This value indicates that the buyer's PayPal payment is in process. This value + is only applicable if the buyer has selected PayPal as the payment method. + + + + + + + This value indicates that the buyer's non-PayPal payment is in process. This value + is only applicable if the buyer has selected a payment method other than PayPal. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Contains detaled payment transaction information. + + + + + + + payment transaction's status + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The person who paid the money + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The person who received the money + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The time when the payment is paid + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + payment amount + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The unique identifier of a payment transaction. This field is not returned if the <b>Payee</b> field's <b>type</b> attribute is <code>eBayPartner</code>. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Fee Amount is a positive value and Credit Amount is a negative value. + + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The unique identifier of an eBay Now payment transaction. This field is only returned for an eBay Now order that has been paid for. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the possible states of a payment transaction. This type is used by several containers in order management-related calls. + + + + + + + This value indicates that the payment transaction failed. + + + + + + + This value indicates that the payment transaction succeeded. + + + + + + + This value indicates that the payment transaction is pending. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type contains details about the allocation of funds to one payee from a buyer payment for a specified order. + + + + + + + The current status of a buyer payment that is allocated to a specified payee. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The person or organization who submitted the payment. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The person or organization who is to receive the payment allocation. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The date and time when the payment is received by the payee. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The amount of the payment that is allocated to the payee. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A unique transaction ID for the payment. + <br/><br/> + This field is not returned if the <strong>Payee</strong> field's <strong>type</strong> attribute is <code>eBayPartner</code>. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Fee Amount is a positive value and Credit Amount is a negative value. + <br/><br/> + This field is not returned if the <strong>Payee</strong> field's <strong>type</strong> attribute is <code>eBayPartner</code>. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The payment transaction ID. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + For GetSellerPayments, indicates the type of Half.com payment being + made (sale or refund). + + + + + + + (out) The buyer paid the seller. + Applicable to Half.com. + + + + + + + (out) The seller issued a refund to the buyer. + Applicable to Half.com. + + + + + + + For eBay internal use. + + + + + + + For eBay internal use. + + + + + + + All other payment types. + + + + + + + + (out) The buyer paid the seller for a rental extension. + Applicable to Half.com only. + + + + + + + (out) The buyer paid the seller for a rental buyout. + Applicable to Half.com only. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the Contains details payment information + + + + + + + Contains payment information + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type defines the <strong>MonetaryDetails</strong> container, which consists of detailed information about one or more exchanges of funds that occur between the buyer, seller, eBay, and eBay partners during the lifecycle of an order, as well as detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a <strong>Payment</strong> container. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This container consists of an array of one or more <strong>Refund</strong> containers, and each <strong>Refund</strong> container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item. + <br/><br/> + This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the <strong>ORDER.RETURNED</strong> notification of the Inbound Notifications API. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumeration type that contains the payout methods available to DE and AT sellers for orders going through the + new eBay payment process flow. Once a DE or AT seller has accepted the supplemental user agreement for the new + eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will + distribute seller payouts to this account. + <br><br> + Currently, this enumerated type is not applicable since the new eBay payment process on + the German and Austrian sites has been put on hold indefinitely. + + + + + + + This value indicates that the seller wants eBay to distribute payouts to their PayPal account. + + + + + + + This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT + (Electronic Funds Transfer). + + + + + + + This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) + account. + + + + + + + + + + Type defining the <b>Performance</b> container returned in the + <b>GetSellerDashboard</b> response. The <b>Performance</b> + container consists of the seller's overall selling performance rating on all eBay sites + on which the seller is sellling, as well as any alerts related to performance. + + + + + + + The eBay site(s) on which the seller's performance is being evaluated. + <br /> + A seller's performance status is evaluated for three specific regions: US, + UK/Ireland, and Germany/Switzerland/Austria. The <b>Site</b> field is + repeated to show all sites in each region, if applicable. + + + + GetSellerDashboard + Always + + + + + + + + This field indicates the seller's performance rating. This rating is an overall + performance for the eBay site(s) found in the <b>Site</b> field(s). + + + + GetSellerDashboard + Always + + + + + + + + The <b>Performance.Alert</b> container is only returned if eBay has + posted one or more informational or warning messages related to the seller's + performance rating. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Performance status. + + + + + + + You are a Top-Rated seller. + + + + + + + Your seller performance rating is Above Standard. + + + + + + + Your seller performance rating is Standard. + + + + + + + Your seller performance rating is Below Standard. + + + + + + + Reserved for internal use. + + + + + + + + + + Type defining the time periods used when evaluating the number of buying policy + violations and unpaid item strikes that a buyer has against their account. + + + + + + + This value is no longer used. + + + + + + + This value indicates that the evaluation period is set back 30 days from the + present date. + + + + + + + This value indicates that the evaluation period is set back 180 days from the + present date. + + + + + + + This value indicates that the evaluation period is set back 360 days from the + present date. + + + + + + + This value indicates that the evaluation period is set back 540 days from the + present date. + + + + + + + This value is reserved for future or internal use. + + + + + + + + + + Specifies the type of image display used in a listing. Some options are + only available if images are hosted through eBay Picture Services (EPS). + Cannot be used with Listing Designer layouts (specified in Item.ListingDesigner). + + + SiteHostedPictureShow, SlideShow, VendorHostedPictureShow + + + + + + + No special image display options. Valid for US Motors listings. + + + + + + + + + + + + + + Increase the size of each image and allow buyers to enlarge images + further. Only available for site-hosted (EPS) images. Not valid for US Motors + listings. For all sites that do not automatically upgrade SuperSize to + PicturePack (see note below), specifying no SuperSize-qualified images is now + accepted in the request. + <br><br> + <span class="tablenote"><b>Note:</b> + SuperSize is automatically upgraded to PicturePack for the same SuperSize + fee on the US Motors Parts & Accessories Category and US (site ID 0) + and CA (site ID 2) and CAFR (site ID 210). This upgrade applies + only to EPS images. + </span> + <br><br> + + + + + + + Increase the number of images displayed. This is only available for + images hosted with eBay. See GetCategoryFeatures and the + online Help (on the eBay site) for additional information. + <br><br> + Picture Pack applies to all sites + (including US Motors), except for NL (site ID 146). You can specify a minimum of + one EPS picture, or no SuperSize-qualified EPS pictures in the request. For + the NL site, PicturePack is replaced with SuperSize. + + + + + + + + + + + + + + + + + + + + + This is valid for US Motors listing only. For other listings, use SuperSize. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type defines the <strong>PickupDetails</strong> container, which contains an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + Container consisting of an In-Store pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. + <br/><br/> + This container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + + + + + The <b>PickupDropOffEnabled</b> field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the "Click and Collect" feature. This field will be returned as long as 'PickupDropOffEnabled' is included as a <b>FeatureID</b> value in the call request or no <b>FeatureID</b> values are passed into the call request. + <br/><br/> + Currently, the "Click and Collect" feature is only available on the eBay UK site (site ID=3) and eBay Australia site (site ID=15). + <br/><br/> + To verify if a specific category supports the the "Click and Collect" feature, pass in a <b>CategoryID</b> value in the request, and then look for a 'true' value in the <b>PickupDropOffEnabled</b> field of the corresponding Category node (match up the <b>CategoryID</b> values if more than one Category IDs were passed in the request). + + + + + + + + + + + Complex type defining the <b>PickupInStoreDetails</b> container, that is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup or Click and Collect. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. The Click and Collect feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + </span> + + + + + + + This field is used in Add/Revise/Relist calls to enable the listing for In-Store Pickup. To enable the listing for In-Store Pickup, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + <br/><br/> + In addition to setting the <b>EligibleForPickupInStore</b> boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the In-Store Pickup option on a multi-quantity, fixed-price listing: + <ul> + <li>Have inventory for the product at one or more physical stores tied to the seller's account. By using the REST-based <b>Inventory Management API</b> API, sellers associate physical stores to their account by using the <b>AddInventoryLocation</b> call, and add product inventory to one or more of these stores by using the <b>AddInventory</b> call. For more information on the <b>Inventory Management API</b>, see the <a href="../../../../store-pickup/Concepts/InStorePickupGuide.html" target="_blank">In-Store Pickup Users Guide</a>;</li> + <li>Include the seller-defined SKU value of the product(s) in the call request. For a single-variation listing, the SKU value would be specified in the <b>Item.SKU</b> field, and for a multi-variation listing, the SKU value(s) would be specified in the <b>Item.Variations.Variation.SKU</b> field(s);</li> + <li>Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: + <ul> + <li>Include the <b>Item.AutoPay</b> flag in the call request and set its value to 'true';</li> + <li>Include only one <b>Item.PaymentMethods</b> field in the call request and set its value to 'PayPal';</li> + <li>Include a valid PayPal payment address in the <b>Item.PayPalEmailAddress</b> field.</li> + </ul> + </li> + </ul> + <br/><br/> + When a seller is successful at listing an item with the In-Store Pickup feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see the "Available for In-Store Pickup" option on the listing, along with information on the closest store that has the item. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + false + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + GetSellerList + GetItemShipping + Conditionally + + + GetItem + Conditionally + + + + + + + + This field is used in Add/Revise/Relist calls to enable the listing for the "Click and Collect" feature. To enable the listing for the "Click and Collect" feature, the seller includes this boolean field and sets its value to 'true'. A seller must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + <br/><br/> + In addition to setting the <b>EligibleForPickupDropOff</b> boolean field to 'true', the merchant must also perform the following actions in an Add/Revise/Relist call to enable the "Click and Collect" option on a listing: + <ul> + <li>Have inventory for the product at one or more physical stores tied to the merchant's account.</li> + <li>Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: + <ul> + <li>Include the <b>Item.AutoPay</b> flag in the call request and set its value to 'true';</li> + <li>Include only one <b>Item.PaymentMethods</b> field in the call request and set its value to 'PayPal';</li> + <li>Include a valid PayPal payment address in the <b>Item.PayPalEmailAddress</b> field.</li> + </ul> + </li> + </ul> + <br/><br/> + When a UK merchant is successful at listing an item with the "Click and Collect" feature enabled, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the "Available for Click and Collect" option on the listing, along with information on the closest store that has the item. + + + + false + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + GetSellerList + GetItemShipping + Conditionally + + + GetItem + Conditionally + + + + + + + + + + + + Simple type defining all possible local pickup methods for buyers. A <strong>PickupMethodCodeType</strong> value is always returned under the <strong>PickupOptions</strong> and <strong>PickupMethodSelected</strong> containers. + + + + + + + This value indicates that the buyer will pick up the In-Store Pickup item at the merchant's physical store. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A merchant must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + This value indicates that the buyer will pick up the "Click and Collect" item at the merchant's physical store. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A merchant must be eligible for the "Click and Collect" feature to list an item that is eligible for "Click and Collect". At this time, the "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <strong>PickupMethodSelected</strong> container, which consists of details related to the selected local pickup method (In-Store Pickup or "Click and Collect"), including the pickup method, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. The "Click and Collect" feature is only available to large merchants on the eBay UK (site ID - 3) and eBay Australia (Site ID - 15) sites. + </span> + + + + + + + This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods. + </span> + + + PickupMethodCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + The unique identifier of the merchant's store where the In-Store Pickup item will be picked up. The <strong>PickupStoreID</strong> is picked up by eBay based on the <strong>LocationID</strong> value that is set by the merchant in the <strong>Inventory Management API</strong>. This field is always returned with the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + This field indicates the current status of the local pickup order. The value of the <strong>PickupStatus</strong> field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the <strong>Inbound Notifications API</strong>. This field is always returned with the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + The unique reference number defined by the merchant to track In-Store Pickup orders. The <strong>MerchantPickupCode</strong> is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the <strong>Inbound Notifications API</strong>. This field is only returned with the <strong>PickupMethodSelected</strong> container if it set by the merchant. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <strong>PickupOptions</strong> container, which consists of an In-Store pickup method and the priority of the pickup method. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + This value indicates an available In-Store pickup method. This field is always returned with the <strong>PickupOptions</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, 'InStorePickup' is the only available pickup method; however, additional pickup methods may be added to list in future releases. + </span> + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + PickupMethodCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. This field is always returned with the <strong>PickupOptions</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Conditionally + + + + + + + + + + + + Simple type defining all possible states for an In-Store Pickup order. The value of the <strong>PickupStatus</strong> field (returned under the <strong>PickupMethodSelected</strong> container) can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the <strong>Inbound Notifications API</strong>. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + This value indicates that the current status value of the In-Store Pickup order is invalid. + + + + + + + This value indicates that the current status value of the In-Store Pickup order is not applicable. + + + + + + + This status indicates that the In-Store Pickup order has yet to be acknowledged by the merchant. This is typically the state before the merchant sends the <strong>ORDER.READY_FOR_PICKUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order is ready to be picked up by the buyer. This state occurs after the merchant sends the <strong>ORDER.READY_FOR_PICKUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order has been picked up by the buyer. This state occurs after the merchant sends the <strong>ORDER.PICKEDUP</strong> notification to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the product was out of stock. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "OUT_OF_STOCK") to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer rejected the item. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "BUYER_REJECTED") to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order has been cancelled by the merchant, because the buyer never showed up to pick up the item. This state occurs after the merchant sends the <strong>ORDER.PICKUP_CANCELED</strong> notification (with the <strong>CANCEL_TYPE</strong> parameter in the notification payload set to "BUYER_NO_SHOW") to eBay through the <strong>Inbound Notifications API</strong>. + + + + + + + This status indicates that the In-Store Pickup order has been cancelled, and the exact reason is not available. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Contains the data for the pictures associated with an item. + Not applicable to Half.com. + + + + + + + <a name="galleryTypeField"></a> + Specifies the Gallery enhancement type for the listing. All listings automatically get the + <b>Gallery</b> enhancement at no cost, so you never need to set this field to Gallery. Note, the Gallery types are accumulative. This means if you use <b>Plus</b>, you also + get the features of <b>Gallery</b> and if you use + <b>Featured</b>, you get all the features of + <b>Gallery</b> and <b>Plus</b>. Passing the values + <b>Plus</b> and <b>Featured</b> together in the same request will return + an error. + + <br/><br/> + Do not use the <b>GalleryURL</b> field to specify the Gallery image. + The Gallery image will be the first <b>PictureURL</b> + in the array of <b>PictureURL</b> fields. This URL will be automatically + set as the value of <b>GalleryURL</b>. If the first value + of <b>PictureURL</b> is a self-hosted picture, it will be + uploaded to EPS (eBay Picture Services) and a thumbnail version will be + generated, which will be used on the Search Results Page. + + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements.</a> + </span> + + <a name="galleryPicRules"></a> + + <br> + When <b>GalleryType</b> value is set and there are multiple images are specified, eBay checks the available image URLs in the + following order to determine which URL to use for the Gallery image: + <br> + <b>Picture Selection Rules</b> + <br> + + <ol> + <li> + If specified, use the URL in <b>GalleryURL</b>. + </li> + + <li> + Otherwise, if <code>ProductListingDetails.UseStockPhotoURLAsGallery=true</code>, use the eBay stock photo. + </li> + + <li> + Otherwise, use the value of the first <b>PictureURL</b> in the array + of <b>PictureURL</b> fields, if any. + </li> + + <li> + Otherwise, if <code>ProductListingDetails.ProductID</code> is specified, + use the eBay stock photo for that ProductID (eBay resets + <b>UseStockPhotoURLAsGallery</b> to true in this case). + </li> + </ol> + + You cannot remove <b>Gallery</b>, <b>Plus</b>, or <b>Featured</b> when revising an item, + however you can upgrade to a higher feature. When you upgrade, the original + feature fee is credited, and the new feature fee is charged. + + + + AddItem + AddItems + AddSellingManagerTemplate + AddItem + AddItems + GetItemRecommendations + AddItem + AddItems + RelistItem + AddItem + AddItems + ReviseItem + AddItem + AddItems + ReviseSellingManagerTemplate + AddItem + AddItems + VerifyAddItem + AddItem + AddItems + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + No + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Picture Selection Rules + #galleryPicRules + complete details on how eBay selects a Gallery thumbnail. + + + + + + + + <a name="GalleryURLField"> </a> + <b>Supported only in Production (not in Sandbox)</b>. + <br/><br/> + The URL for a picture used as the Gallery thumbnail. + The image used for the Gallery thumbnail must comply to the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a> and be in JPEG, BMP, TIF, or GIF graphic format. + See <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html#IntroductiontoPicturesinListings">Introduction to Pictures in Listings</a> + for additional validation rules. + <br/><br/> + The <b>GalleryURL</b> value is ignored if + <b>GalleryType</b> is 'None' or unspecified. If the value of <b>GalleryType</b> is + <b>Gallery</b> or <b>Featured</b>, you can either specify <b>GalleryURL</b> or allow eBay + to use another picture that you have included in the listing. + + <br><br> + <b>How eBay Manages Pictures</b> + <br/> + + <ul> + <li> + If there is a <b>PictureURL</b> and a <b>GalleryURL</b>, the <b>PictureURL</b> will replace the <b>GalleryURL</b>. + </li> + + <li> + eBay selects a Gallery thumbnail from picture URLs in the request using either the <b>GalleryURL</b> or the first <b>PictureURL</b>, based on the <a href="#galleryPicRules">selection rules</a> that consider which URLs were specified and whether an eBay stock photo exists for the item. eBay selects a picture regardless of whether you specified <b>GalleryType</b> or <b>GalleryURL</b>. + </li> + + <li> + A stock photo will not be generated for an item unless <b>UseStockPhotoURLAsGallery</b> and <b>IncludeStockPhotoURL</b> are both set to 'true'. If this is not done and the item does not have a <b>PictureURL</b>, the item will not have a Gallery picture. + </li> + + <li> + If the first <b>PictureURL</b> field in the request is set to the "clear picture" URL (<code>http://pics.ebay.com/aw/pics/dot_clear.gif</code>): + + <ul> + <li> + eBay tries to use the picture referenced by <b>GalleryURL</b> as the gallery thumbnail. If <b>GalleryURL</b> has not been specified, a blank (camera-less) gallery thumbnail displays in the search results and at the top of the listing page. + </li> + + <li> + You can specify <code>Item.ProductListingDetails.UseStockPhotoURLAsGallery</code> or <code>Item.ProductListingDetails.UseStockPhotoURL</code> to true, and eBay will use a stock photo, if available, for the gallery thumbnail and for the picture at the top of a listing. + + <br/><br/> + A gallery picture isn't generated if <b>UseStockPhotoURLAsGallery</b> and <b>IncludeStockPhotoURL</b> are set to false (or not set) and no alternative picture is in <b>PictureURL</b>. + </li> + </ul> + </li> + </ul> + + <br/> + To remove <b>GalleryURL</b> when revising or relisting an item, use <b>DeletedField</b>. When you revise + an item, you can only remove <b>GalleryURL</b> if the item has at least one <b>PictureURL</b> or a + stock photo to use instead. If the item has bids (or items have been sold) or the + listing ends within 12 hours, you can add <b>GalleryURL</b> or change its value, but you + cannot remove the <b>GalleryURL</b> value if it was previously specified. Not applicable to eBay Motors listings. + + <br><br> + <span class="tablenote"><b>Note:</b> + If a URI contains spaces, replace them with <code>%20</code>. + For example, <code>http://example.com/my image.jpg</code> must be + submitted as <code>http://example.com/my%20image.jpg</code> to + replace the space in the image file name. + </span> + + + 1024 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + SecondChanceOffer + WatchList + LostList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Picture Selection Rules + #galleryPicRules + complete details on how eBay selects a Gallery thumbnail. + + + (ReviseItem) DeletedField + ReviseItem.html#Request.DeletedField + + + + + + + + Specifies the type of image display used in a listing. Some options are + only available if images are hosted through eBay Picture Services (EPS). + eBay determines this by parsing the associated <b>PictureURL</b>. + <br><br> + You cannot use <b>PhotoDisplay</b> in combination with Listing Designer layouts. + Specify 'None' or do not add <b>PhotoDisplay</b> when <b>ListingDesigner.LayoutID</b> + is a value other than 0. + <br><br> + Some <b>PhotoDisplay</b> options can result in listing fees, even when the item is relisted. If you are relisting an item that was originally listed with a <b>PhotoDisplay</b> option, and you do not want that <b>PhotoDisplay</b> enhancement in your relisted item, you need to specifically + remove <b>PhotoDisplay</b> in your <b>RelistItem</b> call (or <b>RelistFixedPriceItem</b>, as applicable) by + setting <b>PhotoDisplay</b> to None. Use <b>VerifyRelistItem</b> to review your listing fees before you + relist an item. + + + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + SlideShow + Conditionally + + + GetBidderList + SlideShow + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ SlideShow + Always + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + No + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Fees Resulting from Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-Fees.html + + + + + + + + Contains a URL for a picture associated with an item. + The picture may be hosted on eBay Picture Services (EPS) or self-hosted. + However, some options require the picture to be hosted through EPS and eBay + can determine where the picture is being hosted by parsing the value specified in the request. + + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images whether they are hosted by EPS or self-hosted must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements.</a> + </span> + + A listing can have up to 12 EPS-hosted or self-hosted pictures. But you cannot mix self-hosted and EPS-hosted pictures in one listing. To specify multiple pictures, send each URL in a separate, <b>PictureURL</b> element. + In most cases, the first URL is also used for the picture on the View Item page. + + <br><br> + On the US eBay Motors site (for all vehicle listings), and on the eBay Canada site for + motors, the picture pack of a listing can contain up to 24 pictures. + + <br><br> + If a URI contains spaces, replace them with <code>%20</code>. + For example, <code>http://example.com/my image.jpg</code> must be + submitted as <code>http://example.com/my%20image.jpg</code> to + replace the space in the image file name. + + <br/><br/> + <span class="tablenote"><b>Note: </b> + Embedding pictures in the description (by using IMG tags) is discouraged. The recommended process is to specify the image URLs using <b>PictureURL</b>. + </span> + + If you embed pictures in the description instead of using + <b>PictureURL</b>, but you want a camera icon to appear in the search and listing pages, specify the following "clear picture" URL in <b>PictureURL</b>: + http://pics.ebay.com/aw/pics/dot_clear.gif. + + <br/><br/> + If a listing uses a self-hosted picture (except in the case of a multi-variation listing), the picture will be copied to eBay Picture Services (ESP) and the <code>PictureDetails.PictureURL</code> value returned by <b>GetItem</b> will be an EPS URL. + + <br/><br/> + If there is a <b>PictureURL</b> and a <b>GalleryURL</b>, the <b>PictureURL</b> will replace the <b>GalleryURL</b>. + + <br/><br/> + <b>For VerifyAddItem only:</b> For VerifyAddItem, you can use the following + fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) to verify that + your application is obtaining the correct fees for the quantity of pictures you pass in. + + <br><br> + <b>For ReviseItem and RelistItem only:</b> To remove a picture when + revising or relisting an item, specify <b>PictureDetails</b> with all the pictures that you want the listing to include. That is, you need to completely replace the original set + of URLs with the revised set. To remove all <b>PictureURL</b> fields from a listing, specify + <code>item.PictureDetails.PictureURL</code> in <b>DeletedField</b>. However, note that if the + listing also includes a gallery picture that is based on the first picture in the + listing, you may need to supply an alternate picture to use as the gallery picture if you + delete all <b>PictureURL</b> fields. Pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the listing has already had transactions. + + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours. + </span> + + <br/> + For information about Gallery pictures, see <a href="#GalleryURLField">GalleryURL</a>. + + + 500 + + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ReturnAll
+ 24 + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + Picture Selection Rules + #galleryPicRules + complete details on how eBay selects a Gallery thumbnail. + + + Introduction to Pictures in Item Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + Working with Pictures in an Item Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InListing.html#CopyofaSelfHostedPictureToeBayPictureSer + + + (ReviseItem) DeletedField + ReviseItem.html#Request.DeletedField + + + (RelistItem) <b>GalleryType</b> + RelistItem.html#Request.Item.PictureDetails.GalleryType + + + + + + + + The service hosting the pictures in <b>PictureURL</b>, if any. This information is + primarily useful for Picture Manager subscribers, who pay a flat subscription + fee instead of individual picture fees per listing. Only returned when <b>PictureURL</b> is returned. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + No + + + + + + + + Describes the number of days that the <b>Featured Gallery</b> type applies to a listing. + Applicable values include 'Days_7' and 'LifeTime'. + <br><br> + When a seller chooses <b>Featured</b> as the Gallery type, the listing is highlighted and is + included at the top of search results. This functionality is applicable only for + <b>Gallery Featured</b> items and returns an error for any other Gallery type. Additionally, + an error is returned if the seller attempts to downgrade from Lifetime to limited + duration, but the seller can upgrade from limited duration to Lifetime duration. This + field is not applicable to auction listings. + + + ListingEnhancementDurationCodeType + + AddItem + AddItems + AddSellingManagerTemplate + VerifyAddItem + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + No + + + + + + + + This indicates if the gallery image upload failed and gives a reason + for the failure, such as 'InvalidUrl' or 'ServerDown'. It is not + returned if the gallery image is uploaded successfully. + + + + GetItem + Conditionally + + + + + + + + This indicates the reason the + gallery generation failed, such as, URL for the image is not valid. + This field is returned when <b>GalleryStatus</b> field is returned + and does not appear when the gallery generation is successful. + + + 1024 + + GetItem + Conditionally + + + + + + + + When returned this contains the original URL of a self-hosted pictures, associated with the + item when the item was listed. + + + 500 + 1 + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ + + Working with Pictures in an Item Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InListing.html#CopyofaSelfHostedPictureToeBayPictureSer + + + + + + + + This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the self-hosted picture was uploaded. + + + + GetItem + Conditionally + + + + + + + + + + + + JPG or GIF format. + + + + + + + JPG format. + + + + + + + GIF format. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + Manager account. + + + + + + + + + + + (in) Adds a folder or setting to the account. + + + + + + + + + + + (in) Deletes a folder or setting from the account. + + + + + + + + + + + (in) Renames a folder or picture. + + + + + + + + + + + (in) Moves a picture to the user's default folder in the + default album. If the picture is already there, + then no action occurs. + + + + + + + + + + + (in) Changes a subscription level. + + + + + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + + A small image, thumbnail size. Maximum size 96 pixels. + + + + + + + + + + + A BIBO image. Maximum size 200 pixels. + + + + + + + + + + + A standard size image. Maximum size 400 pixels. + + + + + + + + + + + A large image. Maximum size 500 pixels. + + + + + + + + + + + A very large image. Maximum size 800 pixels. + + + + + + + + + + + The original uploaded image. + + + + + + + + + + + Reserved for internal or future use + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + + (out) Free to Stores users. + + + + + + + + + + + (out) 10 MB of storage. + + + + + + + + + + + (out) 50 MB of storage. + + + + + + + + + + + (out) 125 MB of storage. + + + + + + + + + + + (out) 300 MB of storage. + + + + + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + + + + This type is deprecated as Pictures Manager was retired. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + The size of images generated. + <br/><br/> + <span class="tablenote"><b>Note: </b> + To get the standard website image sizing with Zoom, set the <b>PictureSet</b> field to <b>Supersize</b>. + </span> + + + + + + + Default value for requests. The size for the standard, 3-picture set for item pictures. + + + + + + + Supersize, 4-picture set. + If you specify this value on input, and this value is returned + in the response, then in AddItem or a related call, you must specify <b>Item.PictureDetails.PhotoDisplay.Supersize</b> or <b>Item.PictureDetails.PhotoDisplay.PicturePack</b>. + + + + + + + When returned as output in the call response, the characters after setid may contain this value if a Supersize image cannot be generated. If this value is returned in the response, then in <b>AddItem</b> or a related call, you must specify <b>Item.PictureDetails.PhotoDisplay.Supersize</b> or <b>Item.PictureDetails.PhotoDisplay.PicturePack</b>. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + URL and size information for each generated and stored size. + This data is provided for use in application previews of pictures. + This data is used for display control for specific pictures in the generated imageset. + This container is supplied for all generated pictures. + + + + + + + URL for the picture. + + + + UploadSiteHostedPictures + Always + + + + + + + + Height of the picture in pixels. + + + + UploadSiteHostedPictures + Always + + + + + + + + Width of the picture in pixels. + + + + UploadSiteHostedPictures + Always + + + + + + + + + + + + PictureManager + + + Specifies the service that is used to host a listing's pictures. + + + + + + + (out) The PictureURL images are hosted by eBay Picture Services + and the seller is not a Picture Manager subscriber. + + + + + + + + (out) The PictureURL images are hosted by eBay Picture Manager + and the seller is a Picture Manager subscriber. + + + + + + + (out) The PictureURL images are not hosted by eBay. + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the picture was uploaded. + + + + + + + The URL of an eBay Picture Services (EPS) image. This image is created when a seller uploads a self-hosted image using the <b>UploadSiteHostedPictures</b>, <b>AddItem</b> or <b>AddFixedPriceItem</b> call. + + + 150 + 24 + + GetItem + Conditionally +
DetailLevel: none,ItemReturnDescription,ReturnAll
+ + + + + + + + The URL of seller's self-hosted image. + + + 150 + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ + + + + + + + + + + + Values to be used in choosing that an uploaded picture is added to the available pictures on the eBay site. + + + + + + + Specifies that an uploaded picture is added to the pictures available to a + seller on the eBay site. + + + + + + + Specifies, first, that all pictures available to a seller on the eBay site are + removed, and then second, that the currently uploaded picture is made + available to the seller. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + The watermark choice made by the seller. + + + + + + + SellerId watermark option for EPS upload functionality. + + + + + + + Icon watermark option for EPS upload functionality. + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + Defines variation-specific pictures associated with one + VariationSpecificName (e.g., Color) whose values differ across variations. + + + + + + + One aspect of the variations that will be illustrated in the + pictures for all variations. For example, if each variation + is visually distinguished by color and the pictures show + the different colors available, then specify "Color" as the name. + The name must match one of the names specified in the + <b>VariationSpecifics</b> container. + <br><br> + This field is required in each <b>Item.Variations.Pictures</b> container that is used. + + + 40 + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + A container consisting of one or more picture URLs associated with a variation + specific value (e.g., color=blue). For example, suppose a listing contains blue + and black color variations, and <b>VariationSpecificName=Color</b>. + In this case, one picture set could contain pictures of the blue shirts (e.g., + front view, back view, and close-up of a trim detail), and another picture set + could contain pictures of the black shirts. + <br><br> + A variation specific picture set can consist of up to 12 images hosted by eBay + Picture Services (EPS) or self-hosted (hosted outside of eBay) pictures. + The eBay Picture Services and self-hosted images can never + be combined into the same variation specific picture set. + <br><br> + At least one picture set is required if the <b>Pictures</b> node + is present in the request. You are not required to provide pictures + for all values that correspond to the variation specific name. + For example, a listing could have pictures depicting the blue and + black color variations, but not the pink variations. + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>. + </span> + + + + AddFixedPriceItem + VerifyAddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + + + + + This type has been deprecated, as the <b>PolicyCompliance</b> container is no longer returned in <b>GetSellerDashboard</b>. + + + + + + + + This field is deprecated. + + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + + + This enumerated type is deprecated along with <b>PolicyComplianceDashboardType</b>, which was the only complex type using this simple type. + + + + + + + + You're doing a good job of selling and are in line with eBay policies. + <br><br> + Be sure to continue to follow eBay rules in your selling activities. While your + risk of restrictions is low, a future policy violation could result in a lower + policy-compliance rating. + + + + + + + You could do a better job of following eBay policies and you are at risk of + having your listings canceled. + <br><br> + Check to see what policies you violated and what steps you can take to avoid + those mistakes in the future. Additonal violations could cause eBay to cancel + your listings. + + + + + + + You are doing a poor job of following the eBay selling policies and rules. + Your selling status and privileges are at risk. + <br><br> + Check to see what policies you have violated and take steps improve your + selling practices. Additonal violations could cause eBay to cancel your + listings and/or add restrictions on your account. You could lose your + PowerSeller status and privileges. + + + + + + + You need to increase your compliance with the eBay selling policies and + rules immediately. Your account is at risk and may be suspended. + <br><br> + Check the policies you violated and improve your selling practices immediately. + Additonal violations could cause eBay to cancel your listings, add restrictions + on your account, suspend your account, or take other measures. You could + lose your PowerSeller status and privileges. + + + + + + + Reserved for internal or future use. + + + + + + + + + [Selling] The details about the range used to calculate policy violations. + + + GeteBayDetails + Conditionally + + + + + + + The number of days (last 60 days, last 180 days, etc.) within which the buyer violation reports are calculated. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + The description of the Period, such as 'Last Month', 'Second Quarter', 'First Half or the Year'. This field is often used as + a label for displaying Period data. This is applicable only to sellers. + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type defining the <b>PowerSellerStatus</b> container returned in the + <b>GetSellerDashboard</b> response. The <b>PowerSellerStatus</b> + container is only returned if the seller making the call is a Power Seller. + + + + + + + This field indicates the seller's eBay PowerSeller tier. PowerSellers are + distinguished in five tiers based on average monthly sales. Benefits and services vary + for each tier. eBay calculates eligibility for each tier on a monthly basis. + + + + GetSellerDashboard + Conditionally + + + eBay US PowerSeller Requirements and Levels + http://pages.ebay.com/services/buyandsell/powerseller/criteria.html + + + + + + + + The <b>PowerSellerStatus.Alert</b> container is only returned if eBay + has posted one or more informational or warning messages related to the seller's + PowerSeller status. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request. + + + + + + + (in) Items listed in the currency implied by the site specified in the + request. + + + + + + + (in) Items located in the country implied by the site specified in the + request. + + + + + + + (in) Items available to the country implied by the site specified in the + request. For the US site, this implies listings from ALL English-language + countries that are available to the US. + + + + + + + (in) Items listed on the site specified in the request, regardless of listing + currency. + + + + + + + (in) Items located in Belgium or listed on one of the two Belgian sites. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Premium Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + + + + + + + + Pricing data returned from the Product Pricing engine. + + + + + + + A product's pricing data (if any) and brief information about the product. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + Defines the source for discount price treatment. + + + + + + + STP stands for Strike Through Pricing. + + + + + + + MAP stands for MinimumAdvertisedPrice + + + + + + + None means neither STP nor MinimumAdvertisedPrice. + + + + + + + MFO means stands for MadeForOutletComparisonPrice. + + + + + + + Reserved for future use. + + + + + + + + + + Specifies whether a listing feature is enabled for this site and whether it is restricted to a set of sellers. + + + + + + + The listing feature is enabled for the site. + + + + + + + The listing feature is disabled for the site. + + + + + + + The listing feature is restricted to PowerSellers. + + + + + + + The listing feature is restricted to TopRatedSellers. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the ProPack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the ProPackPlus feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + This type is deprecated because 3rd Party Checkout was deprecated. + + + + + + + + + This field is no longer applicable as all checkouts go through eBay's checkout flow, + and there is no longer a checkout flow through ProStores. + + + + + + + + + + + + This container contains details about the ProStore seller's store, including the name + of the store, the seller's ProStore user name, and the status of the ProStore store. + This container is always returned with the <b>ProStoresPreference</b> + container. + + + + + + + + + + + + + + + This type defines the <b>ProStoresDetails</b> container, which contains + details about the ProStore seller's store. + + + + + + + The user name associated with the seller's ProStore store. This field is always + returned with the <b>ProStoresDetails</b> container. + + + 200 + + GetUser + GetUserPreferences + Conditionally + + + + + + + + The name of the seller's ProStore store. This field is always returned with the + <b>ProStoresDetails</b> container. + + + 200 + + GetUser + GetUserPreferences + Conditionally + + + + + + + + This value indicates if the seller's ProStore store is enabled or disabled. This field + is always returned with the <b>ProStoresDetails</b> container. + + + + GetUser + GetUserPreferences + Conditionally + + + + + + + + + + + + Values indicate whether product creation is enabled, disabled or required for a category. + + + + + + + Product creation is not supported for the category. + AddItem family calls can still list with product. + + + + + + + Product Creation is supported for the category. + AddItem family calls can still list with product but can go through new product creation flow. + + + + + + + Product Creation is required for the category. + AddItem family calls have to list with a product. If no product exists can go through new product creation flow. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the product creation enable feature. If a field of this type is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + + + The average start price (minimum bid), if any, of completed auction items that were listed + with Pre-filled Item Information from this product. + + + + GetItemRecommendations + Conditionally + PricingRecommendations + + + + + + + + The average sold price (winning bid, Buy It Now price, or fixed price), if any, of + completed items that were listed with Pre-filled Item Information from this product. + + + + GetItemRecommendations + Conditionally + PricingRecommendations + + + + + + + + Title associated with the product. This value can be used as the basis for a + suggested listing title. If the title is longer than 80 characters, your + application should make sure the suggested title has a maximum length of 80 + characters so that it will be valid for the AddItem family of calls. + + + 1024 + + GetItemRecommendations + Conditionally + + + + + + + + Indicates that the product has changed or will soon change (usually due to a migration + from one catalog to another catalog). Typically, this field is returned for up to 90 + days for a given product. After that, the product either no longer returns this field + or the product is no longer returned (depending on the state change). + <br><br> + This data is primarily applicable to catalogs used by the US, Germany, Austria, and + Switzerland sites. Other sites may undergo catalog changes in the future. + + + + GetItemRecommendations + Conditionally + + + + + + + + + Unique identifier for the product. See the Developer's Guide for information about + eBay product IDs. If the primary and secondary category are both catalog-enabled, this + ID corresponds to the primary category. + + + 4000 + + GetItemRecommendations + Conditionally + + + + + + + + + + Contains product information that can be included in a listing. + Applicable for listings that use eBay's Pre-filled Item Information feature. + See <a href="http://developer.ebay.com/DevZone//guides/ebayfeatures/Development/ItemSpecifics-CatalogDetails.html">Pre-filling Item Specifics with Product Details</a> + for details on working with Pre-filled Item Information. + + + + + + + eBay's unique identifier for a specific version of a product. + This is the long alphanumeric ID that is returned from + GetProductSearchResults and related calls. + See <a href="http://developer.ebay.com/DevZone//guides/ebayfeatures/Development/ItemSpecifics-CatalogDetails.html">Pre-filling Item Specifics with Product Details</a> + for information about finding this type of + product ID. (For the shorter product ID (ePID) value that is + displayed on the eBay Web site, see ProductReferenceID instead.)<br> + <br> + If the primary and secondary categories are both catalog-enabled, + this ID should correspond to the primary category + (not the secondary category).<br> + <br> + In item-listing requests, if you pass in an old product ID, + eBay lists the item with the latest version of the product and the + latest product ID, and the call returns a warning indicating that + the data has changed.<br> + <br> + Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, + replacing, deleting, or merging some products (as a result of migrating from one + catalog data provider to another). If you specify one of these products in a request, + the call may return the product with a warning, or it may fail with an error if the + product has been deleted. + + + 4000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying + UserDefinedList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + If true, indicates that the item listing includes the stock photo. To use an + eBay stock photo in an item listing, set IncludeStockPhotoURL to true. If a + stock photo is available, it is used at the top of the View Item page and in + the Item Specifics section of the listing. + <br/><br/> + <span class="tablenote"><b>Note: </b> + If you also include additional images with Item.PictureDetails.PictureURL, the + View Item page will show only these images and the stock photo will <i>not</i> + be shown. + </span> + <br/> + If you use Item.ExternalProductID instead of Item.ProductListingDetails, eBay + sets IncludeStockPhotoURL to true (and you cannot set it to false). In + GetItem, the URL of the stock photo will be returned in StockPhotoURL. If you + set IncludeStockPhotoURL to false, the stock photo does not appear in the + listing at all. + <br> <br> + eBay selects a Gallery thumbnail from image URLs included + in the request (i.e. either GalleryURL or the first PictureURL), using + selection rules that consider which of these URLs has been specified and + whether an eBay stock photo exists for the item. Also, eBay selects an + image regardless of whether you have specified either GalleryType or + GalleryURL. A Gallery fee will only apply if you have set GalleryType to + Plus or Featured (as basic Gallery is free).<br> + <br> + In some cases, if IncludeStockPhotoURL is set to false, no image will be + generated for the Gallery. A common example of this occurrence is when only + GalleryURL has been set in the request (i.e., no PictureURL elements are + defined). In this case, eBay will not use a stock photo, even if it is available. + </span> + <br/><br/> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + No + true + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + Introduction to Pictures in Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InResults.html + Including Pictures in the Search Results Gallery + + + + + + + + If true, specifies that the listing should include additional information about the product, + such as a publisher's description or film credits. Such information is hosted through the eBay site + and cannot be edited. If true, Item.Description is optional in item-listing requests. + <br><br> + <b>For GetItem and related calls</b>: + The eBay site shows the catalog product description in the + product details section of a listing. You cannot download this + pre-filled description text via the API. + To retrieve a URL for the catalog product details page, + see DetailsURL in GetProductSearchResults, GetProductFamilyMembers, + or GetProductSellingPages. Or see DetailsURL in FindProducts in the + Shopping API (which may be easier to use if your application doesn't + support eBay Attributes). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + No + true + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + If true, indicates that the stock photo for an item (if available) is used as the + gallery thumbnail. When listing an item, IncludeStockPhotoURL must also be true and + Item.PictureDetails.GalleryType must be passed in with a value of Gallery or Gallery + Featured (but not both). + <br> <br> + eBay selects a Gallery thumbnail from image URLs included + in the request (i.e. either GalleryURL or the first PictureURL), using + selection rules that consider which of these URLs has been specified and + whether an eBay stock photo exists for the item. Also, eBay selects an + image regardless of whether you have specified either GalleryType or + GalleryURL. A Gallery fee will only apply if you have set GalleryType to + Plus or Featured (as basic Gallery is free on all sites).<br> + <br> + In some cases, if UseStockPhotoURLAsGallery is set to false, no + image will be generated for the Gallery. A common example of this + occurrence is when only GalleryURL has been set in the request (i.e., no + PictureURL elements are defined). In this case, eBay will not use a stock + photo, even if it is available. + </span> + <br> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + No + true + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + Introduction to Pictures in Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InResults.html + Including Pictures in the Search Results Gallery + + + + + + + + Fully qualified URL for a standard image (if any) that is associated with the product. + A seller includes the stock photo in the listing + by setting IncludeStockPhotoURL to 'true'. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying + UserDefinedList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Copyright statement indicating the source of the product information. This information will be + included in the listing with Pre-filled Item Information. Your application should also display + the copyright statement when rendering the Pre-filled Item Information. + If more than one copyright statement is applicable, they can be presented to the + user in alphabetical order. Returned as HTML. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + eBay's short global reference ID for a catalog product. + On the eBay Web site, this is known as the "ePID" or "Product ID". + This type of product ID is a fixed reference to a product + (regardless of version). + Multiple (versioned) ProductID values can be associated with a + single product reference ID. + You can find product reference IDs for products by using FindProducts in the Shopping API. + You can also find the product ID on eBay's Web site + (a numeric value prefixed with "EPID"). + You can pass the value with or without the "EPID" prefix; + for example "EPID228742" or "228742" (without quotes). + <br><br> + If the primary and secondary categories are both catalog-enabled, this ID should + correspond to the primary category (not the secondary category). + <br><br> + Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, + replacing, deleting, or merging some products (as a result of migrating from one + catalog data provider to another). If you specify one of these products in a request, + the call may return the product with a warning, or it may return an error if the + product has been deleted. + + + 38 (42 with "EPID") + + Example of Product on eBay US Site with EPID + http://catalog.ebay.com/Harry-Potter-and-Chamber-Secrets-J-K-Rowling-1999-Hardcover-/228742 + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItemRecommendations + Conditionally + + + + + + + + Fully qualified URL for eBay's product details page, which contains + optional information about the product + (such as a movie's description or film credits). This information is + hosted through the eBay Web site and it cannot be edited. Portions + of the content are protected by copyright. Applications can include + this URL as a link so that end users can view additional descriptive + details about the product.<br> + + + + GetItemRecommendations + Conditionally + + + + + + + + Fully qualified URL for eBay's product details page, which contains optional + information about the product (such as a movie's description or film credits). This + information is hosted through the eBay Web site and it cannot be edited. Portions of + the content are protected by copyright. Applications can include this URL as a link so + that end users can view additional descriptive details about the product. + + + + GetItemRecommendations + Conditionally + + + GetMyeBayBuying + UserDefinedList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates what eBay should do if more than one product matches + the external product ID (ISBN, UPC, EAN, BrandMPN, or + TicketListingDetails). Also see UseFirstProduct as an alternative.<br> + <br> + If true and more than one + match is found, the call fails and the response + returns an error and all matching ProductID values. + This lets you choose one of the ProductIDs to pass in instead. + If false and more than one match is found, the call fails and the + response includes an error but does not return the matching + ProductID values. (This flag has no effect when only one match is + found.) + + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + false + + + + + + + + Indicates what eBay should do if no product match has been found. + If no product match was found and ListIfNoProduct is true, the + item is listed without product information. + (By default, eBay attempts to list the item with product information.)<br> + <br> + <span class="tablenote"><b>Note:</b> + If you omit PrimaryCategory and no product match is found, + the listing will fail because eBay won't be able to determine + a category without a product ID. + </span> + + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + false + + + + + + + + A universal format for identifying products. GTIN is a unique + 8, 12, 13, or 14-digit identifier that some external catalogs use + instead of ISBN, UPC, EAN, or other values. + When you pass in GTIN, eBay attempts to map the value to an ISBN, UPC, or EAN. When you know that a value is an ISBN, UPC, or EAN, + we recommend that you use those fields directly instead of GTIN, + for better performance and accuracy.<br> + <br> + Only used to match catalog products when creating listings. + (In some categories, eBay may also copy the ISBN, UPC, or EAN to the + listing's item specifics. The GTIN is not stored.) + + + 14 + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + + ISBN is a unique identifier for books (an international standard). + Specify a 10 or 13-character ISBN. If you specify the + 13-character ISBN, the value must begin with either 978 pr 979. + If the primary and secondary categories are both catalog-enabled, + this ID should correspond to the primary category + (not the secondary category).<br> + <br> + Only used to match catalog products when creating listings. + (In some categories, eBay may also copy the ISBN, UPC, or EAN to the + listing's item specifics.) + + + 13 + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + UPC is a unique, 12-character identifier that many industries use to identify products. + <br><br> + If the primary and secondary categories are both catalog-enabled, this ID should + correspond to the primary category (not the secondary category). + <br> + <br> + Only used to match catalog products when creating listings. + (In some categories, eBay may also copy the ISBN, UPC, or EAN to the + listing's item specifics.) + + + 12 + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + EAN is a unique 8 or 13 digit identifier that many industries + (such as book publishers) use to identify products. + If the primary and secondary categories are both catalog-enabled, + this ID should correspond to the primary category + (not the secondary category).<br> + <br> + Only used to match catalog products when creating listings. + (In some categories, eBay may also copy the ISBN, UPC, or EAN to the + listing's item specifics.) + + + 13 + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + The combination of Brand and MPN (manufacturer part number) can + be used as a unique identifier for a product. + Please specify both Brand and MPN to ensure a unique product match.<br> + <br> + Only used to match catalog products when creating listings + (not for buy-side searching). + + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetItems + Conditionally + + + + + + + + Only applicable when you are listing event tickets. + Only used to match catalog products when creating listings + (not for buy-side searching). + + + + Ticket Listings + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Specialty-Tickets.html + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + Indicates what eBay + should do if more than one product matches the external product ID (ISBN, UPC, EAN, + BrandMPN, or TicketListingDetails). Also see ReturnSearchResultOnDuplicates as an + alternative. If more than one product match was found and UseFirstProduct is true, item + will be listed with first product information. If false, the rules for + ReturnSearchResultOnDuplicates are used. + + + + AddFixedPriceItem + AddItem + + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + false + + + + + + + + + + + + A list of products returned from the Suggested Attributes engine. + + + + + + + A suggested product to use to list an item with Pre-filled Item Information. + Returned from GetItemRecommendations when the Suggested Attributes engine is used + See the Developer's Guide for additional details. + + + + GetItemRecommendations + Conditionally + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + + Unique alphanumeric key help you distinguish between query results in the response. + You define the key. Each search request ID must be unique within the same call. + Primarily useful when conducting multiple searches in the same call. + If not specified, the ProductSearchResult.ID values in the response are + indexed starting from 0 (zero). + + + + + + + + + + + <b>For GetProductFinder and GetProductSearchResults + only:</b> Identifier for a characteristic set + (an attribute set) that is mapped to + a catalog-enabled category (unique across all eBay sites). + Required when you use SearchAttributes + (for searches based on product search page and product finder data). + Returns an error with QueryKeywords (use CharacteristicSetIDs instead). + Use GetProductSearchPage or GetProductFinder to determine valid IDs for the + type of search you are performing. + + + + + + + + + + + Required when you are performing a sell-side product finder search. + (Not applicable to product search page searches.) + Numeric identifier for a sell-side product finder that was used to retrieve + the search attributes being used in the request. The product finder must be + mapped to a catalog-enabled category (i.e., it cannot be a buy-side product finder ID) + associated with the characteristics set. + Use a product finder when you want to specify multiple attributes in a + product search query. Call GetCategory2CS to determine which categories + support sell-side product finder searches. + + + + + + + + + + + Identifier for a representative stock product in a product family. + Used as input in GetProductFamilyMembers requests to identify a product family. + Use GetProductSearchResults to determine the available IDs. + + + + + + + + + + + Unique identifier for a sortable attribute. Use GetProductSearchPage + or GetProductFinder to determine the valid sort attribute IDs for the + specified characteristic set (including the default sort attribute that will be + used if you do not specify this field). + + + + + + + + + + + Pagination instruction that specifies the maximum quantity of products to return for + each product family within the search response whose ID matches the current request's + ID. In the response, if the last family returned contains MaxChildrenPerFamily or fewer + additional products, those additional products are also returned (i.e., the actual + quantity returned for the last family can exceed the specified maximum value). See + "Limit the Quantity of Products Returned Per Family" in the eBay Web Services Guide. + The value should not include punctuation (i.e., a thousands separator is not valid). + + + + + + + + + + + A predefined attribute against which to search (e.g., Author). Use this to create a + query based on a set of Item Specifics from the catalog. Both the product title and + product Item Specifics are searched. If the query includes multiple SearchAttributes + fields (one for each attribute), the search engine will apply "AND" logic to the query. + Call GetProductSearchPage or GetProductFinder to determine the list of valid attributes + and how many are permitted for the specified characteristic set. See the eBay Web + Services guide for details. For each ProductSearch, either SearchAttributes or + QueryKeywords is required (but do not pass both). + + + + + + + + + + + Pagination instruction that specifies the virtual page of data to return + per search request. + When you use ExternalProductID or ProductReferenceID, only one page of + data is typically returned. + + + + + + + + + + + If true, only retrieve products that have been used to pre-fill + active listings on the specified eBay site. + If false, retrieve all products that match the query.<br> + <br> + <b>For GetProductSearchResults:</b> Ths can be useful when + you want to find products that other sellers have recently used to + pre-fill similar listings. + + + + + + + + + + + One or more keywords to search for. The words "and" and "or" are treated like any other + word. Only use "and", "or", or "the" if you are searching for products containing these + words. To use AND or OR logic, use eBay's standard search string modifiers. Wildcards + (+, -, or *) are also supported. Be careful when using spaces before or after modifiers + and wildcards. + <br><br> + <b>For GetProductSearchResults:</b> + eBay searches only in the characteristic set specified in CharacteristicSetIDs. Both + the product title and Item Specifics are searched. For each ProductSearch, either + SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches + are not applicable (and result in a warning). If your search is using a Keyword + attribute returned by GetProductSearchPage, use SearchAttributes instead. + + + + + + + + + + + List of one or more IDs that indicate which domain + (characteristic set) to search in. <br> + <br> + <b>For GetProductSearchResults:</b> Required and + only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified. + + + + + + + + + + + The global reference ID for an eBay catalog product. Use this query to retrieve basic + details about one catalog product. The results can optionally include items, reviews, + and/or buying guides that match that product. (Specifically, the items returned are + items that sellers listed with the specified product's stock information.) + <br><br> + <span class="tablenote"><b>Note:</b> + This value is not the same as the ProductID used in AddItem and related calls. A + ProductID represents a particular version of a catalog product. (A given version + could have an older or newer description, set of Item Specifics, or other details.) A + ProductReferenceID is a more generic or global reference to a product (regardless of + version), which is useful for buy-side searching. One product reference ID can be + associated with multiple product IDs. + </span> + <br><br> + Some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, + replacing, deleting, or merging some products (as a result of migrating from one + catalog data provider to another). If you specify one of these products, the call may + return a warning, or it may return an error if the product has been deleted. + <br><br> + The request requires either QueryKeywords, ProductReferenceID, + or ExternalProductID, but these fields cannot be used together. + + + + + + + + + + + A query that only retrieves items that were listed with stock products + that have ISBN or UPC values (such as books, DVDs, CDs, and video game + products). + Use this query to retrieve basic details about one catalog product + (or a very limited number of products). The results can optionally + include items, reviews, and/or buying guides that match that product. + (Specifically, the items returned are items that sellers listed with the + specified product's stock information.)<br> + <br> + If you have gotten the ISBN or UPC from another Web site or resource, + you can use that ID. Any matching products that + include ISBN or UPC values will return those values in + Product.ExternalProductID.<br> + <br> + The request requires either QueryKeywords, ProductReferenceID, + or ExternalProductID, but these fields cannot be used together. + + + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + + + Sort by product popularity (as determined by eBay), + and return the most popular products first. + + + + + + + + + + + Sort by product popularity (as determined by eBay), + and return the least popular products first. + + + + + + + + + + + Sort by average rating, and return the lowest rated + products first. + + + + + + + + + + + Sort by average rating, and return the highest rated + products first. + + + + + + + + + + + Sort by the number of reviews, and return products with + the fewest reviews first. + + + + + + + + + + + Sort by the number of reviews, and return products with + the most reviews first. + + + + + + + + + + + Sort by the number of active items listed with this product, + and return products with the fewest items first. + + + + + + + + + + + Sort by the number of active items listed with this product, + and return products with the most items first. + + + + + + + + + + + Sort by the product title, and return products in ascending order. + For example, with Western character sets, this means alphabetical order + (e.g., A to Z), where titles that start with the word "A" appear + before titles that start with the word "The". + + + + + + + + + + + Sort by the product title, and return products in reverse order + (e.g., Z to A). + + + + + + + + + + + Reserved for values that are not available in the version of the schema + you are using. If eBay adds a new value to this code type as of a + particular version, we return CustomCode when you specify a + lower request version. + + + + + + + + + + + + + No longer applicable to any categories. + + + 773 + Avoid + FindProducts (Shopping API) + 889 + + + + + + + This product's details have been updated. + If your application currently uses the product for listing or searching, + we recommend that you check to make sure the product data still meets your needs. + + + + + + + This product has changed. This product has been mapped to a newer + product in the catalog that eBay (or Half.com) is currently using, + and its details have been updated based on the new catalog data. + The product reference ID remains the same + (but the longer product ID string may have changed). + If your application currently uses the product for listing or searching, + we recommend that you check to make sure the product data still meets your needs. + + + + + + + This product was previously available in an earlier catalog, + but it has not been mapped to a product in the catalog that eBay + is currently using. It can still be used to pre-fill listings, but + it may contain fewer details than other products. + If your application currently uses the product for listing or searching, + we recommend that you check to make sure the product data still meets your needs. + Not applicable to Half.com. + + + + + + + Some information in this product is scheduled to be merged into another product + in the catalog that eBay (or Half.com) is currently using. This product may + be removed from the system at any time. + If your application currently uses the product for listing or searching, + we recommend that you update your application to use a product that is not + scheduled to be merged or deleted. + + + + + + + This product is marked for deletion, and it will not be mapped to another product. + You cannot add or relist items that use products marked for deletion. + If your application currently uses the product for listing or searching, + we recommend that you update your application to use a product that is not + scheduled to be merged or deleted. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Identifies an individual product suggestion. The product details include the EPID, Title, Stock photo url and if it is + an exact match. + + + + + + + The title of the product from the eBay catalog. + + + 80 + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + The product reference Id of the product + The eBay Product ID, a global reference ID for an eBay catalog product. The + ePID is a fixed reference to a product (regardless of version). + + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + Fully qualified URL for a stock image (if any) that is associated with the + eBay catalog product. The URL is for the image eBay usually displays in + product search results (usually 70px tall). It may be helpful to calculate the + dimensions of the photo programmatically before displaying it. + + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + If true, indicates that the product is an exact match, suitable for listing + the item. + + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Provides a list of products recommended by eBay, which match the item information + provided by the seller. + + + + + + + Contains details for one or more individual product suggestions. The product + details include the EPID, Title, Stock photo url and whether or not the product + is an exact match for the submitted item. This product information can be used + to list subsequent items. + + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + No longer applicable to any category. + + + 773 + NoOp + 889 + FindProducts (Shopping API) + + + + + + + (in) Use this code when calling GetProductSellingPages + before adding an item. This retrieves the latest product ID and the corresponding characteristic meta-data. + + + + + + + (in) Use this code when calling GetProductSellingPages + before revising an item that already contains product information. + If the product ID or data has changed, the original + product ID that you passed in and the data associated with that original version of the + product is returned. This is useful because the original Pre-filled Item Information + is used when you call ReviseItem. + + + + + + + (in) Use this code when calling GetProductSellingPages + before relisting an item that already contains product information. + This retrieves the latest product ID and the + corresponding characteristic meta-data (same data as AddItem). + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + Enumerated type that defines the category group values. Business Policies profiles (Payment, + Shipping, and Return Policy) are linked to category groups. + + + + + + + Default value. + + + + + + + None. + + + + + + + For Business Policies, the 'ALL' enumeration value represents all eBay categories + except for motor vehicles. + + + + + + + For Business Policies, the 'MOTORS_VEHICLE' enumeration value represents all motor vehicle + categories. + + + + + + + + + + Type defining the <b>PaymentProfileCategoryGroup</b>, <b> + ReturnPolicyProfileCategoryGroup</b>, and <b>ShippingProfileCategoryGroup</b> + fields, which are all returned in the <b>GetCategoryFeature</b> response if these + Business Policies profile types apply to the category. Each of these fields is returned as an + empty element. + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + + (out) Bid offer in a competitive-bidding listing. + + + + + + + + + + + (out) Buy It Now offer in a fixed-price or Buy It Now listing. + + + + + + + + + + + (out) Best Offer in Best Offer Only listing. + + + + + + + + + + + (out) Advertised price for a Classified Ad format listing. + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + + Promote/present items that are related to or can be used with the + specified item. + + + + + + + + + + + Promote/present items that of higher quality or more expensive + than the specified item. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + + A container consisting of details related to an eBay Store promotion rule. One or + more <b>PromotionRule</b> containers may be returned in + <b>GetPromotionRules</b>. + + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is deprecated as Cross Promotions are no longer supported in the APIs. + + + + + + + + + The seller specifies individual items in the store that are + promoted when a buyer views, bids on, or purchases a store item. + + + + + + + + + + + The seller specifies a store category from which items are promoted + when a buyer views, bids on, or purchases an individual item in the store. + + + + + + + + + + + The seller specifies referring and promoted categories, both from + the store. When a buyer views or acts on any item from that category, items + from the promoted category are also displayed. + + + + + + + + + + + The seller specifies a referring item and defines promoted items + selected from a store category, eBay category, or keywords. + + + + + + + + + + + The seller specifies a store category or eBay category, with + optional keywords, for referring items and one for promoted items. When a + referring item is selected from the category and keywords, items from the + promoted category and keywords are also displayed. + + + + + + + + + + + This scheme is returned as a backfill scheme used to promote items. + + + + + + + + + + + This scheme is returned as related category scheme used to promote + items. + + + + + + + + + + + This scheme is returned as a backfill scheme used to promote items. + + + + + + + + + + + This scheme is returned as a backfill scheme used to promote items. + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + + + + An array of promotional sales. + + + + + + + Contains promotional sale information based on the request. + If you did not specify a PromotionalSaleID in the request, + then all promotional sales for the seller are returned. + + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + + + + If a seller has reduced the price of a listed item with the Promotional Price Display + feature, this type contains the original price of the discounted item and other + information. + + + + + + + Original price of an item whose price a seller has reduced with the Promotional Price + Display feature. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Start time of a discount for an item whose price a seller has reduced with the + Promotional Price Display feature. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + End time of a discount for an item whose price a seller has reduced with the + Promotional Price Display feature. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Values indicate the status of a sale. Used for the Promotional Price Display + feature, which enables sellers to apply discounts across many listings. + + + + + + + The promotional sale is active. + + + + + + + The promotional sale is scheduled. That is, the start time is in the future. + + + + + + + The status of the promotional sale is pending. When first scheduling a Sale, + if you select over 200 listings to be in any given Sale, it will take some + time for eBay to process the request. + + + + + + + The promotional sale is inactive, the sale has ended. You can reschedule a + sale once it has ended, but you will need to wait at least 24 hours before it + can become active. + + + + + + + The promotional sale has been deleted. Deleted promotional sales cannot be + updated or reactivated. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details for a single promotional sale. + + + + + + + Unique ID of a promotional sale (discount and/or free shipping) for items. + This field is an input field only for the SetPromotionalSale call + and only if you are not adding a new promotional sale. + + + + GetPromotionalSaleDetails + Conditionally + + + SetPromotionalSale + Conditionally + + + + + + + + Name of a promotional sale for items. + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Items covered by a promotional sale. + + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Status of a promotional sale for items. + + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Type of a promotional sale discount for items (for example, percentage). + Applies to price discount sales only. + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Value of a promotional sale discount for items, a percentage discount + or a fixed amount reduction. Percentage discounts must be at least 5% and + cannot exceed 75% of the original listing price. Fixed amount discounts + will be in the currency of the original listing. + Applies to price discount sales only. + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Start date of a promotional sale for items. Promotional sales can start + immediately or be scheduled to start at a later date. Some sites require + items to have been listed for a specific duration before they can be added + to a promotional sale (for example, on the US site, items must have been + listed for a day before they can be added to a promotional sale). + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + End date of a promotional sale discount for items. Maximum listing durations + vary by site from 14 days to 45 days. The minimum promotional sale duration is 1 day for most sites, but 3 days on some sites. + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + Type of promotional sale: price discount, free shipping, or both. + + + + SetPromotionalSale + Conditionally + + + GetPromotionalSaleDetails + Conditionally + + + + + + + + + + + + Values specify or indicate the type of promotional sale offered. + Promotional sales give store owners the ability to apply discounts and/or + free shipping across many listings for a specific duration. + + + + + + + Sale offers price discount only. + + + + + + + Sale offers free shipping only. + + + + + + + Sale offers both price discount and free shipping. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details of a promotional shipping discount. + + + + + + + The type of promotional shipping discount that is detailed in the profile. + If MaximumShippingCostPerOrder, see ShippingCost. + If ShippingCostXForAmountY, see ShippingCost and OrderAmount. + If ShippingCostXForItemCountN, see ShippingCost and ItemCount. + + + + GetShippingDiscountProfiles + + MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN + + Conditionally + + + SetShippingDiscountProfiles + + MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN + + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + MaximumShippingCostPerOrder, ShippingCostXForAmountY, ShippingCostXForItemCountN + + Conditionally + + + + + + + + This is shipping cost X, when DiscountName is either ShippingCostXForAmountY or + ShippingCostXForItemCountN, and is the maximum cost when DiscountName is + MaximumShippingCostPerOrder. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This is the cost Y of the order (not including shipping cost), + when DiscountName is set to ShippingCostXForAmountY. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This is the number of items, when DiscountName is set to ShippingCostXForItemsY. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + The purpose of a purchase (e.g., by a PayPal application). + + + + + + + Custom Code + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + Contains a seller's preference for sending a "Payment Reminder Email" to buyers. + + + + + + + If true, a payment reminder Email is sent to buyers. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + Indicates the text message type of the item's quantity availability. + + + + + + + (out) The message "Limited quantity available" is shown in the web + flow (e.g., for a flash sale or a Daily Deal). + + + + + + + (out) The message "More than 10 available" is shown in the web flow. + 10 is the value of QuantityThreshold tag based on the seller's + preference. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Currently applies to tickets. May apply to other categories in the future. + + + + + + + Enables you (the seller) to avoid being left with 1 item in your + listing. A typical use case is event tickets in reserved, + adjacent seats, or items that typically only sell if more than + 1 can be purchased at once. <br> + <br> + Specify the minimum number of items that + should remain if a buyer doesn't purchase all the items. + Based on the value of MinimumRemnantSet and the listing's + available quantity (Quantity-QuantitySold), eBay calculates how many + items a buyer can purchase. + For example, suppose you list 5 tickets, and you want at least + 2 tickets remaining for the final buyer to purchase. + In this case, you would set MinimumRemnantSet to 2. + This means a buyer can purchase 1, 2, 3, or 5 tickets, but not 4 + (because 4 would leave the seller with 1 ticket).<br> + <br> + To remove this restriction when you revise or relist, + set MinimumRemnantSet to 1.<br> + <br> + Applicable to multi-quantity, fixed-price listings. + Currently supported for US and CA event ticket listings. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + ReviseItem + RelistItem + VerifyAddItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + 1 + + + + + + + + + + + + + Used by QuantityOperator to specify that you are seeking quantities less than Quantity. + + + + + + + Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity. + + + + + + + Used by QuantityOperator to specify that you are seeking quantities equal to Quantity. + + + + + + + Used by QuantityOperator to specify that you are seeking quantities greater than Quantity. + + + + + + + Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type defines the <b>QuantityRestrictionPerBuyer</b> container, which is + used by the seller to restrict the quantity of items that may be purchased by one buyer + during the duration of a fixed-price listing (single or multi-variation). + + + + + + + This integer value indicates the maximum quantity of items that a single buyer may + purchase during the duration of a fixed-price listing (single or multi-variation). + The buyer is blocked from the purchase if that buyer is attempting to purchase a + quantity of items that will exceed this value. Previous purchases made by the buyer + are taken into account. For example, if <b>MaximumQuantity</b> is set to + '5' for an item listing, and <em>Buyer1</em> purchases a quantity of + three, <em>Buyer1</em> is only allowed to purchase an additional + quantity of two in subsequent orders on the same item listing. + <br/><br/> + This field is required if the <b>QuantityRestrictionPerBuyer</b> + container is used. + + + 1 + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + Conditionally + + + RelistFixedPriceItem + RelistItem + VerifyRelistItem + ReviseFixedPriceItem + ReviseItem + Conditionally + + + + + + + + + + + + + General questions about the item. + + + + + + + Questions related to the shipping of the item. + + + + + + + Questions related to the payment for the item. + + + + + + + Questions related to the shipping of this item + bundled with other items also purchased on eBay. + + + + + + + Customized subjects set by the seller using + SetMessagePreferences or the eBay Web site. + + + + Reserved + + + + + + + + No question type applies. This value + doesn't apply to AddMemberMessageAAQToPartner. + Note that the value of None can apply if + Messages.Message.MessageType isn't set to AskSellerQuestion. + + + + + + + Reserved for future or internal use. + + + + + + + + + + The status of a payment. + + + + + + + Order line item payment has been canceled. + (Reserved for future use.) + + + + + + + Order line item payment is completed. + + + + + + + Order line item is awaiting payment. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + High end of the range. + + + + + + + + + + + Low end of the range. + + + + + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + This type contains fields to specify the shipping rate tables that are to be applied to a listing. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a base rate for a large region, then define alternative rates or surcharges for shipping to other (extended) regions within the larger region. + <br><br> + Prerequisites for applying shipping rate tables: + <ul> + <li>The shipping type for the listing must be Flat. </li> + <li>The seller must have previously configured a shipping rate table in My eBay site preferences. </li> + </ul> + This container is returned from the GetItem family of calls only for the seller who listed the item. + <br><br> + You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide. + + + + + + + On input, this field specifies which domestic shipping rate table to apply to a listing. Domestic rate tables can be used only for items listed on the eBay US, UK, DE, AU and Motors Parts and Accessories websites. + <br><br> + Currently, sellers can configure only one domestic shipping rate table, so set <strong>DomesticRateTable</strong> = <code>Default</code> to apply that table. The rates assigned to the various domestic regions are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given domestic region in the domestic rate table, buyers in that region will see only one shipping cost. If several service levels and rates are set up in the domestic shipping rate table for a given domestic region, buyers in that region will see the different shipping levels and rates and can choose one of them. + <br><br> + If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <code>&lt;DomesticRateTable /&gt;</code> + <br><br> + This field is returned from the GetItem family of calls only for the seller who listed the item. + <br><br> + You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide. + + + 50 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetSellerList + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#UsingShippingRateTables + + + + + + + + On input, this field specifies which international shipping rate table to apply to a listing. International rate tables can be used only for items listed on the eBay US, UK and DE sites. + <br><br> + Currently, sellers can configure only one international shipping rate table, so set <strong>InternationalRateTable</strong> = <code>Default</code> to apply that table. The rates assigned to the various countries are applied depending on the location of the buyer. If only one shipping service category and rate has been set for a given country in the international rate table, buyers in that country will see only one shipping cost. If several service levels and rates are set up in the international shipping rate table for a given country, buyers in that country will see the different shipping levels and rates and can choose one of them. + <br><br> + If you are modifying or relisting an item (using the Revise or Relist family of calls), you can delete the existing rate table setting applied to the listing by using the empty tag: <code>&lt;InternationalRateTable /&gt;</code> + <br><br> + This field is returned from the GetItem family of calls only for the seller who listed the item. + <br><br> + You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide. + + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetSellerList + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#UsingShippingRateTables + + + + + + + + + + + + A container for VeRO reason code details. + + + + + + + The short description of the infringement associated with the reason code ID. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + The long description of the infringement associated with the reason code ID. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + + + A unique identifier assigned to a reason code. + + + + + + + GetVeROReasonCodeDetails + Always + + + + + + + + + + Enumerated type that defines the possible reasons why an auction listing + is being hidden from search on the eBay site. + + + + + + + This value indicates that the auction listing is being hidden from search on the eBay site because the + listing has been determined by eBay to be a duplicate listing with zero bids. + <br/><br/> + This enumeration is associated with eBay Duplicate Listings Policy, which has taken + effect on the US, CA, CA-FR, and eBay Motors (Parts and Accessories only) sites. + Event Tickets, Real Estate, and Motor Vehicle categories are excluded from this + policy. For more information, read + <a href="http://pages.ebay.com/help/policies/listing-multi.html">eBay's Duplicate Listings Policy</a> help page. + + + + + + + This value indicates that the listing is hidden from search because the quantity is zero. However, the listing is still alive and will + reappear in the search results when the quantity is set to something greater than zero. For more information, + see <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference</a>. + + + + + + + + + + A seller can make a Transaction Confirmation Request (TCR) for an item. This code + list contains values to specify the current relationship between the seller and + the potential buyer. For a seller to make a Transaction Confirmation Request (TCR) + for an item, the potential buyer must meet one of the criteria in this code list. + + + + + + + Indicates that the recipient has one or more bids on the item; the relationship is "bidder." + + + + + + + Indicates that the recipient has one or more best offers on the item; the + relationship is "best offer buyer." + + + + + + + Indicates that the recipient has asked the seller a question about the item; + the relationship is "a member with an ASQ question." + + + + + + + Indicates that the recipient has a postal code; the relationship is "a member + with a postal code." + + + + + + + Reserved for internal or future use. + + + + + + + + + + RecommendationEngineCodeType - Type declaration to be used by other schema. + Identifies the engines that can be used to analyze proposed listing data. + See the Developer's Guide for a list of recommendation engines that + are currently operational. + + + + + + + (in) Listing Analyzer engine; Returns tips related to fields + that a seller wants to specify in a listing. + + + + + + + (in) Reserved for internal or future use. + + + + + + + (in) Product Pricing engine. Returns average start and sold prices + of completed items that were listed a specified product ID. + + + + + + + (out) Reserved for internal or future use. + + + + + + + (in) Suggested Attributes engine. Returns suggested attributes + and catalog products (for Pre-filled Item Information) that have been + used by other sellers who listed similar items in the same category. + + + + + + + (in) Custom Item Specifics engine. Returns the most popular + names and values to use for custom Item Specifics based the + requested category (and the Title, if specified). + + + + + + + + + + This type is reserved for future or internal use. + + + + + + + This field is reserved for future or internal use. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This field is reserved for future or internal use. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This field is reserved for future or internal use. + + + 10 + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This field is reserved for future or internal use. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + This field is reserved for future or internal use. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Defines rules for recommended Item Specifics. The rules apply when + the Item Specific is subsequently used in AddItem and related calls. + + + + + + + The data type (e.g., decimal) that eBay expects the value to + adhere to in listing requests. + Only returned if the data type is not Text. + In some cases, more details about the data type are returned + in the ValueFormat field.<br> + <br> + As buyers may search on the value you specify in AddItem, + the ISBN, UPC, or EAN should match the value that was specified by + the publisher or manufacturer. + + + + CustomCode, Date, Decimal, EAN, ISBN, Text, UPC + GetCategorySpecifics + NameRecommendation.ValidationRules + Text + Conditionally + + + + + + + + Minimum number of values that you can specify for this Item Specific + in listing requests. Not returned if zero (0).<br> + <br> + If 1 or more, it means this Item Specfic is required + in listing requests (in the specified category). (Your listing + request will return errors if the Item Specific is not present.) + If Relationship is also present, it means this Item Specific is + required when you specify its parent value in listing requests. + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + 0 + Conditionally + + + + + + + + Maximum number of values that you can specify for this Item Specific + in listing requests (like AddItem) in the specified + category.<br> + <br> + Most Item Specifics can only have one value. When this is + greater than 1, your application can present the value + recommendations (if any) as a multi-select list to the seller. + (See SelectionMode to determine whether the seller needs to + choose from eBay's recommendations or not.) + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + 1 + Conditionally + + + + + + + + Controls whether you can specify your own name and value + in listing requests, or if you need to use a name and/or value + that eBay has defined. + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + FreeText, Prefilled, SelectionOnly + FreeText + Conditionally + + + + + + + + Indicates eBay's confidence that this is the right name or value, + given the data you specified your request. The confidence is based + on historical items in the same category, with similar titles + (if specified).<br> + <br> + For example, in GetItemRecommendations, if your request includes a + title with words like "Blue T-Shirt", then Color=Blue is likely to + have a higher confidence score than Color=Red in the response. + If the title does not include a recognized color value, + then Color may still have a high confidence score + (based on historical item data in the category), but the scores for + Blue and Red may have a more even distribution.<br> + <br> + Only returned when IncludeConfidence is true in the request. + Not returned when SelectionMode is Prefilled. + + + 0 + 100 + + GetCategorySpecifics + Conditionally + + + + + + + + Indicates the Item Specific's logical dependency on another + Item Specific, if any. + <br> + <br> + For example, in a clothing category, Size Type could be + recommended as a parent of Size, because Size=XL would + mean something different to buyers when + Size Type=Juniors or Size Type=Regular. <br> + <br> + Or in the US (in the future), a list of cities can vary depending + on the state, so State could be recommended as a parent of City.<br> + <br> + Currently, categories only recommend a maximum of one parent + for an Item Specific. + For example, Size=XL could have a Size Type=Juniors + parent in a Juniors clothing category. + In the future, some categories may recommend multiple parents. + For example, City=Mountain View could have parents like + State=California, State=New York, and State=North Carolina.<br> + <br> + If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then + all of its value recommendations are returned (regardless of the + number you specified in MaxValuesPerName). + + + + GetCategorySpecifics + Conditionally + + + + + + + + Indicates whether the name (e.g., Color) can (or must) be used to + classify the variation pictures. + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + Conditionally + + + + + + + + Indicates whether the recommended name/value pair can be used in + Item.Variations in AddFixedPriceItem and related calls. + For example, a given category could disable a name like Brand + in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could + enable a name like Size for variation specifics + (in addition to recommending it for item specifics). + If not returned, then the name/value can be used for + both variation specifics and item specifics. + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + Conditionally + + + + + + + + The format of the data type (e.g., date format) that eBay + expects the item specific's value to adhere to in listing requests. + A data type identified by the ValueType field may have different + representations, and ValueFormat specifies the precise format + that is required. + + + + GetCategorySpecifics + NameRecommendation.ValidationRules + Conditionally + + + + + + + + + + + + Defines details about recommended names and values for custom Item Specifics. + + + + + + + The category in which the associated Item Specifics are popular. + This is always a category that you specified in the request.<br> + <br> + Only returned for categories that have popular Item Specifics, + or when you also pass in the Name field. + + + 10 + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + Contains an Item Specific that eBay recommends as popular + within the specified category. Only returned if recommendations are + found. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + If true, the recommended Item Specifics for this category + have changed since the time you specified (in LastUpdateTime). + (In this case, we suggest you retrieve the latest data for + the category.) + If false, the recommended Item Specifics for this category + have not changed since the time you specified.<br> + <br> + Only returned when you pass LastUpdateTime in the request. + + + + GetCategorySpecifics + Conditionally + + + + + + + + + + + + Container for supported site information + + + + + + + Site codes for sites where the Seller has agreed to cross-border trade recoupment. + This means that the site where the seller is trading requires a recoupment agreement + for cross-border trade, and the seller has an agreement in effect. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + ComingSoon + + + + + + + + + + + + Type used by the <strong>RefundArray</strong> container, which consists of an array of Half.com refunds. + + + + + + + This container consists of information about a Half.com refund. It is only returned if a Half.com order is going through (or has completed) the refund process. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + This enumerated type contains the possible refund, exchange, or store credit options that a + seller may offer a buyer when the buyer wants to return the item. + + + + + + + This value indicates that the seller will refund the buyer the cost of the item, excluding shipping and handling costs and any restocking fee (US only). + <br><br> + The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the refund will be handled (such as whether the refund will occur via PayPal). + + + + + + + <span class="tablenote"><b>Note:</b> + This value is deprecated on the US site, and all listings attempting to use this + value will be blocked. + </span> + This value indicates that the seller will exchange the returned item for another item. + The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how this will occur (such as whether the seller will send an identical item in place of the returned item). + + + + + + + <span class="tablenote"><b>Note:</b> + This value is deprecated on the US site, and all listings attempting to use this + value will be blocked. + </span> + The seller will give the buyer a credit toward the purchase of another item. The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the buyer can redeem this credit. + + + + + + + <span class="tablenote"><b>Note:</b> + US sellers opted into eBay-managed returns, that are willing to refund buyers or offer an identical replacement item, should use the 'MoneyBackOrReplacement' value instead of 'MoneyBackOrExchange'. + </span> + This value indicates that the seller will refund the buyer the cost of the item, excluding shipping and handling costs and any restocking fee (US only), or the seller will exchange the returned item for another identical/similar item. + <br><br> + The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain how the refund will be handled, such as whether the refund will occur via PayPal, or how the exchange will occur, such as whether the seller will send an identical item in place of the returned item. + + + + + + + <span class="tablenote"><b>Note:</b> + This value is only available on the US site. US sellers opted into eBay-managed returns should use this value (and not 'MoneyBackOrExchange') if they are willing to refund buyers or offer an identical replacement item. + </span> + This value indicates that the seller will refund the buyer the cost of the item (excluding shipping and handling costs and any restocking fee) through eBay-managed returns, or the seller will replace the returned item with another identical item. + <br><br> + The seller should use the <b>ReturnPolicy.Description</b> field in the Add API call to explain to buyer that are refunds and replacements will be handled through the eBay-managed returns process. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>ReturnPolicyDetails.Refund</b> container that is + returned in <b>GeteBayDetails</b>. All of the values (along with descriptions + for each value) that can be used as a Refund Option when listing an item is returned + under the <b>ReturnPolicyDetails.Refund</b> container. + + + + + + + Indicates how the seller will compensate the buyer for a returned item. This value can be passed in the Add/Revise/Relist/VerifyAdd API calls. + <br/><br/> + For <b>RefundOption</b>, the deprecated values on the US site are <b>MerchandiseCredit</b> + and <b>Exchange</b>. Instead of these deprecated values, the seller must + offer a <b>MoneyBack</b> or a <b>MoneyBackOrExchange</b> refund + option. Consider using the <b>MoneyBackOrExchange</b> option when you have + the depth of inventory to support an exchange for a different size, color, or undamaged + unit. Otherwise, use the <b>MoneyBack</b> option if you have limited + inventory. + </span> + + + RefundOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present RefundOption in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use RefundOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + This enumerated type is not used. + + + + + + + The refund attempt failed because the seller's billing agreement with PayPal has + been cancelled. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The new eBay payment process for German and + Austrian sites has been put on hold indefinitely. + </span> + + + + + + + The refund attempt failed because because the PayPayl Risk team declined the + transaction. The seller should log in to their PayPal account to proceed with the + refund request. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> The new eBay payment process for German and + Austrian sites has been put on hold indefinitely. + </span> + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This container is no longer used. + + + + + + + This field is no longer used. + </span> + + + + + + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + </span> + + + + + + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + Type defining the <strong>Refunds</strong> container, which contains an array of <strong>Refund</strong> containers. A <strong>Refund</strong> container consists of detailed information on an In-Store Pickup item refund. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate <strong>Refund</strong> container will be returned for each <strong>ORDER.RETURNED</strong> notification that the merchant sends to eBay through the <strong>Inbound Notifications API</strong>. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + + + + + + + + This type is no longer used. + + + + + + + + This field is no longer used. + </span> + + + + + + + + + + + + + + This enumerated type is no longer used. + + + + + + + The refund was applied to the purchase price. + + + + + + + The refund was applied to the shipping cost. + + + + + + + An additional refund (not accounted for in the original order costs) was issued. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Explanation of the reason that the refund is being issued. Applicable to Half.com refunds only. + + + + + + + Seller is unable to ship the product to the buyer. + + + + + + + Seller shipped the wrong item to the buyer. + + + + + + + The buyer returned the item due to its quality. + + + + + + + The buyer returned the item due to damage. + + + + + + + The buyer decided they did not want the item. + + + + + + + The seller has another reason for issuing a Half.com refund. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This enumerated type is no longer used. + + + + + + + The refund request was successful. + </span> + + + + + + + The refund request is being processed. + + + + + + + The refund request was rejected. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + + + + + Type defining the <strong>Refund</strong> container, which consists of detailed information on an In-Store Pickup item refund. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + + + + This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the <strong>Refund</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + Pending + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the <strong>REFUND_TYPE</strong> parameter through the payload of an <strong>ORDER.RETURNED</strong> notification sent to eBay. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the <strong>Refund</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the <strong>REFUND_ID</strong> parameter through the payload of an <strong>ORDER.RETURNED</strong> notification sent to eBay. This field is not returned if the merchant does not set this value through <strong>ORDER.RETURNED</strong> notification. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the <strong>RefundAmount</strong> value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the <strong>FeeOrCreditAmount</strong> value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. + </span> + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + Contains information about a single Half.com refund. + + + + + + + Total amount refunded by the seller for this order line item. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Total amount refunded to the buyer for this order line item. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The date and time at which the refund was issued. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The unique identifier of the refund. + + + + GetOrders + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + A container consisting of details about an order line item against which the seller issued a refund. + + + + GetOrders + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The total amount of the refund requested. + + + + GetOrders + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This enumerated value indicates the status of the refund request. + + + + GetOrders + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + Explanation of the reason that the refund is being issued. Applicable to Half.com + refunds only. + + + + + + + The seller has issued a refund for the transaction price that + was originally paid to the seller. + (The seller's shipping reimbursement is not included + if Half.com calculates the refund amount). + + + + + + + The seller has issued a refund for the transaction price and + shipping reimbursement that was originally paid to the seller. + (The buyer's return shipping costs + might not be included if Half.com calculates the refund amount.) + + + + + + + The seller has issued a refund amount that is different from + the full refund (with or without shipping). If specified, + it may be helpful to explain the amount in your note to the buyer. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Enumerated type defining the refund types that a merchant can offer a buyer who is returning an In-Store Pickup item to the store. + + + + + + + This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s). + + + + + + + This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s). + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + This enumerated type is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type is no longer used; replaced by <b>ShippingLocationDetails</b>. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This type is no longer used; replaced by <b>ShippingLocationDetails</b>. + + + + + + + + + String identifier for a continent, a geographic region, or a country. + + + + + + + + + + + + Full name of the continent, geographic region, or country; useful for display + purposes. + + + + + + + + + + + + Indicates the status of the Region of Origin value. Only Region of Origin values + in the 'Active' state can be used. + + + + + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + + + + + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Regular Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + + + + + + + + Specifies how to return certain reminder types from the user's My eBay account. + + + + + + + The length of time the reminder has existed in the user's My eBay account, + in days. Valid values are 1-60. + + + + GetMyeBayReminders + No + + + + + + + + Whether to include information about this type of reminder in the response. + When true, the container is returned with default input parameters. + + + + GetMyeBayReminders + No + + + + + + + + + + + Specifies the type of reminders for which you want information. + + + + + + + The number of reminders requesting that the buyer send payment. + + + + GetMyeBayReminders + Conditionally + BuyingReminders + + + + + + + + The number of reminders that feedback has not yet been received by the buyer or seller. + + + + GetMyeBayReminders + Conditionally + + + + + + + + The number of reminders that feedback has not yet been sent by the buyer or seller. + + + + GetMyeBayReminders + Conditionally + + + + + + + + The number of reminders advising the buyer that the buyer has been + outbid. + + + + GetMyeBayReminders + Conditionally + BuyingReminders + + + + + + + + The number of reminders that the seller has not yet received a payment. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders requesting that the seller review second + chance offers. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders advising the seller that shipping is + needed. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders advising the seller that relisting is needed. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + The number of new leads the seller has recieved. + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders advising the buyer to send documents for credit card processing. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders requesting the buyer to process request time extension submitted by the seller. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders requesting the Buyer to confirm item receipt to seller. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the buyer on refund on hold. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the buyer on refund cancelled. + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders requesting the seller to provide shipping details + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the seller on item receipt confirmation pending from buyer + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the seller on refunds initiated + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the seller on pending shipping time extension requests with the buyer + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + The number of reminders to the seller on declined shipping time extension requests by the buyer + + + + GetMyeBayReminders + Conditionally + SellingReminders + + + + + + + + + + + + This type defines the <b>RequiredSellerActionArray</b> container, + which may contain one or more <b>RequiredSellerAction</b> fields. + + + + + + + This field contains a possible action that a seller can take to expedite the + release of a payment hold. There can be one or more <b>RequiredSellerAction</b> + fields in the <b>RequiredSellerActionArray</b> container. + + + + GetOrders +
DetailLevel: none
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + Enumerated type that defines the list of possible actions that a seller can + take to expedite the release of funds for an order into their account. + + + SetupPayoutMethod, UpdatePayoutMethod, None + + + + + + + This value indicates that there is an open eBay Buyer Protection case + involving the seller and the item. The seller must address and get + the case resolved before the funds can be scheduled for release to the + seller's account. See the + <a href="http://developer.ebay.com/DevZone/resolution-case-management/Concepts/ResoCaseAPIGuide.html">Resolution Case Management API User Guide</a> + for information about retrieving and managing eBay Buyer Protection cases. + + + + + + + This value indicates that the seller must mark the order line item as shipped to expedite + the release of funds into their account. The seller can use the <b>CompleteSale</b> + call to mark an item as shipped. If an order line item is marked as shipped, it is possible + that the seller's funds for the order will be released as soon as seven days after the latest + estimated delivery date. + + + + + + + This value indicates that the seller should contact eBay Customer Support to discover + the next required action to expedite the release of funds into their account. + + + + + + + This value indicates that the seller must resolve the PayPal Buyer Protection case filed + against the order line item to expedite the release of funds into their account. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value indicates that the seller must provide the buyer the tracking information for + the order line item to expedite the release of funds into their account. The seller can + use the <b>CompleteSale</b> call to provide tracking information for an + order line item. If the tracking information for an order line item is provided, it is + possible that the seller's funds for the order will be released as soon as three days + after eBay has confirmed that the item has been delivered. + + + + + + + This value indicates that the buyer has not received the item, and the buyer has contacted + the seller through the eBay system in an effort to resolve the issue with the seller. The + seller must make it right with the buyer in order to expedite the release of funds into + their account. + + + + + + + This value indicates that the buyer has received the item, but the item is not as + described in the listing; hence, the buyer has contacted the seller through the eBay + system in an effort to resolve the issue with the seller. The seller must make it right + with the buyer in order to expedite the release of funds into their account. + + + + + + + This value is reserved for internal or future use. + + + + + + + This value indicates that the buyer is returning the item through eBay's managed return + process. Upon receiving the returned item from the buyer, the seller must issue a refund + to the buyer within five business days, and shortly after this happens, eBay will credit + the seller's account with the Final Value Fee that was originally assessed on the sale + of the item. + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + This enumeration type consist of the applicable values that may be used in the + <b>RestockingFeeValueOption</b> field of Add/Revise/Relist API calls. + + + Percent_25 + + + + + + + This value indicates that the seller will not charge a restocking fee to the + buyer if the item is returned. + + + + + + + This value indicates that the seller charges the buyer a restocking fee of 10 + percent of the item's purchase price if the item is returned. + + + + + + + This value indicates that the seller charges the buyer a restocking fee of 15 + percent of the item's purchase price if the item is returned. + + + + + + + This value indicates that the seller charges the buyer a restocking fee of 20 + percent of the item's purchase price if the item is returned. + + + + + + + This is no longer a valid value for RestockingFeeValue. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>RestockingFeeValue</b> container, which contains the + allowed values (and a text description of each value) that may be specified in the + <b>RestockingFeeValueOption</b> field of an Add/Revise/Relist API call. + + + + + + + A restocking fee value option that a seller can specify in the + <b>RestockingFeeValueOption</b> field of Add/Revise/Relist calls. + In order to charge a buyer a restocking fee when an item is returned, a US seller + must input a restocking fee value as part of the return policy. + + + RestockingFeeCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present + the <b>RestockingFeeValueOption</b> values in a more user-friendly + format when used in GUI features such as option buttons or drop-down lists. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type for the return policy details of an item. + + + + + + + How the seller will compensate the buyer for a returned item + (such as money back or exchange). + + + + GeteBayDetails + Conditionally + + + + + + + + Time period within which the buyer can return the item, starting from the day they receive the item. + + + + GeteBayDetails + Conditionally + + + + + + + + Whether the seller allows the buyer to return the item. + + + + GeteBayDetails + Conditionally + + + + + + + + This field is returned with a value of 'true' if the site supports a text + description of the seller's return policy for items. + + + + GeteBayDetails + Conditionally + + + + + + + + Whether the item includes a warranty. + + + + GeteBayDetails + Conditionally + + + + + + + + The type of warranty offered. + + + + GeteBayDetails + Conditionally + + + + + + + + The length of the warranty offered. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns true if the site supports specifying a European Article Number (EAN) with the return policy. + + + + GeteBayDetails + Conditionally + + + + + + + + The party who pays the shipping cost for a returned item. + + + + GeteBayDetails + Conditionally + + + + + + + + Container consisting of the allowed values (and a text description of each + value) that may be specified in the + <b>RestockingFeeValueOption</b> field of an Add/Revise/Relist + API call. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Defines the feature that specifies whether a return policy + could be enabled on the site. + + + + + + + + + + + Type for the return policy details of an item. + + + + + + + Indicates how the seller will compensate the buyer for a returned item. + Use the <b>ReturnPolicy.Description</b> field to explain the policy details + (such as how quickly the seller will process the refund, whether the seller must + receive the item before processing the refund, and other useful details.).<br> + <br> + The <b>RefundOption</b> field is not supported by any of the European sites. + <br> + <br> + <b>Applicable values:</b> To get the applicable <b>RefundOption</b> values for + your site, call <b>GeteBayDetails</b> with + <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, and + then look for the <b>ReturnPolicyDetails.Refund.RefundOption</b> fields in the + response. <br> + <br> + <b>For Add/Revise/Relist/VerifyAdd API calls):</b> + If the seller accepts returns (<b>ReturnsAcceptedOption=ReturnsAccepted</b>) + but you do not pass in this <b>RefundOption</b> field when listing the item, + some eBay sites may set a default value (like 'MoneyBack'), and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field.<br> + <br> + <b>For Revise calls only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent <b>ReturnPolicy</b> node description + for more details. + <br/><br/> + <span class="tablenote"><b>Note:</b> The <b>RefundOption</b> values supported on the US site are 'MoneyBack', 'MoneyBackOrExchange', and 'MoneyBackOrReplacement'. If a seller has the depth of inventory to support an exchange for a different size, color, or undamaged + unit, that seller should consider using 'MoneyBackOrExchange' for traditional returns or 'MoneyBackOrReplacement' for eBay-managed, hassle-free returns. A seller with limited inventory on an item should use the <b>MoneyBack</b> option. + </span> + + + RefundOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) RefundOption + GeteBayDetails.html#Response.ReturnPolicyDetails.Refund.RefundOption + + + + + + + + Display string that buyer applications can use to present <b>RefundOption</b> in + a more user-friendly format to buyers. For example, in <b>GetItem</b> and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the <b>Refund.Description</b> options returned by <b>GeteBayDetails</b>.<br> + <br> + Not applicable as input to the Add/Revise/Relist family of calls. (Use <b>RefundOption</b> instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + The buyer can return the item within this period of time from the day they receive the item. + Use the ReturnPolicy.Description field to explain the policy details.<br> + <br> + <b>Applicable values:</b> + To get the applicable ReturnsWithinOption values for your site, + call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption fields in the response. + ReturnsWithinOptionsCodeType defines all the possible values.<br> + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but you do not pass in this ReturnsWithinOption field when listing the item, + some eBay sites may set a default value (like Days_14), and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field. + <br/> + <br/> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + ReturnsWithinOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) ReturnsWithinOption + GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsWithin.ReturnsWithinOption + + + + + + + + Display string that buyer applications can use to present ReturnsWithinOption in + a more user-friendly format to buyers. For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the ReturnsWithin.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Indicates whether the seller allows the buyer to return the item. + This field is required when ReturnPolicy is specified. + If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.)<br> + <br> + All sites support the ability for a seller to not accept returns. + If the seller doesn't accept returns, the item must specifically + indicate ReturnsNotAccepted. (The return policy cannot be omitted + from the item.)<br> + <br> + On the eBay UK and Ireland sites, business sellers must accept + returns for fixed-price items (including auction items with + Buy It Now, and any other fixed price formats) when the category + requires a return policy. + On some European sites (such as eBay Germany (DE)), registered + business sellers are required to accept returns. + Your application can call GetUser to determine a user's current + business seller status. + <br> + <br> + <span class="tablenote"><b>Note:</b> + In order for Top-Rated sellers to receive a Top-Rated Plus seal for their listings, + returns must be accepted for the item (<b>ReturnsAcceptedOption=ReturnsAccepted</b>) and + handling time should be set to zero days (same-day shipping) or one day. The handling time is set through an integer value in the <b>Item.DispatchTimeMax</b> field. + Top-Rated listings qualify for the greatest average boost in Best Match and + for the 20 percent Final Value Fee discount. For more information on eBay's + Top-Rated seller program, see the + <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page. + </span> + <br> + <b>Applicable values:</b> + To get the applicable ReturnsAcceptedOption values for your site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.ReturnsAccepted.Description fields in the response. + ReturnsAcceptedOptionsCodeType defines all the possible values.<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + ReturnsAcceptedOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + VerifyAddFixedPriceItem + VerifyAddItem + Conditionally + + + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + RelistFixedPriceItem + RelistItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) ReturnsAcceptedOption + GeteBayDetails.html#Response.ReturnPolicyDetails.ReturnsAccepted.ReturnsAcceptedOption + + + Returns and the Law (UK) + http://pages.ebay.co.uk/businesscentre/law-policies/returns.html + + + + + + + + Display string that buyer applications can use to present ReturnsAcceptedOption in + a more user-friendly format to buyers. For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the ReturnsAccepted.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + A detailed explanation of the seller's return policy. <br> + <br> + eBay uses this text string as-is in the Return Policy section of the View Item page. Avoid HTML, and avoid character entity references (such as &amp;pound; or &amp;#163;). If you include special characters in the return policy description, use the literal UTF-8 or ISO-8559-1 character (e.g. &#163;). <br> + + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but does not specify this field when listing the item, + GetItem returns this as an empty node<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + 5000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) ReturnPolicyDetails.Description + sites that support this field + GeteBayDetails.html#Response.ReturnPolicyDetails.Description + + + + + + + + Indicates whether a warranty is offered for the item.<br> + <br> + <b>Applicable values:</b> + To get the applicable WarrantyOfferedOption values for your site, + call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption fields in the response. + WarrantyOfferedCodeType defines all the possible values.<br> + <b>Note:</b> Only the eBay India site supports this field. + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but you do not pass in this WarrantyOfferedOption field when listing the item, + the eBay India site may set a default value, and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field.<br> + <br> + <span class="tablenote"><b>Note:</b> + For the US eBay Motors limited warranty (Short-Term Service Agreement) option, + use Item.LimitedWarrantyEligible instead.<br> + <br> + For the US eBay Motors "Is There an Existing Warranty?" option, use + Item.AttributeSetArray instead.</span><br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + WarrantyOfferedCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + Warranties (eBay India) + http://pages.ebay.in/help/policies/warranties.html + + + Guidelines for Creating Legally Compliant Listings (eBay India) + http://pages.ebay.in/help/tp/compliant-listings.html + + + (GeteBayDetails) WarrantyOfferedOption + GeteBayDetails.html#Response.ReturnPolicyDetails.WarrantyOffered.WarrantyOfferedOption + + + (AddItem) Item.LimitedWarrantyEligible + US eBay Motors Short-Term Service Agreement + AddItem.html#Request.Item.LimitedWarrantyEligible + + + (AddItem) Item.AttributeSetArray + US eBay Motors existing warranty option + AddItem.html#Request.Item.AttributeSetArray + + + + + + + + Display string that buyer applications can use to present WarrantyOfferedOption in + a more user-friendly format to buyers. For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the WarrantyOffered.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Indicates the source or type of the warranty, if any.<br> + <br> + <b>Applicable values:</b> + To get the applicable WarrantyTypeOption values for your site, + call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.WarrantyType.WarrantyTypeOption fields in the response. + WarrantyTypeOptionsCodeType defines all the possible values.<br> + <b>Note:</b> Only the eBay India site supports this field. + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but you do not pass in this WarrantyTypeOption field when listing the item, + the eBay India site may set a default value, and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field.<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + WarrantyTypeOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) WarrantyTypeOption + sites that support this field, and applicable values + GeteBayDetails.html#Response.ReturnPolicyDetails.WarrantyType.WarrantyTypeOption + + + + + + + + Display string that buyer applications can use to present WarrantyTypeOption in + a more user-friendly format to buyers. For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the WarrantyType.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + The warranty period.<br> + <br> + <b>Applicable values:</b> + To get the applicable WarrantyDurationOption values for your site, + call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.WarrantyDuration. WarrantyDurationOption fields in the response. + WarrantyDurationOptionsCodeType defines all the possible values.<br> + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but you do not pass in this WarrantyDurationOption field when listing the item, + the eBay India site may set a default value, and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field.<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + WarrantyDurationOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) WarrantyDurationOption + GeteBayDetails.html#Response.ReturnPolicyDetails.WarrantyDuration.WarrantyDurationOption + + + + + + + + Display string that buyer applications can use to present WarrantyDurationOption in + a more user-friendly format to buyers. For example, For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the WarrantyDuration.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + The European Article Number (EAN) associated with the item, if any. + To determine if your site supports this field, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for a 'true' value in the ReturnPolicyDetails.EAN field. + Only returned if the seller has specified this value in their return policy.<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details.<br> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) ReturnPolicyDetails.EAN + GeteBayDetails.html#Response.ReturnPolicyDetails.EAN + + + + + + + + The party who pays the shipping cost for a returned item. + Use the ReturnPolicy.Description field to explain any additional details.<br> + <br> + <b>Applicable values:</b> + To get the applicable ShippingCostPaidByOption values for your site, + call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ReturnPolicyDetails</b>, + and then look for the ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption fields in the response. + ShippingCostPaidByOptionsCodeType defines all the possible values.<br> + <br> + <b>For AddItem, VerifyAddItem, and RelistItem:</b> + If the seller accepts returns (ReturnsAcceptedOption=ReturnsAccepted) + but you do not pass in this ShippingCostPaidByOption field when listing the item, + some eBay sites may set a default value (like Buyer), and the seller + is obligated to honor this setting. Therefore, to avoid unexpected obligations, + the seller should set a specific value for this field.<br> + <br> + <b>For ReviseItem only:</b> + If the listing has bids or sales and/or ends within 12 hours, + you can't change this value. See the parent ReturnPolicy node description + for more details. + + + ShippingCostPaidByOptionsCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + (GeteBayDetails) ShippingCostPaidByOption + sites that support this field, and applicable values + GeteBayDetails.html#Response.ReturnPolicyDetails.ShippingCostPaidBy.ShippingCostPaidByOption + + + + + + + + Display string that buyer applications can use to present ShippingCostPaidByOption in + a more user-friendly format to buyers. For example, in GetItem and + related calls, this value is usually localized and can contain spaces. + If necessary, you can predict the choice of values based on + the ShippingCostPaidBy.Description options returned by GeteBayDetails.<br> + <br> + Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.) + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + Display string that indicates the restocking fee charged by the + seller for returned items. This value is directly related to the + <b>RestockingFeeValueOption</b> value, with the difference + being that applications can use <b>RestockingFeeValue</b> + to present the <b>RestockingFeeValueOption</b> value + in a more user-friendly format when used in a GUI features such as option + buttons or drop-down lists. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + + + + + + This enumeration value indicates the restocking fee charged by the + seller for returned items. In order to charge the buyer a restocking + fee when an item is returned, a US seller must input a restocking + fee value as part of the return policy. + <br><br> + <b>For Add/Revise/Relist calls</b>: To obtain the list + of applicable values, call <b>GeteBayDetails</b> with + <b>DetailName</b> set to <b>ReturnPolicyDetails</b>. + Then look for the list of restocking fee value options in the + <b>ReturnPolicyDetails.RestockingFeeValue</b> container in the + response. + <br><br> + <b>For Get calls</b>: The <b>RestockingFeeValue</b> + field is directly related to <b>RestockingFeeValueOption</b>, and + gives a user-friendly description of the restocking fee policy. + + + RestockingFeeCodeType + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + RelistFixedPriceItem + RelistItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList +
GranularityLevel: Medium, Fine
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GeteBayDetails.ReturnPolicyDetails + applicable values for RestockingFeeValueOption + GeteBayDetails.html#Response.ReturnPolicyDetails.RestockingFeeValue + + + + + + + + <span class="tablenote"> + <strong>Note:</strong> + This field is available for Production use on the eBay US and UK sites, and will be available in approximately September 2015 for the eBay CA/CAFR, DE, AT and AU sites. It is currently available for Sandbox testing on all of these eBay sites. + </span> + + When you list an item by using the AddItem, ReviseItem and RelistItem families of calls, use this field to enable a holiday returns policy for the item. A value of <code>true</code> indicates the seller is offering the item with an extended holiday returns period. + <br/><br/> + + The extended holiday returns period is defined by three dates: + <ul> + <li>The start date - start of November.</li> + <li>The purchase cutoff date - end of the year.</li> + <li>The end date - end of January.</li> + </ul> + + <span class="tablenote"> + <strong>Note:</strong> These dates may vary by a few days each year. Sellers will be notified of the current dates on their eBay site before the holiday period starts. + </span> + + Sellers can specify Extended Holiday Returns (as well as their regular non-holiday returns period) for chosen listings at any time during the year. The Extended Holiday Returns offer is not visible in the listings until the current year's holiday returns period start date, at which point it overrides the non-holiday returns policy. Buyers will see and be subject to the Extended Holiday Returns offer in listings purchased through the purchase cutoff date, and will be able to return those purchases through the end date. + <br/><br/> + + After the purchase cutoff date, the Extended Holiday Returns offer automatically disappears from listings, and the seller's non-holiday returns period reappears. Purchases made from that point on are subject to the non-holiday returns period, while purchases made before the cutoff date still have until the end date to be returned. + <br/><br/> + + If the value of <strong>ExtendedHolidayReturns</strong> is <code>false</code> for an item, the returns period specified by the <strong>ReturnsWithinOption</strong> field applies, regardless of the purchase date. If the item is listed with a policy of no returns, <strong>ExtendedHolidayReturns</strong> is automatically reset to <code>false</code>. + <br/><br/> + + <strong>For the AddItem family of calls</strong>, the value of <strong>ExtendedHolidayReturns</strong> is <code>false</code> by default. + <br/><br/> + + <strong>For the ReviseItem family of calls</strong>, you can omit <strong>ExtendedHolidayReturns</strong> from the input if its value does not need to change. If the item being revised has bids or orders, you can add the extended holiday returns option to the listing, but you can't remove it. If the item <em>does not</em> have bids or orders, you can add <em>or</em> remove the extended holiday returns option; however, this is a significant revision, triggering a version change in the listing. + <br/><br/> + + <strong>For the RelistItem family of calls</strong>, you can omit <strong>ExtendedHolidayReturns</strong> from the input if its value does not need to change. + <br/><br/> + + <strong>For the GetItem call</strong>, <strong>ExtendedHolidayReturns</strong> is returned only if the site you sent the request to supports the seller's return policy. Typically, this is only when the request is sent to the listing site. + <br/><br/> + + <span class="tablenote"> + <strong>Note:</strong> Top-Rated Sellers offering Extended Holiday Returns on a listing will get an additional 5 percent discount on the Final Value Fees on top of the 20 percent discount they get for creating Top-Rated Plus qualifying listings. See the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> help topic for more information on Top-Rated Seller, Top-Rated Plus requirements, and the 5 percent bonus discount for Extended Holiday Returns. + </span> + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + Enumerated type that defines the possible states of an eBay return. + + + + + + + This value indicates that the return request is invalid. + + + + + + + This value indicates that the return request is not applicable. + + + + + + + This value indicates that the return request is pending approval. + + + + + + + This value indicates that the return request was rejected. + + + + + + + This value indicates that a return request was successfully opened. + + + + + + + This value indicates that the buyer has return shipped the item(s) in the return request back to the seller. + + + + + + + This value indicates that the seller has received the item(s) that the buyer return shipped. + + + + + + + This value indicates that a return request was closed with no refund issued to the buyer. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case and closed. + + + + + + + This value indicates that a return request was closed with a refund issued to the buyer. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from the buyer. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from the seller. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, and it is pending a response from eBay Customer Support. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, but it was closed with a refund issued to the buyer. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, but it was closed with no refund issued to the buyer. + + + + + + + This value indicates that a return was escalated to an eBay Buyer Protection case, but the reason why is not necessarily known. + + + + + + + This value indicates that the return request is currently in the pending state. + + + + + + + This value indicates that the return request was closed with a refund to the buyer. + + + + + + + This value indicates that the return request was closed with no refund to the buyer. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Specified whether returns are accepted. + + + + + + + The seller accepts returns, subject to other details + specified in the policy. + + + + + + + The seller does not accept returns. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <b>ReturnPolicyDetails.ReturnsAccepted</b> container that + is returned in <b>GeteBayDetails</b>. This container contains the values + that may be used in the <b>ReturnPolicy.ReturnsAcceptedOption</b> field of Add/Revise/Relist + API calls. + + + + + + + Whether the seller allows the buyer to return the item. + This value can be passed in the AddItem family of calls. + + + ReturnsAcceptedOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present ReturnsAcceptedOption in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use ReturnsAcceptedOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + This enumerated type contains the list of values that can be used by the seller to set + the number of days (after the purchase date) that a buyer has to return an item (if the + return policy states that items can be returned) for a refund or an exchange. + + + + + + + The seller specifies this value to enable a 3-day return policy. A buyer must + return an item within three days after purchase in order to receive a refund or + an exchange. + <br> + <br> + <span class="tablenote"><b>Note:</b> + This value is deprecated. Listings created or revised with this value will be + blocked. + + + + + + + The seller specifies this value to enable a 7-day return policy. A buyer must + return an item within seven days after purchase in order to receive a refund or + an exchange. + <br> + <br> + <span class="tablenote"><b>Note:</b> + This value is deprecated. Listings created or revised with this value will be + blocked. + + + + + + + The seller specifies this value to enable a 10-day return policy. A buyer must + return an item within 10 days after purchase in order to receive a refund or + an exchange. + <br> + <br> + <span class="tablenote"><b>Note:</b> + This value is deprecated. Listings created or revised with this value will be + blocked. + + + + + + + The seller specifies this value to enable a 14-day return policy. A buyer must + return an item within 14 days after purchase in order to receive a refund or + an exchange. + + + + + + + The seller specifies this value to enable a 30-day return policy. A buyer must + return an item within 30 days after purchase in order to receive a refund or + an exchange. + + + + + + + The seller specifies this value to enable a 60-day return policy. A buyer must + return an item within 60 days after purchase in order to receive a refund or + an exchange. + + + + + + + The seller specifies this value to enable a one-month return policy. A buyer must return an item within one month after purchase in order to receive a refund or an exchange. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + Type defining the <b>ReturnPolicyDetails.ReturnsWithin</b> container that + is returned in <b>GeteBayDetails</b>. This container contains the values + that may be used in the <b>ReturnPolicy.ReturnsWithinOption</b> field of + Add/Revise/Relist API calls. + + + + + + + Value indicates the number of days that a buyer has to return an item from the day they + receive the item. This value can be passed in the Add/Revise/Relist family of API calls. Supported values can vary by eBay site. + + + ReturnsWithinOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present ReturnsWithinOption in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use ReturnsWithinOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Contains product reviews written by eBay members. + + + + + + + The product's average rating (out of 5) based on all reviews. + For example, a value like 4.5 would mean the average rating + is 4.5 out of 5. (See ReviewCount for the total number of reviews.) + + + 0 + 5 + + + + + + + An eBay member's review of the product. + + + 20 + + + + + + + + + + + A product review written by an eBay member. + + + + + + + A link to the full review on the eBay Web site. + This URL optimized for natural search: "_W0QQ" is like "?" + (question mark), "QQ" is like "&" (ampersand), + and "Z" is like "=" (equals sign).<br> + <br> + <span class="tablenote"><b>Note:</b> + For a link to all reviews for the product, remove the upvr parameter + from this URL. + </span> + + + + + + + The title of the review. + + + + + + + The eBay member's rating of the product. + + + + + + + The text of the review. If the review is longer than + 2000 characters, the text is cut off and it ends with "...". + See Review.URL for a link to the full text of the review. + + + 2000 + + + + + + + The reviewer's eBay user ID. + + + + + + + The time and date when the reviewer posted the review. + + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Specifies the reason for revising the item. + + + + + + + (out) Reserved for internal or future use. + + + + + + + The Item is revised in prostores. + + + + + + + The Item is revised internally by eBay system. + + + + + + + + + + + Contains data indicating whether an item has been revised since the + listing became active and, if so, which among a subset of properties + have been changed by the revision. + Output only. + + + + + + + If true, indicates the item was revised since the listing became + active. + Output only. + + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + If true, indicates that a Buy It Now Price was added for the item. + Only applicable to US eBay Motors items. + Output only. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + If true, indicates that the item's Buy It Now price was lowered. + Only applicable to US eBay Motors items. + Output only. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + If true, indicates that the reserve price was lowered for + the item. Only applicable to US eBay Motors items. + Output only. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + If true, indicates that the reserve price was removed + from the item. Only applicable to US eBay Motors items. + Output only. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + + + + + Reserved for future use.. + + + + + + + Reserved for future use. + + + + + + + + + + + A list of stock-keeping unit (SKU) identifiers that a seller uses in listings. + + + + + + + A SKU (stock keeping unit) is an identifier defined by a seller. + Some sellers use SKUs to track complex flows of products + and information on the client side. + A seller can specify a SKU when listing an item with AddItem + and related calls. eBay preserves the SKU on the item, enabling you + to obtain it before and after an order line item is created. + (SKU is recommended as an alternative to ApplicationData.)<br> + <br> + A SKU is not required to be unique. A seller can specify a + particular SKU value on one item or on multiple items. + Different sellers can use the same SKUs.<br> + <br> + If the SKU is unique across a seller's active listings, and if + the seller listed the item by using AddFixedPriceItem + or RelistFixedPriceItem, the seller can also set + Item.InventoryTrackingMethod to SKU. This allows the seller to use + SKU instead of ItemID as a unique identifier in subsequent calls, + such as GetItem and ReviseInventoryStatus.<br> + <br> + <span class="tablenote"><b>Note:</b> + AddFixedPriceItem and RelistFixedPriceItem are defined in + the Merchant Data API (part of Large Merchant Services). + </span> + + + 50 + + GetSellerTransactions + GetSellerList + No + + + + + + + + + + + Describes or includes information associated with the SKU. + + + + + + + + + + Stock Keeping Unit that serves as a unique identifier for an item. + Many merchants assign a SKU number to an item of a specific type, + size, and color. This way, they can keep track of how many products + of each type, size, and color are selling, and they can re-stock + their shelves according to customer demand. <br> + <br> + You can include a SKU when you list any item, and then use the SKU + instead of (or in addition to) using the ItemID to track your + inventory on eBay.<br> + <br> + For fixed-price items, if you set Item.InventoryTrackingmethod to + SKU, you can use the SKU instead of ItemID as a unique ID when you + revise the listing.<br> + <br> + Only returned when the listing included a SKU. + + + 70 + + ActiveInventoryReport + Conditionally + + + + + + + + The price that the seller assigns to the item. If this value + changes when the item is revised, the new value becomes the price. + For a multi-variation listing, price is only returned at + the variation level. <br> + <br> + You can revise this value using ReviseFixedPriceItem or ReviseInventoryStatus in the Trading API. + + + + ActiveInventoryReport + Conditionally + + + + + + + + The total number of items available for sale in the listing. + For a multi-variation listing, the item quantity for each variation + is returned at the variation level. + <br> + You can revise this value using ReviseFixedPriceItem or ReviseInventoryStatus in the Trading API. + + + + ActiveInventoryReport + Always + + + + + + + + The ID that uniquely identifies the item listing. + The ID is generated by eBay after an item is listed. + You cannot choose or revise this value. + <br> + Also applicable to Half.com. + + + + ActiveInventoryReport + Always + + + + + + + + Number of bids placed so far for the item. + Returned only for auction-style listings if auctionItemDetails.includeBidCount has + a value of true in the activeInventoryReportFilter of a Bulk Data Exchange Service + startDownloadJob request. + <br><br> + See <a href="http://developer.ebay.com/DevZone/bulk-data-exchange/CallRef/startDownloadJob.html#Request.downloadRequestFilter.activeInventoryReportFilter" target="_blank">activeInventoryReportFilter</a> + + + + ActiveInventoryReport + Conditionally + + + + + + + + Indicates whether the Reserve Price has been met for the listing. + Returned only for auction-style listings if auctionItemDetails.includeReservePrice has + a value of true in the activeInventoryReportFilter of a Bulk Data Exchange Service + startDownloadJob request. + <br><br> + See <a href="http://developer.ebay.com/DevZone/bulk-data-exchange/CallRef/startDownloadJob.html#Request.downloadRequestFilter.activeInventoryReportFilter" target="_blank">activeInventoryReportFilter</a> + + + + ActiveInventoryReport + Conditionally + + + + + + + + Variations are multiple similar (but not identical) items in one + fixed-price listing. For example, a clothing listing can + contain items of the same brand that vary by color and size. + Each variation specifies a combination of one of these + colors and sizes. Each variation can have a different + quantity and price. + + + + ActiveInventoryReport + Conditionally + + + + + + + + + + + + Primitive type that represents a stock-keeping unit (SKU). + The usage of this string may vary in different contexts. + For usage information and rules, see the fields that reference this type. + + + + + + + + + Type of SMS subscription error. + + + + + + + Aggregator not available. + + + + + + + Phone number invalid. + + + + + + + Phone number has changed. + + + + + + + The carrier has changed. + + + + + + + The user has requested to be unregistered. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + User data related to notifications. Note that SMS is currently reserved for future use. + + + + + + + The wireless phone number to be used for receiving SMS messages. + Max length of phone number varies by country. + + + varies by country + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + Registered/Unregistered/Pending. + + + + SetNotificationPreferences + Failed, Pending, Registered, Unregistered + No + + + GetNotificationPreferences + Conditionally + + + + + + + + The wireless carrier ID. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + Reason for SMS subscription error (postback from thired-party integrator). + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + ID of item to unsubscribe from SMS notification. + + + + SetNotificationPreferences + No + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + The current state of user SMS subscription. + + + + + + + (out) Registered. + + + + + + + (out) Unregistered. + + + + + + + (out) Pending subscription. + + + + + + + (out) Subscription failed. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + For the US, Canada and Australia sites, users are + required to offer at least one safe payment method (i.e. PayPal/PaisaPay, or one + of the credit cards specified in Item.PaymentMethods). + <br> + If a seller has a 'SafePaymentExempt' status, they are exempt from the category + requirement to offer at least one safe payment method when listing an item on a + site that has the safe payment requirement. + <br> + The safe payment requirement also applies to two-category listings that have one + ship-to or available-to location in the US, Canada, or Australia. The French + Canadian (CAFR) site is a special case, because listings on the CAFR site with + ship-to or available-to locations in Canada do not require a Safe Payment method, + yet listings on the CAFR site with ship-to or available-to locations in the US or + Australia do require a safe payment method. + <br> + The Business and Industrial, Motors, Real Estate, and Mature Audiences categories, + and all listings that don't support Item.PaymentMethods are exempt from this + requirement. Therefore, listings in those categories do not require a safe payment + method. + <br> + Currently, this field contains no other special meta-data.(An empty element is + returned.) + <br> + Use SiteDefaults.SafePaymentRequired and Category.SafePaymentRequired to determine + which categories require a safe payment method. + + + + + + + + + + + Type for expressing sales tax data. + + + + + + + Percent of an item's price to be charged as the sales tax for the order. + The value passed in is stored with a precision of 3 digits after the decimal + point (##.###). + <br><br> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddOrder + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerSaleRecord + ReviseSellingManagerTemplate + SendInvoice + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + GetSellingManagerSaleRecord + GetTaxTable + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + + + + + + State or jurisdiction for which the sales tax is being collected. + Only returned if the seller specified a value. + <br><br> + To see the valid values for your site, call <b>GeteBayDetails</b> with + <b>DetailName</b> set to <b>TaxJurisdiction</b>, and then + look for the TaxJurisdiction.JurisdictionID fields in the response. + <br><br> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddOrder + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + SendInvoice + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + (US only) Whether shipping costs were part of the base amount + that was taxed. Flat or calculated shipping. + <br><br> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddOrder + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + SendInvoice + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + The amount of sales tax, calculated for an order based on the + SalesTaxPercent and pricing information. US and US Motors (site 0) sites + only, excluding vehicle listings. + <br><br> + GetItemTransactions can return incorrect sales tax if the name of a state is not + abbreviated (e.g. if the value is "Illinois" rather than "IL") in + TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If + the name of a state is not abbreviated, sales tax should be obtained by using + the OrderLineItemID to call GetOrderTransactions. + <br><br> + Applicable to Half.com (for GetOrders). + + + + SendInvoice + No + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + + + + + This type is deprecated as Live Auctions are no longer a valid listing type. + + + + + + + This field is deprecated as Live Auctions are no longer a valid listing type. + + + + + + + + + + This field is deprecated as Live Auctions are no longer a valid listing type. + + + + + + + + + + + + + + Contains information for scheduling limits for the user. + + + + + + + Maximum number of minutes that a listing may be scheduled in advance of its going live. + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Minimum number of minutes that a listing may be scheduled in advance of its going live. + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Maximum number of Items that a user may schedule. + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + This field is deprecated. + + + + + + + + + + + + + + + + This type is deprecated as <b>GetProduct*</b> calls were deprecated. + + + + + + + + + + + + Indicates whether a listing has an image associated with it. + + + + + + + + + + + Indicates whether a listing is no more than one day old. + + + + + + + + + + + + + + This enumerated type lists the possible values that can be returned under the + <b>FavoriteSearch.SearchFlag</b> field of a + <b>GetMyeBayBuying</b> response. These values are output only and are + controlled by the filter types used in a buyer's Saved Search. + + + NowAndNew, DigitalDelivery, Picture, Gallery, WorldOfGood, GetItFast + + + + + + + This value being returned in the <b>FavoriteSearch.SearchFlag</b> + field indicates that the buyer selected the <b>eBay Giving Works</b> + option in the Saved Search. + + + + + + + This value being returned in the <b>FavoriteSearch.SearchFlag</b> + field indicates that the buyer set a filter to only retrieve listings where the + seller offers gift services to the buyer. + <br/><br/> + Gift services are not available on all sites (including the US). To see if a + country supports gift services, call <b>GeteBayDetails</b>, using the + appropriate eBay Site ID in the call header and 'ListingFeatureDetails' as a + <b>DetailName</b> filter in the request, and then look for a + <b>ListingFeatureDetails.GiftIcon</b> flag in the response. + + + + + + + This value is no longer applicable. + + + + + + + This value being returned in the <b>FavoriteSearch.SearchFlag</b> + field indicates that the buyer selected the <b>Local pickup</b> + option in the Saved Search. A buyer would select the <b>Local Pickup</b> + filter in a Saved Search to restrict retrieved listings to those that offer 'local pickup' + as an option to buyers. + + + + + + + This value being returned in the <b>FavoriteSearch.SearchFlag</b> + field indicates that the buyer selected the <b>Free shipping</b> + option in the Saved Search. A buyer would select the <b>Free shipping</b> + filter in a Saved Search to restrict retrieved listings to those that offer a free + shipping option to that specific buyer (the availability of free shipping may + be dependent on the buyer's location). + + + + + + + This value is no longer applicable as there is always a gallery picture by + default since all listings must have at least one picture. + + + + + + + This value is no longer applicable as there is now a requirement that all + listings have at least one picture. + + + + + + + This value is no longer used. + + + + + + + This value being returned in the <b>FavoriteSearch.SearchFlag</b> + field indicates that the buyer selected the <b>Items listed as lots</b> + option in the Saved Search. A buyer would select the <b>Items listed as lots</b> + filter in a Saved Search to restrict retrieved listings to those that are offering + a "lot" of items in one listing. Specifically, a "lot" is defined as, "a group of + similar or identical items that are sold together to one buyer." + + + + + + + This value is only applicable to the German site and if the user is searching for + motor vehicle listings. This value being returned in the + <b>FavoriteSearch.SearchFlag</b> field indicates that the buyer + selected a filter in a Saved Search to restrict retrieved eBay Germany motor + vehicle listings that are also being displayed on the mobile.de vehicle + marketplace. + + + + + + + This value is no longer used. + + + + + + + This value is no longer applicable. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Provides information about the visibility level you've earned for your eBay listings. + When you have a better search standing, your listings may receive higher + placement in Best Match search results. + + + + + + + Your earned search standing status. To qualify for a Standard or Raised + search standing, make sure your ratings meet or exceed the required minimum + levels in buyer satisfaction (see BuyerSatisfaction.Status in this call) and + detailed seller ratings (DSRs). See GetFeedback for details. + + + + GetSellerDashboard + Always + + + (GetFeedback) FeedbackSummary.SellerRatingSummaryArray + GetFeedback.html#Response.FeedbackSummary.SellerRatingSummaryArray + + + + + + + + + + + + The Search standing that you have earned. + + + + + + + Your listings may receive higher placement in search results + that are sorted by Best Match. + You earn this standing when you provide excellent customer service to eBay buyers + (such as good BuyerSatisfaction.Status and high detailed seller ratings). + If you already have a raised search standing, you can still boost your + ratings and increase the visibility of your items by maintaining or + improving your customer service. + + + + + + + Listings recieve standard placement in search results that are sorted by Best Match. + + + + + + + Your listings may receive lower placement in search results that + are sorted by Best Match. + You earn this standing when you have not been successful in providing + eBay buyers with the customer service they expect. + You can still take positive steps to improve your customer service + and increase your ratings. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This enumerated type contains the list of values that can be used by the seller to set + the length of time that a Second Chance offer will be available to a specific bidder to + whom the Second Chance offer was presented. The recipient of a Second Chance offer must + purchase the Second Chance item within this time or the offer will expire. Second Chance + offers are only applicable for closed auction listings. + + + + + + + The seller specifies this value to make the Second Chance offer available to the + bidder for one day. This value will affect the <b>EndTime</b> value + returned in the <b>AddSecondChanceItem</b> response. + + + + + + + The seller specifies this value to make the Second Chance offer available to the + bidder for three days. This value will affect the <b>EndTime</b> value + returned in the <b>AddSecondChanceItem</b> response. + + + + + + + The seller specifies this value to make the Second Chance offer available to the + bidder for five days. This value will affect the <b>EndTime</b> value + returned in the <b>AddSecondChanceItem</b> response. + + + + + + + The seller specifies this value to make the Second Chance offer available to the + bidder for seven days. This value will affect the <b>EndTime</b> value + returned in the <b>AddSecondChanceItem</b> response. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + This is automatic or manual depending on selection. + + + + + + + + + + Automatic criteria. Reserved for future use. + + + + + + + Manual criteria. Reserved for future use. + + + + + + + In listing requests, do not specify the name or value because + they will be filled in by eBay. + In GetItemRecommendations, this indicates that the Item Specific + will be pre-filled from a catalog, based on a product ID + that you passed in the request. They should be presented as + read-only to the seller. If you specify a prefilled value in + your listing request when you list with a catalog product, + eBay drops the value and uses the value from the catalog instead. + + + + + + + In listing requests, only specify a value that eBay has + recommended. That is, select from the list of recommended values; + don't specify your own custom details. If you specify a different value, the listing request may return errors. Rarely used. + + + + + + + In listing requests, specify any name or value, or select from the + list of recommended values, if present. This is used in most cases. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>SellerAccount</b> container returned in the + <b>GetSellerDashboard</b> response. + + + + + + + This field indicates the status of your seller's account. Specifically, you'll find out if your + account is current and active, or if your account has a past due balance or is on + hold. For more details about your account, you can go to your Seller Account page + on the eBay site (login to My eBay), or you can call <b>GetAccount</b>. + + + + GetSellerDashboard + Always + + + GetAccount + GetAccount.html + + + + + + + + The <b>SellerAccount.Alert</b> container is only returned if eBay has + posted one or more informational or warning messages to the seller's account. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Seller account status. + + + + + + + Your account is current. + + + + + + + Your account is past due. + + + + + + + Your account is on hold and risking suspension. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type of seller account. This value is returned if the user is a + business seller with a site ID of 77 (Germany), 3 (UK), 205 (Ireland) or 0 (US Motors). + + + + + + + Type of seller account not defined. + + + + + + + Private seller account. + + + + + + + Commercial seller account. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the SellerContactDetailsEnabled feature. If the field is present, the + category allows retrieval of seller-level contact information. The field is + returned as an empty element (e.g., a boolean value is not returned). + + + + + + + + + + + Alerts can be either informational or a warning that identifies a problem. + + + + + + + The alert message is informational in nature. + <br><br> + Some examples: you might get a PowerSeller status message if your PowerSeller + level has been increased, a policy-compliance message if you have no recent + policy violations, a buyer-satisfaction message if you are providing excellent + customer service, or a seller-account message if there is a new notice available + about your payment status. + + + + + + + The alert message is a warning that identifies a problem. + <br><br> + For example, you might get a PowerSeller status warning if you missed the + PowerSeller sales requirements in the past month. Or you might get a + policy-compliance warning if you recently listed an item with excessive + shipping costs, or a seller-account warning if a collections message + asks you to pay now to make sure no restrictions are placed on your account. + + + + + + + The alert message is a strong warning that indicates a serious problem. + <br><br> + For example, you might get a PowerSeller status strong warning if you have lost + your PowerSeller status because of policy violations, or you might get a + policy-compliance strong warning if your account has been restricted. + + + + + + + Reserved for internal (or future) use. + + + + + + + + + + A message to help the you understand your status as a seller (PowerSeller status, + policy compliance status, etc.). + + + + + + + The severity level helps you understand whether the alert is identifying a + problem (a warning or strong warning) or if it is informational in nature. + This field is present if an alert has been issued to your account. + + + + GetSellerDashboard + Conditionally + + + + + + + + The warning or informational alert text. When you parse this text, note that + some alerts may use plain text while others can include HTML. Returned only + if the seller has been issued an alert. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Type defining the <b>SellerDiscounts</b> container, which consists of one or + more <b>SellerDiscount</b> nodes, as well as the original purchase price and + shipping cost of the order line item. + + + + + + + The original purchase price of the order line item (before any seller discounts are + applied). + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The original shipping cost for the order line item. Note that shipping discounts have + not yet been enabled for seller discount campaigns. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The original shipping service offered by the seller to ship an item to a buyer. + + + ShippingServiceCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A container consisting of name and ID of the seller's discount campaign, as well as the + discount amount that is being applied to the order line item. Note that shipping + discounts have not yet been enabled for seller discount campaigns. Seller + discount campaigns are created through the Order Size Discounts API. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + http://developer.ebay.com/Devzone/order-size/CallRef/createCampaigns.html + Order Size Discounts API - createCampaigns call + for information on creating discount campaigns + + + http://developer.ebay.com/Devzone/related-items/CallRef/createBundles.html + Related Items Management API - createBundles call + for information on creating product bundles + + + + + + + + + + + Type that defines the <b>SellerDiscount</b> container, which contains the ID, + name, and amount of the seller discount. + + + + + + + Unique identifier for a seller discount campaign. This ID is automatically + created when the seller creates the discount campaign. This field is always returned + with the <b>SellerDiscount</b> container. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + http://developer.ebay.com/Devzone/order-size/CallRef/createCampaigns.html#Response.campaignStatus.campaignId + campaignId field in Order Size Discounts API + + + + + + + + The name of the seller discount campaign. A name can be associated with a seller discount + campaign when the seller uses the <b>createCampaigns</b> or + <b>updateCampaigns</b> calls of the Order Size Discounts API. + The name for a discount campaign is optional, so this field will only be + returned with the <b>SellerDiscount</b> container if defined + for the seller discount campaign. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + http://developer.ebay.com/Devzone/order-size/CallRef/createCampaigns.html#Request.campaign.name + campaign.name field in Order Size Discounts API + + + + + + + + The dollar amount of the order line item discount. The original purchase price (denoted + in <b>OriginalItemPrice</b>) will be reduced by this value. The amount of the + item discount will depend on the rules defined in the the seller discount + campaign. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field. + </span> + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + http://developer.ebay.com/Devzone/order-size/CallRef/createCampaigns.html#Request.campaign.offer + campaign.offer container in Order Size Discounts API + + + + + + + + The dollar amount of the shipping discount applied to the order line item. Note that + shipping discounts have not yet been enabled for seller discount campaigns, so this + field will not be returned until shipping discounts are enabled. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + + + + + Container consisting for the list of locations to where the seller will not ship items. + + + + + + + One ExcludeShipToLocation field is returned for each region or country excluded + as a possible shipping location in the seller's My eBay Shipping Preferences. + Sellers can also exclude Alaska/Hawaii and Army Post Office/Fleet Post Office as + possible shipping locations. For excluded countries, "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm">ISO 3166</a> + country codes are returned. + <br><br> + Domestically, the seller can specify Alaska/Hawaii, US Protectorates (including + American Samoa, Guam, Mariana Island, Marshall Islands, Micronesia, Palau, + Puerto Rico, and U.S. Virgin Islands) as places he/she will not ship to. + Internationally, the sellers can exclude entire regions (including Africa, Asia, + Central America and Caribbean, Europe, Middle East, North America, Oceania, + Southeast Asia, and South America) or specific countries within those regions. + <br><br> + If a buyer's primary ship-to location is a location that you have listed as + an excluded ship-to location (or if the buyer does not have a primary ship-to + location), they will receive an error message if they attempt to buy or place + a bid on your item. + <br><br> + To see the valid exclude ship-to locations for a specified site, call + GeteBayDetails with DetailName set to ExcludeShippingLocationDetails. Repeat + GeteBayDetails for each site on which you list. + <br><br> + <span class="tablenote"><strong>Note:</strong> + To enable your default Exclude Ship-To List, you must enable Exclude + Shipping Locations and Buyer Requirements in your My eBay Site Preferences. + For details, see the KnowledgeBase Article <a href= + "https://ebaydts.com/eBayKBDetails?KBid=1495" + >HowTo: ExcludeShipToLocation</a>. + </span> + Code denoting a location to where the seller will not ship. + <br> + The codes reflect the <a href= + "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm" + >ISO 3166</a> location codes. + + + + GetUserPreferences + Conditionally + + + + + + + + + + + + Contains the data for the seller favorite item preferences, i.e. the manual or automatic selection criteria to display items for buyer's favourite seller opt in email marketing. + + + + + + + The keywords in the item title for the automatic item search criteria. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + (For eBay Store owners only) The store custom category for the automatic item search criteria. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + The listing format (fixed price, auction, etc) for the automatic item search criteria. + + + + GetUserPreferences + Auction, LeadGeneration, FixedPriceItem + Conditionally + + + SetUserPreferences + Auction, LeadGeneration, FixedPriceItem + No + + + + + + + + The sort order chosen from the standard ebay sorts for the automatic search criteria. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the lower limit of price range for the automatic search criteria. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the upper limit of price range for the automatic search criteria. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the list of favorite items. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + PowerSeller discount information (e.g., to show in a Seller Dashboard). As a + PowerSeller, you can earn discounts on your monthly invoice Final Value Fees based + on how well you're doing as a seller. + + + + + + + PowerSeller discount as a percentage. For example, a 5% discount is returned + as 0.05. + + + + GetSellerDashboard + Conditionally + + + + + + + + + + + + Maximum level of guarantee a seller is authorized to offer. + + + + + + + (out) Not eligible for Seller Level Guarantee + + + + + + + (out) Regular eligibility level + + + + + + + (out) Premium eligibility level + + + + + + + (out) Ultra eligibility level + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates the user's eBay PowerSeller tier. PowerSellers are distinguished in 5 + tiers based on average monthly sales. Benefits and services vary for each tier. + eBay calculates eligibility for each tier monthly. + + + + + + + Bronze (lowest tier) + + + + + + + Silver (between Bronze and Gold) + + + + + + + Gold (between Silver and Platinum) + + + + + + + Platinum (between Gold and Titanium) + + + + + + + Titanium (highest tier) + + + + + + + Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or + you have not chosen to be a member of the PowerSeller program, + or you lost your PowerSeller status due to a policy violation.) + + + + + + + Reserved for internal or future use + + + + + + + + + + This enumerated type is reserved for future use. + + + + + + + This value is reserved for future use. + + + + + + + This value is reserved for future use. + + + + + + + This value is reserved for future use. + + + + + + + Reserved for internal or future use + + + + + + + + + + These are payment methods that sellers can use to pay eBay fees. + + + + + + + Used for all other payment methods which are not specifically listed in other columns. + + + + + + + Credit Card + + + + + + + PayPal + + + + + + + Direct Debit + + + + + + + Direct Debit, pending signature mandate + + + + + + + eBay Direct Pay + + + + + + + (out) Reserved for internal or future use + + + + + + + Direct Debit, pending verification + + + + + + + + + + Type defining the <b>SellerPaymentPreferences</b> container, which + consists of the seller's payment preferences. Payment preferences specified in a + <b>SetUserPreferences</b> call override the settings in My eBay payment + preferences. + + + + + + + Sellers include this field and set it to 'true' if they want buyers to mail payment + to the payment address specified in the + <b>SellerPaymentPreferences.SellerPaymentAddress</b> field. A payment + address only comes into play if the item's category allows offline payments, and the + seller has allowed the buyer to mail a payment. This payment address will only be + displayed to winning bidders and buyers. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + If set, this field determines whether a Pay Now button is displayed for all of the + user's listings. The user has the option of using a PayPal only version of the Pay + Now button or a Pay Now button for all payment methods. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies whether a seller wants to let buyers know that PayPal payments + are preferred. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the default email address the seller uses for receiving PayPal payments. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Indicates whether PayPal is always accepted for the seller's listings. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the address the seller uses to receive mailed payments from buyers. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the type of United Parcel Service rates to use. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the type of FedEx rates to use. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Specifies the type of USPS rates to use. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + Type defining the <b>SellerPaymentProfile</b> container, which is used in an + Add/Revise/Relist Trading API call to reference a Business Policies payment profile. + + + + + + + The unique identifier of a Business Policies payment profile. A <b>PaymentProfileID</b> + and/or a <b>PaymentProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the payment policy values of a Business Policies payment + profile. If both fields are provided and their values don't match, the <b>PaymentProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>PaymentProfileID</b> value will always be + returned if the listing is using a Business Policies payment profile, and the <b>PaymentProfileName</b> + value will be returned if a name is assigned to the payment profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The name of a Business Policies payment profile. A <b>PaymentProfileID</b> + and/or a <b>PaymentProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the payment policy values of a Business Policies payment + profile. If both fields are provided and their values don't match, the <b>PaymentProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>PaymentProfileID</b> value will always be + returned if the listing is using a Business Policies payment profile, and the <b>PaymentProfileName</b> + value will be returned if a name is assigned to the payment profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + A payment between Half.com and a seller. The financial value of a payment is + typically based on an amount that a buyer paid to Half.com for one order line + item, plus the buyer's shipping cost, minus Half.com's commission. + + + + + + + Unique identifier for the Half.com item listing. + + + 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) + + GetSellerPayments + Always + + + + + + + + Unique identifier for a Half.com order line item (transaction). An order + line item is created once there is a commitment from a buyer to purchase an + item. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used and + referenced during an order checkout flow and after checkout has been + completed. + + + 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) + + GetSellerPayments + Always + + + + + + + + A unique identifier that identifies a single line item or multiple line item + (Combined Invoice) Half.com order. + <br><br> + For a single line item order, the <b>OrderID</b> value is identical to the + <b>OrderLineItemID</b> value that is generated upon creation of the order line + item. For a Combined Invoice order, the <b>OrderID</b> value is created by eBay + when the buyer or seller (sharing multiple, common order line items) + combines multiple order line items into a Combined Invoice order through + the Half.com site. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetSellerPayments + Always + + + + + + + + An ID that the seller specified when they listed the Half.com item, if any. + It can be used for the seller's SKU. Note that <b>SellerInventoryID</b> is not + returned if no ID was specified. (Note: The SKU field used for eBay.com + listings is not applicable to Half.com listings.) + + + + GetSellerPayments + Conditionally + + + + + + + + A text note that the seller specified for the Half.com item, if any. Only + visible to the seller. Not returned if the seller specified no notes. + + + + GetSellerPayments + Conditionally + + + + + + + + Contains an ISBN, UPC, or EAN value from the catalog product associated with + the Half.com item. All Half.com items are listed with Pre-filled Item + Information. + + + + GetSellerPayments + Always + + + + + + + + The title of the item listing as it appears on Half.com. + + + 80 + + GetSellerPayments + Always + + + + + + + + Indicates whether the payment is for a Half.com sale or a refund. + + + + GetSellerPayments + Sale, Refund + Always + + + + + + + + Price of the order line item (transaction) before shipping and other costs. + + + + GetSellerPayments + Always + + + + + + + + The adjusted shipping cost that Half.com pays the seller. For a multiple + line item (Combined Invoice) order, the total shipping cost may be less than + the cost to ship the items individually, which makes the adjustment + necessary. The shipping cost may also be adjusted due to Half.com handling + charges. + <br><br> + <b>Note</b>: Due to the way shipping costs are calculated, this + value may be different for identical items in different orders. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetSellerPayments + Always + + + + + + + + Amount of commission charged by Half.com. + + + + GetSellerPayments + Always + + + + + + + + Total amount paid by buyer for the Half.com order. + + + + GetSellerPayments + Always + + + + + + + + The time and date when Half.com created the payment. Half.com creates a + payment when the buyer pays for an order. This time is specified + in GMT (not Pacific time). See <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/DataTypes.html#ConvertingBetweenUTCGMTandLocalTime"> eBay Features Guide</a> + for information about converting between GMT and other time zones. + + + + GetSellerPayments + Always + + + + + + + + A unique identifier for a Half.com order line item. This field is created as + soon as there is a commitment to buy from the seller, and its value is based + upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between + these two IDs. For a single line item order, the <b>OrderLineItemID</b> value is + identical to the <b>OrderID</b> value. + + + 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) + + GetSellerPayments + Always + + + + + + + + + + + + Type defining the <b>SellerProfilePreferences</b> container. This container + consists of a flag that indicates whether or not the seller has opted into Business + Policies, as well as a list of Business Policies profiles that have been set up for the + seller's account. + + + + + + + Boolean flag indicating whether or not a seller has opted in to Business + Policies. Sellers must opt in to Business Policies to create and manage payment, + return policy, and shipping profiles. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Container consisting of one or more Business Policies profiles active for a + seller's account. This container is only returned if SellerProfileOptedIn=true + and the seller has one or more Business Policies profiles active on the account. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + Type defining the <b>SellerProfiles</b> container, which consists of references + to a seller's payment, shipping, and/or return policy profiles. + + + + + + + The <b>SellerShippingProfile</b> container is used in an Add/Revise/Relist + Trading API call to reference and use the values of a Business Policies shipping policy + profile. Business Policies shipping profiles contain detailed information on + domestic and international shipping, including shipping service options, handling + time, package handling costs, excluded ship-to locations, and shipping insurance + information. + <br/><br/> + Business Policies shipping profiles are also returned in + <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other + Trading calls that retrieve Item data. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddSellingManagerTemplate + ReviseSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + The <b>SellerReturnProfile</b> container is used in an Add/Revise/Relist + Trading API call to reference and use the values of a Business Policies return policy + profile. Business Policies return policy profiles contain detailed information on + the seller's return policy, including the refund option, how many days the buyer has + to return the item for a refund, warranty information, and restocking fee (if any). + <br/><br/> + Business Policies return policy profiles are also returned in + <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other + Trading calls that retrieve Item data. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + ReviseSellingManagerTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + The <b>SellerPaymentProfile</b> container is used in an Add/Revise/Relist + Trading API call to reference and use the values of a Business Policies payment + profile. Business Policies payment profiles contain accepted payment methods, a + flag to set up the immediate payment feature, a payment instructions field, and a + field to specify the seller's PayPal email address. + <br/><br/> + Business Policies payment profiles are also returned in + <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other + Trading calls that retrieve Item data. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + ReviseSellingManagerTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + If present, the site defines category settings for whether the seller can provide their own title for a US or CA eBay Motors listing. + + + + + + + + + + + Type defining the <b>SellerRatingSummaryArray</b> container that is returned + in the <b>GetFeedback</b> response. The <b>SellerRatingSummaryArray</b> + container consists of an array of <b>AverageRatingSummary</b> containers, + which provide details on Detailed Seller Ratings (DSRs), including the type of rating + (Communication, Item As Described, Shipping and Handling Charges, or Shipping Time), the + seller's average rating for that DSR type, the total number of DSR ratings, and the + period in which those ratings were received (the last year or the last 30 days). + + + + + + + Container consisting of a seller's Detailed Seller Rating (DSR) for each type of + rating (Communication, Item As Described, Shipping and Handling Charges, or Shipping + Time), the seller's average rating for each DSR type, the total number of DSR ratings + for each DSR type, and the period in which those ratings were received (the last year + or the last 30 days). + + + + GetFeedback + Conditionally +
DetailLevel: none, ReturnAll
+ + + + + + + + + + + Details the recoupment policy on this site. There are two sites involved in recoupment - the listing site + and the user registration site, each of which must agree before eBay enforces recoupment for a seller and listing. + + + + + + + Indicates whether recoupment policy is enforced on the site on which the item is listed. + + + + GeteBayDetails + Always + + + + + + + + Indicates whether recoupment policy is enforced on the registration site for which the call is made. + + + + GeteBayDetails + Always + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails + Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails + Always + + + + + + + + + + + + Type defining the <b>SellerReturnPreferences</b> container, which consists of the <b>OptedIn</b> flag that indicates whether or not the seller has opted in to eBay Managed Returns. + <br><br> + eBay Managed Returns are currently only available on the US and UK sites. + + + + + + + This flag indicates whether or not an eligible seller has opted in to eBay + Managed Returns through the Return Preferences of My eBay. + <br><br> + eBay Managed returns are currently only available on the US and UK sites. + + + + GetUserPreferences + Conditionally + + + + + + + + + + + + Type defining the <b>SellerReturnProfile</b> container, which is used in an + Add/Revise/Relist Trading API call to reference a Business Policies return policy profile. + Business Policies return policy profiles contain detailed information on + the seller's return policy, including the refund option, how many days the buyer has + to return the item for a refund, warranty information, and restocking fee (if any). + <br/><br/> + Business Policies return policy profiles are also returned in + <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other + Trading calls that retrieve Item data. + + + + + + + The unique identifier of a Business Policies return policy profile. A <b>ReturnProfileID</b> + and/or a <b>ReturnProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the payment policy values of a Business Policies return policy + profile. If both fields are provided and their values don't match, the <b>ReturnProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>ReturnProfileID</b> value will always be + returned if the listing is using a Business Policies return policy profile, and the <b>ReturnProfileName</b> + value will be returned if a name is assigned to the return policy profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + The name of a Business Policies return policy profile. A <b>ReturnProfileID</b> + and/or a <b>ReturnProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the return policy values of a Business Policies return policy + profile. If both fields are provided and their values don't match, the <b>ReturnProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>ReturnProfileID</b> value will always be + returned if the listing is using a Business Policies return policy profile, and the <b>ReturnProfileName</b> + value will be returned if a name is assigned to the return policy profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + Specifies 1 year feedback metrics for a seller. + + + + + + + Count of positive feedback entries given as a seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of negative feedback entries given as a seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of neutral feedback entries given as a seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Percentage of leaving feedback as a seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Number of buyers who bought more than once from this seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Percentage of repeat buyers. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Count of unique buyers from this seller. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Percentage of number of times a member has sold successfully vs. the number of + times a member has bought an item in the preceding 365 days. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The count of Cross-Border Trade order line items. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The percentage of order line items that are Cross-Border Trade order line items. + + + + GetFeedback +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Type defining the <b>SellerShippingProfile</b> container, which is used in an + Add/Revise/Relist Trading API call to reference a Business Policies shipping policy profile. + Business Policies shipping profiles contain detailed information on domestic and + international shipping, including shipping service options, handling time, package + handling costs, excluded ship-to locations, and shipping insurance information. + <br/><br/> + Business Policies shipping profiles are also returned in + <b>GetItem</b>, <b>GetMyeBaySelling</b>, and other + Trading calls that retrieve Item data. + + + + + + + The unique identifier of a Business Policies shipping policy profile. A <b>ShippingProfileID</b> + and/or a <b>ShippingProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the shipping policy values of a Business Policies shipping policy + profile. If both fields are provided and their values don't match, the <b>ShippingProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>ShippingProfileID</b> value will always be + returned if the listing is using a Business Policies shipping policy profile, and the <b>ShippingProfileName</b> + value will be returned if a name is assigned to the shipping policy profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + The name of a Business Policies shipping policy profile. A <b>ShippingProfileID</b> + and/or a <b>ShippingProfileName</b> value is used in the Add/Revise/Relist + call to reference and use the shipping policy values of a Business Policies shipping policy + profile. If both fields are provided and their values don't match, the <b>ShippingProfileID</b> + takes precedence. + <br/><br/> + In the "Get" calls, the <b>ShippingProfileID</b> value will always be + returned if the listing is using a Business Policies shipping policy profile, and the <b>ShippingProfileName</b> + value will be returned if a name is assigned to the shipping policy profile. + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddItem + AddItems + ReviseItem + RelistItem + VerifyAddItem + AddItemFromSellingManagerTemplate + AddItemFromTemplate + AddTemplate + ReviseTemplate + VerifyRelistItem + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents + GetItems + GetMyeBaySelling + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + Information about a user returned in the context of an item's seller. + + + + + + + Indicates the seller's PaisaPay and PaisapayEscrow registration status. India site only.<br> + 0 - Seller not registered<br> + 1 - Seller registered<br> + 2 - Seller registered but registration suspended<br> + 3 - Seller registered but outbound payment suspended<br> + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the user as a seller by default allows buyers to edit the + total cost of an item (while in checkout). (Sellers enable this property in + their My eBay user preferences on the eBay site.) + + + + GetBidderList + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Currency type in which the user is billed seller fees. + + + + + + + This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at + listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, + a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This + preferance is enabled by default if PayPal is one of the payment methods. + + + + GetBidderList + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + + + + + + If true, this flag indicates that the seller has stored bank account information on file + with eBay. A seller must have stored bank account information on file with eBay in order + to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This + field is applicable to all eBay sites that support 'CashOnPickup' as a payment method. + + + + GetBidderList + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + If true, indicates that the user is in good standing with eBay. (One of the + requirements for listing a new item with Immediate Payment.) + + + + GetBidderList + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates whether the seller participates in the + Merchandising Manager feature. If so, the seller can + set up rules for cross-promoting items from the seller's store. + If not, eBay cross-promotes items as the seller's items are + being viewed or purchased. + + + + GetBidderList + Always + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Indicates whether the user is subject to VAT. Users who have registered with + eBay as VAT-exempt are not subject to VAT. + + + + GetBidderList + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + No longer supported. + + + + + + + + + + The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. + SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and + GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using + a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that + SellerInfo.SellerLevel could potentially be removed from other sites as well. + + + + GetBidderList + Always + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + Address used by eBay for purposes of billing the user for seller fees. + + + + GetUser +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Container for scheduling limits for the user. + Conveys the minimum and maximum + minutes the user may schedule listings in advance, as well as the maximum + number of items the user may schedule. + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Boolean value indicates whether or not the seller is an eBay Store owner. + + + + GetBidderList + Always + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The URL for the seller's eBay Store. This field is only returned if the seller is a store + owner. To determine if a seller is a Store owner, check for the <b>User.SellerInfo.StoreOwner</b> + and a value of true. The eBay Stores domain that is returned in this field is based on the + <b>SITEID</b> header that is passed in the request, and not on the user's + registration address, as was the case prior to version 757. So, if the seller's + registration county is the UK, but a <b>SITEID</b> value of 71 (France) is + passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Type of seller account. This value is returned if the German + (ID 77), UK (ID 3), Ireland (ID 205), or US eBay Motors (ID 0) sites are specified. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If true, the user is registered as a vehicle dealer on the eBay Motors site. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + The site associated with the seller's eBay Store. + + + + GetUser + Conditionally + + + + + + + + Indicates the method the seller selected to pay eBay with for + the account. + The payment methods vary from one eBay site to the next. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Details about the checkout preferences related to the ProStores store. Returned + only if set by the user. (Currently those preferences are not settable using the public API.) + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the seller is a registered charity + seller. If CharityRegistered is false, the user must + register with the eBay Giving Works provider to list items + with eBay Giving Works. + + + + eBay Giving Works for Seller + http://givingworks.ebay.com/sell/ + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + If true, the user is currently exempt from the requirement to offer at least + one safe payment method (PayPal/PaisaPay or one of the credit cards specified + in Item.PaymentMethods) when listing items. This value should only return true + for sellers who registered before January 17, 2007. Otherwise, it should + return false. This setting overrides both the site and category values for + SafePaymentRequired. + + + false + + GetBidderList + Always + Seller +
DetailLevel: none, ReturnAll
+ + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription,ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + + + + + + Indicates the seller's PaisaPayEscrowEMI (Equal Monthly Installment) registration status. India site only.<br> + 0 - Seller not registered<br> + 1 - Seller registered<br> + 7 - Seller eligible<br> + + + + GetUser +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains information about the seller's charity affiliations detail. + Returned if the user is affiliated with one or more + charities. Seller must be registered with the eBay Giving + Works provider to be affiliated with a charity non-profit + organization. + + + + eBay Giving Works Program + http://givingworks.ebay.com/ + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Percentage of the number of times a member has sold successfully vs. + the number of times a member has bought an item in the preceding 365 days. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates the sites on which a seller has a payment gateway account + (and thus the sites on which the seller can use the IntegratedMerchantCreditCard + payment method). + Sellers use a payment gateway account to accept online + credit cards. + + + + Specifying a Payment Method + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-PaymentMethod.html#DeterminingthePaymentMethodsAllowedforaC + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Contains eligibility details about seller- or platform-based features. This is returned only + if IncludeFeatureEligibility is set to true in the request. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This boolean field indicates if the seller is certified as a + <em>Top Rated Seller</em>. To qualify as a Top Rated Seller, a + seller must meet the following requirements: + <ul> + <li>100 or more selling transactions in a one-year period</li> + <li>Shipment tracking information provided to the buyer within the + specified handling time for at least 90 percent of their listings</li> + </ul> + This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), AT (EBAY-AT), CH (EBAY-CH), DE (EBAY-DE), IE (EBAY-IE) and UK (EBAY-GB). + <br/><br/> + On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (<strong>DispatchTimeMax</strong>=<code>1</code>). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount. + + + + GetBidderList + Conditionally + + + GetSellerList + SellerInfo +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + Top Rated Seller Resource Center + http://pages.ebay.com/sellerinformation/sellingresources/toprated.html + more information about how to become a Top Rated Seller and qualify for Top Rated Plus on the eBay US site + + + Seller Help Page + http://pages.ebay.com/help/sell/top-rated.html + more information about how to qualify as a Top Rated Seller on the eBay US, AT, CH, DE, IE and UK sites + + + + + + + + Contains top-rated seller program details for the seller. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + The list of the sites where a seller has agreed to the cross-border recoupment terms. + <br><br> + Sellers who engage in cross-border trade on sites that require a recoupment agreement, must + agree to the recoupment terms before adding items to the site. This agreement allows eBay to + reimburse a buyer during a dispute and then recoup the cost from the seller. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + If true, the seller has configured a domestic shipping rate table on the DE, UK or US website. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + If true, the seller has configured an international shipping rate table on the US, UK or DE website. + + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This field is no longer used. + + + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + This enumerated type is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + This value is no longer used. + + + + + + + Reserved for internal or future use + + + + + + + + + + Type defining the Alert container, which contains summary information on one type of + Selling Manager alert. + + + + + + + This field indicates the type of Selling Manager alert returned to the seller. This + field is always returned with the <b>Alert</b> container in the + <b>GetSellingManagerAlerts</b> response. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This value indicates an alert related to a sold item. This field is only returned + if <b>AlertType</b>='Sold'. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This value indicates an alert related to the seller's inventory, such as a + restocking alert. This field is only returned if + <b>AlertType</b>='Inventory'. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This value indicates an alert related to listing automation, and may be received + when a listing does not conform to listing automation rules. This field is only + returned if <b>AlertType</b>='Automation'. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This value indicates an alert related to a PaisaPay issue. This field is only + returned if <b>AlertType</b>='PaisaPay'. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This value indicates a general alert was received, such as negative feedback + received or an unpaid item dispute. This field is only returned if <b> + AlertType</b>='General'. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + Represents the duration for which this alert is computed. This field is only + returned if the alert is based on duration. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + This field indicates the number of items affected by the alert. This field is not + returned if the count is 0. + + + + GetSellingManagerAlerts + Conditionally + + + + + + + + + + + + Container for various alert types. + + + + + + + Indicates that an alert related to a sold listing has been issued. + + + + + + + Indicates that an alert related to inventory has been issued. + + + + + + + Indicates that an automation alert has been sent because a listing did + not conform to listing automation rules. + + + + + + + Indicates that an alert related to PaisaPay, a payment method used for eBay + India, has been issued. + + + + + + + Indicates that an alert has been issued for negative feedback received, bad + email, or an unpaid item dispute. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + Defines the options available for an Automated Listing Rule that + keeps a fixed number of items on the site + + + + + + The day of the week on which items should be listed. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The number of weeks between rule executions. + + + + GetSellingManagerTemplateAutomationRule + GetSellingManagerItemAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The time at which items should be listed. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The date from which the rule is active. + + + + GetSellingManagerItemAutomationRule + GetSellingManagerTemplateAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The date after which the rule is disabled. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The number of current, listed items required for the rule to no longer be run. + + + + GetSellingManagerItemAutomationRule + GetSellingManagerTemplateAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Sets a minimum inventory level for listings of associated products + to occur. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + Defines the options available for an automated listing rule that + keeps a minimum number of items on the site. + + + + + + + The minimum number of listings that should be active on the site. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The start time of the time interval during which new listings should start. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The end time of the time interval during which new listings should start. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Provides a number of minutes for spacing start times of listings. + Used when you list multiple items at the same time. Delays subsequent + listings by the specified number of minutes. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Sets a minimum inventory level for listings of associated products + to occur. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + Provides information about an automated listing rule. + Automated listing rules cannot be combined with automated relisting rules. + A template can have one set of information per automated listing rule specified. + + + + + + + The source template ID for the rule that was retrieved. + In the case of automated listing rules retrieved for an item, even if the item + does not have an associated automation rule, an automated listing rule is + inherited from the source template. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Specifies an automated listing rule that keeps a minimum number of listings on the site. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Specifies an automated listing rule that lists items according to a specified schedule. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + Enumerated type that defines the values that control how soon the item is relisted after the original listing ends. + + + + + + + If this value is set, the item is relisted immediately after the original listing ends. + + + + + + + If this value is set, the item is relisted after a specified number of days and/or hours. If this value is set, the <b>RelistAfterDays</b> and/or the <b>RelistAfterHours</b> fields must also be set. + + + + + + + If this value is set, the item is relisted at a specific time of day, either the day when the listing ends (if the specified time has not passed), or the day after (if the specified time has already passed on that day). If this value is set, the <b>RelistAtSpecificTimeOfDay</b> field must also be set. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Provides information about an automated relisting rule. + Automated relisting rules cannot be combined with automated listing rules. + A template can have one set of information per automated relisting rule specified. + + + + + + + The type of auto-relist rule for the item. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + The condition under which relist occurs. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Used when RelistCondition equals RelistAfterDaysHours; specifies + the number days after the item ends that it should be relisted. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Used when RelistCondition equals RelistAfterDaysHours; specifies + the number hours after the item ends that it should be relisted. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Used when RelistCondition equals RelistAtSpecificTimeOfDay; specifies the time + of day the item should be relisted. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Specifies whether Best Offer should be enabled on the auto-relisted item. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Specifies that item is not listed if inventory levels on the associated + product are at or below the specified level. + + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + Specifies the type of auto relist that will be performed. + + + + + + + If the item is unsold, relist the item once. + + + + + + + Relist the item continuously, until it is sold. + + + + + + + Relist the item continuously. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the options available for an automated + second chance offer rule. + + + + + + + The condition under which a second chance offer should be sent. + + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Used when SecondChanceOfferCondition is equal to + BidsGreaterThanAmount or BidsGreaterThanCostPlusAmount. Specifies + the amount associated with the SecondChanceOfferCondition. + + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Used when SecondChanceOfferCondition is equal + to BidsGreaterThanCostPlusPercentage to specify the amount of profit + associated with the SecondChanceOfferCondition. + + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Specifies the length of time the second chance offer listing will be active. + The recipient bidder has that much time to purchase the item or the offer expires. + + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + Do not list if inventory levels on the associated product + are at or below the specified amount. + + + + SetSellingManagerItemAutomationRule + No + + + SetSellingManagerItemAutomationRule + Conditionally + + + GetSellingManagerTemplateAutomationRule + Conditionally + + + GetSellingManagerItemAutomationRule + Conditionally + + + SetSellingManagerTemplateAutomationRule + No + + + SetSellingManagerTemplateAutomationRule + Conditionally + + + DeleteSellingManagerItemAutomationRule + Conditionally + + + DeleteSellingManagerTemplateAutomationRule + Conditionally + + + + + + + + + + + + SellingManagerAutoSecondChanceOfferTypeCodeType - Specifies the type of second chance offer automation rule that will be added to an item. + + + + + + + Sends a second chance offer to all bidders who bid more than a specific amount. + + + + + + + Sends a second chance offer to all bidders who bid more than the cost plus a specific amount. + + + + + + + Sends a second chance offer to all bidders who bid more than the cost plus a specific percentage. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates the filters for Selling Manager automation listings. + + + + + + + Item failed to be listed using automation rules. + + + + + + + Relist item automation rule failed. + + + + + + + Item failed to be listed with Second Chance offer automation rule. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains list of Email log. + + + + + + + Specifies the type of Selling Manager email. + + + + GetSellingManagerEmailLog + Always + + + + + + + + Template name of the custom email. + + + + GetSellingManagerEmailLog + Conditionally + + + + + + + + Success or failure state of this email. + + + + GetSellingManagerEmailLog + Always + + + + + + + + Date on which this email event occurred. + + + + GetSellingManagerEmailLog + Always + + + + + + + + + + + + Specifies the Selling Manager email status + + + + + + + Email sent successfully. + + + + + + + Sending of email failed. + + + + + + + Email is not yet sent and is in Queue. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies the Selling Manager email type enumeration + + + + + + + Email logged manually. For example, the seller manually adds an entry to + track email sent to a buyer offline. + + + + + + + Winning Buyer Notification. + + + + + + + Payment Reminder emails. + + + + + + + Payment received notification. + + + + + + + Request shipping address email. + + + + + + + Feedback Reminder emails. + + + + + + + Shipment sent email. + + + + + + + Personalized emails. + + + + + + + Invoice notification emails. + + + + + + + Custom email template 1. + + + + + + + Custom email template 2. + + + + + + + Custom email template 3. + + + + + + + Custom email template 4. + + + + + + + Custom email template 5. + + + + + + + Custom email template 6. + + + + + + + Custom email template 7. + + + + + + + Custom email template 8. + + + + + + + Custom email template 9. + + + + + + + Custom email template 10. + + + + + + + Custom email template 11. + + + + + + + Custom email template 12. + + + + + + + Custom email template 13. + + + + + + + Custom email template 14. + + + + + + + Custom email template 15. + + + + + + + Custom email template 16. + + + + + + + Custom email template 17. + + + + + + + Custom email template 18. + + + + + + + Custom email template 19. + + + + + + + Custom email template 20. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains information about a Selling Manager folder. + + + + + + + Unique ID of the folder. Originally returned in the AddSellingManagerInventoryFolder response. + + + + GetSellingManagerInventoryFolder + ReviseSellingManagerInventoryFolder + Always + + + GetSellingManagerInventoryFolder + ReviseSellingManagerInventoryFolder + Yes + + + ReviseSellingManagerProduct + No + + + + + + + + Unique ID of the parent folder. If it exists, it is returned. + + + + ReviseSellingManagerInventoryFolder + No + + + GetSellingManagerInventoryFolder + Conditionally + + + + + + + + Level of this folder in the folder tree hierarchy. Root folder is at level 1. + + + + ReviseSellingManagerInventoryFolder + No + + + GetSellingManagerInventoryFolder + Always + + + + + + + + Name assigned to the folder by the user in the AddSellingManagerInventoryFolder or + the ReviseSellingManagerInventoryFolder call. + + + + ReviseSellingManagerInventoryFolder + Yes + + + GetSellingManagerInventoryFolder + ReviseSellingManagerInventoryFolder + Always + + + + + + + + Comments associated with the folder. Returned if it exists. + + + + GetSellingManagerInventoryFolder + ReviseSellingManagerInventoryFolder + Conditionally + + + + + + + + Container for sub-folder information. Returned if requested. + + + + GetSellingManagerInventoryFolder + ReviseSellingManagerInventoryFolder + Conditionally + + + + + + + + Date when this folder was created. + + + + ReviseSellingManagerInventoryFolder + GetSellingManagerInventoryFolder + Always + + + + + + + + + + + + Container for other alerts for Selling Manager. + + + + + + + Items that received negative feeback. + + + + + + + Unpaid item disputes require your response. + + + + + + + Emails not set because of HTML or active content. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates the filters for Selling manager inventory listings. + + + + + + + Products which are out of stock. + + + + + + + Products that are active. + + + + + + + Products that are inactive. + + + + + + + Products in low stock. + + + + + + + Products with listings. + + + + + + + Products without listings. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + This type contains details on the status of an order. + + + + + + + Indicates the current status of the checkout flow for the order. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The paid status of the order. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The shipped status of the order. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The success or failure of a buyer's online payment. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Unique identifier of the PayPal transaction for the order. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The payment method the buyer selected for paying the seller + for the order. If checkout is incomplete, + PaymentMethodUsed is set to whatever the buyer selected as his + or her preference on the Review Your Purchase page. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The type of feedback received (if feedback was received). + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + Whether the seller has left feedback. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The total emails sent. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + Contains the current status of a hold on a PayPal payment. + The payment hold that is referred to as a "payment review" hold + results from a possible issue with a buyer. + The payment hold referred to as + a "merchant hold" results from a possible issue with a seller. + For more information, please see the link below. + + + + Holds on PayPal Payments + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The custom invoice number. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The date on which the seller marks the item as shipped, either set by default as + the date date the item was marked shipped or set explicitly by the seller using + the Edit Sales Record page. Note that sellers have the ability to set this value + up to 3 calendar days in the future. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + Date on which the order was paid. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + The time that the last email was sent. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The time the invoice was sent. This is a seller-entered value for VAT-enabled + sites. It is returned only for business sellers in VAT-enabled sites. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Indicates whether the item can be paid for through a payment gateway (Payflow) account. + If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is + enabled for credit cards because the seller has a payment gateway account. + Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or + VisaMC is returned for an item, then on checkout, an online credit-card payment + is processed through a payment gateway account. + A payment gateway account is used by sellers to accept online + credit cards (Visa, MasterCard, American Express, and Discover). + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + + + + Mark paid status type + + + + + + + The status of the order is "paid." + + + + + + + The status of the order is "partially paid." + + + + + + + The status of the order is "unpaid." + + + + + + + The status of the order is "pending." + + + + + + + The status of the order is "refunded." + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for the PaisaPay alert types. + + + + + + + PaisaPay items awaiting shipment. + + + + + + + PaisaPay items for which time extension requests are rejected by the buyers. + + + + + + + PaisaPay items for which the item receipt has not yet been confirmed by the buyer or not + yet been auto-confirmed by the system. + + + + + + + PaisaPay items for which buyers have filed "Item not received". + + + + + + + PaisaPay items for which the seller has requested a time extension to enter the + shipping information. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Returned if the user is a Selling Manager user. Defines product information for Selling Manager + users. + + + + + + + The name of a Selling Manager product. The AddSellingManagerProduct call is used to create a + Selling Manager product. + + + + ReviseSellingManagerProduct + No + + + GetItemTransactions + GetSellerTransactions + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddSellingManagerTemplate + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerProduct + ReviseSellingManagerTemplate + Always + + + + + + + + The ID of a Selling Manager product. When you call AddSellingManagerProduct, a product ID is + returned for the product created. When you use this ID to make subsequent calls, such as + AddSellingManagerTemplate, the ProductID you provide on input is returned in the output. + + + + ReviseSellingManagerProduct + Yes + + + AddSellingManagerProduct + AddSellingManagerTemplate + DeleteSellingManagerProduct + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerProduct + ReviseSellingManagerTemplate + Always + + + + + + + + Custom label of this product. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerProduct + DeleteSellingManagerProduct + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerProduct + Conditionally + + + ReviseSellingManagerTemplate + Always + + + + + + + + Quantity of items in the seller's inventory for this product. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerProduct + AddSellingManagerTemplate + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerProduct + Always + + + ReviseSellingManagerTemplate + Always + + + + + + + + Cost of each item of this product. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerTemplate + Always + + + AddSellingManagerProduct + ReviseSellingManagerProduct + Conditionally + + + + + + + + ID of the inventory folder that contains the product. Value is initially returned in + the AddSellingManagerInventoryFolder response. + + + + GetSellingManagerInventory + Always + + + ReviseSellingManagerTemplate + Always + + + + + + + + Specifies whether a restock alert is triggered for the product or not. + + + + GetSellingManagerInventory + GetSellingManagerInventory + ReviseSellingManagerProduct + Conditionally + + + ReviseSellingManagerTemplate + Always + + + ReviseSellingManagerProduct + No + + + + + + + + Specifies the quantity at which a restock alert should be triggered. + + + + GetSellingManagerInventory + ReviseSellingManagerProduct + ReviseSellingManagerTemplate + GetSellingManagerTemplates + GetSellingManagerInventory + Conditionally + + + ReviseSellingManagerProduct + No + + + + + + + + Primary vendor information. Vendor information is returned only if it has been + set. + + + + GetSellingManagerInventory + GetSellingManagerTemplates + GetSellingManagerInventory + ReviseSellingManagerTemplate + Conditionally + + + + + + + + Seller's note about this product. + + + + GetSellingManagerInventory + Conditionally + + + GetSellingManagerTemplates + ReviseSellingManagerTemplate + Always + + + + + + + + + + + Describes the inventory status of a specific Selling Manager Product + + + + + + Quantity of products scheduled to be listed. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Quantity of products actively listed. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Quantity of products sold. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Quantity of product unsold. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Percentage of ended listings that sold. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Average selling price for the product. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + + + + + Sorting specifications for retrieved Selling Manager inventory products. + + + + + + + Sort products by by quantity currently listed. + + + + + + + Sort unlisted products by availability to list. + + + + + + + Sort by average price of sold items. + + + + + + + Sort by average unit cost of items. + + + + + + + Sort products by label. + + + + + + + Sort by product name. + + + + + + + Sort by submitted date. + + + + + + + Sort by quantity scheduled to be listed. + + + + + + + Sort by quantity sold. + + + + + + + Sort by the percentage of ended listings that had a sale. + + + + + + + Sort by number of unsold items. + + + + + + + Sort products by folder name. + + + + + + + + + + Describes a Selling Manager Template + + + + + + + Category ID for a product with variations. + Only applicable (and required on input) + when Variations and/or ItemSpecifics is specified in the request + or returned in a response. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + GetSellingManagerInventory + Conditionally + Conditionally + + + + + + + + Variations are multiple similar (but not identical) versions of the + same product. For example, two shirt variations could have the same + brand and sleeve style, but could vary by color and size + (like "Blue, Large" and "Black, Medium"). + On eBay, a single fixed-price listing + can include multiple variations. + Each variation can have its own quantity and price. + To determine which categories support variations, use GetCategoryFeatures. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + GetSellingManagerInventory + + + + + + + + A list of custom Item Specifics for the product. + Custom Item Specifics give sellers a structured way to describe + details of their items in a name-value format. + For example, a book could have + Item Specifics like Author=J.K. Rowling and Format=Hardcover. + To determine which categories support + custom Item Specifics, use GetCategoryFeatures. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + GetSellingManagerInventory + No + Conditionally + + + + + + + + + + + Describes a Selling Manager Product + + + + + + Container for information about the product. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Contains the list of the seller's templates contained in the product, one + SellingManagerTemplateType object per template. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Container for statistics about the product. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + Specifies an eBay category associated with the product, + defines Item Specifics that are relevant to the product, + and defines variations available for the product + (which may be used to create multivariation listings). + + + + GetSellingManagerInventory + Conditionally + + + + + + + + + + + + For searches of Selling Manager listings, specifies search type, such as ProductID or BuyerUserID, + and search value. + + + + + + + Specifies the type of value, such as ProductID or BuyerUserID, for the search. + + + + GetSellingManagerSoldListings + GetSellingManagerInventory + No + + + + + + + + String identifying the value, matching the SearchType, that the search should return listings + for. For example, when ProductID is specified as the SearchType, SearchValue must be a valid + ProductID. + + + + GetSellingManagerSoldListings + GetSellingManagerInventory + No + + + + + + + + + + + + Specifies search term types for Selling Manager listings. + + + + + + + Search for listings based on Buyer ID. + + + + + + + Search for listings based on Buyers email. + + + + + + + Search for listings based on Buyers full name. + + + + + + + Search for listings based on ItemID. + + + + + + + Search for listings based on Item Title. + + + + + + + Search for listings based on Product ID. + + + + + + + Search for listings based on ProductName. + + + + + + + Search for listings based on SKU. + + + + + + + Search for listings based on the sale record ID. + When an item is sold, Selling Manager generates a sale record. + A sale record contains buyer information, shipping, and other information. + A sale record is displayed in the Sold view in Selling Manager. + In the following calls, + the value for the sale record ID is in the SellingManagerSalesRecordNumber field: + GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. + In the Selling Manager calls, the value for the sale record ID is in the + SaleRecordID field. The sale record ID can be for a single or multiple line item order. + <br/><br/> + For orders that occurred within the last 30 days, passing only the SaleRecordID into the GetSellingManagerSoldListings + request will return the sale record. However, for sales that occurred more than 30 days ago, the SaleDateRange container + must also be used, passing in a date range that includes the date on which the specific sale occurred. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains values for shipped status. + + + + + + + The shipped status is "shipped." + + + + + + + The shipped status is "unshipped." + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates the filters for Selling Manager sold listings. + + + + + + + Item is not paid and not shipped. + + + + + + + Item is paid but not shipped. + + + + + + + Item is paid but not shipped. + + + + + + + Item is paid for and is shipped. + + + + + + + An alert has been issued about a listing that is paid with no feedback left. + + + + + + + Payment Reminder emails not sent due to system error. + + + + + + + Payment received notification not sent due to system error. + + + + + + + Request shipping address emails not sent due to system error. + + + + + + + Request shipping address emails not sent due to system error. + + + + + + + Personalized emails not sent due to system error. + + + + + + + Winning Buyer Notification not sent due to system error. + + + + + + + Final value fee credit requests can be filed. + + + + + + + If true, indicates that the PayPal Payment Received alert has been issued. + + + + + + + Automated feedback message is not sent. + + + + + + + Feedback Reminder emails not sent due to system error. + + + + + + + Item is not shipped. + + + + + + + Listing eligible for unpaid item reminder + + + + + + + Escrow status is Cancelled. + + + + + + + Escrow status is Completed. + + + + + + + Escrow status is Initiated. + + + + + + + Escrow status is in refund state. + + + + + + + Item is shipped and Escrow status is in Release payment. + + + + + + + Payment is confirmed and item can be shipped to buyer. + + + + + + + All Escrow states. + + + + + + + Item is shipped and feedback is not yet received. + + + + + + + New international sale. + + + + + + + Charity filter. + + + + + + + Payment is overdue. + + + + + + + Payment is done with PaisaPay Escrow. + + + + + + + Failed to send custom email template 1. + + + + + + + Failed to send custom email template 2. + + + + + + + Failed to send custom email template 3. + + + + + + + Failed to send custom email template 4. + + + + + + + Failed to send custom email template 5. + + + + + + + Failed to send custom email template 6. + + + + + + + Failed to send custom email template 7. + + + + + + + Failed to send custom email template 8. + + + + + + + Failed to send custom email template 9. + + + + + + + Failed to send custom email template 10. + + + + + + + Failed to send custom email template 11. + + + + + + + Failed to send custom email template 12. + + + + + + + Failed to send custom email template 13. + + + + + + + Failed to send custom email template 14. + + + + + + + Failed to send custom email template 15. + + + + + + + Failed to send custom email template 16. + + + + + + + Failed to send custom email template 17. + + + + + + + Failed to send custom email template 18. + + + + + + + Failed to send custom email template 19. + + + + + + + Failed to send custom email template 20. + + + + + + + Reserved for future use. If a buyer requests to return an item, the seller's response is required. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + SellingManagerSoldListingsSortType - Specifies the fields that can be used to sort the listings. + + + + + + + Sorts listings by sales Record ID. + + + + + + + Sorts listings by Buyer email or ID. + + + + + + + Sorts listings by sale format. + + + + + + + Sorts listings by Custom label. + + + + + + + Sorts listings by Total Price. + + + + + + + Sorts listings by Sale Date. + + + + + + + Sorts listings by Paid Date. + + + + + + + Sorts listings by Emails sent. + + + + + + + Sorts listings by Checkout status. + + + + + + + Sorts by Paid status. + + + + + + + Sorts by Shipped state. + + + + + + + Sorts by feedback left. + + + + + + + Sorts by FeedbackReceived. + + + + + + + Sorts by Shipped Date. + + + + + + + Sorts by buyer Postal code. + + + + + + + Sorts by Days since sale. + + + + + + + Sort by Start price. + + + + + + + Sort by ReservePrice. + + + + + + + Sorts by Sold site. + + + + + + + Sorts by Shipping cost. + + + + + + + Sorts by Listed site. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains information about a sale record. + + + + + + + Information about one line item in the order. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + + + + + + Shipping address of a buyer. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The shipping-related details for an order, + including flat and calculated shipping costs and shipping insurance costs. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The cost of cash-on-delivery. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Total cost in the order. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + + + + + + Total item quantity. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + A SMPro seller can record the cost of the item, as calculated by the seller, in + this field. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Rate of applicable value added tax. + + + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Total cost of shipping insurance. + + + + GetSellingManagerSaleRecord + Always + + + + + + + + Amount of applicable value added tax insurance fee. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + VAT shipping fee. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Total shipping fee. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The seller records in this field a net total amount obtained according to the + seller's method of calculation. This field is returned for VAT transactions + only. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + VAT total amount. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The shipping cost paid by the seller to ship the order line item. + <br/><br/> + For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer. + </span> + + + + GetSellingManagerSaleRecord + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Discount, or charge, to which the buyer and seller have agreed. + If this value is a positive value, + the amount is the extra money that the buyer pays the seller. + If this value is a negative value, + the amount is a discount the seller gives the buyer. + + + + GetSellingManagerSaleRecord + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Notes from the seller to the buyer. + + + + GetSellingManagerSaleRecord + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Notes from the buyer to the seller. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Notes to self from seller. + + + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Status of the order regarding payment, shipping, feedback, and other + communications. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The status of an unpaid item regarding final value, state of communications + between buyer and seller, and the filing of an Unpaid Item. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Amount of the accepted offer for the listing. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Number of emails sent regarding this order. + + + + GetSellingManagerSaleRecord + Always + + + + + + + + Number of days since the sale. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The user ID of the buyer. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + + + + + + The email of the buyer. + + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Always + + + + + + + + The sale record ID. Applicable to Selling Manager users. + When an item is sold, Selling Manager generates a sale record. + A sale record contains buyer information, shipping, and other information. + A sale record is displayed in the Sold view in Selling Manager. + Each sale record has a sale record ID. In the following calls, + the value for the sale record ID is in the SellingManagerSalesRecordNumber field: + GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. + In the Selling Manager calls, the value for the sale record ID is in the + SaleRecordID field. The sale record ID can be for single or multiple line item orders. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + The sale date. + + + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + + Contains information about a single line item (transaction) in an order created + through Selling Manager. + + + + + + + Seller's customized invoice number. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). An order line + item is created once there is a commitment from a buyer to + purchase an item. Since an auction listing can only have one order line + item during the duration of the listing, the <b>TransactionID</b> + for auction listings is always 0. Along with its corresponding <b>ItemID</b>, a + <b>TransactionID</b> is used and referenced during an order checkout flow and + after checkout has been completed. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + + + + + + Unique identifier for a Selling Manager sale record. This field is created + at the same time as the order line item (transaction). A sale record is + displayed in the Sold view in Selling Manager and contains information on + the buyer and shipping. In the <b>GetItemTransactions</b>, <b>GetSellerTransactions</b>, + <b>GetOrders</b>, and <b>GetOrderTransactions</b> calls, the <b>SaleRecordID</b> value is + reflected in the <b>ShippingDetails.SellingManagerSalesRecordNumber</b> field. + <br/><br/> + For orders that occurred within the last 30 days, passing only the SaleRecordID into the GetSellingManagerSoldListings + request will return the sale record. However, for sales that occurred more than 30 days ago, the SaleDateRange container + must also be used, passing in a date range that includes the date on which the specific sale occurred. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + + + + + + Unique identifier for an eBay item listing. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + + + + + + Total number of identical items sold in the order line item. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + + + + + + Price per item. + + + + GetSellingManagerSaleRecord + Always + + + + + + + + This value is calculated by multplying the <b>ItemPrice</b> value by the + <b>QuantitySold</b> value. + + + + GetSellingManagerSaleRecord + Always + + + + + + + + The title of the item listing. + + + 80 + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Always + + + + + + + + The item listing type. + + + + GetSellingManagerSoldListings + Conditionally + StoresFixedPrice + + + + + + + + Boolean value indicating whether the item is a relisted item. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Number of users watching the item. + + + + GetSellingManagerSoldListings + GetSellingManagerSoldListings + Conditionally + + + + + + + + Start price of the item. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Reserve Price of the item (if a Reserve Price was set for the item). + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Boolean value indicating whether or not a Second Chance offer was sent by + the seller to an eligible bidder. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Custom label associated with this order line item. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + The platform on which the item was sold. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + The platform on which the item was listed. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + Container consisting of tracking information for the shipment. + + + + GetSellingManagerSaleRecord + Conditionally + + + + + + + + This field is returned as True if the item is listed as a charity item. + + + + GetSellingManagerSoldListings + Conditionally + + + + + + + + In a fixed-priced listing, a seller can offer variations of the same item. + For example, the seller could create a fixed-priced listing for a t-shirt + design and offer the shirt in different colors and sizes. In this case, each + color and size combination is a separate variation. Each variation can have + a different quantity and price. Due to the possible price differentiation, + buyers can buy multiple items from this listing at the same time, but all of + the items must be of the same variation. One order line item is created + whether one or multiple items of the same variation are purchased. + <br><br> + The <b>Variation</b> node contains information about which variation was purchased. + Therefore, applications that process order line items should always check to see + if this node is present. + + + + GetSellingManagerSoldListings + GetSellingManagerSaleRecord + Conditionally + + + + + + + + A unique identifier for an eBay order line item. This field is created as + soon as there is a commitment to buy from the seller, and its value is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. + + + 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) + + GetSellingManagerSoldListings + Always + + + GetSellingManagerSaleRecord + Always + + + + + + + + + + + + A list of Selling Manager templates. + + + + + + + Selling Manager template details. + + + + GetSellingManagerTemplates + No + + + GetSellingManagerInventory + GetSellingManagerTemplates + Conditionally + + + + + + + + + + Describes a Selling Manager Template + + + + + + + ID of the template. + + + + GetSellingManagerTemplates + GetSellingManagerInventory + Always + + + + + + + + Name of the template. + + + + GetSellingManagerTemplates + GetSellingManagerInventory + Always + + + + + + + + Success ratio. + + + + GetSellingManagerTemplates + GetSellingManagerInventory + Always + + + + + + + + The details of the product that this template belongs to. + + + + GetSellingManagerTemplates + GetSellingManagerInventory + Always + + + + + + + + ItemType object that contains the data for the specified template. + + + + GetSellingManagerTemplates + GetSellingManagerInventory + Always + + + + + + + + + + + Describes vendor information. + + + + + + Primary vendor name. Vendor information is returned only if it has been set. + + + + AddSellingManagerTemplate + GetSellingManagerInventory + GetSellingManagerTemplates + ReviseSellingManagerTemplate + Conditionally + + + + + + + + Contact information of vendor. Vendor information is returned only if it has been set. + + + + AddSellingManagerTemplate + GetSellingManagerInventory + GetSellingManagerTemplates + ReviseSellingManagerTemplate + Conditionally + + + + + + + + + + + + Contains various details about the current status of a listing. These + values are computed by eBay and cannot be specified at listing time. + + + + + + + Number of bids placed so far against the auction item. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetMyeBayBuying + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + UnsoldList + DeleteFromUnsoldList + BidList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Item.SellingStatus + Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Item + Conditionally + + + + + + + + The minimum amount a progressive bid must be above the current high bid to be accepted. This field is only + applicable to auction listings. The value of this field will always be '0.00' for Classified Ad and fixed-price + listings. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + + + + + + Converted value of the CurrentPrice in the currency of the site that + returned this response. For active items, refresh the listing's data every 24 + hours to pick up the current conversion rates. Only returned when the item's + CurrentPrice on the listing site is in different currency than the currency of + the host site for the user/application making the API call. ConvertedCurrentPrice + is not returned for Classified listings (Classified listings are not available + on all sites).<br> + <br> + In multi-variation listings, this value matches the lowest-priced + variation that is still available for sale. + + + + GetBidderList + GetDispute + PlaceOffer + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Item.SellingStatus + Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The current price of the item in the original listing currency. + <br><br> + For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. + <br><br> + For fixed-price and ad format listings, this is the current listing price. + <br><br> + In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. + + + + GetBidderList + GetDispute + PlaceOffer + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Item.SellingStatus + Always + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetMemberMessages + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList + ActiveList + ScheduledList + SoldList + UnsoldList + DeletedFromSoldList + DeletedFromUnsoldList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Item + Conditionally + + + + + + + + For ended auction listings that have a winning bidder, + this field is a container for the high bidder's user ID. + For ended, single-item, fixed-price listings, + this field is a container for the user ID of the purchaser. + This field isn't returned for auctions with no bids, or for active fixed-price listings. + In the case of PlaceOffer, for auction listings, + this field is a container for the high bidder's user ID. + In the PlaceOffer response, the following applies: + For multiple-quantity, fixed-price listings, + the high bidder is only returned if there is just one order line item + (or only for the first order line item that is created). + + + + PlaceOffer + Conditionally + + + GetBidderList +
DetailLevel: ReturnAll
+
GranularityLevel: Medium
+ Variation + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Conditionally + + + GetMyeBayBuying + BidList + LostList + WatchList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + BidList + ActiveList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Item + Conditionally + + + + + + + + Applicable to Ad type listings only. Indicates how many leads to + potential buyers are associated with this item. Returns 0 (zero) for listings in other formats. You must be the seller of the item to retrieve the lead count. + + + + GetSellerList +
DetailLevel: ReturnAll
+ Variation + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Conditionally + + + + + + + + Smallest amount the next bid on the item can be. Returns same value as + Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus + BidIncrement (if at least one bid has been placed). Only applicable to + auction listings. Returns null for fixed-price + and Ad type listings. + <br><br> + In multi-variation listings, this value matches the lowest-priced + variation that is still available for sale. + + + + PlaceOffer + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + + + + + + The total number of items purchased so far (in the listing's lifetime). + Subtract this from Quantity to determine the quantity available. + <br> + <br> + If the listing has Item Variations, + then in GetItem (and related calls) and GetItemTransactions, + Item.SellingStatus.QuantitySold contains the sum of all quantities + sold across all variations in the listing, and Variation.SellingStatus.QuantitySold contains the number + of items sold for that variation. + In GetSellerTransactions, + Transaction.Item.SellingStatus.QuantitySold contains the number + of items sold in that order line item.<br> + <br> + For order line item calls, also see Transaction.QuantityPurchased for + the number of items purchased in the order line item.<br> + In multi-variation listings, this value matches total quantity sold + across all variations. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ + Always + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Item + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Variation + Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + SoldList + UnsoldList + ScheduledList + DeletedFromSoldList + DeletedFromUnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the reserve price has been met for the listing. Returns + true if the reserve price was met or no reserve price was specified. + + + + PlaceOffer + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetMyeBayBuying + BidList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + GetMyeBaySelling + ActiveList + BidList + ScheduledList + SoldList + UnsoldList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Part of the Second Chance Offer feature, indicates whether the seller can + extend a second chance offer for the item. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetBidderList + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + + + + + + Number of bidders for an item. Only applicable to auction listings. + Only returned for the seller of the item. + + + + GetMyeBaySelling + ActiveList + UnsoldList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Specifies an active or ended listing's status in eBay's processing workflow. + If a listing ends with a sale (or sales), eBay needs to update the sale details + (e.g., total price and buyer/high bidder) and the final value fee. This processing + can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder + are returned or no final value fee is available, use this listing status information + to determine whether eBay has finished processing the listing. + + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Always + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Item.SellingStatus + Always + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Variation + Conditionally + + + GetSellerEvents + Item +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a + winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and + is generated before the buyer makes a payment. + <br/><br/> + The FVF is calculated using a percentage. This percentage is based on whether the seller has a + Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on + the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the + <a href="http://www.feectr.ebay.com/feecenter/home">Fee Center Home Page</a>. + <br/><br/> + The Final Value Fee for each order line + item is returned by <b>GetSellerTransactions</b>, <b>GetItemTransactions</b>, <b>GetOrders</b>, + and <b>GetOrderTransactions</b>, regardless of the checkout status. + <br><br> + If a seller requests a Final Value Fee credit, the value of + <b>Transaction.FinalValueFee</b> will not change if a credit is + issued. The credit only appears in the seller's account data. + <br><br> + Not applicable to Half.com. + + + + GetBidderList + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Item.SellingStatus + Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll, ItemReturnDescription
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + If a seller has reduced the price of a listed item with the Promotional Price Display feature, + this field contains the original price of the discounted item, along with the start-time + and end-time of the discount. + + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Variation + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Variation + Conditionally + + + GetMyeBayBuying + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + Variations +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + If included in the response as true, indicates that the listing was administratively + canceled due to a violation of eBay's listing policies and that the item can be relisted + using RelistItem. Note that GetItem returns an error (invalid item ID) + in the response if Item.SellingStatus.AdminEnded is true and the requesting user + is not the seller of the item. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Variation + Conditionally + + + GetItem + GetSellingManagerTemplates + Variation + Conditionally + + + + + + + + If this flag appears in the <b>GetItem</b> response, the auction has ended due to the + item being sold to a seller using the <b>Buy It Now</b> option. + This flag is not relevant for fixed-priced listings. + + + + GetItem + Conditionally + + + + + + + + This field indicates the total quantity of items sold and picked up by buyers using the In-Store Pickup option. This value is the total number of items purchased by one or more buyers using the In-Store Pickup option, and is not the total number of In-Store Pickup orders. So, if two buyers selected the In-Store Pickup option, but each of these buyers bought a quantity of five of these items (in same purchase), the <b>Item.SellingStatus.QuantitySoldByPickupInStore</b> value would be '10' and not '2'. + <br> + <br> + In the case of multi-variation, fixed-price listings, each <b>Item.Variations.Variation.SellingStatus.QuantitySoldByPickupInStore</b> value indicates the total quantity of that corresponding item variation (for example, large blue shirts) sold and picked up by buyers using the In-Store Pickup option, and the <b>Item.SellingStatus.QuantitySoldByPickupInStore</b> value would be the total quantity of all item variations sold for the listing. + <br> + <br> + This field will only be returned if the listing is eligible for In-Store Pickup (<b>EligibleForPickupInStore</b> is returned as 'true'). + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + GetItem +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + + + + + + + + + + Contains summary information about the items the seller is selling. + + + + + + + The number of currently active auctions that will sell. That + is, there is at least one bidder, and any reserve price has + been met. Equivalent to the "Will Sell" value in My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The total number of currently active auctions for a given + seller. Equivalent to the + "Auction Quantity" value in My eBay. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The total number of bids made on the seller's active auction listings. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The total value of all items the seller has for sale in all listings. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + The total number of items the seller has sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + https://ebaydts.com/eBayKBDetails?KBid=1111 + Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions + + + + + + + + The total monetary value of the items the seller has sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + https://ebaydts.com/eBayKBDetails?KBid=1111 + Discrepancies Between Results of GetMyeBaySelling and GetSellerTransactions + + + + + + + + The average duration, in days, of all items sold. + + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + + + + Specifies the action to take for an item's My eBay notes. + + + + + + + Creates or replaces an item's My eBay notes. Note that if + the specified item already has notes in My eBay, the new + notes will completely replace the existing notes. They will + not be appended. + + + + + + + Deletes any existing My eBay notes for the specified item. + Specifying Delete when no notes exist does nothing, but does + not return an error. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details pertinent to one or more items for which + calculated shipping (or flat rate shipping using shipping rate tables with + weight surcharges) has been offered by the seller, such as package + dimension and weight and packaging/handling costs. Also returned + with the data for an item's transaction. + + + + + + + Specifies the unit type of the weight and dimensions of a + shipping package. + If MeasurementUnit is used, it overrides the system specified by measurementSystem. + If MeasurementUnit and measurementSystem are not specified, the following defaults + will be used: + <br><br> + English: US<br> + Metric: CA, CAFR, AU + <br><br> + CA and CAFR supports both English and Metric, while other sites + only support the site's default. + <br><br> + Use MeasurementUnit with weight and package dimensions. For example, + to represent a 5 lbs 2 oz package: + <br> + &lt;MeasurementUnit&gt;English&lt;/MeasurementUnit&gt; + <br> + &lt;WeightMajor&gt;5&lt;/WeightMajor&gt; + <br> + &lt;WeightMinor&gt;2&lt;/WeightMinor&gt; + + + + AddItem + AddItems + AddSellingManagerTemplate + RelistItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + AddFixedPriceItem + RelistFixedPriceItem + ReviseFixedPriceItem + VerifyAddFixedPriceItem + VerifyRelistItem + Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + Depth of the package, in whole number of inches, needed to ship the item. + This is validated against the selected shipping service. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + <br><br> + Developer impact: UPS requires dimensions for any Ground packages that are 3 + cubic feet or larger and for all air packages, if they are to provide correct + shipping cost. If package dimensions are not included for an item listed with + calculated shipping, the shipping cost returned will be an estimate based on + standard dimensions for the defined package type. eBay enforces a dimensions + requirement on listings so that buyers receive accurate calculated shipping + costs. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + Length of the package, in whole number of inches, needed to ship the item. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + Width of the package, in whole number of inches, needed to ship the item. + Upon mismatch, a message is returned, such as, "Package + dimensions exceeds maximum allowable limit for + service XXXXX," where XXXXX is the name of the shipping service. + For calculated shipping only. Only returned if the seller + specified the value for the item. (In many cases, the seller + only specifies the weight fields.) + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#PackageDimensionsandWeight + + + + + + + + Whether a package is irregular and therefore cannot go + through the stamping machine at the shipping service office and + thus requires special or fragile handling. For calculated + shipping only. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The nature of the package used to ship the item(s). + Required for calculated shipping only. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + WeightMajor and WeightMinor are used to specify the weight of a + shipping package. Here is how you would represent a package + weight of 5 lbs 2 oz: &lt;WeightMajor unit="lbs"&gt;5&lt;/WeightMajor&gt; + &lt;WeightMinor unit="oz"&gt;2&lt;/WeightMinor&gt; + See http://www.ups.com for the maximum weight allowed by UPS. + Above this maximum, the shipping type becomes Freight, an option + that can only be selected via the eBay Web site and not via API. + The weight details are validated against the selected shipping service. + <br><br> + For calculated shipping or for flat rate shipping if shipping rate tables are + specified and the shipping rate table uses weight surcharges. + Required on input when calculated shipping is used. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + See the definition of WeightMajor. For calculated shipping or for flat rate shipping + if shipping rate tables are specified and the shipping rate table uses weight surcharges. + (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater + than zero results in WeightMajor getting rounded up in the shipping cost calculation + for example, 1 lb, 2 oz is rounded up to 2 lbs.) + <br><br> + Required on input when calculated shipping is used. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Status of the delivery. + + + + + + + Created (default). + + + + + + + Dropped off. + + + + + + + In transit. + + + + + + + Delivered. + + + + + + + Returned. + + + + + + + Cancelled. + + + + + + + Label printed. + + + + + + + Unconfirmed. + + + + + + + Unknown. + + + + + + + Error. + + + + + + + Reserved for future use. + + + + + + + + + + This type provides information about one or more order line items in a Global Shipping Program package. + + + + + + + Contains information about one order line item in a Global Shipping Program package. The package can contain multiple units of a given order line item, and multiple order line items. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This type details the shipping carrier and shipment tracking number associated with a + package shipment. It also contains information about the line items shipped through the Global Shipping program. + + + + + + + The name of the shipping carrier used to ship the item. This is required if <b>ShipmentTrackingNumber</b> is supplied. This can be any value, because it is not checked by eBay. Commonly used shipping carriers can be found by calling <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>ShippingCarrierDetails</b> and examining the returned <strong>ShippingCarrierDetails.ShippingCarrier</strong> field. + <br><br> + <strong>For the CompleteSale call</strong>: + <ul> + <li>When using UPS Mail Innovations, supply the value <code>UPS-MI</code>. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking status. </li> + <li>When using FedEx SmartPost, supply the value <code>FedEx</code>. Buyers will subsequently be sent to the FedEx web site for tracking status. </li> + </ul> + <strong>For the Get calls</strong>: When using the Global Shipping Program, this field returns a value of <code>PBI</code>. + <br><br> + Returned only if set. Returned for Half.com as well. + + + ShippingCarrierCodeType + + CompleteSale + Conditionally + + + GetSellingManagerSaleRecord + Conditionally + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Required if <b>ShippingCarrierUsed</b> is supplied. + The tracking number assigned by the shipping carrier to the item shipment. The + format of the tracking number must be consistent with the format used by the + specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid + spaces and hyphens. + Returned only if set. + Returned for Half.com as well. + + + + CompleteSale + Conditionally + + + GetSellingManagerSaleRecord + Conditionally + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>PBI</code>. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + + + + + Type defining the <b>Shipment</b> container, which is used by + the seller in <b>CompleteSale</b> to provide shipping information. The + <b>Shipment</b> container is also returned in the + <b>GetSellingManagerSaleRecord</b> response. + + + + + + + + + + + + + + + + + + + Depth dimension of the package needed to ship the item after it is sold. + <br> + For calculated shipping only. + + + + + + + Length dimension of the package needed to ship the item after it is sold. + <br> + For calculated shipping only. + + + + + + + Width dimension of the package needed to ship the item after it is sold. + <br> + For calculated shipping only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The address from which the item is being shipped. + + + + + + + The address to which the item is to be shipped. + + + + + + + The shipping carrier used to ship the package. This value can be any + combination of alphanumeric characters and it is not checked and verified by + eBay. This field is required if ShipmentTrackingNumber is included in the + call request. + <br><br> + ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other. + You must either specify both, or specify neither. + + + + + + + + + + + + + + + + The size of the package used to ship the item(s). See ShippingPackageCodeType + for its possible values. Input. + + + + + + + The size of the package used to ship the item(s). See ShippingPackageCodeType + for its possible values. Input. + + + + + + + The tracking number associated with one package of a shipment. The seller is + responsible for the accuracy of the shipment tracking number. eBay verifies + the tracking number is unique (across all of a seller's orders) and consistent + with the numbering scheme used by the specified shipping carrier. eBay cannot + verify the accuracy of the tracking number. This field is required if + ShippingCarrierUsed is included in the call request. + <br><br> + Sellers can specify multiple tracking numbers for the same ShippingCarrierUsed + by separating the tracking numbers with commas. + <br><br> + ShippingCarrierUsed and ShipmentTrackingNumber are dependent upon each other. + You must either specify both, or specify neither. + + + + + + + + + + See the documentation regarding "Working with Item Weights". + The 'unit' attribute can have a value of lbs. + + + + + + + See the documentation regarding "Working with Item Weights". + The 'unit' attribute is optional and assumed to be the + minor compared to the value of 'unit' in WeightMajor. + + + + + + + + + + + + + Revise only + + + + + + + Revise only + + + + + + + Revise only + + + + + + + Revise only + + + + + + + Status, for revise only + + + + + + + The date and time that the seller handed off the package(s) to the shipping + carrier. If this field is not included in the request, the timestamp of the call + execution is used as the shipped time. Note that sellers have the ability to set + this value up to 3 calendar days in the future. + + + + SetShipmentTrackingInfo + No + + + CompleteSale + No + + + + + + + + This string field allows a seller to provide notes to the buyer regarding shipment of a + Half.com item. Only alphanumeric characters can be used in this field. This is an optional + field that is only applicable to Half.com items. + + + + CompleteSale + No + + + + + + + + Container consisting of the tracking number and shipping carrier associated with + the shipment of one item (package). + <br><br> + Because an order can have multiple line items and/or packages, there can be + multiple <b>ShipmentTrackingDetails</b> containers under the + <b>Shipment</b> container. + + + + CompleteSale + No + + + GetSellingManagerSaleRecord + Conditionally + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of <strong>ShippingCarrierUsed</strong> is <code>PBI</code>. + + + + CompleteSale + AddShipment + ReviseShipment + ReviseSellingManagerSaleRecord + SetShipmentTrackingInfo + No + + + GetSellingManagerSaleRecord + GetSellingManagerSoldListings + Conditionally + + + + + + + + + + + + Identifies a shipping carrier used to ship an order. Applications should not depend on the completeness of <strong>ShippingCarrierCodeType</strong>. Instead, applications should call GeteBayDetails, with a <strong>DetailName</strong> value of <code>ShippingCarrierDetails</code>, to return the complete list of shipping carriers. To check for the shipping carriers available for a specific site, specify the site ID in the header. + + + + + + + United Parcel Service. + <br><br> + For UPS Mail Innovations (for CompleteSale call requests only), + specify the value UPS-MI. + + + + + + + U.S. Postal Service. + + + + + + + Fedex + For FedEx SmartPost (for CompleteSale call requests only), + specify the value FedEx. + + + + + + + Deutsche Post. + + + + + + + DHL service + + + + + + + Hermes + + + + + + + iLoxx + + + + + + + Other postal service + + + + + + + Coliposte Domestic + + + + + + + Coliposte International + + + + + + + Chronopost + + + + + + + Correos + + + + + + + Seur (reserved for future use) + + + + + + + Nacex + + + + + + + Reserved for internal or future use + + + + + + + + + + Details about type of Carrier used to ship an item. + + + + + + + Numeric identifier. + Some applications use this ID + to look up shipping Carriers more efficiently. + + + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present a list of shipping carriers in + a more user-friendly format (such as in a drop-down list). + + + + GeteBayDetails + Conditionally + + + + + + + + The code for the shipping carrier. + <span class="tablenote"> + <strong>Note:</strong> Applications should not depend on the completeness of <strong>ShippingCarrierCodeType</strong>. Instead, applications should call GeteBayDetails, with a <strong>DetailName</strong> value of <code>ShippingCarrierDetails</code>, to return the complete list of shipping carriers. To check for the shipping carriers available for a specific site, specify the site ID in the header. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + This type defines the <b>ShippingCategoryDetails</b> container. When the <b>DetailName</b> field + is set to ShippingCategoryDetails in a GeteBayDetails request, one + <b>ShippingCategoryDetails</b> container is returned for each valid shipping category + used on the eBay site. Besides being useful to view the list of valid shipping + categories, this container is also useful to discover when the last update to + shipping categories was made by eBay. + + + + + + + Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, and which services fall into which category, see the <a href="http://pages.ebay.com/sellerinformation/shipping/chooseservice.html">Shipping Basics</a> page on the eBay Shipping Center site. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This field is returned only for those sites that support shipping categories: US (0), CA (2), CAFR (210), UK (3), AU (15), FR (71), DE (77), IT (101) and ES (186). + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present a list of shipping categories in + a more user-friendly format (such as in a drop-down list). This field is localized + per site. + + + + GeteBayDetails + Conditionally + + + + + + + + The current version number for shipping categories. Sellers can compare this + version number to their version number to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Indicates the time of the last version update. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + This simple type contains the values that specify the party (seller/buyer) who will be responsible for paying the return shipping cost if an item is returned. + + + EUBuyer_CancelRightsUnder40, EUSeller_CancelRights, EUSeller_ReturnRights + + + + + + + This value indicates that the buyer is responsible for paying the return shipping cost. + + + + + + + This value indicates that the seller is responsible for paying the return shipping cost. + + + + + + + (out) Reserved for internal or future use. + + + + + + + This value is no longer applicable. + + + + + + + This value is no longer applicable. + + + + + + + This value is no longer applicable. + + + + + + + + + + This type defines the ShippingCostPaidBy container that is returned in GeteBayDetails if ReturnPolicyDetails is set as a DetailNameCodeType value (or if no value is included in the request. + + + + + + + The party who pays the shipping cost for a returned item. + This value can be passed in the AddItem family of calls. + + + ShippingCostPaidByOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present ShippingCostPaidByOption in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use ShippingCostPaidByOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type defining the ShippingDetails container, which contains the shipping-related + details for an item (pre-checkout) or order (post-checkout). + <br/><br/> + <span class="tablenote"> + <strong>IMPORTANT:</strong> To avoid loss of shipping details when revising a listing, you must include all <strong>ShippingDetails</strong> fields that were originally provided. Do not omit any tag, even if its value does not change. Omitting a shipping field when revising an item will remove that detail from the listing. + </span> + + + + + + + This field is no longer returned and has been replaced by the ShippingDetails.PaymentEdited field. + <br><br> + Not applicable to Half.com. + + + + GetBidderList + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + No longer used. To be deprecated in late 2010. + + + + + + + + + + Indicates whether eBay's Global Shipping Program is offered for the listing. If the value of <strong>GlobalShipping</strong> is True, the Global Shipping Program is the default international shipping option for the listing, and eBay sets the international shipping service to International Priority Shipping. If the value of <strong>GlobalShipping</strong> is False, the seller is responsible for specifying an international shipping service for the listing if desired. + <br/><br/> + When calling <strong>RelistFixedPriceItem</strong>, <strong>RelistItem</strong>, <strong>ReviseFixedPriceItem</strong> or <strong>ReviseItem</strong>, you can omit this field if its value doesn't need to change. + <br/><br/> + Before using this field for a listing, ensure that the seller and the item being listed are eligible for the Global Shipping Program. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + Conditionally + + + GetItem + GetSellerList + GetMyeBaySelling +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Introduction to Shipping + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Managing.html#ParticipationintheGlobalShippingProgram + information about Global Shipping Program eligibility + + + + + + + + Details pertinent to one or more items for which calculated shipping has been + offered by the seller, such as package dimension and weight and + packaging/handling costs. If your call specifies a large-dimension item listed + with UPS, see <a href= + "https://ebaydts.com/eBayKBDetails?KBid=1159" + >Dimensional Weight limit on UPS shipping services results in failure of + shipping calculator</a>. + <br><br> + Not applicable to Half.com. + <br><br> + <span class="tablenote"><strong>Note:</strong> + The <strong>CalculatedShippingRate</strong> container should only be used to specify values for the <strong>InternationalPackagingHandlingCosts</strong>, <strong>OriginatingPostalCode</strong>, and/or <strong>PackagingHandlingCosts</strong> fields. The rest of the fields in the <strong>CalculatedShippingRate</strong> container are used to specify package dimensions and package weight, and these values should now be specified in the <strong>ShippingPackageDetails</strong> container instead. + </span> + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Whether the seller specified payment and shipping instructions during checkout + (for example, to update the details of an order). Valid for flat and calculated + shipping. + <br><br> + Not applicable to Half.com. + + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Cost of shipping insurance set by the seller. If the buyer bought more than one + of this item, this is the insurance for just a single item. Exception: for + GetItemShipping, this is proportional to QuantitySold. Value should be greater + than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. + Optional as input and only allowed if ChangePaymentInstructions is true. This + field is ignored when InsuranceOption is not specified in the request. + <br><br> + Valid only on the following sites: FR and IT + <br> + Applicable to Half.com for GetOrders. + + + 0.00 + + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions + Order +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Transaction + Always + + + + + + + + Whether the seller offers shipping insurance and, if so, whether the insurance is + optional or required. Optional as input and only allowed if + ChangePaymentInstructions is true. If this field is not included in the request, + values specified in the InsuranceFee field will be ignored. + <br><br> + <span class="tablenote"><strong>Note:</strong> + Note that sellers are responsible for the items they sell until they safely + arrive in their customers' hands, and that offering buyer-paid insurance + (either as an optional or required service) infers that the buyer is somehow + responsible for the safe delivery of the items they purchase. This notion can + reduce buyer confidence in the marketplace and the practice of including buyer- + paid shipping insurance in your item listings is discouraged. + </span> + <br> + This field is only returned if the value is other than NotOffered. + <br><br> + Valid only on the following sites: FR and IT + <br> + If you include buyer-paid shipping insurance for an item listed on one + of the sites that supports this option, a buyer on a site that does not support + buyer-paid shipping insurance can still purchase the item. In these cases, the + buyer is responsible for all the shipping insurance terms that have been outlined + in the item listing. + <br><br> + Applicable to Half.com + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + AddOrder + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + NotOfferedOnSite + No + + + GetBidderList + GetItemShipping + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + Whether or not the buyer selected to pay for insurance as an option offered by + the seller. This only has a value after the buyer has gone through checkout and + selected the insurance preference. + <br><br> + Valid only on the following sites: FR and IT + <br> + Applicable to Half.com for GetOrders. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Whether the seller allows the buyer to edit the payment amount for the order. + (Sellers enable this property in their My eBay user preferences on the eBay site.) + <br><br> + Not applicable to Half.com. + + + + GetItemShipping + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Payment instructions (or message) from the seller to the buyer. These + instructions appear on eBay's View Item page and on eBay's checkout page when the + buyer pays for the item. + <br><br> + Sellers usually use this field to specify payment instructions, how soon the item + will shipped, feedback instructions, and other reminders that the buyer should be + aware of when they bid on or buy an item. This field can be specified regardless + of the shipping type eBay only allows 500 characters as input, but due to the way + the eBay Web site UI treats characters, this field can return more than 500 + characters in the response. Characters like & and ' (apostrophe/single quote) + count as 5 characters each. Use DeletedField to remove this value when revising + or relisting an item. + <br><br> + Applicable to eBay Motors (usually used to elaborate on the return policy). + <br> + Not applicable to Half.com. + + + 1000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + Offering a Clear Return Policy + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-ReturnPolicy.html + + + (AddItem) Item.AttributeSetArray + AddItem.html#Request.Item.AttributeSetArray + + + (GetItem) Item.AttributeSetArray + GetItem.html#Response.Item.AttributeSetArray + + + + + + + + Sales tax details. US and US Motors (site 0) sites only, excluding vehicle listings. Flat and calculated shipping. + <br><br> + Applicable to Half.com (for GetOrders). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddOrder + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerSaleRecord + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetBidderList + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetSellingManagerSaleRecord +
DetailLevel: none
+ Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + Enabling Multi-jurisdiction Sales Tax + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Feature-SalesTax.html + + + + + + + + For most applicable calls, returns the words No Error or returns an error message + related to an attempt to calculate shipping rates. For calculated shipping only. + <br><br> + The message text explains that a postal code is needed to calculate + shipping. Only returned when ItemDetails is set to Fine. + <br><br> + Not applicable to Half.com or eBay Motors vehicle listings. + + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if <strong>ShippingRateType</strong> is <code>DailyPickup</code>). <strong>ShippingRateType</strong> is returned only if the value of <strong>ShippingService</strong> is one of the USPS shipping services. For calculated shipping only. + <br><br> + Not applicable to Half.com or eBay Motors vehicle listings. + + + + GetItemShipping + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + Shipping + + + + + + + + + Shipping costs and options related to domestic shipping services offered by the + seller. Flat and calculated shipping. Required if + InternationalShippingServiceOption is specified. + <br><br> + For flat shipping, a maximum shipping cost may apply when listing. See Shipping + documentation for details about Maximum Flat Rate Shipping Costs. + <br><br> + If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be + contiguous. For example, you can insert InternationalShippingServiceOption nodes + after a list of repeating ShippingServiceOptions nodes, but not between them: + <br><br> + &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> + &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> + &lt;ShippingServiceOptions&gt;...&lt;/ShippingServiceOptions&gt;<br> + &lt;InternationalShippingServiceOption&gt;...&lt;/InternationalShippingServiceOption&gt;<br> + &lt;InternationalShippingServiceOption&gt;...&lt;/InternationalShippingServiceOption&gt; + <br><br> + If you specify ShippingDetails when you revise or relist an item but you omit + ShippingServiceOptions, eBay will drop the domestic shipping services from the + listing. This may also have unintended side effects, as other fields that depend + on this data may be dropped as well. To retain the shipping services and + dependent fields when you modify other shipping details, it may be simplest to + specify all ShippingDetails that you still want to include in the listing. + <br><br> + A seller can offer up to four domestic shipping services and up to five + international shipping services. All specified domestic and international + shipping services must be the same shipping type (for example, Flat versus + Calculated). + <br><br> + For GetItemShipping, results are filtered: if any service is not available + in the buyer's region, it is removed. If no services remain after this + filtering, a warning is returned. + <br><br> + Not applicable to Half.com or eBay Motors vehicle listings. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Always + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromWonList + WonList + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + GetSellingManagerSaleRecord +
DetailLevel: none
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + ReviseSellingManagerSaleRecord + No + + + Overview of the API Schema + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-APISchema.html + rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) + + + + + + + + Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. + <br><br> + If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. + <br><br> + All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). + <br><br> + A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). + <br><br> + If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. + <br><br> + For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. + <br><br> + Not applicable to Half.com or eBay Motors vehicle listings. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddOrder + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetItemShipping +
DetailLevel: none
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BestOfferList + BidList + DeletedFromWonList + WonList + WatchList +
DetailLevel: none, ReturnAll
+ Conditionally + + + Overview of the API Schema + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Call-APISchema.html + rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) + + + + + + + + The shipping cost model offered by the seller. This is not returned for + various calls since shipping type can be deduced: if a CalculatedShippingRate + structure is returned by the call, the shipping type is Calculated. Otherwise, + it is one of the other non-Calculated shipping types. + <br><br> + <b>GetItemShipping and GetItemTransactions</b>: + If the type was a mix of flat and calculated services, this is + set simply to Flat or Calculated because it is the buyer's + selection that results in one of these. + <br><br> + <b>GetMyeBayBuying</b>: + If the seller has set the <b>ShipToLocation</b> as 'Worldwide' for an item, but has not specified any international shipping service options, 'NotSpecified' is returned as the <b>ShippingType</b> value. + <br><br> + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Free, Freight + No + + + GetSellingManagerSoldListings + Always + + + GetItemShipping + Always + Free, Freight + + + GetBidderList + Free + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Free, Freight + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ReturnAll
+ Free, Freight + Conditionally + + + GetMyeBayBuying + GetMyeBaySelling + Free, Freight + Conditionally + + + + + + + + The sale record ID. Applicable to Selling Manager users. + When an item is sold, Selling Manager generates a sale record. + A sale record contains buyer information, shipping, and other information. + A sale record is displayed in the Sold view in Selling Manager. + Each sale record has a sale record ID. In the following calls, + the value for the sale record ID is in the SellingManagerSalesRecordNumber field: + GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. + In the Selling Manager calls, the value for the sale record ID is in the + SaleRecordID field. The sale record ID can be for a single or a multiple line item order. + <br> + Applicable to Half.com (for GetOrders). + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Third-party applications can no longer be used for + eBay checkout, so this field is deprecated and can no longer be passed into the Add Item family of calls. + + + + + + + + + + + + Tax details for a jurisdiction, such as a state or province. If no tax table + is associated with the item, a tax table is not returned. + <br><br> + For GetItem, a tax table is returned if it exists when: + <br> + - DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, + the value of IncludeTaxTable does not matter). + <br> + - IncludeTaxTable is set to true and DetailLevel is not set or it is set + to ItemReturnAttributes. + <br><br> + Not applicable to Half.com. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This flag is no longer used. + + + + + + + + + + The shipping service actually used by the seller to ship the item(s) to the + buyer. + <br><br> + Not applicable to Half.com. + + + ShippingServiceCodeType + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The default shipping cost for the item. If the seller specified + multiple shipping services, this is the "first" shipping service + as specified by the seller when they listed the item. + <br><br> + Not applicable to Half.com. + + + + + + + Container for domestic insurance information. + <br><br> + Note that there are fields named InsuranceFee and InsuranceOption at the same + level as this container. These were once used for representing both domestic and + international insurance details. If this (newer) container is provided on input + and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also + provided, those two (older fields) are ignored. If this container is omitted on + input, its InsuranceFee and InsuranceOption subfields are set to match whatever + (the older fields) ShippingDetails.InsuranceFee and + ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, + depending on which subfields are used. + <br><br> + Valid only on the following sites: FR and IT + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerSaleRecord + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Always + + + GetSellingManagerSaleRecord + Always + + + + + + + + Container for international insurance information. + <br><br> + Note that there are fields named InsuranceFee and InsuranceOption at the same + level as this container. These were once used for representing both domestic + and international insurance details. If this (newer) container is provided on + input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption + are also provided, those two (older fields) are ignored. If this container is + omitted on input, its InsuranceFee and InsuranceOption subfields are set to + match whatever (the older fields) are set to for flat and calculated shipping, + depending on which subfields are used. + <br><br> + Valid only on the following sites: FR and IT + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + On input, this is the ID of the shipping discount to offer for the domestic + shipping services (where the shipping discount is either of type + FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID + of the shipping discount offered and corresponds to whichever is returned: + FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the + calling user is the seller. If the user created a shipping discount profile, + use the ShippingDiscountProfileID. + <br><br> + In the RelistItem and ReviseItem family of calls, you can remove the existing + ShippingDiscountProfileID associated with the item by supplying a value of 0 (zero). + <br><br> + Only returned if the calling user is the seller. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + If a flat rate shipping discount was offered for the domestic shipping + services, this contains the details of the flat rate shipping discount. + Otherwise, it is not returned. Only returned if the calling user is the seller. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + If a calculated shipping discount was offered for the domestic shipping + services, this contains the details of the calculated shipping discount. + Otherwise, it is not returned. Only returned if the calling user is the seller. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + On input, this specifies whether to offer the promotional shipping discount for + the domestic shipping services of this listing (only applicable if the seller + has a promotional shipping discount in effect at the moment). + <br><br> + Returned on output only if the seller is making the call. This indicates + whether the promotional shipping discount is being offered for the domestic + shipping services of this listing (if the listing is still active--this is only + possible if the seller has a promotional shipping discount in effect at the + moment) or whether the discount was offered at the time the listing ended. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + On input, this is the ID of the shipping discount to offer for the + international shipping services (where the shipping discount is either + of type FlatShippingDiscount or CalculatedShippingDiscount). + <br><br> + In the RelistItem and ReviseItem family of calls, you can remove the existing + InternationalShippingDiscountProfileID associated with the item by supplying a + value of 0 (zero). + <br><br> + Returned on output only if the seller is making the call. The value is + the ID of the shipping discount offered and corresponds to whichever + is returned: FlatShippingDiscount or CalculatedShippingDiscount. + <br><br> + If the user created a shipping discount profile, use + InternationalShippingDiscountProfileID. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + This value is returned only if the seller is making the call. If a flat + rate shipping discount was offered for the international shipping + services, this contains the details of the flat rate shipping discount. + Otherwise, it is not returned. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + This value is returned only if the seller is making the call. If a + calculated shipping discount was offered for the international shipping + services, this contains the details of the calculated shipping + discount. Otherwise, it is not returned. + + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + On input, this specifies whether to offer the promotional shipping + discount for the listing's international shipping services (only + applicable if the seller has a promotional shipping discount in effect + at the moment). + <br><br> + Returned on output only if the seller is making the call. This value + indicates whether the promotional shipping discount is being offered + for the international shipping services of this listing (if the listing + is still active--this is only possible if the seller has a promotional + shipping discount in effect at the moment) or whether the discount was + offered at the time the listing ended. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + This value is returned only if the seller is making the call. Contains details of + the promotional shipping discount, if such is being offered while the listing is + active or if it was offered at the time the listing ended. + + + + GetShippingDiscountProfiles + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#ShippingCostDiscountProfiles + + + + + + + + This dollar value indicates the money due from the buyer upon delivery of the item. + <br><br> + This field should only be specified in the request if 'COD' (cash-on-delivery) is a + valid payment method for the site and it is included as a <b>PaymentMethods</b> + value in the same request. + <br><br> + This field is only returned if set for the listing. + <br><br> + To see if 'COD' is a supported payment method for a site, call <b>GeteBayDetails</b> + with the <b>DetailName</b> field set to 'PaymentOptionDetails'. Look for + a value of 'COD' in one of the <b>PaymentOptionDetails.PaymentOption</b> + fields in the response. + + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItemShipping + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions + Order +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Transaction + Conditionally + + + Other Shipping Features + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-OtherFeatures.html#SpecifyingtheCashonDeliveryOptioninShipp + + + + + + + + Use this field to specify an international country or region, or a special domestic + location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you + will not ship the associated item. Repeat this element in the call request for each + location that you want to exclude as a shipping destination for your item. + <br><br> + Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation + settings applied to your listing. The locations you have excluded display in + the Shipping and Handling section of your item listing. + <br><br> + If a buyer's primary ship-to location is a location that you have listed as + an excluded ship-to location (or if the buyer does not have a primary ship-to + location), they will receive an error message if they attempt to buy or place + a bid on your item. + <br><br> + The exclude ship-to location values are eBay regions and countries. To see + the valid exclude ship-to locations for a specified site, call <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ExcludeShippingLocationDetails</b>, + and then look for the ExcludeShippingLocationDetails.Location fields in the response. + Repeat <b>GeteBayDetails</b> for each site on which you list. + <br><br> + This field works in conjunction with Item.ShipToLocations to create a set of + international countries and regions to where you will, and will not, ship. + You can list a region in the ShipToLocations field, then exclude specific + countries within that region with this field (for example, you can specify + Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation + setting). In addition, if your ShipToLocations is Worldwide, you can use + this field to specify both regions and countries that you want to exclude + from your shipping destinations. + <br><br> + You can specify a default set of locations to where you will not ship in My + eBay. If you create an Exclude Ship-To List, it is, by default, in effect + when you list items. However, if you specify any value in this field on + input, it nullifies the default settings in your Exclude Ship-To List. (If + you use ExcludeShipToLocation when you list an item, you will need to list + all the locations to where you will not ship the associated item, regardless + of the default settings in your Exclude Ship-To List.) + <br><br> + Specify NONE in this field to override the default Exclude Ship-To List you + might have set up in My eBay and indicate that you do not want to exclude any + shipping locations from the respective item listing. + <br><br> + <span class="tablenote"><strong>Note:</strong> + To enable your default Exclude Ship-To List, you must enable Exclude + Shipping Locations and Buyer Requirements in your My eBay Site Preferences. + For details, see the KnowledgeBase Article <a href= + "https://ebaydts.com/eBayKBDetails?KBid=1495" + >HowTo: ExcludeShipToLocation</a>. + </span> + + + ShippingRegionCodeType, CountryCodeType + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ + + GetItemShipping + Conditionally + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddFixedPriceItem + AddItem + AddItemFromSellingManagerTemplate + AddItems + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseTemplate + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + Sellers can set up a global Exclude Ship-To List through their My eBay account. + The Exclude Ship-To List defines the countries to where the seller does not + ship, by default. + <br><br> + This flag returns true if the Exclude Ship-To List is enabled by the seller for + the associated item. If false, the seller's Exclude Ship-To List is either not + set up, or it has been overridden by the seller when they listed the item with + ExcludeShipToLocation fields. + <br><br> + In the response, ExcludeShipToLocation fields detail the locations to where the + seller will not ship the item, regardless of the value returned in this field. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ VerifyRelistItem + Conditionally + + + + + + + + Container for the shipping carrier and tracking information associated with the + shipment of an order. + <br><br> + As each package has a unique tracking number, this container should be + repeated for each package in the order. + <br> + <br> + <span class="tablenote"><b>Note:</b> + Top-rated sellers must have a record of uploading shipment tracking + information (through site or through API) for at least 90 percent of their order line + items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more + information on eBay's Top-rated seller program, see the <a href="http://pages.ebay.com/help/sell/top-rated.html">Becoming a Top Rated Seller and qualifying for Top Rated Plus</a> page. + </span> + <br> + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This container specifies the shipping rate tables that are to be applied to this listing. Shipping rate tables enable sellers to tailor the flat shipping rates offered for an item to fit the shipping destination. They can specify a shipping rate for a large <em>base</em> region, then define alternative rates or surcharges for shipping to other <em>extended</em> regions within the base region. + <br><br> + Prerequisites for applying shipping rate tables: + <ul> + <li>The shipping type for the listing must be Flat. </li> + <li>The seller must have previously configured a shipping rate table in My eBay site preferences. </li> + </ul> + In a domestic shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each of several extended domestic regions within their country. For example, in the US the shipping categories are Economy, Standard, Expedited and One-day. The extended regions are Alaska and Hawaii, US Protectorates, and Army/Fleet Post Offices. + <br><br> + In an international shipping rate table, sellers can specify an alternative shipping rate for each shipping service category, for each country in a given base region. The international rate table has nine base regions: Africa, Asia, Central America and Caribbean, Europe, Middle East, North America, Oceania, Southeast Asia, and South America. + You can use the GetUser call to determine if the seller has configured a shipping rate table. If the domestic shipping rate table is available for this seller, the <strong>User.SellerInfo.DomesticRateTable</strong> field will be <code>true</code>. If the international shipping rate table is available for this seller, the <strong>User.SellerInfo.InternationalTable</strong> field will be <code>true</code>. + <br><br> + <span class="tablenote"> + <strong>Note:</strong> You can use <strong>RateTableDetails</strong> to apply a shipping rate table to a listing or remove it from a listing. However, the details of a shipping rate table configuration can only be viewed and modified on the eBay website, not by using the API. + </span> + Sellers use a dropdown list to specify the alternative shipping rate applied by the rate table as one of the following: + <ul> + <li>A flat amount per item </li> + <li>A flat surcharge (domestic rate tables only) </li> + <li>A surcharge by weight </li> + </ul> + This selection applies to the entire table; there is no mixing and matching by region or shipping category. + <br><br> + If you are applying a shipping rate table that specifies a surcharge by weight, you must specify the item weight in the <strong>ShippingDetails.CalculatedShippingRate</strong> container's <strong>WeightMajor</strong> and <strong>WeightMinor</strong> fields, even though this is a flat rate listing. Do not use any other fields in the <strong>CalculatedShippingRate</strong> container because those are not supported in this scenario. + <br><br> + <span class="tablenote"> + <strong>Note:</strong> There is currently no way to determine through the API whether a seller's rate table specifies a surcharge by weight, so your application must make it clear to the seller that item weight must be supplied if the seller has specified a surcharge by weight. If the required weight values are not supplied, a default weight of one unit (1 lb or 1 kg, depending on locale) is used as the basis for the surcharge. + </span> + This container is returned from the GetItem family of calls only for the seller who listed the item. + <br><br> + You can find more information about using shipping rate tables in the Shipping chapter of the Trading API User's Guide. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#UsingShippingRateTables + + + + + + + + + + + + This type is not currently in use. + + + + + + + + This field is not currently in use. + + + + + + + + + + + This field is not currently in use. + + + + + + + + + + + + + + + Miscellaneous details of the shipment. + + + + + + + Confirmation requested. + + + + + + + Signature requested upon receipt. + + + + + + + Stealth postage. + + + + + + + Saturday delivery. + + + + + + + Other. + + + + + + + Not defined. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Details about insurance for <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice">Combined Invoice</a> + orders. + + + + + + + Whether the seller offers shipping insurance and, if + so, whether the insurance is optional or required. Flat and + calculated shipping. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + NotOfferedOnSite + Conditionally + + + + + + + + A pairing of range of item price total and insurance cost. + For SetShippingDiscountProfiles, if InsuranceOption is Optional or Required, you must + submit all range pairs. For those ranges that do not apply, set the cost to 0. + + + + GetShippingDiscountProfiles + Conditionally + + + SetShippingDiscountProfiles + Conditionally + + + + + + + + + + + + Details about a region or location to which the seller is willing to ship. + + + + + + + Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan). + + + + ShippingDetails.InternationalShippingServiceOption in AddItem + AddItem.html#Request.Item.ShippingDetails.InternationalShippingServiceOption + + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present a list of shipping locations in + a more user-friendly format (such as in a drop-down list). This field is localized + in the language of the site. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + The nature of the package used to ship the item(s). + Required for calculated shipping only. Not all package types + are supported by a specific shipping service (ShippingServiceCodeType). + + + + + + + None + + + + + + + Letter + + + + + + + LargeEnvelope + + + + + + + USPS Large Package/Oversize 1 + + + + + + + Very Large Package/Oversize 2 + + + + + + + Extra Large Package/Oversize 3 + + + + + + + UPS Letter + + + + + + + USPS Flat Rate Envelope + + + + + + + Package/thick envelope + + + + + + + Roll + + + + + + + Europallet + + + + + + + Onewaypallet + + + + + + + Bulky goods + + + + + + + Furniture + + + + + + + Cars + + + + + + + Motorbikes + + + + + + + Caravan + + + + + + + Industry vehicles + + + + + + + Parcel or padded Envelope + + + + + + + Small Canada Post Box + + + + + + + Medium Canada Post Box + + + + + + + Large Canada Post Box + + + + + + + Small Canada Post Bubble Mailer + + + + + + + Medium Canada Post Bubble Mailer + + + + + + + Large Canada Post Bubble Mailer + + + + + + + Padded Bags + + + + + + + Tough Bags + + + + + + + Expandable Tough Bags + + + + + + + Mailing Boxes + + + + + + + Winepak + + + + + + + Reserved for internal or future use. + + + + + + + + + + Details about type of package used to ship an item. + + + + + + + Numeric identifier. + Some applications use this ID to look up shipping packages more efficiently. + + + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present a list of shipping package + options in a more user-friendly format (such as in a drop-down list). + + + + GeteBayDetails + Conditionally + + + + + + + + A supported value for the site that can be used in the + <b>Item.ShippingPackageDetails.ShippingPackage</b> or + <b>Item.ShippingDetails.CalculatedShippingRate.ShippingPackage</b> fields + of an Add/Revise/Relist API call. + + + + GeteBayDetails + Conditionally + + + + + + + + Indicates if the package type is the default for the specified site. + + + + GeteBayDetails + Conditionally + + + + + + + + This field is returned as 'true' if the shipping package supports the use of + package dimensions. + + + false + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Type defining the <b>ShippingPackageInfoType</b> container, which is returned in order management calls. Various fields are returned if the order is being delivered through eBay Now; other fields are returned for non-eBay Now orders. + + + + + + + The unique identifier of the store from where the eBay Now order will be delivered. The eBay Now valet picks up the order from this store and delivers it to the buyer. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This enumeration value indicates whether or not the eBay Now valet has picked up the order from the store indicated by the <b>StoreID</b> value. + + + ShippingTrackingEventCodeType + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> timestamps indicate the delivery window for which the buyer can expect to receive the eBay Now order. The <b>ScheduledDeliveryTimeMin</b> value indicates the earliest time that the buyer can expect to receive the order. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The <b>ScheduledDeliveryTimeMin</b> and <b>ScheduledDeliveryTimeMax</b> timestamps indicate the delivery window for which the buyer can expect to receive the eBay Now order. The <b>ScheduledDeliveryTimeMax</b> value indicates the latest time that the buyer can expect to receive the order. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This timestamp indicates when the eBay Now order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer. + + + 0 + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + For a non-eBay Now order, the <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> timestamps indicate the window during which the buyer can expect to take delivery. The <b>EstimatedDeliveryTimeMin</b> value indicates the earliest date and time that the buyer can expect to receive the order. + + + + GetOrders + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + ShippingServiceSelected + Conditionally + + + GetOrderTransactions + ShippingServiceSelected +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + For a non-eBay Now order, the <b>EstimatedDeliveryTimeMin</b> and <b>EstimatedDeliveryTimeMax</b> timestamps indicate the window during which the buyer can expect to take delivery. The <b>EstimatedDeliveryTimeMax</b> value indicates the latest date and time that the buyer can expect to receive the order. + + + + GetOrders + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + ShippingServiceSelected + Conditionally + + + GetOrderTransactions + ShippingServiceSelected +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + ShippingServiceSelected +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + A shipping rate scale for shipping through USPS that affects the shipping cost calculated for USPS (lower if <strong>ShippingRateType</strong> is <code>DailyPickup</code>). For calculated shipping only. + + + + + + + "On-demand" shipping rate scale. + + + + + + + "Daily pickup" shipping rate scale. + + + + + + + "Standard List" shipping rate scale. + + + + + + + "Counter" shipping rate scale. + + + + + + + "Discounted" shipping rate scale. + + + + + + + "Commercial Plus" shipping rate scale. + + + + + + + "Commercial Plus Discounted Rate1" shipping rate scale. + + + + + + + "Commercial Plus Discounted Rate2" shipping rate scale. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Regions to which the seller is willing to ship the item. + These values are applicable to ShipToLocation. + + + + + + + Africa + + + + + + + Asia + + + + + + + Caribbean + + + + + + + Europe + + + + + + + Latin America + + + + + + + Middle East + + + + + + + North America + + + + + + + Oceania (Pacific region other than Asia) + + + + + + + South America + + + + + + + European Union + + + + + + + Seller will not ship the item. + + + + + + + Seller has specified Worldwide or eBay has + determined that the specified regions add up to Worldwide. + + + + + + + + + + + + + + + + + + + Reserved for internal or future use + + + + + + + + + + A shipping service used to ship an item. Applications should not depend on the completeness of <strong>ShippingServiceCodeType</strong>. Instead, applications should call GeteBayDetails, with a <strong>DetailName</strong> value of <code>ShippingServiceDetails</code>, to return the complete list of shipping services. To check for the shipping services available for a specific site, specify the site ID in the header. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> It is possible that some of the returned shipping services can no longer be used in the AddItem family of calls. To distinguish between the valid and invalid shipping services, look for the <strong>ValidForSellingFlow</strong> flag in the <strong>ShippingServiceDetails</strong> node. If this flag is not returned for a specific shipping service, that shipping service can no longer be used in the AddItem family of calls. + </span> + + + + CA_PostExpeditedFlatRateBox, CA_PostExpeditedFlatRateBoxUSA, FreightOtherShipping, SameDayShipping, UK_RoyalMailStandardParcel + + + + + + + UPS Ground + + + + + + + UPS 3rd Day + + + + + + + UPS 2nd Day + + + + + + + UPS Next Day + + + + + + + USPS Priority + + + + + + + USPS Parcel Select Non-Presort + + + + + + + USPS Standard Post + + + + + + + USPS Media + + + + + + + USPS First Class + + + + + + + Standard shipping method + + + + + + + Reserved for internal or future use + + + + + + + USPS Priority Mail Express + + + + + + + UPS Next Day Air + + + + + + + UPS Next Day Air + + + + + + + USPS Priority Mail Express Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Express Padded Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Small Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Large Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Padded Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Legal Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Express Legal Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Regional Box A + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Regional Box B + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Regional Box C + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Express Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + Other (see description) + + + + + + + Local Delivery/Pickup + + + + + + + Not Selected + + + + + + + International Not Selected + + + + + + + Standard International Flat Rate Shipping + + + + + + + Expedited International Flat Rate Shipping + + + + + + + USPS Global Express Mail + + + + + + + USPS Global Priority Mail + + + + + + + USPS Economy Parcel Post + + + + + + + USPS Economy Letter Post + + + + + + + USPS Airmail Letter Post + + + + + + + USPS Airmail Parcel Post + + + + + + + UPS Worldwide Express Plus + + + + + + + UPS Worldwide Express + + + + + + + UPS Worldwide Expedited + + + + + + + UPS Worldwide Saver + + + + + + + UPS Standard To Canada + + + + + + + USPS Priority Mail Express International Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail Express International Padded Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail International Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail International Small Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail International Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + The seller must also specify a package size of Package/Thick Envelope when + using a calculated shipping service. + + + + + + + USPS Priority Mail International Large Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail International Padded Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail International Legal Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Express International Legal Flat Rate Envelope + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + USPS Priority Mail Express International Flat Rate Box + To use this service, a seller must specify the package weight so that eBay + can validate the weight against the maximum weight limit for the service. + + + + + + + Other International Shipping (see description) + + + + + + + Standardversand (unversichert) + + + + + + + Versicherter Versand + + + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + + + Sonstige (Siehe Artikelbeschreibung) + + + + + + + Unversicherter Versand International + + + + + + + Versicherter Versand International + + + + + + + Sonstiger Versand International + + + + + + + Unversicherter Express Versand International + + + + + + + Versicherter Express Versand International + + + + + + + Sparversand aus dem Ausland + + + + + + + Standardversand aus dem Ausland + + + + + + + Expressversand aus dem Ausland + + + + + + + Versand mit Nachverfolgung aus dem Ausland + + + + + + + Regular + + + + + + + Express + + + + + + + Registered + + + + + + + Courier + + + + + + + Other + + + + + + + EMS International Courier - Parcels + + + + + + + EMS International Courier - Documents + + + + + + + Express Post International - Documents + + + + + + + Air Mail + + + + + + + Economy Air + + + + + + + Sea Mail + + + + + + + Standard International Flat Rate Postage + + + + + + + Expedited international flat rate postage + + + + + + + Other international postage + + + + + + + Australia Post Registered Post International Padded Bag 1 kg + + + + + + + Australia Post Registered Post International Padded Bag 500 g + + + + + + + Australia Post Registered Post International Parcel + + + + + + + Expedited delivery from outside Australia + + + + + + + Economy delivery from outside Australia + + + + + + + Standard Delivery From Outside AU + + + + + + + Australian Air Express Metro 15 kg + + + + + + + Australian Air Express Flat Rate 5 kg + + + + + + + Australian Air Express Flat Rate 3 kg + + + + + + + Australian Air Express Flat Rate 1 kg + + + + + + + Express delivery (1-3 business days) in Australia + + + + + + + Standard delivery (1-6 business days) in Australia + + + + + + + eBay/Australian Post 3 kg Flat Rate Satchel + + + + + + + eBay/Australian Post 500 g Flat Rate Satchel + + + + + + + Freight delivery in Australia. Used for heavy and bulky items. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + De Post + + + + + + + UPS + + + + + + + FedEx + + + + + + + DHL + + + + + + + TPG Post/TNT (Netherlands) + + + + + + + Frais de livraison internationale fixes + + + + + + + Frais fixes pour livraison internationale express + + + + + + + Autres livraisons internationales (voir description) + + + + + + + La Poste (France) + + + + + + La Poste - livraison standard (1 a 2 jours ouvrables) + + + + + La Poste - envoi recommande (1 jour ouvrable) + + + + + La Poste - Taxipost LLS (2 jours ouvrables) + + + + + La Poste - Taxipost 24h (1 jour ouvrable) + + + + + Autres livraisons + + + + + La Poste - livraison standard + + + + + La Poste - envoi recommande + + + + + TNT + + + + + + + + + + Standard Delivery + + + + + + + Priority Delivery + + + + + + + Parcel Post + + + + + + + Registered Mail + + + + + + + Other Shipping Service + + + + + + + De Post + + + + + + + UPS + + + + + + + FedEx + + + + + + + DHL + + + + + + + TPG Post/TNT (Netherlands) + + + + + + + Standard International + + + + + + + Expedited International + + + + + + + Other International Shipping Services + + + + + + + La Poste (France) + + + + + + De Post - standaardverzending (1 tot 2 werkdagen) + + + + + De Post - aangetekende zending (1 werkdag) + + + + + De Post - Taxipost LLS (2 werkdagen) + + + + + De Post - Taxipost 24u (1 werkdag) + + + + + De Post - Taxipost Secur (1 werkdag) + + + + + Andere verzending + + + + + De Post - standaardverzending + + + + + De Post - aangetekende zending + + + + + TNT + + + + + Voordelige verzending uit het buitenland + + + + + Standaardverzending uit het buitenland + + + + + Express verzending uit het buitenland + + + + + Verzending uit het buitenland met internationale tracking + + + + + + Standard Delivery + + + + + + + + Canada Post Lettermail + + + + + + + Canada Post Regular Parcel + + + + + + + Canada Post Expedited Parcel + + + + + + + + + + + + + Canada Post Priority Courier + + + + + + + Canada Post Expedited Flat Rate Box + + + + + + + + (This value is no longer used.) + + + + + + + Standard International Flat Rate Shipping + + + + + + + Expedited International Flat Rate Shipping + + + + + + + Other International Shipping (see description) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Small Packets - International + + + + + + + Purolator International + + + + + + + Canada Post Small Packets - USA - Ground + + + + + + + Canada Post Small Packets - USA - Air + + + + + + + Small Packets - International - Ground + + + + + + + Small Packets - International - Air + + + + + + + Canada Post USA Letter-post + + + + + + + Canada Post International Letter-post + + + + + + + + (This value is no longer used.) + + + + + + + UPS Express Canada + + + + + + + UPS Express Saver Canada + + + + + + + UPS Expedited Canada + + + + + + + UPS Standard Canada + + + + + + + UPS Express United States + + + + + + + UPS Expedited United States + + + + + + + UPS 3 Day Select United States + + + + + + + UPS Standard United States + + + + + + + UPS Worldwide Express + + + + + + + UPS Worldwide Expedited + + + + + + + Canada Post Priority Worldwide + + + + + + + Canada Post Expedited Flat Rate Box USA + + + + + + + Canada Post Tracked Packet - USA + + + + + + + Canada Post Tracked Packet - International + + + + + + + Freight + + + + + + + Standardversand (A-Post/Priority) + + + + + + + Standardversand (B-Post/Economy) + + + + + + + Versicherter Versand (z.B. Assurance/Fragile) + + + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + + + Sonstige (Siehe Artikelbeschreibung) + + + + + + + Sonstiger Versand (Siehe Artikelbeschreibung) + + + + + + + ECONOMY Sendungen + + + + + + + PRIORITY Sendungen + + + + + + + URGENT Sendungen + + + + + + + Sparversand aus dem Ausland + + + + + + + Standardversand aus dem Ausland + + + + + + + Expressversand aus dem Ausland + + + + + + + Versand mit Nachverfolgung aus dem Ausland + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unversicherter Versand + + + + + + + Versicherter Versand + + + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + + + Unversicherter Versand + + + + + + + Deutsche Post Brief + + + + + + + eBay DHL Paket 24/7 (Abgabe und Lieferung an Packstation) + + + + + + + DHL Postpaket + + + + + + + + Deutsche Post Warensendung + + + + + + + + Hermes Paket (unversichert) + + + + + + + Hermes Paket (versichert) + + + + + + + iloxx Transport XXL + + + + + + + + iloxx Standard + + + + + + + Sonstige (Siehe Artikelbeschreibung) + + + + + + + Unversicherter Versand + + + + + + + Versicherter Versand + + + + + + + DHL Postpaket International + + + + + + + + Sonstiger Versand (Siehe Artikelbeschreibung) + + + + + + + Unversicherter Express - Versand + + + + + + + Versicherter Express - Versand + + + + + + + Deutsche Post Brief (Land) + + + + + + + Deutsche Post Brief (Luft) + + + + + + + iloxx Europa + + + + + + + iloxx World Wide + + + + + + Paketversand + + + + + Expressversand + + + + + DHL Paket + + + + + Deutsche Post Buecher-/Warensendung + + + + + Hermes Paket + + + + + iloxx Transport + + + + + Sonstige + + + + + Einschreiben (inkl. aller Gebuehren) + + + + + Nachnahme (inkl. aller Gebuehren) + + + + + Sonderversand + + + + + UPS + + + + + DPD + + + + + GLS + + + + + Paketversand + + + + + DHL Paket International + + + + + DHL Paket International Express + + + + + + Sonstige + + + + + Expressversand + + + + + Deutsche Post Brief + + + + + iloxx Transport International + + + + + Hermes Paket International + + + + + UPS International + + + + + DPD International + + + + + GLS International + + + + + + eBay Hermes Paket Shop2Shop (Kaeufer erhaelt E-Mail von Hermes bei Zustellung) + + + + + + + Hermes Paket Shop2Shop (Kaeufer erhaelt E-Mail von Hermes bei Zustellung) + + + + + + + eBay Hermes Paket Shop2Shop + + + + + + + Hermes Paket Shop2Shop + + + + + + + Hermes Paket Sperrgut + + + + + + + eBay Hermes Paket Sperrgut Shop2Shop (Abgabe und Zustellung im Paketshop) + + + + + + + DHL Paeckchen Packstation + + + + + + + DHL Paket Packstation + + + + + + + eBay DHL Paeckchen + + + + + + + DHL Star-Paeckchen + + + + + + + Versand mit Nachverfolgung aus dem Ausland + + + + + + + Cartas nacionales hasta 20 gr + + + + + + + + Cartas internacionales hasta 20 gr + + + + + + + Cartas internacionales de mas de 20 gr + + + + + + + Paquete Azul (nacional) hasta 2 kg + + + + + + + + + + + + + + Cartas y tarjetas postales internacionales + + + + + + + Ems postal expres internacional + + + + + + + Paquete internacional economico + + + + + + + + + + + Entrega a un Kiala point hasta 8 kg + + + + + + + Chronoposte International Classic + + + + + + + Coliposte Colissimo Direct + + + + + + + DHL Express Europack + + + + + + + UPS Standard + + + + + + + Lettre + + + + + + + Lettre avec suivi + + + + + + + + Colissimo + + + + + + + + Contre remboursement + + + + + + + Autre mode d'envoi de courrier + + + + + + + Ecopli + + + + + + + + Autre mode d'envoi de colis + + + + + + + Remise en main propre + + + + + + + + + + La Poste - Courrier International Prioritaire + + + + + + + La Poste - Courrier International Economique + + + + + + + La Poste - Colissimo International + + + + + + + La Poste - Colis Economique International + + + + + + + La Poste - Colissimo Emballage International + + + + + + + Chronopost Classic International + + + + + + + Chronopost Premium International + + + + + + + UPS Standard + + + + + + + UPS Express + + + + + + + DHL + + + + + + + La Poste Lettre Max + + + + + + + Livraison en Relais Kiala + + + + + + + + National - Regular + + + + + + + National - Express + + + + + + + National - COD + + + + + + + Local - Courier + + + + + + + Local - COD + + + + + + + International - Standard + + + + + + + International - Expedited + + + + + + + International - other + + + + + + + Flat Rate COD + + + + + + + Buyer picks up and pays + + + + + + + Posta ordinaria + + + + + + + Posta prioritaria + + + + + + + Posta raccomandata + + + + + + + Posta raccomandata con contrassegno + + + + + + + Posta assicurata + + + + + + + Posta celere + + + + + + + Pacco ordinario + + + + + + + Pacco celere 1 + + + + + + + Pacco celere 3 + + + + + + + Corriere espresso + + + + + + + Paccocelere Maxi + + + + + + + Spedizione internazionale standard a prezzo fisso + + + + + + + Spedizione internazionale celere a prezzo fisso + + + + + + + Altre spedizioni internazionali (vedi descrizione) + + + + + + + Spedizione tracciata dall estero + + + + + + + Standaardverzending + + + + + + + Pakketpost + + + + + + + Verzending met ontvangstbevestiging + + + + + + + Andere verzendservice + + + + + + + TPG Post/TNT + + + + + + + UPS + + + + + + + FedEx + + + + + + + DHL + + + + + + + DPD (Germany) + + + + + + + GLS (Business only) + + + + + + + Vaste kosten standaard internationale verzending + + + + + + + Vaste kosten versnelde internationale verzending + + + + + + + Andere internationale verzending (zie beschrijving) + + + + + + + Voordelige verzending uit het buitenland + + + + + + + Standaardverzending uit het buitenland + + + + + + + Verzending per expresse uit het buitenland + + + + + + + Verzending met internationale tracering uit het buitenland + + + + + + + + + + + + + + + + + + + + + + FedEx International Priority + + + + + + + FedEx International Economy + + + + + + + UPS Worldwide Expedited + + + + + + + UPS Worldwide Express + + + + + + + UPS Worldwide Express Plus + + + + + + + + Royal Mail 1st Class + + + + + + + Royal Mail 2nd Class + + + + + + + Royal Mail 1st Class Signed For + + + + + + + Royal Mail 2nd Class Signed For + + + + + + + Royal Mail Special Delivery + + + + + + + + (This value is no longer used.) + + + + + + + Parcelforce 24 + + + + + + + Parcelforce 48 + + + + + + + Other Courier + + + + + + + Hermes Tracked + + + + + + + Collect+ : drop at store-delivery to door + + + + + + + Seller's Standard Rate + + + + + + + Collection in Person + + + + + + + Sellers Standard International Rate + + + + + + + Royal Mail Airmail + + + + + + + Royal Mail Airsure + + + + + + + Royal Mail Surface Mail + + + + + + + Royal Mail International Signed-for + + + + + + + Royal Mail HM Forces Mail + + + + + + + Parcelforce International Datapost + + + + + + + Parcelforce Ireland 24 + + + + + + + Parcelforce Euro 48 + + + + + + + Parcelforce International Scheduled + + + + + + + Other courier or delivery service + + + + + + + Collect in person + + + + + + + Parcelforce Global Express + + + + + + + Parcelforce Global Value + + + + + + + Parcelforce Global Economy (Not available for destinations in Europe) + + + + + + + Tracked delivery from outside abroad + + + + + + + International tracked postage + + + + + + + Seller's standard rate + + + + + + + First Class Letter Service + + + + + + + SwiftPost National + + + + + + + Registered Post + + + + + + + EMS SDS Courier + + + + + + + Economy SDS Courier + + + + + + + Other courier + + + + + + + Collection in person + + + + + + + Seller's Standard International Rate + + + + + + + International Economy Service + + + + + + + International Priority Service + + + + + + + SwiftPost Express + + + + + + + SwiftPost International + + + + + + + EMS SDS Courier + + + + + + + Economy SDS Courier + + + + + + + Other courier or delivery service + + + + + + + International collection in person + + + + + + + Economy delivery from abroad + + + + + + + Standard delivery from abroad + + + + + + + Express delivery from abroad + + + + + + + Tracked delivery from abroad + + + + + + + Domestic Regular shipping + + + + + + + Domestic Special shipping + + + + + + + Przesylka z zagranicy - ekonomiczna + + + + + + + Przesylka z zagranicy - standardowa + + + + + + + Przesylka z zagranicy - ekspresowa + + + + + + + Przesylka z zagranicy - ze sledzeniem + + + + + + + Service associated with FreightQuote.com + + + + + + + + (This value is no longer used.) + + + + + + + Service associated with any freight service other than FreightQuote.com + + + + + + + Freight Shipping International + + + + + + + + + + + + + Overnight flat rate shipping service (domestic only) + + + + + + + Reserved for internal or future use + + + + + + + USPS Priority Flat Rate Envelope + + + + + + + USPS Priority Flat Rate Box + + + + + + + USPS Global Priority Mail Small Envelope + + + + + + + USPS Global Priority Mail Large Envelope + + + + + + + USPS Priority Mail Express Flat Rate Envelope + + + + + + + UPS Worldwide Express Box 10 Kg + + + + + + + UPS Worldwide Express Box 25 Kg + + + + + + + UPS Worldwide Express Plus Box 10 Kg + + + + + + + UPS Worldwide Express Plus box 25 Kg + + + + + + + Local pick up only + + + + + + + Local courier + + + + + + + Domestic regular shipping + + + + + + + Domestic special shipping + + + + + + + International regular shipping + + + + + + + International special shipping + + + + + + + Local pick up only + + + + + + + Local courier + + + + + + + Domestic standard mail + + + + + + + Domestic non standard mail + + + + + + + Domestic Speedpost Islandwide + + + + + + + International standard mail + + + + + + + International Express Mail Service (EMS) + + + + + + + International courier (DHL, FedEx, UPS) + + + + + + + De Post zending - NON PRIOR (2 werkdagen) + + + + + + + De Post zending - PRIOR (1 werkdag) + + + + + + + De Post zending - aangetekend (1 werkdag) + + + + + + + Kilopost pakje (2 werkdagen) + + + + + + + Taxipost (express) + + + + + + + Kiala afhaalpunt (1 tot 4 werkdagen) + + + + + + + Vaste kosten standaard verzending + + + + + + + Vaste kosten versnelde verzending + + + + + + + Verzekerde verzending + + + + + + + La Poste envoi NON PRIOR (2 jours ouvrables) + + + + + + + La Poste envoi PRIOR (1 jour ouvrable) + + + + + + + La Poste envoi recommande (1 jour ouvrable) + + + + + + + Paquet Kilopost (2 jours ouvrables) + + + + + + + Taxipost (express) + + + + + + + Point retrait Kiala (1 a 4 jours ouvrables) + + + + + + + Livraison standard - prix forfaitaire + + + + + + + Livraison express - prix forfaitaire + + + + + + + Livraison securisee + + + + + + + De Post zending - PRIOR + + + + + + + De Post zending - NON PRIOR + + + + + + + De Post zending - aangetekend + + + + + + + Kilopost pakje Internationaal + + + + + + + Taxipost expressverzending + + + + + + + Verzekerde verzending + + + + + + + La Poste envoie PRIOR + + + + + + + La Poste envoie NON PRIOR + + + + + + + La Poste envoie recommande + + + + + + + Paquet Kilopost Internationale + + + + + + + BEFR_Express Taxipost + + + + + + + Livraison standard internationale - prix forfaitaire + + + + + + + Livraison express internationale - prix forfaitaire + + + + + + + Livraison securisee + + + + + + + Chronopost + + + + + + + Royal Mail Special Delivery; 1:00 pm + + + + + + + Canada Post Light Packet International + + + + + + + Canada Post Light Packet USA + + + + + + + DHL + + + + + + + Przesylka zagraniczna - zwykla + + + + + + + Przesylka zagraniczna - priorytetowa + + + + + + + UPS + + + + + + + Normes de livraison postale + + + + + + + Expedition acceleree + + + + + + + Postes Canada, Poste-lettres + + + + + + + Postes Canada, Colis standard + + + + + + + Postes Canada, Colis acceleres + + + + + + + Postes Canada, Xpresspost + + + + + + + Postes Canada, Messageries prioritaires + + + + + + + Expedition standard - International, tarif fixe + + + + + + + Expedition acceleree - International, tarif fixe + + + + + + + Autres services d'expedition internationale (voir description) + + + + + + + Postes Canada, Colis acceleres - E.U. + + + + + + + Postes Canada, Petits paquets - E.U. + + + + + + + Postes Canada, Xpresspost - E.U. + + + + + + + Postes Canada, Xpresspost - International + + + + + + + Postes Canada, Colis international de surface + + + + + + + Postes Canada, Colis-avion - International + + + + + + + Petits paquets - International + + + + + + + Purolator International + + + + + + + Postes Canada, Petits paquets - E.U. service de surface + + + + + + + Postes Canada, Petits paquets - E.U. par avion + + + + + + + Petits paquets - International, courrier-surface + + + + + + + Petits paquets - International, courrier-avion + + + + + + + Postes Canada, Poste aux lettres - E.U. + + + + + + + Postes Canada, Poste aux lettres - International + + + + + + + UPS Express Saver + + + + + + + UPS Express Saver Canada + + + + + + + UPS Expedited Canada + + + + + + + UPS Standard au Canada + + + + + + + UPS Express Etats-Unis + + + + + + + UPS Expedited Etats-Unis + + + + + + + 3Day Select aux Etats-Unis + + + + + + + UPS Standard aux Etats-Unis + + + + + + + UPS Worlwide Express + + + + + + + UPS Worlwide Expedited + + + + + + + Royal Mail Special Delivery 9:00 am + + + + + + + USPS First Class Mail Intl / First Class Package Intl Service + + + + + + + USPS Priority Mail International + + + + + + + USPS Priority Mail Express International + + + + + + + Standardpauschale fur internationalen Versand + + + + + + + Expresspauschale fur internationalen Versand + + + + + + + Sonstiger Versand (Siehe Artikelbeschreibung) + + + + + + + International Standard FixedRate for Taiwan + + + + + + + International Express FixedRate for Taiwan + + + + + + + USPS Global Express Guaranteed + + + + + + + Regular with Insurance + + + + + + + Express with Insurance + + + + + + + Deutsche Post Warensendung + + + + + + + Deutsche Post Byendung + + + + + + + Hermes Paket (unversichert) + + + + + + + Hermes Paket (versichert) + + + + + + + iloxx Transport XXL + + + + + + + iloxx Ubernacht Express + + + + + + + iloxx Standard + + + + + + + Standardpauschale fur internationalen Versand + + + + + + + Expresspauschale fur internationalen Versand + + + + + + + Deutsche Post Presse & Bucher Economy + + + + + + + Deutsche Post Presse & Bucher Priority + + + + + + + AT_BITTE_TREFFEN_SIE_EINE_AUSWAHL + + + + + + + Einschreiben (Versand inkl. Einschreibengebuhr) + + + + + + + Nachnahme (Versand inkl. Nachnahmegebuhr) + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + Sonderversand (z.B. Sperrgut, KFZ) + + + + + + + Versicherter Sonderversand (z.B. Sperrgut, KFZ) + + + + + + + Standardpauschale fur internationalen Versand + + + + + + + Expresspauschale fur internationalen Versand + + + + + + + Sonstiger Versand (Siehe Artikelbeschreibung) + + + + + + + CH_BITTE_TREFFEN_SIE_EINE_AUSWAHL + + + + + + + Unversicherter Versand + + + + + + + Versicherter Versand + + + + + + + Einschreiben (Versand inkl. Einschreibengebuhr) + + + + + + + Nachnahme (Versand inkl. Nachnahmegebuhr) + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + Sonderversand (z.B. Sperrgut, KFZ) + + + + + + + Versicherter Sonderversand (z.B. Sperrgut, KFZ) + + + + + + + Standardversand (A-Post/Priority) + + + + + + + Standardversand (B-Post/Economy) + + + + + + + DE_BITTE_TREFFEN_SIE_EINE_AUSWAHL + + + + + + + Einschreiben (Versand inkl. Einschreibengebuhr) + + + + + + + Nachnahme (Versand inkl. Nachnahmegebuhr) + + + + + + + Express- oder Kurierversand + + + + + + + Versicherter Express- oder Kurierversand + + + + + + + Sonderversand (z.B. Mobel, KFZ) + + + + + + + Versicherter Sonderversand (z.B. Mobel, KFZ) + + + + + + + Deutsche Post Brief + + + + + + + Standard Int'l Flat Rate Postage + + + + + + + Expedited Int'l Flat Rate Postage + + + + + + + Other Int'l Postage (see description) + + + + + + + Standard Int'l Flat Rate Postage + + + + + + + Expedited Int'l Flat Rate Postage + + + + + + + Other Int'l Postage (see description) + + + + + + + Chronopost - Chrono Relais + + + + + + + Chrono 10 + + + + + + + Chrono 13 + + + + + + + Chrono 18 + + + + + + + Chronopost Express International + + + + + + + PickUp Only Service + + + + + + + Delivery + + + + + + + Pickup Only Service + + + + + + + Abholung + + + + + + + Pickup + + + + + + + Small Parcels + + + + + + Small Parcel With Tracking + + + + + Small Parcel With Tracking And Signature + + + + + Regular Parcel With Tracking + + + + + Regular Parcel With Tracking And Signature + + + + + PrePaid Express Post Satchel 5kg + + + + + + PrePaid Parcel Post Satchels 500g + + + + + + + PrePaid Parcel Post Satchels 3kg + + + + + + + PrePaid Parcel Post Satchels 5kg + + + + + + + PrePaid Express Post Satchel 500g + + + + + + + PrePaid Express Post Satchel 3kg + + + + + + + PrePaid Express Post Platinum 500g + + + + + + + PrePaid Express Post Platinum 3kg + + + + + + + Express Courier International + + + + + + + Express Post International + + + + + + + PrePaid Express Post International Envelope C5 + + + + + + + PrePaid Express Post International Envelope B4 + + + + + + + PrePaid Express Post International Satchels 2kg + + + + + + + PrePaid Express Post International Satchels 3kg + + + + + + + PrePaid Express Post International Box 5kg + + + + + + + PrePaid Express Post International Box 10kg + + + + + + + PrePaid Express Post International Box 20kg + + + + + + + Registered Parcel Post + + + + + + + Registered Small Parcel + + + + + + + Registered Parcel Post Prepaid Satchel 500g + + + + + + + Registered Parcel Post Prepaid Satchel 3kg + + + + + + + Registered Parcel Post Prepaid Satchel 5kg + + + + + + + eBay Australia Post Express Post 500g Satchel + + + + + + + eBay Australia Post Express Post 3kg Satchel + + + + + + + Enlevement + + + + + + + Pickup + + + + + + + Afhalen + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Pickup + + + + + + + Other 24 Hour Courier + + + + + + + Other 48 Hour Courier + + + + + + + Other Courier 3 days + + + + + + + Other Courier 5 days + + + + + + + Courier Shipping + + + + + + + FedEx Priority Overnight + + + + + + + FedEx Standard Overnight + + + + + + + FedEx 2Day + + + + + + + FedEx Ground + + + + + + + FedEx Home Delivery + + + + + + + FedEx Express Saver + + + + + + + Reserved for internal or future use + + + + + + + Reserved for internal or future use + + + + + + + FedEx International First + + + + + + + FedEx International Priority + + + + + + + FedEx International Economy + + + + + + + FedEx International Ground + + + + + + + Economy shipping from outside US + + + + + + + Expedited shipping from outside US + + + + + + + Standard shipping from outside US + + + + + + + Economy postage from outside UK + + + + + + + Express postage from outside UK + + + + + + + Standard postage from outside UK + + + + + + + Economy postage from outside DE + + + + + + + Standard postage from outside DE + + + + + + + Express postage from outside DE + + + + + + + DHL 2kg Paket (nur fuer kurze Zeit) + + + + + + + Global Shipping Program + <br/> + This shipping service must be selected for the international leg of the shipment. + + + + + + + + Reserved for future use. + + + + + + + Royal Mail Tracked 24 + + + + + + + Royal Mail Tracked 48 + + + + + + + This value indicates that the order will be delivered by an eBay Now valet through the eBay Now program. + + + + + + + + + + Type defining the <b>ShippingServiceCostOverrideList</b> container, which is used when the seller wants to override the flat shipping costs for all domestic and/or all international shipping services defined in the Business Policies shipping profile referenced in the <b>SellerProfiles.SellerShippingProfile.ShippingProfileID</b> field of an Add/Revise/Relist call. + <br/><br/> + Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverrideList.ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile. + + + + + + + A <b>ShippingServiceCostOverride</b> container is required for each domestic and/or international shipping service that is defined in the <b>domesticShippingPolicyInfoService</b> and <b>intlShippingPolicyInfoService</b> containers of the Business Policies shipping profile. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. + <br/><br/> + Shipping service cost overrides are a listing-level concept, and the shipping costs specified through each <b>ShippingServiceCostOverride</b> container will not change the shipping costs defined for the same shipping services in the Business Policies shipping profile. + <br/><br/> + To override the shipping costs for each domestic shipping service in the Business Policies shipping profile, the <b>ShippingServiceType</b> field should be set to 'Domestic', and to override the shipping costs for each international shipping service, the <b>ShippingServiceType</b> field should be set to 'International'. For both domestic and international shipping services, the <b>ShippingServicePriority</b> value should match the <b>sortOrderId</b> value for the matching shipping service in the shipping profile. If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs. + <br/><br/> + If shipping service cost overrides are used in a listing, the <b>ShippingServiceCostOverride</b> container will be returned in the <b>GetSellerList</b> and <b>GetSellingManagerTemplates</b> calls. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellerList + GetSellingManagerTemplates + Conditionally + + + + + + + + + + + + Type defining the <strong>ShippingServiceCostOverride</strong> container, which is used to override the flat shipping costs for each domestic and/or international shipping service that is defined in the <strong>domesticShippingPolicyInfoService</strong> and <strong>intlShippingPolicyInfoService</strong> containers of the Business Policies shipping profile. Shipping costs include the cost to ship one item, the cost to ship each additional identical item, and any shipping surcharges applicable to domestic shipping services. A <strong>ShippingServiceCostOverride</strong> container is required for every domestic and/or international shipping service that is defined in the Business Policies shipping profile. For example, you cannot override the shipping costs for one domestic shipping service but not the other domestic shipping services defined in the Business Policies shipping profile. The same rule applies to international shipping services. + + + + + + + This integer value maps the particular instance of the <strong>ShippingServiceCostOverride</strong> container to the <strong>domesticShippingPolicyInfoService</strong> or <strong>intlShippingPolicyInfoService</strong> container of the Business Policies shipping profile. The <strong>ShippingServicePriority</strong> value should match the <strong>sortOrderId</strong> value for the matching shipping service in the Business Policies shipping profile. If overriding the shipping costs for domestic shipping services, the <strong>ShippingServiceType</strong> field should be set to 'Domestic', and to override the shipping costs for international shipping services, the <strong>ShippingServiceType</strong> field should be set to 'International'. + <br/><br/> + If any of the domestic and/or international shipping service priorities and shipping service options in the Add/Revise/Relist call and Business Policies shipping profile do not match, an error occurs. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + This enumerated value indicates whether domestic or international shipping costs are being overridden. To override the shipping costs for each domestic shipping service in the Business Policies shipping profile, this field should be set to 'Domestic', and to override the shipping costs for each international shipping service, this field should be set to 'International'. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + + This dollar value indicates the shipping service cost to ship one item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingServiceCost</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> (domestic shipping service) or <strong>intlShippingPolicyInfoService</strong> (international shipping service) containers in the Business Policies shipping profile. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + This dollar value indicates the cost to ship each additional identical item to the buyer. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingServiceAdditionalCost</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> (domestic shipping service) or <strong>intlShippingPolicyInfoService</strong> (international shipping service) containers in the Business Policies shipping profile. + <br/><br/> + This field is only applicable to multi-quantity, fixed-price listings. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + This dollar value indicates the shipping surcharge applicable to the domestic shipping service. If the shipping service costs override operation is successful, this value will override the corresponding <strong>shippingSurcharge</strong> value set in the <strong>domesticShippingPolicyInfoService</strong> container in the Business Policies shipping profile. + <br/><br/> + This field can only be used if the shipping surcharges are applicable for the corresponding shipping service. + + + + AddFixedPriceItem + AddItem + AddItems + VerifyAddItem + VerifyAddFixedPriceItem + VerifyRelistItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + No + + + + + + + + + + + Details about a specific shipping service. + + + + + + + Display string that applications can use to present a list of shipping service + options in a more user-friendly format (such as in a drop-down list). + + + + GeteBayDetails + Conditionally + + + + + + + + Indicates whether the shipping service is an expedited shipping service. + See Enabling Get It Fast. Only returned for sites for which the Get It + Fast feature is enabled and only if true. + + + + Item.DispatchTimeMax in AddItem + AddItem.html#Request.Item.DispatchTimeMax + + + Item.GetItFast in AddItem + AddItem.html#Request.Item.GetItFast + + + GeteBayDetails + Conditionally + + + + + + + + Indicates whether the shipping service is an international shipping service. + An international shipping service option is required if an item is being + shipped from one country (origin) to another (destination). + + + + Item.ShippingDetails.InternationalShippingServiceOption in AddItem + AddItem.html#Request.Item.ShippingDetails.InternationalShippingDiscountProfileID + + + GeteBayDetails + Conditionally + + + + + + + + The name of shipping service option. The ShippingServiceDetails.<strong>ValidForSellingFlow</strong> flag must also be present and <code>true</code>. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. + + + + GeteBayDetails + Conditionally + + + + + + + + Numeric identifier. A value greater than 50000 represents an + international shipping service (confirmed by + InternationalShippingService being true). Some applications use this ID + to look up shipping services more efficiently. + Also useful for applications that have migrated from the legacy XML API. + + + + GeteBayDetails + Conditionally + + + + + + + + The maximum guaranteed number of days the shipping carrier will + take to ship an item (not including the time it takes the + seller to deliver the item to the shipping carrier). Always + returned when ExpeditedService is true or if defined for a particular service. + See Enabling Get It Fast feature. + + + + GeteBayDetails + Conditionally + + + + + + + + The minimum guaranteed number of days the shipping carrier will + take to ship an item (not including the time it takes the + seller to deliver the item to the shipping carrier). Always + returned when ExpeditedService is true or if defined for a + particular service. + See Enabling Get It Fast feature. + + + + GeteBayDetails + Conditionally + + + + + + + + For future use. + + + + + + + The types of shipping that this shipping service supports. + + + + GeteBayDetails + Conditionally + Flat, Calculated + + + + + + + + The kinds of packages supported by this shipping service. + + + + GeteBayDetails + Conditionally + + + + + + + + This field is only returned if the shipping service option requires that package + dimensions are provided by the seller. If it is returned, it is always returned + as 'true'. + + + + GeteBayDetails + Conditionally + + + + + + + + If this field is returned as 'true', the shipping service option can be used in a + Add/Revise/Relist API call. If this field is returned as 'false', the shipping + service option is not currently supported and cannot be used in a + Add/Revise/Relist API call. + + + + GeteBayDetails + Conditionally + + + + + + + + True if a surcharge applies for any region that this service ships to. + + + + GeteBayDetails + Conditionally + + + + + + + + The codes for carriers supported by this shipping service. + <span class="tablenote"> + <strong>Note:</strong> Applications should not depend on the completeness of <strong>ShippingCarrierCodeType</strong>. Instead, applications should call GeteBayDetails, with a <strong>DetailName</strong> value of <code>ShippingCarrierDetails</code>, to return the complete list of shipping carriers. To check for the shipping carriers available for a specific site, specify the site ID in the header. + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + This flag is returned as 'true' if the corresponding + <b>ShippingServiceDetails.ShippingService</b> value is a COD (Cash-On-Delivery) + service. + <br/><br/> + COD shipping services are not supported by all sites. This field is only returned if + 'true'. + + + + GeteBayDetails + Conditionally + + + + + + + + A mechanism by which details about deprecation of a shipping service is + announced. See also MappedToShippingServiceID. + If this container is empty, it means that there is no mapping for this + shipping service and that the shipping service will be dropped from the + listing without an accompanying warning message from the eBay API. + + + + GeteBayDetails + Conditionally + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#DeprecatedShippingServices + + + + + + + + The ID of another shipping service that will be used when a + shipping service is deprecated. See also DeprecationDetails. + + + + GeteBayDetails + Conditionally + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#DeprecatedShippingServices + + + + + + + + If returned, this is the shipping service group to which the shipping service belongs. + Valid values are found in CostGroupFlatCodeType. + + + CostGroupFlatCodeType + + GeteBayDetails + Conditionally + + + + + + + + Shipping Package level details for the enclosing shipping service, this + complex type replaces the existing ShippingPackage type. + + + + GeteBayDetails + Conditionally + + + + + + + + If true, a seller who selects this package type for the listing and then offers + this shipping service must specify WeightMajor and WeightMinor in the item definition. + If not returned, WeightRequired is false. + + + false + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, see the <a href="http://pages.ebay.com/sellerinformation/shipping/chooseservice.html">Shipping Basics</a> page on the eBay Shipping Center site. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> This field is returned only for those sites that support shipping categories: US (0), CA (2), CAFR (210), UK (3), AU (15), FR (71), DE (77), IT (101) and ES (186). + </span> + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Container consisting of shipping costs and other details related to a domestic + shipping service. An exception to the domestic shipping service rule is seen in the + ShippingServiceSelected container returned under the Order and Transaction + containers in order and order line item retrieval calls such as GetOrders or + GetItemTransactions. In this scenario, the SelectedShippingService container + consists of either domestic or international shipping service data, based on the + selected service according to the buyer's shipping address. + <br/><br/> + If one or more international shipping services are provided, the + seller must specify at least one domestic shipping service as well. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For GetItemTransactions and GetSellerTransactions, this container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order's combined <strong>OrderID</strong> to retrieve this information. + </span> + + + + + + + The insurance cost associated with shipping a single item + with this shipping service. Exception: for GetItemShipping, + this is proportional to QuantitySold. If the item has not yet been + sold, insurance information cannot be calculated and the value is + 0.00. For calculated shipping only. + Also applicable to Half.com (for GetOrders). + + + + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + AddOrder + SendInvoice + No + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + + A shipping service option being offered by the seller to ship an item to a + buyer. For a list of valid ShippingService values, <b>GeteBayDetails</b> + with <b>DetailName</b> set to <b>ShippingServiceDetails</b>. The + ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, + that particular shipping service option is no longer valid and cannot be offered + to buyers through a listing. + <br><br> + To view the full list of domestic shipping service options in the response, look for the + ShippingServiceDetails.ShippingService fields. Domestic shipping service options will + not have a InternationalService=true field, as this indicates that the ShippingService + value is an International shipping service option. + <br><br> + For flat and calculated shipping. + Also applicable to Half.com (for GetOrders). + <br><br> + If there are two or more services and one is "pickup", "pickup" + must not be specified as the first service. + + + ShippingServiceCodeType + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellingManagerSaleRecord + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + ReviseSellingManagerSaleRecord + No + + + GeteBayDetails + + + + + + + + + The meaning of this element depends on the call and on whether flat or + calculated shipping has been selected. (For example, it could be the + cost to ship a single item, the cost to ship all items, or the cost to ship + just the first of many items, with ShippingServiceAdditionalCost accounting + for the rest.) When returned by <strong>GetItemShipping</strong>, it includes the packaging and + handling cost. For flat and calculated shipping. + <br> + <br> + If a shipping service has been specified (even LocalPickup), GetItem returns + the shipping service cost, even if the cost is zero. Otherwise, cost is not + returned. + <br> + <br> + If this is for calculated shipping for a listing that has not + yet ended, note that the cost cannot be determined until the listing + has ended and the buyer has specified a postal code. + <br> + <br> + For <strong>GetItemShipping</strong>, promotional shipping savings is reflected in the cost, if + applicable. If the promotional shipping option is lower than other shipping + services being offered, the savings is reflected in the returned shipping + cost. + The shipping service named Promotional Shipping Service (or whatever is + the localized name for it) is included among the shipping services. + If the promotional shipping cost is lower than the cost of other shipping + services being offered, it is presented first in the list. (The LOWEST shipping + service cost is always presented first, regardless of whether there is + promotional shipping.) + <br> + <br> + For <strong>GetMyeBaySelling</strong>, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). + <br> + <br> + Also applicable to Half.com (for GetOrders). + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + GetMyeBayBuying + GetSellingManagerSaleRecord + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BidList + WonList + WatchList + DeletedFromWonList + BestOfferList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + ReviseSellingManagerSaleRecord + No + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + + The cost of shipping each additional item beyond the first item. For input, + this is required if the listing is for multiple items. For single-item + listings, it should be zero (or is defaulted to zero if not provided). + For flat shipping only. + Not applicable to Half.com. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + Determining Shipping Costs for a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-DeterminingCosts.html + + + + + + + + This integer value controls the order (relative to other shipping services) in + which the corresponding ShippingService will appear in the View Item and + Checkout page. Sellers can specify up to four domestic shipping services (with + four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A + shipping service with a ShippingServicePriority value of 1 appears at the top. + Conversely, a shipping service with a ShippingServicePriority value of 4 appears + at the bottom of a list of four shipping service options. + <br><br> + This field is applicable to Flat and Calculated shipping. This field is not + applicable to Half.com listings. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The minimum guaranteed number of days in which the shipping carrier + can ship an item (not including the time it takes the seller to + deliver the item to the shipping carrier). See Enabling Get It Fast. + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The maximum guaranteed number of days the shipping carrier will + take to ship an item (not including the time it takes the seller to + deliver the item to the shipping carrier). See Enabling Get It Fast. + Not applicable to Half.com. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii + or Puerto Rico. Can only be assigned a value for the eBay US site and for + items in the Parts and Accessories category of the eBay Motors site. Only returned if set. + If some line items in an order have a surcharge, surcharge is added + only for those line items. + Flat rate shipping only. + + + + SendInvoice + No + + + AddFixedPriceItem + AddItem + AddItems + AddOrder + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + US, motors + Conditionally + + + GetBidderList + GetItemShipping + GetMyeBayBuying + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + BidList + Conditionally + + + GetMyeBaySelling + BidList + ScheduledList + Conditionally + + + + + + + + A seller offers free shipping by setting FreeShipping to true. This free + shipping applies only to the first specified domestic shipping service. (It is + ignored if set for any other shipping service.) If the seller has required + shipping insurance as part of shipping (the seller set InsuranceOption to + Required) and then the seller specified FreeShipping, eBay sets the insurance + cost to 0.00. However, if the seller made shipping insurance optional, eBay + preserves the cost of shipping insurance; it is up to the buyer whether to buy + shipping insurance, regardless of whether the seller specified FreeShipping. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemShipping +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + Conditionally + + + Specifying Shipping Services + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-Services.html#SpecifyingFreeShipping + + + + + + + + The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. + The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup. For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping. + + + + GetMyeBayBuying + GetMyeBaySelling + Conditionally + + + + + + + + The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. + + + 0 + + + GetItemShipping + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + Conditionally + + + + + + + + This container is returned in order management calls. + <br/><br/> + If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times. + <br/><br/> + For non-eBay Now orders, this container returns an estimated delivery window. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + The last time of day that an order using the specified shipping service will be accepted by the seller for the current listing. The cut off time applies and is returned only when the <strong>ShippingService</strong> field contains the name of a qualifying time-sensitive shipping service, such as <code>eBayNowImmediateDelivery</code>. + <br/><br/> + The cut off time is set by eBay and determined in part by the policies and locations of the seller and the shipping carrier. + + + + GetItemShipping + Conditionally + + + + + + + + Reserved for internal or future use. + + + + + Conditionally + + + + + + + + + + + + Packages supported by the enclosing shipping service. + + + + + + + The name of the package type. + + + + GeteBayDetails + Conditionally + + + + + + + + This field is only returned if package dimensions are required for the corresponding + package type (<b>ShippingServicePackageDetails.Name</b> value) supported + by the corresponding shipping service option + (<b>ShippingServiceDetails.ShippingService</b> value). + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + This enumerated type defines the possible values that can be used in the <b>ShippingServiceType</b> field of the <b>ShippingServiceCostOverride</b> container. + + + + + + + This value should be used if the seller is overriding shipping costs for all domestic shipping services defined in the Business Policies shipping profile. + + + + + + + This value should be used if the seller is overriding shipping costs for all international shipping services defined in the Business Policies shipping profile. + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + This enumerated type defines the possible pickup states for an eBay Now order. + + + + + + + This value indicates that the eBay Now order is ready for pickup by the eBay Now valet at the store. + + + + + + + This value indicates that the eBay Now order was picked up by the eBay Now valet. + + + + + + + This value is reserved for internal or future use. + + + + + + + + + + The shipping cost model offered by the seller. + + + + + + + Flat shipping model: the seller establishes the cost + of shipping and cost of shipping insurance, regardless of + what any buyer-selected shipping service might charge the + seller. + + + + + + + Calculated shipping model: the cost of shipping is + determined in large part by the seller-offered and + buyer-selected shipping service. The seller might assess an + additional fee via PackagingHandlingCosts. + + + + + + + Freight shipping model. Available only for US domestic shipping. The cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). + <br/><br/> + Currently, Freight can be specified only on input via eBay Web site, not via API. + + + + + + + Free shipping. + This field is output-only so if you want to use AddItem to specify a free + Shipping Cost, specify 0 in + Item.ShippingDetails.ShippingServiceOptions.ShippingServiceCost. + + + + + + + The seller did not specify the shipping type. + + + + + + + The seller specified one or more flat domestic shipping services + and one or more calculated international shipping services. + + + + + + + The seller specified one or more calculated domestic shipping services + and one or more flat international shipping services. + + + + + + + Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. + <br/><br/> + Currently, FreightFlat is available only for the US, UK, AU, CA and CAFR sites, and only for domestic shipping. On the US site, FreightFlat applies to shipping with carriers that are not affiliated with eBay. For details about freight shipping, see "Specifying Freight Shipping" in the Shipping chapter of the User's Guide. + + + + + + + Reserved for future use. + + + + + + + + + + This enumerated type defines the sort values that can be used in the + <b>FavoriteSearch.ItemSort</b> filter in a <b>GetMyeBayBuying</b> + request. + + + + + + + Sorts items by Best Match, and no sort order applies. If specified, + then Best Match sort also applies to CategoryHistogram. + + + + + + + This value is reserved for future or internal use. + + + + + + + Sorts by the end time of the listing, in ascending or descending order according to the + <b>SortOrder</b> value. + + + + + + + Sorts by number of bids on the item, in ascending or descending order according to the + <b>SortOrder</b> value. + + + + + + + Sorts by country; no sort order can be specified. + + + + + + + Sorts by current bid; descending order only. + + + + + + + Sorts by distance; ascending order only. + + + + + + + Sorts by the start time of the listing; recently-listed first. + + + + + + + Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category. + + + + + + + Sorts by total cost, which is item cost plus shipping cost. If + <b>SortOrder</b> is included and set to 'Ascending', items are sorted + in the following order: Lowest total cost (for items where shipping was + properly specified); then freight-shipping items (lowest to highest); and finally, + items for which shipping was not specified (lowest to highest). + + + + + + + + + + Type defining the <b>BuyerRequirementDetails</b> container, which is returned in + GeteBayDetails, and provides the seller with the buyer requirement features (and applicable + values) that are supported by the listing site. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This container is only returned if <b>BuyerRequirementDetails</b> is included as a <b>DetailName</b> + filter in the request, or if no <b>DetailName</b> filters are used in the request. + </span> <br/><br/> + + + + + + + Specifies that the site's buyer requirements support PayPal. + + + + GeteBayDetails + Conditionally + + + + + + + + Blocks bidders who have reached the maximum allowed buyer + policy violation stricks (in a specific time period) from bidding on this item. + + + + GeteBayDetails + Conditionally + + + + + + + + Limits unpaying or low feedback bidders, by setting the MaximumItemCount and + MinimumFeedbackScore to define when a bidder is blocked from bidding. + + + + GeteBayDetails + Conditionally + + + + + + + + Specifies a maximum number of unpaid items strikes that will result in blocking a bidder from + bidding on the item (within a specific time period). + + + + GeteBayDetails + Conditionally + + + + + + + + This container consists of the values that can be used in the + <b>BuyerRequirementDetails.MinimumFeedbackScore</b> field when listing + an item through an Add/Revise/Relist API call. The Feedback Score for a potential + buyer must be greater than or equal to the specified value, or that buyer is blocked + from buying the item. + <br/><br/> + For this container to appear in the response, + <b>BuyerRequirementDetails</b> must be one of the values passed into the + <b>DetailLevel</b> field in the request (or, no + <b>DetailLevel</b> filters should be used). + + + + GeteBayDetails + Conditionally + + + + + + + + Specifies that the site's buyer requirements support ShipToRegistrationCountry. + + + + GeteBayDetails + Conditionally + + + + + + + + Specifies the valid values for limiting unverified bidders. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT when the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + eBay sites (by the country in which each resides) on which a user is registered + and on which items can be listed. + + + China, eBayMotors, Sweden, Taiwan + + + + + + + USA, site ID 0, abbreviation US, currency USD. + <br/>(<a href="http://www.ebay.com" target="_blank">http://www.ebay.com</a>) + + + + + + + Canada, site ID 2, abbreviation CA, currencies CAD and USD. + <br/>(<a href="http://www.ebay.ca" target="_blank">http://www.ebay.ca</a>) + + + + + + + United Kingdom, site ID 3, abbreviation UK, currency GBP. + <br/>(<a href="http://www.ebay.co.uk" target="_blank">http://www.ebay.co.uk</a>) + + + + + + + Australia, site ID 15, abbreviation AU, currency AUD. + <br/>(<a href="http://www.ebay.com.au" target="_blank">http://www.ebay.com.au</a>) + + + + + + + Austria, site ID 16, abbreviation AT, currency EUR. + <br/>(<a href="http://www.ebay.at" target="_blank">http://www.ebay.at</a>) + + + + + + + Belgium (French), site ID 23, abbreviation BEFR, currency EUR. + <br/>(<a href="http://www.ebay.be" target="_blank">http://www.ebay.be</a>) + + + + + + + France, site ID 71, abbreviation FR, currency EUR. + <br/>(<a href="http://www.ebay.fr" target="_blank">http://www.ebay.fr</a>) + + + + + + + Germany, site ID 77, abbreviation DE, currency EUR. + <br/>(<a href="http://www.ebay.de" target="_blank">http://www.ebay.de</a>) + + + + + + + Italy, site ID 101, abbreviation IT, currency EUR. + <br/>(<a href="http://www.ebay.it" target="_blank">http://www.ebay.it</a>) + + + + + + + Belgium (Dutch), site ID 123, abbreviation BENL, currency EUR. + <br/>(<a href="http://www.ebay.be" target="_blank">http://www.ebay.be</a>) + + + + + + + Netherlands, site ID 146, abbreviation NL, currency EUR. + <br/>(<a href="http://www.ebay.nl" target="_blank">http://www.ebay.nl</a>) + + + + + + + Spain, site ID 186, abbreviation ES, currency EUR. + <br/>(<a href="http://www.ebay.es" target="_blank">http://www.ebay.es</a>) + + + + + + + Switzerland, site ID 193, abbreviation CH, currency CHF. + <br/>(<a href="http://www.ebay.ch" target="_blank">http://www.ebay.ch</a>) + + + + + + + Taiwan, currency TWD. Note that the old eBay Taiwan site is no longer in operation, and the new site does not use this API. + + + + + + + + + + + + + + Hong Kong, site ID 201, abbreviation HK, currency HKD. + <br/>(<a href="http://www.ebay.com.hk" target="_blank">http://www.ebay.com.hk</a>) + + + + + + + Singapore, site ID 216, abbreviation SG, currency SGD. + <br/>(<a href="http://www.ebay.com.sg" target="_blank">http://www.ebay.com.sg</a>) + + + + + + + India, site ID 203, abbreviation IN, currency INR. + <br/>(<a href="http://www.ebay.in" target="_blank">http://www.ebay.in</a>) + + + + + + + + + + + + + + Ireland, site ID 205, abbreviation IE, currency EUR. + <br/>(<a href="http://www.ebay.ie" target="_blank">http://www.ebay.ie</a>) + + + + + + + Malaysia, site ID 207, abbreviation MY, currency MYR. + <br/>(<a href="http://www.ebay.com.my" target="_blank">http://www.ebay.com.my</a>) + + + + + + + Philippines, site ID 211, abbreviation PH, currency PHP. + <br/>(<a href="http://www.ebay.ph" target="_blank">http://www.ebay.ph</a>) + + + + + + + Poland, site ID 212, abbreviation PL, currency PLN. + <br/>(<a href="http://www.ebay.pl" target="_blank">http://www.ebay.pl</a>) + + + + + + + + + + + + + + Reserved for internal or future use. + + + + + + + CanadaFrench, site ID 210, abbreviation CAFR, currencies CAD and USD. + + + + + + + Russia, site ID 215, abbreviation RU, currency RUB. Sellers must use Merchant Integration Platform (MIP) to create and revise listings on the Russia site. Russian listings cannot be created or revised through the Trading API's add and revise calls, so 'Russia' would not be a valid value to pass in through <b>Item.Site</b> field of an Add or Revise Trading API call. + + + + + + + + + + A container for feature definitions that apply to the entire site. + + + + + + + Specifies the ID of a set of default durations for a certain type of listing. + The actual duration values are returned within the FeatureDefinitions node. + The type of listing is named in the type attribute. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether sellers are + required to specify a domestic shipping service and its associated cost + when listing items. True means the shipping terms are required + unless a specific category overrides this setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + Best Offers. True means Best Offers are allowed site-wide, + unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field is no longer applicable as Dutch auctions are no longer available on + eBay sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether a bidder must consent to the + bid by confirming that he or she read and agrees to the terms in eBay's + privacy policy. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not it is possible to enhance a listing by putting + it into a rotation for display on a special area of the eBay home page. + Support for this feature varies by site. Item or feedback restrictions may apply. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + the ProPack feature (a feature pack). True means ProPack is allowed site-wide, + unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + categories allow the BasicUpgradePack feature (a feature pack). + No longer allowed on any sites. + Formerly, Australia site (site ID 15, abbreviation AU) only. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + categories allow the ValuePack feature (a feature pack). + True means it is allowed site-wide, unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + categories allow the ProPackPlus feature (a feature pack). + True means it is allowed site-wide, unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + Classified Ad format listings. True means the feature is allowed site-wide, + unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow counter offers + for Best Offers. True means counter offers are allowed site-wide, unless a + specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto decline for Best Offers. True means auto decline is allowed site-wide, + unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + LocalMarketSpecialitySubscription feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether LocalMarketRegularSubscription + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether LocalMarketPremiumSubscription + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether LocalMarketNonSubscription + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether most categories on the site are eligible for eBay Express. + eBay Express is a specialty site where customers can buy new, fixed-price + goods in a more conventional e-commerce experience.<br> + <br> + If true, items on the site are eligible for Express, but specific categories + can override the setting if they don't support Express. For example, + categories that are not covered by PayPal Buyer Protection (e.g., Live + Auctions and Motors vehicles) are excluded from Express.<br> + If false, items on the site are not eligible for Express, but some + categories may override the setting.<br> + <br> + If you list in an Express-enabled category, it does not necessarily mean + that the item will appear in that category when buyers browse and search + Express. It only means that the item can also be included on Express, + assuming all other Express eligibility requirements are met. See "eBay + Express" in the eBay Web Services guide for information about other + eligibility requirements. + + + + + + + + + + Specifies whether most categories on the site require a listing to include a + picture in order to qualify for eBay Express.<br> + <br> + If true, items on the site require a picture in order to qualify for + Express, but specific categories can override this requirement. For example, + on the US site, pictures are normally required for Express listings. + However, the Event Tickets category could override this requirement if + pictures are not commonly expected for tickets.<br> + If false, items on the site do not require a picture, + but some categories may override the setting.<br> + <br> + Only meaningful if ExpressEnabled is true for the category. + + + + + + + + + + Specifies whether most categories on the site require a listing to include + the Item Condition attribute in order to qualify for eBay Express.<br> + <br> + If true, items on the site require the Item Condition in order to qualify + for Express, but specific categories can override this requirement. For + example, on the US site, the Item Condition is normally required for Express + listings. However, the Event Tickets category could override this + requirement because there is little need to distinguish between new and used + tickets. (People rarely sell used tickets after an event unless the ticket + is also a collectible item.)<br> + If false, items on the site do not require the Item Condition, but some + categories may override the setting.<br> + <br> + Only meaningful if ExpressEnabled is true for the category. + + + + + + + + + + Specifies the default site setting for whether the Minimum Reserve Price + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories allow seller- + level contact information for Classified Ad listings. A value of true means + seller-level contact information is available for Classified Ad format + listings site-wide, unless a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether the Transaction Confirmation + Request feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow the Store + Inventory Format feature. True means the feature is allowed site-wide, unless + a specific category overrides the setting. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most + categories allow the addition of Skype buttons to listings. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most + categories allow the addition of Skype buttons to listings + for non-transactional formats (e.g., the advertisement format). + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the supported local listing distances of regular vehicles + for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the supported local listing distances of specialty vehicles + for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the supported local listing distances for most categories, + for users who have not subscribed to either Regular or Specialty vehicles. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user + for most categories. Even if enabled, checkout may or may not + be enabled. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings + in most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for + most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether automatic decline for Best Offers is allowed for most + categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a phone number in the + seller's contact information. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an email address in the + seller's contact information. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether categories on the site require a seller to offer a safe payment method, i.e. + PaisaPay/PayPal or one of the credit cards specified in Item.PaymentMethods). + If a seller has a 'SafePaymentExempt' status, they are exempt from the + category requirement to offer at least one safe payment method, even if the + site and category have the safe payment method turned on. If true, items on + the site need to have the safe payment method selected, but specific + categories can override the setting if they don't need this requirement. For + example, Business and Industrial, Motors, Real Estate, and Mature Audiences + categories, and all listings that don't support Item.PaymentMethods are + exempt from this requirement, which means that any seller can list without + any safe payment method selected. + <br> + If false, all sellers in all categories can list without any safe payment + method selected and this setting cannot be overridden at the category level. + If site is not enabled, there is no category where this requirement is + enabled on that site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether the pay-per-lead feature + is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies whether most categories support on the site support + custom Item Specifics. If enabled, sellers can use the + <b>Item.ItemSpecifics</b> node in Add/Revise/Relist calls to fill in + Item Specifics.<br> + <br> + Item Specifics are typical aspects of items in the same category. + They enable users to classify items by presenting descriptive details + in a structured way. For example, in a jewelry category, sellers might + describe lockets with specifics like "Chain Length=18 in." and + "Main Shape=Heart", but in a Washers & Dryers category, + sellers might include "Type=Top-Loading" instead of "Main Shape=Heart". + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the site is enabled for PaisaPayEscrow payment method. If + "true" sellers can offer PaisaPayEscrow and PaisaPayEscrow EMI payment methods + in the site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category is enabled for ISBN field for specific item. If + true, sellers can add ISBN for that item. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category is enabled for UPC field for specific item. If + true, sellers can add UPC for that item. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category is enabled for EAN field for specific item. If + true, sellers can add EAN for that item. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether the category is enabled for BrandMPN field for specific item. If + true, sellers can add BrandMPN for that item. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-accept for Best Offers for Classified Ads. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-accept for Best Offers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + you to specify that listings be displayed in the default search + results of the respective sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + you to specify that listings be displayed in the default search + results of the respective site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + you to specify that listings be displayed in the default search + results of the respective site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + For the Australia site, if both PayPalBuyerProtectionEnabled and + BuyerGuaranteeEnabled are returned, then the default site setting + is that categories allow buyer protection. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + For the Australia site, if both PayPalBuyerProtectionEnabled and + BuyerGuaranteeEnabled are returned, then the default site setting + is that categories allow buyer protection. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the workflow timeline that applies to the category on the India + site: Default Workflow, Workflow A or Workflow B. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting + that categories allow combined fixed price treatment of Basic Fixed Price items. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting + that enables durations for "Gallery Featured". + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + categories have PayPal as a required payment method for listings. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + Classified Ad listings. True means the feature is allowed site-wide, + unless a specific category overrides the setting. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a phone number in the + seller's contact information. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled to + contact the seller. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an address in the seller's + contact information. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled to + contact the seller. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a company name in the + seller's contact information. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an email address in the + seller's contact information. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings + in most categories. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-accept for Best Offers for Classified Ads. + This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-decline for Best Offers for Classified Ads. + This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user + for most categories. Even if enabled, checkout may or may not + be enabled. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for most categories. + This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for + most categories. This element is for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories allow seller- + level contact information for Classified Ad format listings. A value of true + means seller-level contact information is available for Classified Ad listings + site-wide, unless a specific category overrides the setting. This element is + for eBay Motors Pro users. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow Classified Ad + listings. True means the feature is allowed site-wide, unless a specific + category overrides the setting. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a phone number in the + seller's contact information. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled to + contact the seller. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an address in the seller's + contact information. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled to + contact the seller. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a company name in the + seller's contact information. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an email address in the + seller's contact information. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if Best Offer is enabled for Classified Ad listings + in most categories. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-accept for Best Offers for Classified Ads. + This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + auto-decline for Best Offers for Classified Ads. + This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if the payment method should be displayed to the user + for most categories. Even if enabled, checkout may or may not + be enabled. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates if shipping options are available for most categories. + This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether counter offers are allowed on Best Offers for + most categories. This element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories allow seller- + level contact information for Classified Ad format listings. A value of true + means seller-level contact information is available for Classified Ad format + listings site-wide, unless a specific category overrides the setting. This + element is for Local Market dealers. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which telephone option is enabled to + contact the seller. This element is for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including an address in the seller's + contact information. This element is for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which address option is enabled to + contact the seller. This element is for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates whether most categories support including a company name in the + seller's contact information. This element is for For Sale By Owner. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether + LocalMarketSpecialitySubscription feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether LocalMarketRegularSubscription + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether LocalMarketPremiumSubscription + feature is supported for most categories. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the supported local listing distances for most categories, + for users who have not subscribed to either Regular or Specialty vehicles. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Defines if PayPal is required for Store Owner. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings as well as Sif Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if quantity can be revised while a listing is in semi or fully restricted mode. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if price can be revised while a listing is in semi or fully restricted mode. + If the field is present, the corresponding feature applies to the category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Defines if extended business seller listing durations are enabled in a given category. + When the value of this element is true, it means the listing duration values + defined in StoreOwnerExtendedListingDurations are applicable to fixed price + listings in a given category. + The field is returned as an empty element (e.g., a boolean value is not returned). + Applies to Fixed Price Listings. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Provides additional listings durations that are supported by Store Owners. + The extended listing durations provided here in this element should be merged + in with the baseline listing durations provided in the ListingDurations element. + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether a return policy is + required for most categories.<br> + <br> + <b>For most sites:</b> If true, listings in most + categories require a return policy. <br> + <br> + <b>For eBay India (IN), Australia (AU), and + US eBay Motors Parts and Accessories:</b> + If true, most categories supports but do not require a + return policy.<br> + <br> + Individual categories can override the site default. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether a handling time (dispatch time) is + required for most categories.<br> + <br> + The handling time is the maximum number of business days the seller + commits to for preparing an item to be shipped after receiving a + cleared payment. The seller's handling time does not include the + shipping time (the carrier's transit time).<br> + <br> + If false, most listings on the site require a handling time + (see DispatchTimeMax in AddItem) when flat or calculated shipping + is specified. (A handling time is not required for local pickup + or for freight shipping.)<br> + <br> + For a list of the handling time values allowed for each site, use + DispatchTimeMaxDetails in GeteBayDetails.<br> + <br> + <span class="tablenote"><b>Note:</b> + Although the field name ends with "Enabled", a value of true means + that a handling time is NOT required, and value of false means + that a handling time IS required.</span> + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether a maximum flat rate shipping cost + is imposed for listings in most categories on the site. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost + + + + + + + + Specifies the default site setting for whether a maximum flat rate shipping cost + is imposed on sellers who list in categories on this site yet are shipping an + item into the country of this site from another country. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + Specifying Shipping Types and Costs + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Shipping-TypesCosts.html#MaximumFlatRateShippingCost + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group1 + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group2 + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Returns the applicable max cap per shipping cost for shipping service group3 + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the supported payment methods. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories support + multi-variation listings. If true, you can pass in Item.Variations + in the AddFixedPriceItem family of calls when you list in + categories that support this feature.<br> + <br> + Multi-variation listings contain items that are logically the same + product, but that vary in their manufacturing details or packaging. + For example, a particular brand and style of shirt could be + available in different sizes and colors, such as "large blue" and + "medium black" variations. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field is deprecated since "old" eBay attributes are no longer supported. + + + + + + + + + + + + + Specifies the default site setting for whether categories allow + free, automatic upgrades for Gallery Plus, which enhances pictures + in search results. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether categories allow + free, automatic upgrades for Picture Pack, a discount package + that includes super-sizing of pictures. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether listing items with parts + compatibility is supported by application (ByApplication), by specification + (BySpecification), or not at all (Disabled). A given category cannot support + both types of parts compatibility. + <br><br> + Parts compatibility listings contain information to determine the assemblies + with which a part is compatible. For example, an automotive part or accessory + listed with parts compatibility can be matched with vehicles (e.g., specific + years, makes, and models) with which the part or accessory can be used. + <br><br> + Parts Compatibility is supported in limited Parts & Accessories + categories for the US eBay Motors site (site ID 0) only. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + Listing Items with Parts Compatibility + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CompatibleParts.html + + + + + + + + Specifies the default site setting for whether parts compatibility + information is required when listing items, and if so, how many + compatibilities must be specified. If the value is "0," you are not required + to specify compatibility information. A value greater than "0" indicates that + listing with parts compatibility is mandatory and the listing must contain the + specified number of compatibilities at a minimum. + <br><br> + Parts compatibility listings contain information to determine the assemblies + with which a part is compatible. For example, an automotive part or accessory + listed with parts compatibility can be matched with vehicles (e.g., specific + years, makes, and models) with which the part or accessory can be used. + <br><br> + This field applies only to listings in which compatibility is specified by + application. Entering parts compatibility by application specifies the + assemblies (e.g., a specific year, make, and model of car) to which the item + applies. This can be done automatically by listing with a catalog product + that supports parts compatibility, or manually, using + <b class="con">Item.ItemCompatibilityList</b> when listing or + revising an item. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for the maximum number of compatible + applications allowed per item when adding or revising items with parts + compatibility. + <br><br> + Parts compatibility listings contain structured information to determine the + assemblies with which a part is compatible. For example, an automotive part + or accessory listed with parts compatibility can be matched with vehicles + (e.g., specific years, makes, and models) with which the part or accessory + can be used. + <br><br> + This field applies only to listings in which compatibility is specified by + application manually when listing or revising an item. Entering parts + compatibility by application manually specifies the assemblies (e.g., a + specific year, make, and model of car) to which the item applies, using <b + class="con">Item.ItemCompatibilityList</b>. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories + support (or require) Item.ConditionID in listings. + Use this to determine whether to use + ConditionID in AddItem and related calls. + See ConditionValues for a list of valid IDs.<br> + <br> + In general, this is set to Disabled, and meta-categories + (level 1 categories) define their own default settings. + + + Disabled + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The comprehensive list of item conditions on the site. That is, + this lists any value that could be supported by at least one + category on the site. + Individual meta-categories define their own default set of + condition values. (In other words, categories always override + this list with a customized subset of these values.) + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories + follow specific rules associated with "value categories".<br> + <br> + Some eBay sites may select a few categories and designate them as + "value categories". These are typically selected from + categories where buyers can find great deals. (Not all categories + with great deals are designated as value categories.) + This designation can change over time. <br> + <br> + While a category is designated as a value category + (i.e., when ValueCategory is true), + it is subject to the following rule: Items in value categories can only be listed in one category.<br> + <br> + For example, if you attempt to list in two categories and the + PrimaryCategory or SecondaryCategory is a value category, + then eBay drops the SecondaryCategory and lists the + item in the PrimaryCategory only. + Similarly, if you attempt to add a secondary category to an existing + listing, or you change the category for an existing listing, + and if the primary or secondary category is a value category, + then eBay drops the secondary category. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the default site setting for whether most categories + support (or require) product creation in listings. + Use this to determine whether it is mandatory to send + product id in AddItem and related calls. + In general, this is set to Disabled, and meta-categories + (level 1 categories) define their own default settings. + + + Disabled + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies the maximum fitment count. Sellers can provide up to 1000 fitments at the lowest level of granularity. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates the type of vehicle; car, truck, or motorcycle. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Indicates which payment options group a category supports in listings. + + + EbayPaymentProcessEnabled + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + Specifies what categories the Shipping profile is applicable to. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies what categories the Payment profile is applicable to. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + Specifies what categories the Return Policy profile is applicable to. + Only returned when this value (or this category's setting) + overrides the value inherited from the category's parent. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + After EOL Attributes, VIN will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports VIN. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, VRM will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports VRM. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Seller Provided Title will no longer be supported as primary attributes, + rather consumers should use new tag. This feature helps consumers in identifying + if category supports Seller Provided Title. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + After EOL Attributes, Deposit will no longer be supported as primary attributes, + rather consumers should use new tags. This feature helps consumers in identifying + if category supports Deposit. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + Indicates whether or not the specified category is enabled for Global Shipping Program. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This field will indicate whether or not most categories on the specified eBay site + support the Boats Parts Compatibility feature. The Boats Parts Compatibility + feature allows sellers to list their boats' parts and accessories items with + parts compatibility name-value pairs specific to boats, and allows potential + buyers to search for these items using parts compatibility search fields. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + This field will indicate whether or not most categories on the specified eBay site + support the "Click and Collect" feature. With the 'Click and Collect' feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. The "Click and Collect" feature is only available to large merchants on the UK and Australia sites. + + + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + Details about a specific site. + + + + + + + Short name that identifies an eBay site. Usually, an eBay site is associated + with a particular country or region (e.g., US or Belgium_French). Specialty + sites (e.g., eBay Stores) use the same site ID as their associated main eBay + site. The US eBay Motors site is an exception to this convention. + + + + Item.Site in AddItem + AddItem.html#Request.Item.Site + + + User.Site in GetUser + GetUser.html#Response.User.Site + + + GeteBayDetails + Conditionally + + + + + + + + Numeric identifier for an eBay site. If you are using the + SOAP API, you use numeric site IDs in the request URL. + If you are using the XML API, you use numeric site IDs in the + X-EBAY-API-SITEID header. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Type defining the <b>SiteHostedPictureDetails</b> container that is returned + in an <b>UploadSiteHostedPictures</b> call. + + + + + + + Corresponds to the PictureName input value that you specified in the request. + You can use the PictureName output field to confirm that the + UploadSiteHostedPictures response corresponds to a specific + UploadSiteHostedPictures request. + + + + UploadSiteHostedPictures + Conditionally + + + + + + + + The size of images generated. This value may differ from the one requested, + e.g. if a Supersize image cannot be generated. + + + + UploadSiteHostedPictures + Always + + + + + + + + The format into which an uploaded picture has been converted. + This value is usually JPG, but may be GIF. + + + + UploadSiteHostedPictures + Always + + + + + + + + The URL for the uploaded picture. + Store this value for association with an item listing. + That is, after you use UploadSiteHostedPictures to upload an image, + use the value in FullURL to associate the image with an item + (specify the value in Item.PictureDetails.PictureURL in + AddItem, ReviseItem, or RelistItem) prior to the UseByDate returned in the + response. + + + + UploadSiteHostedPictures + Always + + + + + + + + Truncated version of FullURL. + + + + UploadSiteHostedPictures + Always + + + + + + + + URL and size information for each generated and stored size. + This data is not necessarily needed by your application, + but is provided for use in picture previews. + This data is used for display control for specific pictures in the generated imageset. + This data is supplied for all generated pictures. + + + + UploadSiteHostedPictures + Always + + + + + + + + The URL of the external Web site hosting the uploaded photo. This field is returned if an <b>ExternalPictureURL</b> is provided in the call request. + <br> + <br> + + + 500 + 1 + + UploadSiteHostedPictures + Conditionally + + + + + + + + The UseByDate is the last date that the picture can be associated + with an item. + <br> + <br> + If the image is used in a listing, the image is kept for 90 days + plus the duration length of the listing (e.g. 90 + 7). If the image + is used in another listing while it is still being kept on the + server, the image will be kept until 90 days after the end of the + newest listing. + + + + UploadSiteHostedPictures + Always + + + + + + + + + + + + Site criteria for filtering search results. The site value is determined by the + site specified in the request (the site ID in the SOAP URL or, for Unified + Schema XML requests, the site ID in the X-EBAY-API-SITEID HTTP Header). + + + + + + + (in) Items listed in the currency implied by the site specified in the + request. + + + + + + + (in) Items located in the country implied by the site specified in the + request. + + + + + + + (in) Items available to the country implied by the site specified in the + request. For the US site, this implies listings from ALL English-language + countries that are available to the US. + + + + + + + (in) Items listed on the site specified in the request, regardless of listing + currency. + + + + + + + (in) Items located in Belgium or listed on one of the two Belgian sites. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Contains the data that defines a site-based filter (used when searching for + items and filtering the search result set). + + + + + + + Specifies the criteria for filtering search results by site, where site is + determined by the site ID in the SOAP URL or, for Unified Schema XML requests, + X-EBAY-API-SITEID HTTP Header. + + + + + + + + + + + + + + A list of one or more characteristics sets mapped to the category, + if any. Use this information when working with Item Specifics (Attributes) + and Pre-filled Item Information (Catalogs) functionality. + + + 773 + Avoid + GetCategoryFeatures + 889 + + + + + + + No longer applicable to any category. + + + + + + + + + + A category that does not support the specified site-wide characteristics set. + + + + + + + + + + + + + + Enumerated type defining the Skype contact options between seller and buyer. + + + + + + + The seller can communicate with the buyer by Skype Chat. + + + + + + + The seller can communicate with the buyer by Skype Voice. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Defines the feature of adding Skype buttons to listings for nontransactional formats (e.g., the advertisement format). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the feature of adding Skype buttons to listings for transactional formats (e.g., the Chinese auction format). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + This type specifies the sort order of a returned array of elements. The array or list to be sorted, the sort key, and the default sort order depend on the call. + + + + + + + The results will be sorted by the specified key in ascending (low to high) order. + + + + + + + The results will be sorted by the specified key in descending (high to low) order. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Indicates category support for listing of Local Market items by sellers + subscribed to Local Market for Specialty Vehicles. + Each of the subscriptions will have following options, which will define + "National" vs "Local" ad format listing. + "LocalOptional" : This will allow national and local listing. + "LocalOnly" : Seller can have Local listings only. + "NationalOnly" : Seller can not opt into local only exposure. It has to be + national listing. + + + + + + + + + + + This type is no longer used; replaced by <b>ShippingLocationDetails</b>. + + + + + + + + + (out) Indicates that the region of origin is active. + + + + + + + + + + + (out) Indicates that the region of origin is inactive. + + + + + + + + + + + Reserved for future use. + + + + + + + + + + + + + Specifies the type of action to carry out with SetStoreCategories. + + + + + + + (in) Add the listed categories to the store. + + + + + + + (in) Delete the listed categories from the store. + + + + + + + (in) Move the listed categories from one place in the store category + structure to another. + + + + + + + (in) Rename the listed store categories to the names provided. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Set of eBay Store color schemes. + + + + + + + A Store color scheme. + + + + GetStoreOptions + Always + + + + + + + + + + + Store color scheme. + + + + + + + Store color scheme ID. (use GetStoreOptions to get the list of + valid theme color scheme IDs). + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Store color scheme name. Provides a user-friendly name for the + color scheme. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Store color set. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Container consisting of the Store's font properties. This container is not returned if an eBay predefined store theme is + used 'as is'. Use the <b>GetStoreOptions</b> + call to retrieve the complete set of data for the list of predefined eBay Stores options, including the themes and color + schemes. + + + + SetStore + Conditionally + + GetStoreOptions + GetStoreOptions.html + + + + GetStore + Conditionally + + GetStoreOptions + GetStoreOptions.html + + + + GetStoreOptions + Always + + + + + + + + + + + + Store color set. + + + + + + + Primary color for the Store. Specified in 6-digit Hex format. + For example: F6F6C9 + + + 6 + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Secondary color for the Store. Specified in 6-digit Hex format. + For example: F6F6C9 + + + 6 + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Accent color for the Store. Specified in 6-digit Hex format. + For example: F6F6C9 + + + 6 + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + + + + + Set of custom categories for the Store. + + + + + + + A custom category for your eBay Store. + + + + GetStore + Always + + + SetStoreCategories + Yes + + + + + + + + + + + Configuration of a store custom category. + + + + + + + Custom category ID. For SetStoreCategories, required only if + Action is set to Rename, Move or Delete. + + + + GetStore + SetStoreCategories + Always + + + SetStoreCategories + Conditionally + + + + + + + + Name of the custom category. + + + + GetStore + SetStoreCategories + Always + + + SetStoreCategories + Conditionally + + + + + + + + Order in which the custom category appears in the list of store + categories. + + + + GetStore + SetStoreCategories + Always + + + SetStoreCategories + No + + + + + + + + Contains the properties of a custom subcategory for an eBay Store. eBay Stores support + three category levels. + + + 3 + + GetStore + SetStoreCategories + Always + + + SetStoreCategories + Conditionally + + + + + + + + + + + + Specifies whether the Store has a custom header. + + + + + + + Specifies that the Store does not have a custom header. + + + + + + + Specifies that the Store does have a custom header. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies how the custom listing header will be displayed. + + + + + + + No custom listing header is displayed. + + + + + + + The full custom listing header is displayed. + + + + + + + The full custom listing header and the left navigation bar is displayed. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Specifies the type of link in the custom listing header. + + + + + + + No type. + + + + + + + Link is to an About Me page. + + + + + + + Link is to a custom page. + + + + + + + Link is to a custom category. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Custom listing header link. + + + + + + + Link ID for the listing header link. The ID is used when the link + is a custom category or for a custom page, and it is not needed + when the LinkType property is "AboutMe" or "None". + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Order in which to show the custom listing header link. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Type of link to include in the custom listing header. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + + + + + Configuration of a Store custom listing header. + + + + + + + Display type for the custom listing header. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies whether the custom header has a logo. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies whether the custom header has a search box. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Link to include in the custom header. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies whether the custom header has a link to Add to + Favorite Stores. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies whether the custom header has a link to Sign up for Store + Newsletter. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + + + + + Set of Store custom pages. + + + + + + + A Store custom page. + + + + GetStoreCustomPage + Always + + + + + + + + + + + List of possible statuses for Store custom pages. + + + + + + + The page is visible. + + + + + + + The page is to be deleted. + + + + + + + The page is not visible. + + + + + + + Reserved for internal or future use. + + + + + + + + + + + Type defining <b>CustomPage</b> container, which is used by a seller in + <b>SetStoreCustomPage</b> to configure and create an eBay Store custom + page. The <b>CustomPage</b> container can also be used to modify an + existing custom page (by including a <b>PageID</b> value). The + <b>CustomPage</b> container is always returned in the + <b>GetStoreCustomPage</b> response. + + + + + + Name of the eBay Store custom page. This value is required if you are creating a new + page (and omitting a <b>PageID</b> value). Note that you must include a + name for the page even if you are using the <b>PreviewEnabled</b> flag. + However, since using the preview functionality means that the page will not be + persisted, you can enter a dummy value for this field if you have not decided on a + name for the page. The <b>Name</b> value is used in links to the page. + + + + GetStoreCustomPage + Always + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + Unique identifier for an eBay Store custom page. If you specify a valid + <b>PageID</b> value in a + <b>SetStoreCustomPage</b> call, the existing custom page + is updated. If you do not specify a <b>PageID</b> value, you are + creating a new custom page. + <br/><br/> + The <b>PageID</b> field is always returned in + <b>GetStoreCustomPage</b>. + + + + GetStoreCustomPage + Always + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + The URL path of the eBay Store custom page. This field is only required if you are + using Chinese characters in the <b>Name</b> field. The URL path of the + eBay Store custom page is normally derived from the <b>Name</b> field, but + the URL path cannot be derived from the name of the custom page if it contains Chinese + characters because URLs cannot contain Chinese characters. + <br/><br/> + The <b>URLPath</b> is only returned in the <b>GetStoreCustomPage</b> + response if it is defined for the eBay Store custom page, and if a <b>PageID</b> + value is included in the request. + + + + GetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + The full URL of the eBay Store custom page, which is generally derived from the + <b>CustomPage.Name</b> value. The exception to this rule is if the seller + specified a custom URL using the <b>CustomPage.URLPath</b> field in a + <b>SetStoreCustomPage</b> call. + <br/><br/> + The <b>URL</b> is only returned in the + <b>GetStoreCustomPage</b> response if a <b>PageID</b> value + is included in the request. + + + + GetStoreCustomPage + Conditionally + + + + + + + + This value indicates the status of the eBay custom page. In a + <b>SetStoreCustomPage</b> call, the seller uses the optional + <b>Status</b> field to make an inactive custom page active, to make an + active custom page inactive, or to delete an active or inactive custom page. To + change the status (including delete) of a custom page, a <b>PageID</b> + value must be included to identify the custom page to modify. + <br/><br/> + The <b>Status</b> value is always returned in the + <b>GetStoreCustomPage</b> response. + + + + GetStoreCustomPage + Active, Inactive + Always + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + The HTML content of the eBay Store custom page. This field has a maximum size of 96 + kilobytes. If the <b>PreviewEnabled</b> field is set to 'true', then + this field is required in a <b>SetStoreCustomPage</b> call. Otherwise, + it is optional. + <br/><br/> + The <b>Content</b> field is only returned in the + <b>GetStoreCustomPage</b> response if a <b>PageID</b> value + is included in the request. + + + + GetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + This flag controls whether or not the left navigation bar is included in the eBay + Store custom page. To include the left navigation bar in a custom page, the seller + will include the <b>LeftNav</b> field in the <b>SetStoreCustomPage</b> + request and set it to 'true'. + <br/><br/> + The <b>LeftNav</b> field is only returned in the + <b>GetStoreCustomPage</b> response if a <b>PageID</b> value + is included in the request. + + + + GetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + This flag controls whether or not a custom page preview is enabled. To enable the + a custom page preview, the seller will include the + <b>PreviewEnabled</b> field in the <b>SetStoreCustomPage</b> + request and set it to 'true'. + <br/><br/> + The <b>PreviewEnabled</b> field is only returned in the + <b>GetStoreCustomPage</b> response if a <b>PageID</b> value + is included in the request. + + + + SetStoreCustomPage + No + + + SetStoreCustomPage + Conditionally + + + + + + + + This integer value controls the order in which the corresponding eBay Store custom + page is displayed in the list of custom pages. To make the corresponding custom + page appear first in the list of custom pages, the seller would include the + <b>Order</b> field and set its value to '1'. + <br/><br/> + The <b>Order</b> value is always returned in the + <b>GetStoreCustomPage</b> response. + + + + GetStoreCustomPage + Always + + + SetStoreCustomPage + Conditionally + + + SetStoreCustomPage + Conditionally + + + + + + + + + + + + Font selection for Store configuration. + + + + + + + Arial font. + + + + + + + Courier font. + + + + + + + Times New Roman font. + + + + + + + Verdana font. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Font size selection for Store configuration. + + + + + + + Extra extra small. + + + + + + + Extra small. + + + + + + + Small. + + + + + + + Medium. + + + + + + + Large. + + + + + + + Extra large. + + + + + + + Extra extra large. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Store font set. + + + + + + + Font for the Store name. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font size for the Store name. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font color for the Store name. Specified in 6-digit Hex format. + For example: F6F6C9 + + + 6 + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font for the Store section title. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font size for the Store section title. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font color for the Store section title. Specified in 6-digit Hex + format. For example: F6F6C9 + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font for the Store description. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font size for the Store description. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Font color for the Store description. Specified in 6-digit Hex + format. For example: F6F6C9 + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + + + + + + + + + + + The full Store header is used. + + + + + + + A minimized Store header is used. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Defines the StoreInventoryEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (e.g., a boolean value is not returned).value different from site. + + + + + + + + + + Set of available layouts for items listed in an eBay Store. + + + + + + + Displays item list as a single column, with smaller item pictures. + + + + + + + Displays item list in two columns, with larger item pictures. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + List of available options for how items are sorted in an eBay Store. + + + + + + + Lists items with those ending soon listed first. + + + + + + + Lists items with those newly listed appearing in the list first. + + + + + + + Lists items by price in ascending order. The item with the lowest + starting price is listed first. + + + + + + + Lists items by price in descending order. The item with the highest + starting price is listed first. + + + + + + + Lists items by combined price and shipping cost in ascending order. The item + with the lowest combined starting price plus shipping cost is listed first. + + + + + + + Reserved for future use. + Lists items by combined price and shipping cost in descending order. The item + with the highest combined starting price plus shipping cost is listed first. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Set of Store logos. + + + + + + + A Store logo. + + + + GetStoreOptions + Always + + + + + + + + + + + Store logo. + + + + + + + Store logo ID (use GetStoreOptions to get the list of valid logo IDs). + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Store logo name. Provides a user-friendly name for the logo. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + URL of the logo. Must have a .gif or .jpg extention. Specified when + you are using a customized logo. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + If the field is present, the corresponding feature applies to the category. The + field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines the extended listing durations available to store owners. If the field is + present, the corresponding feature applies to the category. The field is returned as + an empty element (e.g., a boolean value is not returned). Applies to Fixed Price + Listings. + + + + + + + Specifies the length of time an auction can be open, in days. The allowed + durations vary according to the type of listing. The value GTC means Good Til + Canceled. + + + ListingDurationCodeType + + GetCategoryFeatures +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + + + + + Store Preferences type. + + + + + + + Store vacation hold preferences. + + + + GetStorePreferences + Conditionally + + + SetStorePreferences + No + + + + + + + + + + + Set of eBay Store subscription levels. + + + + + + + A Store subscription level. + + + + GetStoreOptions + Always + + + + + + + + + + + User's eBay Store subscription level. + + + + + + + This closes your eBay Store and cancels your eBay Store subscription. + All of your current Online Auction and Fixed Price items will remain active + until their ending date is reached or they are sold. All your Store pictures + hosted on eBay will be deleted unless you have a Picture Manager + subscription. + + + + + + + Basic level subscription. + + + + + + + Featured level subscription. + + + + + + + Anchor level subscription. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type used by the Subscription container that is returned in GetStoreOptions to indicate the subscription level and monthly fee associated with the eBay Store. + + + + + + + Store subscription level. + + + + GetStoreOptions + Anchor, Basic, Featured + Always + + + + + + + + Monthly fee for the Store subscription level. + + + + GetStoreOptions + Always + + + + + + + + + + + + Set of Store themes. + + + + + + + A Store theme. + + + + GetStoreOptions + Always + + + + + + + + Set of color schemes. This set is for use with those themes that do + not explicitly list a color scheme in the theme definition (these + themes are also known as advanced themes). + + + + GetStoreOptions + Always + AdvancedThemeArray + + + + + + + + + + + + Store theme. + + + + + + + Store theme ID (use GetStoreOptions to get the list of valid theme + IDs). + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Store theme name. Provides a user-friendly name for the theme. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + + + + + + + + Theme color scheme. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + GetStoreOptions + Always + BasicThemeArray + + + + + + + + + + + + The configuration of an eBay Store. + + + + + + + Name of the eBay Store. The name is shown + at the top of the Store page. + + + 35 + + SetStore + Conditionally + + + GetStore + Always + + + + + + + + The URL path of the Store (58 characters maximum). Only if you + are using Chinese characters in the Name property do you need to + use this field, such as if you are opening a Store on the Taiwan + site. The reason for this is that the URL path is normally derived + from the Store name, but it cannot be derived from the name of the + Store if it contains Chinese characters because URLs cannot + contain Chinese characters. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + The complete URL of the user's Store. This field is only ever + returned, and does not need to be explicitly set. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Subscription level (tier) for the user's eBay Store. + + + + SetStore + Conditionally + + + GetStore + Anchor, Basic, Featured + Always + + + + + + + + Store description (300 characters maximum). + + + + SetStore + Conditionally + + + GetStore + Always + + + + + + + + Store logo. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Store theme. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Style for the Store header. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Page to use as the Store's homepage (default is 0). To change the + homepage, specify the PageID of one of the Store's custom pages. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + The default layout type to use for the Store items. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + The default sort order to use for the items for sale in the Store. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Layout for the Store's custom header. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Custom header text for the Store. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies whether to export the Store listings to comparison + shopping websites. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Container consisting of an array of one or more <b>CustomCategory</b> + containers. Each <b>CustomCategory</b> container consists of details + related to an eBay Store custom category. + <br> + <br> + To modify an eBay Store's custom categories, an eBay Store owner would use the + <b>StoreCategories</b> container in the request of a + <b>SetStoreCategories</b> call. + + + + GetStore + Always + + + + + + + + Custom listing header for the Store. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Specifies the chosen customization display scheme for this store's Merch Widgets. + See MerchDisplayCodeType for specific values. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + Indicates the time the store was last opened or reopened. + + + + SetStore + Conditionally + + + GetStore + Conditionally + + + + + + + + A flag indicating if a Compatibility tab exists for the Store item listing. This + field is only applicable to Parts & Accessories listings in eBay US Motors. + The Compatibility tab will contain vehicles that are compatible with the part + in the listing. The seller specifies this information at listing time. + + + + SetStore + No + + + GetStore + Conditionally + + + + + + + + + + + + Specifies a set of Store vacation preferences. + + + + + + + Specifies whether the Store owner is on vacation. + + + + GetStorePreferences + Always + + + SetStorePreferences + No + + + + + + + + Seller return date from vacation. + + + + GetStorePreferences + Conditionally + + + SetStorePreferences + No + + + + + + + + Used for Store Inventory listings, which are no longer supported on any eBay site. + + + + GetStorePreferences + Always + + + SetStorePreferences + No + + + + + + + + Add a message when the Store owner is on vacation to all their active items. + + + + GetStorePreferences + Always + + + SetStorePreferences + No + + + + + + + + Add a message to all the Store pages when the Store owner is on vacation. + + + + GetStorePreferences + Always + + + SetStorePreferences + No + + + + + + + + Display custom message on the Store pages instead of the default message. + + + 10000 + + GetStorePreferences + Always + + + SetStorePreferences + No + + + + + + + + The custom message to display for the Store when the user is on vacation. + May contain HTML markup. + + + + GetStorePreferences + Conditionally + + + SetStorePreferences + No + + + + + + + + + + + This type defines the <b>Storefront</b> container, which can be used by eBay Stores sellers to list an item under two primary custom categories either by category ID or category name. A custom category is a category that was created by a seller in their eBay store. This container is used by Add/Revise/Relist calls. + <br/><br/> + The <b>Storefront</b> container is also returned in <b>GetItem</b> and other Trading calls that retrieve Item data. + <br/><br/> + <span class="tablenote"><b>Note: </b> + This type is applicable only for eBay Store sellers. + </span> <br/><br/> + + + + + + + Unique identifier of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories. + <br> <br> + To list an item using the categories in a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the 'Other' store category. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Unique identifier for the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories). + <br> <br> + The system resets the value to 0 (None) in the following cases: + <br> - The values of <b>StoreCategoryID</b> and <b>StoreCategory2ID</b> field are the same + <br> - You specify <b>StoreCategory2ID</b> but not <b>StoreCategoryID</b> + <br> <br> + <br>In other words, <b>StoreCategoryID</b> must be set to a valid custom category and be different from <b>StoreCategory2ID</b>. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Category name of a primary custom category in which to list the item. A custom category is a category that the seller created in their eBay Store. eBay Store sellers can create up to three levels of custom categories for their stores, but the API only supports root-level categories. + <br> <br> + To list an item using a category name from a seller's store, you must set this field to a root-level custom category or a custom category that has no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the store category called 'Other'. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + No + + + + + + + + Name of the secondary custom category in which to list the item. Set this field to a root-level custom category or a custom category that has no child categories (subcategories). + <br> <br> + The system resets the value to 0 (None) in the following cases: + <br> - The values of <b>StoreCategoryName</b> and <b>StoreCategory2Name</b> field are the same + <br> - You specify <b>StoreCategory2Name</b> but not <b>StoreCategoryName</b> + <br> <br> + <br>In other words <b>StoreCategoryName</b> must be set to a valid custom category name and be different from <b>StoreCategory2Name</b>. + + + + AddFixedPriceItem + AddItem + AddItems + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddItem + VerifyRelistItem + No + + + + + + + + The URL of the seller's eBay Stores page. + + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + The name of the seller's eBay Store. + + + 200 + + + + + + + + + + + (in) Indicates the type of string matching to use + when a value is submitted in CharityName. If no value is + specified, default behavior is "StartsWith." Does not + apply to Query. + + + + + + + (in) Reserved for internal or future use. + + + + + + + (in) Matches strings that begin with the submitted + value. For example, submitting a CharityName value + of "heart" matches "Heart of Gold," but not "Open + Hearts." Default behavior if no value is + specified. + + + + + + + (in) Matches strings that contain the submitted + value. For example, submitting a CharityName value + of "heart" matches both "Heart of Gold" and "Open + Hearts." + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains an array of categories that contain listings with + specified keywords in their titles or descriptions. The array + can contain up to 10 categories. + + + + + + + Describes a category that contains listings that match + specified keywords in the query. Returned if a category matches the query. + + + + GetSuggestedCategories + Conditionally + + + + + + + + + + + + Defines a suggested category, returned + in response to a search for categories that contain + listings with certain keywords in their titles and descriptions. + + + + + + + Describes a category that contains items that match the query. + + + + GetSuggestedCategories + Conditionally + + + + + + + + Percentage of the matching items that were found in this category, + relative to other categories in which matching items were also found. + Indicates the distribution of matching items across the suggested categories. + + + + GetSuggestedCategories + Conditionally + + + + + + + + + + + + Details about a summary event schedule. + + + + + + + The event type associated with this alert. + + + + SetNotificationPreferences + None + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + The period of time for which to create a summary. + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + How often the summary is to be delivered. + + + + SetNotificationPreferences + Conditionally + + + GetNotificationPreferences + Conditionally + + + + + + + + + + + + How often the summary is to be delivered. + + + + + + + Deliver every Sunday. + + + + + + + Deliver every Monday. + + + + + + + Deliver every Tuesday. + + + + + + + Deliver every Wednesday. + + + + + + + Deliver every Thursday. + + + + + + + Deliver every Friday. + + + + + + + Deliver every Saturday. + + + + + + + On day 1 of the month. + + + + + + + On day 2 of the month. + + + + + + + On day 3 of the month. + + + + + + + On day 4 of the month. + + + + + + + On day 5 of the month. + + + + + + + On day 6 of the month. + + + + + + + On day 7 of the month. + + + + + + + On day 8 of the month. + + + + + + + On day 9 of the month. + + + + + + + On day 10 of the month. + + + + + + + On day 11 of the month. + + + + + + + On day 12 of the month. + + + + + + + On day 13 of the month. + + + + + + + On day 14 of the month. + + + + + + + On day 15 of the month. + + + + + + + On day 16 of the month. + + + + + + + On day 17 of the month. + + + + + + + On day 18 of the month. + + + + + + + On day 19 of the month. + + + + + + + On day 20 of the month. + + + + + + + On day 21 of the month. + + + + + + + On day 22 of the month. + + + + + + + On day 23 of the month. + + + + + + + On day 24 of the month. + + + + + + + On day 25 of the month. + + + + + + + On day 26 of the month. + + + + + + + On day 27 of the month. + + + + + + + On day 28 of the month. + + + + + + + On day 29 of the month. + + + + + + + On day 30 of the month. + + + + + + + On day 31 of the month. + + + + + + + Every 31 days. + + + + + + + Every 60 days. + + + + + + + + + + + + + + + + The period of time for which to create a summary. + + + + + + + The last 24 hours. + + + + + + + The last 7 days. + + + + + + + The last 31 days. + + + + + + + The current week. + + + + + + + The prior week. + + + + + + + The current month. + + + + + + + The prior month. + + + + + + + The last 60 days. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type defining the <b>SupportedSellerProfile</b> container, which contains + summary information related to specific Business Policies payment, return policy, and shipping + profiles. The profile type is found in the <b>ProfileType</b> field. + + + + + + + Unique identifier of a Business Policies profile. This identifier is auto- + generated by eBay when the seller creates the profile. This field is always + returned with the <b>SupportedSellerProfile</b> container. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Indicates the type of the Business Policies profile. Valid values are PAYMENT, + RETURN_POLICY, and SHIPPING. This field is always returned with the + <b>SupportedSellerProfile</b> container. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + The seller-defined name for a Business Policies profile. This field is always + returned with the <b>SupportedSellerProfile</b> container. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Seller-provided description of a Business Policies profile. This field is only + returned if a seller has provided a description for the profile. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Identifies the the Business Policies category group associated with the Business + Policies profile. Current values are ALL (referring to all non-motor vehicle + categories) and MOTORS_VEHICLE (for motor vehicle listings). + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + Type defining the <b>SupportedSellerProfiles</b> container for all payment, + return, and shipping policy profiles that a seller has defined for a site. + + + + + + + Container consisting of information related to specific Business Policies payment, return, + and shipping policy profiles. The profile type is found in the + <b>ProfileType</b> field. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + Defines the Transaction Confirmation Request feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + + Status values for the processing progress for the category structure changes + specified by a SetStoreCategories request. If the SetStoreCategories call is + processed asynchronously, then the status is returned by + GetStoreCategoryUpdateStatus, otherwise, the status is returned in the + SetStoreCategories response. + + + + + + + (out) The category changes have not started. + + + + + + + (out) The category changes are in progress. + + + + + + + (out) The category changes completed successfully. + + + + + + + (out) The category changes failed. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type that defines the TaxDescription field. The TaxDescription field allows the + seller to provide a description of the sales tax type. + + + + + + + A standard sales tax charge. + + + + + + + A charge for an electronic waste recycling fee. + + + + + + + A charge for a tire recycling fee. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the TaxDetails container, which consists of detailed sales tax + information for an order line item, including the tax type and description, sales tax + on the item cost, and sales tax related to shipping and handling. The information in + this container supercedes/overrides the sales tax information in the + ShippingDetails.SalesTax container. + + + + + + + This field indicates the sales tax type. A separate TaxDetails container is + required for each unique imposition (tax type). + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This field indicates the description of the sales tax. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This value is the total amount of sales tax for the order line item for the + corresponding impositiion (tax type). + <br><br> + <b>TaxAmount</b> = <b>TaxOnSubtotalAmount</b> + <b>TaxOnShippingAmount</b> + <b>TaxOnHandlingAmount</b> + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This value is the amount of sales tax applied based on the unit cost of the + order line item for the corresponding impositiion (tax type). + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This value is the amount of sales tax applied based on shipping costs for the + order line item for the corresponding impositiion (tax type). + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This value is the amount of sales tax applied based on handling costs for the + order line item for the corresponding impositiion (tax type). + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the <b>Order.BuyerTaxIdentifier</b> container is returned, the type of tax ID can be found in the <b>BuyerTaxIdentifier.Type</b> field. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + This enumerated type contains the possible values that can be returned in the <b>name</b> attribute of the <b>BuyerTaxIdentifier.Attribute</b> field. Currently, this type only contains one enumeration value, but in the future, other attributes related to the tax ID may be created for this type. + + + + + + + This value indicates that the value returned in the <b>BuyerTaxIdentifier.Attribute</b> field is the country that issued the buyer tax ID. + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type is used to display the value of the <b>name</b> attribute of the <b>BuyerTaxIdentifier.Attribute</b> field. + + + + + + + + The only supported value for this attribute is 'IssuingCountry', but in the future, other attributes related to the tax ID may be supported. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + TaxIdentifierCodeType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type defines the <b>BuyerTaxIdentifier</b> container that is returned in order management calls. This container consists of taxpayer identification information for the buyer and it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of buyers registered on the Italy or Spain sites. + + + + + + + This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process. + + + + Date, Decimal, EAN, ISBN, Text, UPC + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + Date, Decimal, EAN, ISBN, Text, UPC + OrderReport + Conditionally + + + Date, Decimal, EAN, ISBN, Text, UPC + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + Date, Decimal, EAN, ISBN, Text, UPC + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This value is the actual tax ID for the buyer. The type of tax ID is shown in the <b>Type</b> field. + + + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an <a href="http://en.wikipedia.org/wiki/ISO_3166-1" target="_blank">ISO 3166-1 two-digit code</a> that represents the issuing country. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + Tax-related details for a region or jurisdiction. + + + + + + + Representative identifier for the jurisdiction. Typically an abbreviation + (for example, CA for California). + + + + SetTaxTable + Yes + + + GetBidderList + GeteBayDetails + Conditionally + + + GetTaxTable + GetSellerList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + The tax percent to apply for a listing shipped to this jurisdiction. The value + passed in is stored with a precision of 3 digits after the decimal point + (##.###). + <br> + For GetTaxTable: this tag has no value if the user's tax table has not been set. + + + + SetTaxTable + Yes + + + GetBidderList + Conditionally + + + GetSellerList + GetTaxTable +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Whether shipping costs are to be part of the base amount that is taxed. + <br> + For GetTaxTable: This tag is empty if the user did not previously provide + information. + + + + GetBidderList + Conditionally + + + GetSellerList + GetTaxTable +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SetTaxTable + Yes + + + + + + + + Full name for the jurisdiction or region for display purposes. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this feature. Use the version to determine + if and when to refresh your cached client data. + + + + GeteBayDetails + Conditionally + + + + + + + + The time in GMT when the details for this feature were last updated. Use this + timestamp to determine if and when to refresh your cached client data. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Sales tax details for zero or more jurisdictions (states, + provinces, etc). + + + + + + + Sales tax details for zero or more jurisdictions (states, + provinces, etc). + <br><br> + For GetTaxTable: If DetailLevel is not specified, information is returned only + for the jurisdictions for which the user provided tax information. If + DetailLevel is ReturnAll, tax information is returned for all possible + jurisdictions, whether specified by the user or not. ShippingIncludedInTax and + SalesTaxPercent are returned, but are empty. + + + + SetTaxTable + Yes + + + GetTaxTable +
DetailLevel: none, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + + + + Type that defines the Imposition field. The Imposition field allows the seller to + provide a description of the sales tax type. + + + + + + + A standard sales tax charge. + + + + + + + A charge for an electronic waste recycling fee. + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the Taxes container, which contains detailed sales tax information for an + order line item. The Taxes container is only returned if the seller is using the Vertex- + based Premium Sales Tax Engine solution. The information in this container + supercedes/overrides the sales tax information in the ShippingDetails.SalesTax container. + + + + + + + This value indicates the total tax amount for the order line item, including the + sales tax on the item, the sales tax on shipping and handling, and any electronic + waste recycling fee. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + Container consisting of detailed sales tax information for an order line item, + including the tax type and description, sales tax on the item cost, and sales tax + related to shipping and handling. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + SoldReport + Conditionally + + + + + + + + + + + + Data for one theme group. Returned for GetDescriptionTemplates + if theme groups are requested. + + + + + + + Unique identifier for this theme group. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + Name of this theme group (localized to the language associated + with the eBay site). + + + + GetDescriptionTemplates + Conditionally + + + + + + + + Unique identifier for each theme in this group. There + is at least one theme in a theme group. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + The number of ThemeID elements in this group. + + + + GetDescriptionTemplates + Conditionally + + + + + + + + + + + + Supported event ticket types. + + + + + + + (in) Any event (applicable to US, UK, and DE) + + + + + + + (in) Comedy & Kabarett (Comedy and Cabaret) + + + + + + + (in) Freizeit & Events (Leisure and Events) + + + + + + + (in) Konzerte & Festivals (Concerts and Festivals) + + + + + + + (in) Kultur & Klassik (Culture and Classical) + + + + + + + (in) Musicals & Shows + + + + + + + (in) Sportveranstaltungen (Sporting Events) + + + + + + + (in) Other events that are not the above Germany event types + (applicable to listings on the DE site) + + + + + + + (in) Amusement Parks (applicable to listings on the UK site) + + + + + + + (in) Comedy (applicable to listings on the UK site) + + + + + + + (in) Concerts/Gigs (applicable to listings on the UK site) + + + + + + + (in) Conferences/Seminars (applicable to listings on the UK site) + + + + + + + (in) Exhibitions/Shows (applicable to listings on the UK site) + + + + + + + (in) Experiences (applicable to listings on the UK site) + + + + + + + (in) Sporting events (applicable to listings on the UK site) + + + + + + + (in) Theatre/Cinema/Circus (applicable to listings on the UK site) + + + + + + + (in) Other. Events that are not the above UK types + (applicable to listings on the UK site) + + + + + + + (in) Concerts (applicable to listings on the US site) + + + + + + + (in) Movies (applicable to listings on the US site) + + + + + + + (in) Sporting events (applicable to listings on the US site) + + + + + + + (in) Theater (applicable to listings on the US site) + + + + + + + (in) Events that are not concerts, + movies, sporting events, or theater events + (applicable to listings on the US site) + + + + + + + Reserved for internal or future use. + + + + + + + + + + Type defining the <b>TicketListingDetails</b> container, which is used in + an Add/Revise/Relist call to provide more details about event tickets. + + + + + + + The name of the event, as shown on the ticket. Typically the + headliner. There is no maximum number of words or characters. + However, the words in the name must be an exact match (or a subset + consisting of complete words) to the words in the product title in + the catalog. The words in the name are matched using OR logic + (the order of the words does not matter). As with all strings, you + need to escape reserved characters such as ampersand. + See the eBay Trading API Guide for more information about how + to specify this value. + + + 1024 + + Ticket Listings + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Specialty-Tickets.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + The name of the venue, as shown on the ticket. + The validation rules are the same as the rules for the event name. + In addition, eBay supports both US English and UK English spelling + variations for typical words found on tickets (such as "theater" and + "theatre"). As with all strings, you need to escape reserved + characters such as ampersand. + + + 4000 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + The date of the event, as shown on the ticket. Use the date shown on + the ticket, without attempting to adjust it for a different time + zone (such as Pacific time or GMT).<br> + <br> + In most cases, you should be able to specify any numeric date format + in month/day/year order. eBay supports m or mm for the month, + d or dd for the day, and yy or yyyy for the year, in all + combinations. The delimiters must be forward slashes (/). + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + The time of the event, as shown on the ticket. Use the time value + shown on the ticket, without attempting to convert it to a different + time zone (such as Pacific time or GMT). Do not round the value up + or down (e.g., do not round 7:01 PM to 7:00 PM).<br> + <br> + In most cases, you should be able to specify the time format exactly + as shown on the ticket. For a list of formats that have been tested, + see the eBay Trading API Guide. + + + + Ticket Listings + http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Specialty-Tickets.html + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + + + + + + + + + + Specifies the Date range. + + + + + + + Specifies the earliest (oldest) date to be used in a date range. + + + + GetSellingManagerSoldListings + GetSellingManagerEmailLog + No + + + + + + + + Specifies the latest (most recent) date to be used in a date range. + + + + GetSellingManagerSoldListings + GetSellingManagerEmailLog + No + + + + + + + + + + + + Time zone details about a region or location to which the seller is willing to + ship. + + + + + + + A unique identifier for a given time zone. This ID does not change for a + given time zone, even if the time zone supports both standard and daylight + saving time variants. Valid values for TimeZoneID correspond to OLSON IDs. + These IDs provide not only the information as to the offset from GMT (UTC), + but also daylight saving time information. Thus, for example, America/Phoenix + is distinct from America/Denver because they have different daylight saving + time behavior. This value is not localized. + + + + Time Values + http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/DataTypes.html + + + Olson ID Comparison + http://en.wikipedia.org/wiki/Tz_database + + + GeteBayDetails + Conditionally + + + + + + + + Display name of a time zone in its standard (non-daylight saving) time + representation. This value is localized and returned in the language for the + site specified in the request (i.e., the numeric site ID that you specify in + the request URL for the SOAP API or the X-EBAY-API-SITEID header for the XML + API). + + + + GeteBayDetails + Conditionally + + + + + + + + The offset in hours from GMT for a time zone when it is not adjusted for + daylight saving time. + + + + GeteBayDetails + Conditionally + + + + + + + + Display name of a time zone in its daylight saving time representation. + This element is emitted for time zones that support daylight saving time + only. The value is localized and returned in the language for the site + specified in the request. + + + + GeteBayDetails + Conditionally + + + + + + + + The offset in hours from GMT for a time zone when it is on daylight saving + time. This element is emitted for time zones that support daylight + saving time only. + + + + GeteBayDetails + Conditionally + + + + + + + + Indicates whether or not the time zone is currently on daylight saving time. + A value of true indicates that the time zone is on daylights savings time. + This element is emitted for time zones that support daylight saving time only. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Indicates how the application wants eBay to handle the user's token after + the user signs in. + + + + + + + Return the token in the HTTP redirect to the application-specified + accept URL. + + + + + + + Leave the token at eBay so that the application can get + the token through the FetchToken API call (SecretId required). + + + + + + + Reserved for future use + + + + + + + + + + Contains the status of the token + + + + + + + Token is Active + + + + + + + Token is Expired + + + + + + + Token is revoked by eBay + + + + + + + Token is revoked by user + + + + + + + Token is revoked by Application + + + + + + + Token is Invalid + + + + + + + Reserved for internal or future use + + + + + + + + + + Returns token status. + + + + + + + Current token status. + + + + GetTokenStatus + Always + + + + + + + + Identifies the user to whom the token belongs. + + + + GetTokenStatus + Always + + + + + + + + Original expiration time for the token. + + + + GetTokenStatus + Always + + + + + + + + Token revocation time, if the token has been revoked. + + + + GetTokenStatus + Always + + + + + + + + + + + + Container for top-rated seller program codes. + + + + + + + Specifies the US Top-Rated Seller Program. + + + + + + + Specifies the UK Top-Rated Seller Program. + + + + + + + Specifies the German Top-Rated Seller Program. + + + + + + + Specifies the Global Top-Rated Seller Program. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for top-rated seller program information. + + + + + + + Top-rated seller program details for the seller. Returned when the seller is qualified as a top-rated seller. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + ComingSoon + + + + + + + + + + + + Enumerated type listing the possible roles an eBay user may have in regards to an + eBay order. + + + + + + + The eBay user is acting as the buyer for the order(s). In <b>GetOrders</b>, + this value should be passed into the <b>OrderRole</b> field in the + request to retrieve orders in which the calling eBay user is the buyer in the order. + + + + + + + The eBay user is acting as the seller for the order(s). In <b>GetOrders</b>, + this value should be passed into the <b>OrderRole</b> field in the + request to retrieve orders in which the calling eBay user is the seller in the order. + + + + + + + This value is reserved for future or internal use. + + + + + + + + + + Type defining the <b>TransactionArray</b> container, which contains an + array of <b>Transaction</b> containers. Each <b>Transaction</b> + container consists of detailed information on one order line item. + + + + + + + The <b>Transaction</b> container consists of detailed information on one + order line item. Also applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemsAwaitingFeedback + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying + DeletedFromWonList + WonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + AddOrder + Yes + + + Listing an Item + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedPayment + + + + + + + + + + + Cost of insuring the delivery of this order with the courier. + + + + + + + + + + Description of the fee type. + + + + FeeSettlementReport + Always + + + + + + + + List of transactions. + + + + FeeSettlementReport + Always + + + + + + + + + + + + Specifies the site on which the purchase was made. + + + + + + + The order line item was created + on the main eBay site. + + + + + + + The order line item was created on the eBay Express site. + + + + + + + The order line item was created on Half.com site. + + + + + + + The order line item was created on the Shopping.com site. + + + + + + + The order line item was created on the WorldOfGood site. + + + + + + + Reserved for future use. + + + + + + + + + + Enumerated type defining the possible values that can returned in the attribute of the <b>Payment.ReferenceID</b> and <b>Payment.PaymentReferenceID</b> field. + + + + + + + This value is the unique identifier of an external payment transaction. + + + + + + + This value is the unique identifier of an eBay Now payment transaction. + + + + + + + This value is reserved for future or internal use. + + + + + + + + + + Type defining the <strong>ReferenceID</strong> element, which is used to display the unique identifier of a payment (and payment type through the <strong>type</strong> attribute. + + + + + + + + This attribute indicates the type of payment. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains the order status, e.g. the buyer's online + payment and whether the checkout process for the order is complete. + + + + + + + Indicates the success or failure of the buyer's online payment + for an order. Applicable for the payment method that the buyer chose + for the order. + If the payment failed, the value returned indicates the reason for the failure. + Output only. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates the current status of the checkout flow for the order. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates date and time an order's status was last updated (in GMT). + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The payment method that the buyer selected to pay for the order. If checkout is + not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his + or her preference on the Review Your Purchase page. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether checkout is complete, incomplete, or pending for an order. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the buyer has selected shipping details + during checkout. False indicates that the shipping service was + selected by eBay for the buyer. For example, if the buyer has + not yet completed the Review Your Purchase page, he has not + picked a shipping service. If it is false, the application + should ignore ShippingServiceCost and ShippingServiceSelected + (items whose values are defaulted by eBay). + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This field indicates the type and/or status of a payment hold on the item. + + + + Holds on PayPal Payments + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sales-Completing.html + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + SoldReport + Always + + + + + + + + Indicates whether the item can be paid for through a payment gateway account. + If IntegratedMerchantCreditCardEnabled is true, then integrated merchant + credit card (IMCC) is enabled for credit cards because the seller + has a payment gateway (Payflow) account. + Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or + VisaMC is returned for an item, then on checkout, an online credit-card payment + is processed through a payment gateway account. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + This container is no longer used. + + + + + + + + + + This field gives the status of a buyer's request for shipment tracking information. This field is only returned if the buyer has requested shipment tracking information from the seller, or has escalated an existing request to an eBay Buyer Protection "Item Not Received" case. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return, or has escalated an existing return. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the <b>PaymentMethodUsed</b> field. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Contains information about a single order line item (transaction). An order + line item contains information about the sale of one or multiple + items from a single listing to a single buyer. The eBay system creates an order + line item when a buyer has committed to make a purchase in an + auction or fixed-price listing. A fixed-priced listing (with multiple identical + items or a similar item with variations) can spawn one or more order line items. Auction and single-item, fixed-price listings can only spawn + one order line item. + + + + + + + The total amount the buyer paid for the order line item. This + amount includes all costs such as shipping, handling, or sales tax. If the + seller allowed the buyer to change the total for an order, the buyer is + able to change the total up until the time when Checkout status is + Complete. Determine whether the buyer changed the amount by retrieving the + order line item data and comparing the <b>AmountPaid</b> value to + what the seller expected. If multiple order line items + between the same buyer and seller have been combined into a Combined + Invoice order, the <b>AmountPaid</b> value returned in <b>GetSellerTransactions</b> and + <b>GetItemTransactions</b> reflects the amount paid for the Combined Invoice order + and not the individual order line item. You can determine the + order line items that belong to the same Combined Invoice order by checking + to see if the <b>ContainingOrder.OrderID</b> value is the same. For Motors items, + <b>AmountPaid</b> is the amount paid by the buyer for the deposit.<br + /> + <br /> + Not applicable to Half.com. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Adjustment amount entered by the buyer. A positive amount indicates the + amount is an extra charge being paid to the seller by the buyer. A negative + value indicates this amount is a credit given to the buyer by the seller. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Converted value of <b>AdjustmentAmount</b> in the currency of the site that + returned the response. Refresh this value every 24 hours to pick up the + current conversion rates. + <br /> + <br /> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Container consisting of user and shipping details for the buyer. See + <b>UserType</b> for its child elements. Returned by <b>GetItemsAwaitingFeedback</b> if + Seller is making the request.<br> + <br> + Applicable to Half.com (for <b>GetOrders</b> only). + + + + GetItemsAwaitingFeedback + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Container consisting of shipping-related details for an order. Shipping + details include shipping rates, package dimensions, handling costs, + excluded shipping locations (if specified), shipping service options, + shipping insurance information, sales tax information (if applicable), and + shipment tracking details (if shipped). + <br><br> + For <b>GetSellerTransactions</b> and <b>GetItemTransactions</b>, the <b>ShippingDetails</b> + container is returned in the <b>Transaction</b> container. For <b>GetOrders</b> and + <b>GetOrderTransactions</b>, the <b>ShippingDetails</b> container is returned at the + Order level. + <br><br> + Applicable to Half.com (for <b>GetOrders</b> only). + + + + GetItemTransactions + GetSellerTransactions + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Shipping + + + + + + + + + Converted value of <b>AmountPaid</b> in the currency of the site that returned the + response. Refresh this value every 24 hours to pick up the current + conversion rates. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Converted value of <b>TransactionPrice</b> in the currency of the site that + returned the response. Refresh this value every 24 hours to pick up the + current conversion rates. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates the creation time of the order line item. For + auction listings, an order line item is created when that + listing ends with a high bidder whose bid meets or exceeds the Reserve + Price (if set). For a fixed-price listing or a Buy It Now auction listing, + an order line item is created once the buyer clicks the Buy + button. + <br><br> + Applicable to Half.com (for <b>GetOrders</b> only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates whether or not the seller requires a deposit for the + vehicle. This field is only applicable to US eBay Motors listings. + Otherwise, this field is returned as an empty value. + <br><br> + Not applicable to Half.com. + + + + Listing US and CA eBay Motors Items + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-eBayMotors.html#SpecifyingaVehicleDepositandDepositAmoun + + + GetItemTransactions + GetSellerTransactions + None, OtherMethod +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions + None, OtherMethod +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Container consisting of details about an item in a listing. The child + fields return are dependent on the call, the type of item or listing, and + the listing site. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback + GetMyeBaySelling + Conditionally + + + AddOrder + Yes + + + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + + + + + + This value indicates the number of identical items purchased at the same + time by the same buyer from one listing. For auction listings, this value + is always 1. For fixed-price, non-variation listings, this value can be + greater than 1. In either case, this field is tied to the same order line + item. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Container consisting of status details of an order line item, + including payment information. Several of these fields change values during + the checkout flow. See <b>TransactionStatusType</b> for its child elements. + <br><br> + For <b>GetOrders</b>, only the <b>IntegratedMerchantCreditCardEnabled</b>, + <b>PaymentHoldStatus</b>, and <b>PaymentMethodUsed</b> child elements are returned. The + fields indicating the status of the order are actually found in the + <b>OrderArray.Order.CheckoutStatus</b> container. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Unique identifier for an eBay order line item (transaction). An order line + item is created once there is a commitment from a buyer to + purchase an item. Since an auction listing can only have one order line + item during the duration of the listing, the <b>TransactionID</b> + for auction listings is always 0. Along with its corresponding <b>ItemID</b>, a + <b>TransactionID</b> is used and referenced during an order checkout flow and + after checkout has been completed. + <br><br> + Applicable to Half.com (for <b>GetOrders</b> only). + + + 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.) + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemsAwaitingFeedback + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + AddOrder + Yes + + + + + + + + The price of the order line item (transaction). This amount does not take + into account shipping, sales tax, and other costs related to the order line + item. If multiple units were purchased through a non- + variation, fixed-price listing, consider this value the per-unit price. In + this case, the <b>TransactionPrice</b> would be multiplied by the + <b>Transaction.QuantityPurchased</b> value. + <br><br> + For eBay Motors, <b>TransactionPrice</b> is the deposit amount. For Best Offers, + this is the seller-accepted per-item price. + <br><br> + Applicable to Half.com (for <b>GetOrders</b>). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether or not the order line item was created + as the result of the seller accepting a Best Offer from a buyer. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + VAT rate for the item. When the <b>VATPercent</b> is specified, the item's VAT + information appears on the item's listing page. In addition, the seller + can choose to print an invoice that includes the item's net price, VAT + percent, VAT amount, and total price. Since VAT rates vary depending on the + item and on the user's country of residence, a seller is responsible for + entering the correct VAT rate; it is not calculated by eBay. To specify a + <b>VATPercent</b>, a seller must have a VAT-ID registered with eBay and must be + listing the item on a VAT-enabled site. Max precision 3 decimal places. Max + length 5 characters. Note: The View Item page displays the precision to 2 + decimal places with no trailing zeros. However, the full value you send in is + stored. + <br><br> + Not applicable to Half.com. + + + + + + + Container consisting of details for a PayPal transaction that relates to + the eBay order. PayPal transactions may include a buyer payment or refund, + or a fee or credit applied to the seller's account. This field is only + returned if a PayPal transaction related to order has occurred. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + This container consists of Selling Manager product details and is only + returned if the item was listed through Selling Manager. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The shipping service selected by the buyer from the services + offered by the seller. + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions + GetOrders +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + Shipping + + + + + + + + + Display message from buyer. This field holds transient data that is only + being returned in Checkout related notifications. + <br><br> + Not applicable to Half.com. + + + + Working with Platform Notifications + http://developer.ebay.com/DevZone/guides/ebayfeatures/Notifications/Notifications.html + + + + + + + + + This field is deprecated at Dutch-style auctions are no longer supported on eBay. + + + + + + + Specifies the paid status of the order. + <br><br> + Not applicable to Half.com. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ WonList + DeletedFromWonList + Conditionally + + + + + + + + Specifies the paid status of the order. + <br><br> + Not applicable to Half.com. + + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates the time when the order was marked paid. This field is not + returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds. + <br><br> + This value will only be + visible to the user on either side of the order. An order can be marked as + paid in the following ways: + <ul> + <li>Automatically when a payment is made via PayPal </li> + <li>Seller marks the item as paid in My eBay or through Selling Manager Pro </li> + <li>Programmatically by the seller through the <b>ReviseCheckoutStatus</b> or <b>CompleteSale</b> calls.</li> + </ul> + <br><br> + Not applicable to Half.com. + + + + GetItemTransactions + GetSellerTransactions + GetOrders + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ WonList + DeletedFromWonList + Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates the time when the item(s) associated with the order were marked + as shipped. This value will only be visible to the user on either side of + the order. An order can be marked as shipped in My eBay or through Selling + Manager Pro, or programmatically by the seller through the <b>CompleteSale</b> + call. + <br><br> + Applicable to Half.com (for <b>GetOrders</b> only). + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ WonList + DeletedFromWonList + Conditionally + + + + + + + + This field indicates the total price for an order line item. + <br><br> + Not applicable to Half.com. + + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ WonList + DeletedFromWonList + Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ SoldList + Conditionally + + + + + + + + This container consists of Feedback left by the caller for their order + partner. This container is only returned if the order is complete and + feedback on the order line item has been left by the caller. + <br><br> + Not applicable to Half.com. + + + + + GetMyeBayBuying + DeletedFromWonList + WonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + DeletedFromSoldList + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This container consists of Feedback received by the caller from their + order partner. This container is only returned if the order is complete and + feedback on the order line item has been received by the + caller. + <br><br> + Not applicable to Half.com. + + + + + GetItemsAwaitingFeedback + Conditionally + + + GetMyeBayBuying + DeletedFromWonList + WonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + DeletedFromSoldList + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The Combined Invoice order to which the order line item + belongs. This container is only returned if <b>IncludeContainingOrder</b> is + included and set to true in a <b>GetItemTransactions</b> or <b>GetSellerTransactions</b> + request. + <br><br> + Not applicable to Half.com. + + + + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Listing-AnItem.html#CombinedInvoice + Combined Invoice + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A Final Value Fee is calculated and charged to a seller's account + immediately upon creation of an order line item. Note that this fee is created + before the buyer makes a payment.The Final Value Fee for each order line + item is returned by <b>GetSellerTransactions</b>, <b>GetItemTransactions</b>, <b>GetOrders</b>, + and <b>GetOrderTransactions</b>, regardless of the checkout status. + <br><br> + If a seller requests a Final Value Fee credit, the value of + <b>Transaction.FinalValueFee</b> will not change if a credit is + issued. The credit only appears in the seller's account data. + <br><br> + Not applicable to Half.com. + + + + GetOrderTransactions + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + ProStores listing level preferences regarding the store to which + checkout should be redirected for the listing if <b>Item.ThirdPartyCheckout</b> + is true. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Container consisting of one or more refund transactions to Half.com buyers or one or more refund transactions for orders subject to eBay's new payment process. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The site upon which the order line item (transaction) was created. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates from which site (eBay.com or Half.com) the order line item originated. If 'eBay' was set as the <b>Platform</b> value in the request, all retrieved order line items should have originated from eBay.com. If 'Half' was set as the <b>Platform</b> value in the request, all retrieved order line items should have originated from Half.com. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + CustomCode, eBay, Half + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + CustomCode, eBay, Half + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + CustomCode, eBay, Half + + + + + + + + Unique identifier for an instance of Shopping.com shopping cart. This field is only + returned for Shopping.com order line items (transactions). + + + 10 + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the buyer has opted to accept emails from all the selling + partners on Shopping.com. This field is only returned for order line items + purchased through the Shopping.com shopping cart. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The seller's Paypal email address. This value is only revealed if it is the + seller making the call. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Unique identifier for a PaisaPay transaction. Only applicable for the India + site (203) if PaisaPay was the payment method used. + + + + GetMyeBayBuying + GetMyeBaySelling + No + Conditionally + + + + + + + + For the Australia site, <b>BuyerGuaranteePrice</b> is the PayPal Buyer Protection coverage, + offered for the item at the time of purchase. Details of coverage are in the + following sections of the View Item page: the Buy Safely section and the Payment + Details section. + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + In a fixed-priced listing, a seller can offer variations of the same item. + For example, the seller could create a fixed-priced listing for a t-shirt + design and offer the shirt in different colors and sizes. In this case, each + color and size combination is a separate variation. Each variation can have + a different quantity and price. Due to the possible price differentiation, + buyers can buy multiple items from this listing at the same time, but all of + the items must be of the same variation. One order line item is created + whether one or multiple items of the same variation are purchased. + <br><br> + The <b>Variation</b> node contains information about which variation + was purchased. Therefore, applications that process orders + should always check to see if this node is present. + + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This field is returned if a buyer left a comment for the seller during the + left by buyer during the checkout flow. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + A container consisting of detailed sales tax information for an order line item. The <b>Taxes</b> container is only returned if the seller is using the Vertex-based Premium Sales Tax Engine solution. The information in this container supercedes/overrides the sales tax information in the <b>ShippingDetails.SalesTax</b> container. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Boolean value indicating whether or not an order line item is + part of a bundle purchase using Product Configurator. + + + + GetItemTransactions + GetOrderTransactions + GetSellerTransactions + + + GetOrders +
DetailLevel: none, ReturnAll
+ + + OrderReport + Conditionally + + + + + + + + The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. + <br><br> + The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + A unique identifier for an eBay order line item. This field is created as + soon as there is a commitment to buy from the seller, and its value is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. + + + 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Always + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Always + + + GetItemsAwaitingFeedback + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + GetOrderTransactions + Always + + + + + + + + + This container consists of information related to the payment hold on the order line item, including the reason why the buyer's payment for the order line item is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if PayPal has placed a payment hold on the order line item. + <br/><br/> + An American seller (selling on US or US Motors sites) and a Canadian seller (selling on CA and CA- FR sites) may be subject to PayPal payment holds (that last from three to 21 days) if that seller is new to selling on eBay or is classified as a "Below Standard" seller. For other reasons why a seller's funds may be held by PayPal, see the <b>PaymentHoldReason</b> field. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item. Note that shipping discounts have not yet been enabled for seller discount campaigns. Seller discount campaigns are created through the Order Size Discounts API. + + + + GetItemTransactions + GetOrders + GetOrderTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Amount of the refund issued to the buyer. This field is only returned for a DE/AT order subject to the new eBay payment process, and if a refund was issued to the buyer. + <br> <br> + <span class="tablenote"><b>Note:</b> The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.</span> + <br> + + + + GetMyeBaySelling + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + String value indicating the result of a refund (Success, Failure, Pending) to the buyer for an DE/AT order subject to the new eBay payment process. <br> <br> + <span class="tablenote"><b>Note:</b> The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.</span> + <br> + + + + GetMyeBaySelling + SoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field is returned if the <b>IncludeCodiceFiscale</b> flag is included in the request and set to 'true', and if the buyer has provided this value at checkout time. + <br/><br/> + This field is only applicable to Italian sellers. The Codice Fiscale number is unique for each Italian citizen and is used for tax purposes. + + + + GetSellerTransactions + Conditionally + + + + + + + + If <strong>IsMultilegShipping</strong> is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer. A GSP shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the item was listed, and the seller has specified 'InternationalPriorityShipping' as the default international shipping service in the listing. + <br/><br/> + If <strong>IsMultilegShipping</strong> is false, the order line item will not be shipped with the Global Shipping Program. + </span> + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetMyeBaySelling +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contains details about the domestic leg of a Global Shipping Program shipment. + <br/><br/> + This container is not returned if <strong>IsMultilegShipping</strong> is false. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This field indicates the date/time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer. + + + + GetOrderTransactions + GetOrders + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Container consisting of details related to the type and status of an Unpaid Item case. This container is only returned if there is an open or closed Unpaid Item case associated with the order line item. + + + + GetOrderTransactions + GetOrders + GetItemTransactions + GetSellerTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for PayPal's Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer. + + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contains information about how funds exchanged for an order line item are allocated to payees. + <br/><br/> + For example, for an order line item using eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> In an upcoming release, <strong>MonetaryDetails</strong> will replace the <strong>ExternalTransaction</strong> container, so you are encouraged to start using <strong>MonetaryDetails</strong> now. + </span> + + + + GetOrders +
DetailLevel:ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:ReturnAll
+ Conditionally + + + + + + + + Container consisting of an array of <strong>PickupOptions</strong> containers. Each <strong>PickupOptions</strong> container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. With this initial version of In-Store Pickup, the only pickup method is 'InStorePickup'. + <br/><br/> + For <strong>GetOrders</strong> and <strong>GetOrderTransactions</strong>, this container is always returned prior to order payment if the seller created/revised/relisted the item with the <strong>EligibleForPickupInStore</strong> flag in the call request set to 'true'. If and when the In-Store pickup method is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the <strong>PickupMethodSelected</strong> container. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. + </span> + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant). + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The dollar value in this field indicates the amount that the seller is being charged (at line item level) for the convenience of an eBay Now delivery. The standard minimum order amount for an eBay Now delivery is $25, with a "convenience fee" of $5. If the buyer meets the minimum order amount, this value will generally be '5.0'. However, it is also possible that the buyer's order only totals $15, so that buyer is required to pay a "convenience fee" of $10. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Indicates which type of <em>logistics plan</em> has been selected for the current order line item by the buyer. A logistics plan categorizes the means by which an order line item is transported from the seller to the buyer. It is characterized by the type of location where the buyer will take possession of the package, the type and number of carriers involved, and the timing of sending and delivery. A given logistics plan type helps to determine which shipping types, carriers and services the seller can use. + <br/><br/> + This field is returned only if it has a value. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> Currently, <strong>LogisticsPlanType</strong> has only one applicable value: <code>PickUpDropOff</code>, which is a service available for orders sent and delivered within the UK. When buyers select <code>PickUpDropOff</code>, the order is sent to a contracted third-party location, where it is held for pickup by the buyer. + </span> + + + LogisticsPlanCodeType + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + This container is returned in <b>GetOrders</b> (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the German site. + + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + The unique identifier of the inventory reservation. + + + + GetOrders +
DetailLevel:none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel:none,ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel:none,ReturnAll
+ Conditionally + + + + + + + + A unique identifier for an eBay order line item. <b>ExtendedOrderID</b> values will be used to identify order line items in the After Sale APIs that are scheduled to be released at the end of 2014. For Trading API Get calls, <b>OrderLineItemID</b> values should still be used. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + + + + + This type defines the Universal Product Code (UPC) feature, and whether this feature + is enabled at the site level. An empty UPCIdentifierEnabled field is returned under + the FeatureDefinitions container in GetCategoryFeatures if the feature is applicable + to the site and if UPCIdentifierEnabled is passed in as a FeatureID (or if no + FeatureID is passed in, hence all features are returned). + + + + + + + + + + + UPS Rate Options + + + + + + + UPS Daily Rates + + + + + + + UPS On-Demand Rates + + + + + + + Reserved for internal or future use + + + + + + + + + + Details about a specific eBay URL. + + + + + + + A compressed, representative title for the eBay URL. + + + + GeteBayDetails + Conditionally + + + + + + + + A commonly used eBay URL. Applications use some of these URLs (such as the View Item URL) + to launch eBay Web site pages in a browser.<br><br> + Logo URLs are required to be used in certain types of applications. + See your API license agreement. Also see this page for logo usage rules:<br> + http://developer.ebay.com/join/licenses/apilogousage + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + A compressed, representative title for the eBay URL. + + + + + + + URL Prefix for viewing a particular listing. Just add an item id. + + + + + + + URL Prefix for viewing the feedback for a particular userid. Just add a userid. + + + + + + + Full URL for an eBay login page. + + + + + + + Full URL for viewing the items on which the user is bidding. + + + + + + + Full URL for viewing the items on which the user bid but did not win. + + + + + + + Full URL for viewing the items on which the user bid and also won. + + + + + + + Full URL for viewing the items the user is currently watching. + + + + + + + Full URL for eBay Stores. + + + + + + + Full URL for the small version of the "An eBay Marketplace" logo. + + + + + + + Full URL for the medium version of the "An eBay Marketplace" logo. + + + + + + + Full URL for the large version of the "An eBay Marketplace" logo. + + + + + + + Reserved for future use. + + + + + + + + + + USPS Rate Options + + + + + + + USPS Discounted + + + + + + + USPS Retail + + + + + + + Reserved for internal or future use + + + + + + + + + + Units of measure that you can use to specify properties such as weight and size + dimensions. + + + + + + + + + + + Kilograms + + + + + + + Grams + + + + + + + Pounds + + + + + + + Ounces + + + + + + + Centimeters + + + + + + + Milimeters + + + + + + + Inches + + + + + + + Feet + + + + + + + Reserved for internal or future use. + + + + + + + + + + This type provides information about the weight, volume or other quantity measurement of a listed item. The European Union requires listings for certain types of products to include the price per unit so buyers can accurately compare prices. eBay uses the <strong>UnitType</strong> and <strong>UnitQuantity</strong> values and the item's listed price to calculate and display the per-unit price on eBay EU sites. + + + + + + + Designation of size, weight, volume or count to be used to specify the unit quantity of the item. This value can be one of the following: + <br/> + <pre> Kg 100g 10g L 100ml 10ml M M2 M3 Unit </pre> + <br/> + With GetItem, this field is returned only when you provide <strong>IncludeItemSpecifics</strong> in the request and set it to <code>true</code>. + + + + GetItem + GetItems + Conditionally + + + + + + + + Number of units of size, weight, volume or count of the specified unit type for the item. eBay divides the item price by this number to get the price per unit to be displayed in the item listing for comparison purposes. + <br/><br/> + With GetItem, this field is returned only when you provide <strong>IncludeItemSpecifics</strong> in the request and set it to <code>true</code>. + + + + GetItem + GetItems + Conditionally + + + + + + + + + + + + Type defining the <b>UnitOfMeasurementDetails</b> container, which consists + of suggested and alternative ways of referring to units of measurement. + + + + + + + Container consisting of suggested (<b>SuggestedText</b> values) and + alternative ways (<b>AlternateText</b> values) of referring to units of + measurement. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + + + + + Provides a mapping between suggested unit of measure strings and + other, less popular strings. + + + + + + + A synonym for the unit of measurement (such as a fully spelled out name + like "inches" instead of the standard abbreviation). + This can be used to help a seller map unit names they use in their + own catalog to unit names that are more popular on eBay. + + + + GeteBayDetails + Conditionally + + + + + + + + The preferred way to specify a given unit of measurement name, such as + "in." (instead of "inches" or the " (double quote) symbol). + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + This type defines the <b>UnpaidItemAssistancePreferences</b> container. This container is + used in <b>SetUserPreferences</b> to set the preferences related to the <b>Unpaid Item + Assistant</b> feature. The <b>UnpaidItemAssistancePreferences</b> container is also returned in + <b>GetUserPreferences</b> (if the <b>ShowUnpaidItemAssistancePreference</b> flag is included and + set to true in the request). + + + + + + + This value indicates the number of days that should elapse before the Unpaid + Item Assistant mechanism opens an Unpaid Item case on behalf of the seller. + Valid values for this field are: 2, 4, 8, 16, 24, and 32 (days). This field is + ignored if the <b>OptInStatus</b> flag is included and set to false + in the request, or if the seller is not currently opted into the Unpaid Item + Assistant feature in Unpaid Item Assistant Preferences on My eBay. + + + 2 + 32 + 32 + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Flag to indicate whether or not the Unpaid Item Assistant mechanism is turned on + for the seller. Through the Unpaid Item Assistant mechanism, eBay can + automatically file Unpaid Item cases on behalf of the seller. The Unpaid Item + Assistant feature also has options to automatically relist disputed items, to + automatically request a Giving Works donation refund (for Charity listings + only), or to create an 'Exclusion list' of buyers who are not subject to the + automatic filing of an Unpaid Item case. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Flag to indicate whether or not the seller wants eBay to automatically relist + items after corresponding Unpaid Item cases are opened and closed through the + Unpaid Item Assistant mechanism without payment. For a multi-quantity listing, + the quantity is adjusted if <b>AutoRelist</b> is set to true. + This field is ignored if the <b>OptInStatus</b> flag is included and + set to false in the request, or if the seller is not currently opted into the + Unpaid Item Assistant feature in Unpaid Item Assistant Preferences on My eBay. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + This field should be included and set to true if the seller wants to clear all + users from the Unpaid Item Assistant Exclusion list. The Exclusion list can be + viewed from the Unpaid Item Assistant Preferences in My eBay. Excluded users are + not subject to the automatic filing of Unpaid Item cases. The seller can still + open Unpaid Item cases against excluded users, but these cases must be opened + manually. + <br/><br/> + Users can be added to Exclusion list through the <b>ExcludedUser</b> + field. The <b>RemoveAllExcludedUsers</b> field is ignored if the + <b>OptInStatus</b> flag is included and set to false in the request, + or if the seller is not currently opted into the Unpaid Item Assistant feature + in Unpaid Item Assistant Preferences on My eBay. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + An eBay User ID for which the Unpaid Item Assistant mechanism is disabled. This + field is typically used by a seller who would prefer to file an Unpaid Item + dispute manually for the specified user. + <br/><br/> + One or more <b>ExcludedUser</b> fields are used in + <b>SetUserPreferences</b> to add users to Unpaid Item Assistant Exclusion + list. Any and all <b>ExcludedUser</b> fields are ignored if the + <b>OptInStatus</b> flag is included and set to false in the request, + or if the seller is not currently opted into the Unpaid Item Assistant feature + in Unpaid Item Assistant Preferences on My eBay. + <br/><br/> + In <b>GetUserPreferences</b>, one or more <b>ExcludedUser</b> fields + represent the current Excluded user list. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + Flag to indicate whether or not the seller wants eBay to automatically request + eBay Giving Works donation refunds after Unpaid Item cases are opened and closed + through the Unpaid Item Assistant mechanism without payment. This setting is + only applicable to eBay Charity listings. This field is ignored if the + <b>OptInStatus</b> flag is included and set to false in the request, or if + the seller is not currently opted into the Unpaid Item Assistant feature in + Unpaid Item Assistant Preferences on My eBay. + + + + GetUserPreferences + Conditionally + + + SetUserPreferences + No + + + + + + + + + + + + Enumeration type that indicates the method used to open an Unpaid Item case. + + + + + + + This value indicates that the Unpaid Item case was opened automatically + through eBay's Unpaid Item Assistant feature. + + + + + + + + This value indicates that the seller opened an Unpaid Item case manually + through the Resolution Center or by using the Trading API's + <strong>AddDispute</strong> call. + + + + + + + + This value is reserved for future or internal use. + + + + + + + + + + + Enumeration type that indicates the current status of an Unpaid Item case. + + + + + + + This value indicates that the Unpaid Item case is open. + + + + + + + + This value indicates that the Unpaid Item case is closed with payment + received from the buyer. + + + + + + + + This value indicates that the Unpaid Item case is closed with no payment + received from the buyer. + + + + + + + + + This value is reserved for future or internal use. + + + + + + + + + + + Unpaid item status. + + + + + + + Final value fee denied. + + + + + + + Final value fee credited. + + + + + + + Eligible for final value fee. + + + + + + + Awaiting seller response. + + + + + + + Awaiting buyer response. + + + + + + + Unpaid item filed. + + + + + + + Eligible for unpaid item. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Type defining the <strong>UnpaidItem</strong> container, which consists of + details related to the type and status of an Unpaid Item case. + + + + + + + This field indicates the status of the Unpaid Item case. This field is always + returned with the <strong>UnpaidItem</strong> container. + + + + GetOrderTransactions + GetOrders + GetItemTransactions + GetSellerTransactions + SoldReport +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + This field indicates if the Unpaid Item case was opened manually by the customer or + opened automatically by eBay's Unpaid Item Assistant feature. This field is always + returned with the <strong>UnpaidItem</strong> container. + + + + GetOrderTransactions + GetOrders + GetItemTransactions + GetSellerTransactions + SoldReport +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + http://pages.ebay.com/help/sell/unpaid-item-assistant.html + Using Unpaid Item Assistant + more information about managing the Unpaid Item Assistant feature + + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + This type is no longer used. + + + + + + + + + + + Contains the items, searches and sellers that the user has saved to this + list using the "Add to list" feature. The name of the list is given by the + "Name" element. + + + + + + + The user's chosen name for this list. + + + + GetMyeBayBuying + Conditionally + + + + + + + + The value in this field indicates the total number of items in the + user-defined list. The number of <b>Item</b> nodes in the + <b>ItemArray</b> should match this value. + + + + GetMyeBayBuying + Conditionally + + + + + + + + This field is not supported. + + + + + + + + The value in this field indicates the total number of favorite sellers in the + user-defined list. The number of <b>FavoriteSeller</b> nodes returned + in the response should match this value. + + + + GetMyeBayBuying + Conditionally + + + + + + + + An array of Items that the user has added to the user-defined list. + + + + GetMyeBayBuying + Conditionally + + + + + + + + An array of Favorite Searches that the user has added to the user-defined list. + + + + GetMyeBayBuying + Conditionally + + + + + + + + An array of Favorite Sellers that the user has added to the user-defined list. + + + + GetMyeBayBuying + Conditionally + + + + + + + + + + + + Contains an array of eBay UserID entries. + + + + + + + Unique eBay user ID for the user. + Applies to eBay Motors Pro applications only. + + + + GetSellerList + No + + + + + + + + + + + + This is a string wrapper for the eBay ID that uniquely identifies a user. This is used by + several other types to identify a specific eBay user, such as DisputeType.xsd, FeedbackInfoType.xsd, + GetAllBidders, OrderType, and so on. + <br><br>For GetAllBidders, + some bidder information is anonymous, to protect bidders from fraud. If the seller makes + this API call, the actual IDs of all bidders on the seller's item will be returned. + If a bidder makes this API call, the bidder's actual ID will be returned, but information + for all competing bidders or outside watchers will be returned as anonymized userIDs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Based on the context of the field, this type defines the user is sending or receiving a payment. + + + + + + + + This attribute indicates if the payer or payee is an eBay user or an eBay partner. + + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + These codes indicate the current state or status of an eBay + user account. + + + UnconfirmedPassport, CreditCardVerifyPassport, UnconfirmedExpress + + + + + + + User properties have never been set; this value should + seldom, if ever, be returned and typically represents a + problem + + + + + + + User has been suspended from selling and buying, such as + for violations of eBay terms or agreement + + + + + + + User has completed online registration and has properly + responded to confirmation email; most users should fall + in this category + + + + + + + User has completed online registration, but has either + not responded to confirmation email or has not yet been + sent the confirmation email. Or, if this user began registration + as a seller but did not complete it, the user will have this status. A seller with + this status can begin to list an item but cannot complete the listing until the seller + completes seller registration. (For information on what is needed to complete seller + registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) + + + + + + + Registered users of AuctionWeb (pre-eBay) who never + re-registered on eBay + + + + + + + Temporary user record state indicating the record is in + the process of being changed by eBay; query user + information again to get new status + + + + + + + Records for the specified user have been deleted + + + + + + + User has completed registration and confirmation, but needs to complete + verification of credit card information. A user has this status if this user began registration + as a seller but did not complete it. A seller with + this status can begin to list an item but cannot complete the listing until the seller + completes seller registration. (For information on what is needed to complete seller + registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) + + + + + + + User's account is on hold, such as for non-payment of + amounts due eBay; user cannot sell or buy items + + + + + + + User record has been merged with another account record + for the same user + + + + + + + User has completed online registration and has been sent + the confirmation email, but has not yet responded to the + confirmation email + + + + + + + User has been scheduled for account closure (typically + when a user has requested to have their account closed) + A user in this state should not be considered an active + user + + + + + + + User has completed the registration for Half.com and opted + to automatically also be registered with eBay, but the + registration confirmation is still pending + + + + + + + User has completed the registration for Half.com and opted + to automatically also be registered with eBay, but the + user needs to complete verification of credit card information. + A user has this status on eBay if this user began registration + as a seller but did not complete it. A seller with + this status can begin to list an item but cannot complete the listing until the seller + completes seller registration. (For information on what is needed to complete seller + registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + The user is a guest user. The user has not added a password and has not confirmed an email address. + The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. + The user has been through the buying flow for a guest; + the user has been through checkout using the streamlined Buy-It-Now flow. + + + + + + + Reserved for internal or future use + + + + + + + + + + Type to contain the data for one eBay user. Depending on the context, the user + might be the seller or the buyer on either side of an order, or the bidder or winning bidder + in a listing. An object of this type is returned by a number of calls, including + the GetUser call. + + + + + + + If true, indicates that the user has set up an About Me page. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + + + + + + Unique identifier for the user that does not change when the eBay user name + is changed. Use when an application needs to associate a new eBay user name + with the corresponding eBay user. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetSellingManagerTemplates +
DetailLevel: ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetHighBidders + Always + + + + + + + + Email address for the user. + Please see the links below to the topics related to anonymous user information + and static email addresses. + You cannot retrieve an email address for any user + with whom you do not have an order relationship, regardless of site. + An email address of another user is only returned + if you and the other user are in an order relationship, + within a certain time of order line item creation + (although this limitation isn't applicable to the GetAllBidders call + in the case of motor vehicles categories.) + Based on Trust and Safety policies, the time is + unspecified and can vary by site. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that + bidder, and to the seller of an item that the user is bidding on. + <br><br> + For the order retrieval calls, the buyer's registration email address is only + returned if the buyer is registered on the DE, AT, or CH sites, regardless of + the seller's registration site and the site to which the seller sends the + request. + + + + 64 for US. May differ for other countries. Note: The eBay database + allocates up to 128 characters for this field + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + Static Email Addresses in Trading API Calls + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-Communications.html + + + GetAllBidders + GetBidderList + GetHighBidders + Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetMyeBayBuying + WonList + DeletedFromWonList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetSellerList + Seller +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The aggregate feedback score for a user. A user's feedback score is the net + positive feedback minus the net negative feedback left for the user. + Feedback scores are a quantitative expression of the desirability of dealing + with a user as a buyer or a seller in either side of an order. Each order line item can + result in one feedback entry for a given user (the buyer can leave feedback + for the seller, and the seller can leave feedback for the buyer.). That one + feedback can be positive, negative, or neutral. The aggregated feedback + counts for a particular user represent that user's overall feedback score + (referred to as a "feedback rating" on the eBay site). If the user has + chosen to make their feedback private and that user is not the user + identified in the request's authentication token, FeedbackScore is not + returned and FeedbackPrivate is returned with a value of true.<br> + <br> + In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore + and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For + GetMyeBayBuying, the feedback score of each seller with an item having + received a bid from the buyer is returned. For GetMyeBaySelling, the + feedback score of the seller is returned. <br> + <br> + GetMyeBayBuying and GetMyeBaySelling also return feedback information + (FeedbackScore and FeedbackRatingStar) in + BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns + feedback information on the high bidder of each item the buyer is bidding + on. GetMyeBaySelling returns feedback information on the high bidder of each + item the seller is selling.<br> + <br> + Since a bidder's user info is anonymous, the real feedback score will + be returned only to that bidder, and to the seller of an item that the + user is bidding on. For all other users, the value -99 is returned. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetHighBidders + Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetBidderList + Always + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + GetMyeBayBuying + GetMyeBaySelling + BidList + WatchList + BestOfferList + LostList + DeletedFromLostList + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Total count of negative Feedback entries received by the user, including weekly repeats. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Total count of positive Feedback entries received by the user, including + weekly repeats. Contains the aggregate feedback score for a user. A member's + feedback score is the net positive feedback minus the net negative feedback + left for the member. Feedback scores are a quantitative expression of the + desirability of dealing with that person as a Buyer or a Seller on either side of an order. Each order line item can result in one feedback entry for + a given user (the buyer can leave feedback for the seller, and the seller + can leave feedback for the buyer.). That one feedback can be positive, + negative, or neutral. The aggregated feedback counts for a particular user + represent that user's overall feedback score (referred to as a "feedback + rating" on the eBay site). This rating is commonly expressed as the eBay + Feedback score for the user. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Percent of total feedback that is positive. For example, if the member has + 50 feedbacks, where 49 are positive and 1 is neutral or negative, the + positive feedback percent could be 98.0. The value uses a max precision of 4 + and a scale of 1. If the user has feedback, this value can be returned + regardless of whether the member has chosen to make their feedback private. + Not returned if the user has no feedback. + + + + GetAllBidders +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the user has chosen to make their feedback score and + feedback details private (hidden from other users). Note that the percentage + of positive feedback can still be returned, even if other feedback details + are private. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to + that bidder, and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for + specific values. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetMyeBayBuying + GetMyeBaySelling + BidList + WatchList + BestOfferList + LostList + DeletedFromLostList + ActiveList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Indicates whether the user has been verified. For more information + about the ID Verify program, see: + http://pages.ebay.com/help/policies/identity-idverify.html + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + If true, indicates that the user is in good standing with eBay. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + If true, identifies a new user who has been a registered eBay user for 30 days + or less. Always false after the user has been registered for more than 30 + days. Does not indicate an ID change (see UserIdChanged). + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + This container consists of the Registration address for the eBay user making the call.<br> + <br> + <b>GetUser:</b> eBay returns complete + <b>RegistrationAddress</b> details (including Phone), as applicable to the + registration site for the eBay user making the call. The <b>RegistrationAddress</b> container will only be returned if the Detail <br> + <br> + <b>GetItem and GetSellerTransactions:</b> RegistrationAddress for another user + (except for Phone) is only returned if you have an order relationship + with that user AND that user is registered on DE/AT/CH, regardless of your + registration site and the site to which you send the request. For example, + the seller can see the buyer's registration address if the buyer is + registered on DE/AT/CH, or the buyer can see the seller's registration + address if the seller is registered on DE/AT/CH. (The buyer and seller won't + see their own registration addresses in GetItem.) + + + + GetUser +
DetailLevel: ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + Seller + HighBidder +
DetailLevel: ReturnAll
+ + + GetSellerTransactions +
DetailLevel: ReturnAll, none
+ Conditionally + + + + + + + + Indicates the date the specified user originally registered with eBay. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that bidder, + and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Always + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + eBay site the user is registered with. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to + that bidder, and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Indicates the user's registration/user status. + + + + GetAllBidders + GetBidderList + GetHighBidders + UnconfirmedPassport, + CreditCardVerifyPassport + Always + + + GetUser + UnconfirmedPassport, + CreditCardVerifyPassport +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Seller + UnconfirmedPassport, + CreditCardVerifyPassport +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Always + + + GetItem + GetSellingManagerTemplates + HighBidder + UnconfirmedPassport, + CreditCardVerifyPassport +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetOrderTransactions + UnconfirmedPassport, + CreditCardVerifyPassport +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + UnconfirmedPassport, + CreditCardVerifyPassport + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetSellerList + UnconfirmedPassport, + CreditCardVerifyPassport + Seller +
DetailLevel: none, ItemReturnDescription, + ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions + UnconfirmedPassport, + CreditCardVerifyPassport + Seller +
DetailLevel: none, ReturnAll
+ Always + + + GetItemTransactions + GetSellerTransactions + UnconfirmedPassport, + CreditCardVerifyPassport + Buyer +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Unique eBay user ID for the user.<br> + <br> + Since a bidder's user info is anonymous, this tag contains the actual + value of an ID only for that bidder, and for the seller of an item that the user is + bidding on. For other users, the actual value is replaced by an + anonymous value, according to these rules: + <br><br> + When bidding on items, UserID is replaced with the + value "a****b" where a and b are random characters from the UserID. For + example, if the UserID = IBidALot, it might be displayed as, "I****A". + <br><br> + Note that in this format, the anonymous bidder ID can change for each + auction. + <br><br> + For GetMyeBayBuying only, when bidding on items: UserID + is replaced with the value "a****b" where a and b are random characters from + the UserID. + <br><br> + When bidding on items listed on the the Philippines site: UserID is replaced + with the value "Bidder X" where X is a number indicating the order of that + user's first bid. For example, if the user was the third bidder, + UserID = Bidder 3. + <br><br> + Note that in this Philippines site format, the anonymous bidder ID stays the same for a given + auction, but is different for different auctions. For example, a bidder who + is the third and then the seventh bidder in an auction will be listed for + both bids as "Bidder 3". However, if that same bidder is the first bidder on + a different auction, the bidder will be listed for that auction as "Bidder + 1", not "Bidder 3". + <br><br> + For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: + UserID is replaced with the string "High Bidder". + <br><br> + For PlaceOffer, see also SellingStatus.HighBidder. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + PlaceOffer + Conditionally + + + GetAllBidders + GetBidderList + GetHighBidders + Conditionally + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemsAwaitingFeedback + Conditionally + Buyer + + + GetMyeBayBuying +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + SoldList + BidList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetSellerEvents +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + If true, identifies a user whose ID has changed within the last 30 days. Does not + indicate a new user (see NewUser). + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that bidder, + and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Date and time the user's data was last changed (in GMT). + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that bidder, + and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Indicates whether or not the user is subject to VAT. + Users who have registered with eBay as VAT-exempt are not + subject to VAT. See documentation on Value-Added Tax (VAT). + + + + Value-Added Tax (VAT) + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-IntlDiffsVATB2B.html#VATexemptSellers + + + GetAllBidders + GetBidderList + GetHighBidders + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetOrderTransactions +
DetailLevel: ReturnAll
+ Conditionally + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Contains information about the user as a buyer, such as + the shipping address. See BuyerType for its child elements. + <br><br> + Since a bidder's user info is anonymous, this tag will be returned only to that bidder, + and to the seller of an item that the user is bidding on. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetHighBidders + Always + + + GetSellerList + HighBidder +
DetailLevel: ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Conditionally + HighBidder +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + OrderReport + Buyer + Conditionally + + + + + + + + Contains information about a seller, including listing settings, listing + preferences, seller rankings, and seller type. + <br><br> + This field is replaced by the SellerBusinessType + field if the user is a business seller with a site + ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors). + <br><br> + See SellerType or SellerBusinessCodeType for the child elements. + + + + GetBidderList + Seller + Always + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetItem + GetSellingManagerTemplates + Always + Seller +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Coarse, Medium, Fine
+ Always + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Always + Seller + + + + + + + + This field indicates whether the user's account is enabled for buying and selling + (indicated by 'FullMarketPlaceParticipant') on eBay, or if the account is a Partially + Provisioned Account (indicated by 'Shopper') without selling and buying privileges on + eBay. + + + + GetUser + Always + + + + + + + + Contains information about the seller's charity affliations. + Returned if the user is affiliated with one or more + charities. Seller must be registered with the eBay Giving + Works provider to be affiliated with a charity non-profit + organization. + + + + + + + + + + The user's PayPal account level. Only returned for the user identified in + eBayAuthToken. That is, you cannot see someone else's PayPal account level. + Use this information to check whether a seller is eligible to list digital + downloadable items. See the eBay Web site online + help for current PayPal requirements for listing digital items. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + The user's PayPal account type. Only returned for the user identified in + eBayAuthToken. That is, you cannot see someone else's PayPal account type. + Use this information to check whether a seller is likely to be eligible to + list digital downloadable items. See the eBay Web site online help for + current PayPal requirements for listing digital items. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + The user's PayPal account status. Only returned for the user identified in + eBayAuthToken. That is, you cannot see someone else's PayPal account status. + Use this information to check whether a seller is eligible to list digital + downloadable items. See the eBay Web site online + help for current PayPal requirements for listing digital items. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Specifies the subscription level for a user. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + No longer used. + + + + + + + + + + Indicates the Skype name of the user. Available if + the seller has a Skype account and has linked it (on the eBay site) + with his or her eBay account. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates whether a user has read-only access to the eBay Wiki (true) + or whether the user is able contribute or edit articles on the eBay Wiki + (false). By default, all registered eBay users have access to contribute and + edit articles on the eBay Wiki. All content contributed to the eBay Wiki is + subject to the Community Content Policy. + + + false + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Always + + + + + + + + TUV level is a number allocated to a user based on various characteristics + such as buyer, seller, new buyer, new seller, high risk, or bid limit. + Applies to eBay Motors Pro applications only. + + + AU, DE, FR, IT, UK + + GetUser +
DetailLevel: ReturnAll
+ Conditionally + + + + + + + + The value added tax identifier (VATID) is applicable to the VAT-enabled + sites. + Applies to eBay Motors Pro applications only. + + + AU, DE, FR, IT, UK + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Indicates if item is listed for sale by owner (FSBO) or listed by a + dealer. + Applies to eBay Motors Pro applications only. + + + AU, DE, FR, IT, UK + + AddItem + AddItems + AddSellingManagerTemplate + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + Conditionally + + + GetItem + GetSellingManagerTemplates + Seller +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + GetSellerList + Seller +
DetailLevel: none, ItemReturnDescription, ReturnAll
+
GranularityLevel: Fine
+ Conditionally + + + + + + + + Not used by any call. + + + + + + + + + + Contains information about the user as a bidder on a certain + item. Returned for GetAllBidders if IncludeBiddingSummary = + true is included in the request. + + + + GetAllBidders + Conditionally + + + + + + + + Indicates whether or not the User container has been made + anonymous. If true, some elements in the User container have + either been removed, or had their values changed to remove + identifying characteristics. If false, all expected elements + are returned, and no values are changed. + <br><br> + Since a bidder's user info is anonymous, this tag is returned as false + only to the bidder, and to the seller of an item that the user is bidding + on. For all other users, this tag is returned as true. + + + + Working with Anonymous User Information + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-UserInformation.html + + + GetAllBidders + GetHighBidders + GetSellerEvents + Always + + + GetSellerList +
GranularityLevel: Fine
+ Always + + + GetItem + GetSellingManagerTemplates + Always +
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
+ HighBidder + + + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Total count of neutral Feedback entries received by the user, including weekly repeats. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Reserved for internal or future use. + + + + GetUser +
DetailLevel: none, ReturnAll
+ Always + + + + + + + + When a user has their billing option set to 'email', they can include + this element in a GetUser request to retrieve their own email bills. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + This flag indicates whether or not the user is eligible to sell items on eBay. This field is only returned if the <b>IncludeFeatureEligibility</b> flag is included in the call request and set to 'true'. + + + + GetUser +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + Contains the static email address of an eBay member, used within the "reply to" + email address when the eBay member sends a message. + (Each eBay member is assigned a static alias. The alias is + used within a static email address.) + + + + Static Email Addresses in Trading API Calls + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/CRM-Communications.html + + + GetOrderTransactions + GetOrders +
DetailLevel: ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBaySelling + SoldList + DeletedFromSoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + Buyer + + + + + + + + Contains the shipping address of a bidder who has made a best offer for an item. + <br/><br/> + You cannot retrieve a shipping address for any user with whom you do not have an order relationship, regardless of site. The shipping address of another user is returned only if you and the other user are in an order relationship, within a certain time of order line item creation. + <br><br> + Because a bidder's user information is anonymous, this container is returned only to that bidder, and to the seller of an item that the user is bidding on. + + + + GetBestOffers +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + The first name of the buyer who purchased the order. + + + + GetOrderTransactions + GetOrders +
DetailLevel: none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The last name of the buyer who purchased the order. + + + + GetOrderTransactions + GetOrders +
DetailLevel: none,ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetItemTransactions + GetSellerTransactions +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + + + + + Container for eBay's Business User features. A business seller can choose + to offer an item exclusively to bidders and buyers that also represent businesses. + Only applicable when the item is listed in a B2B-enabled category. + Currently, the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites support + B2B business features. + + + + + + + If true, this indicates that the seller is a business user + and intends to use listing features that are offered to + business users only. Applicable only to business sellers + residing in Germany, Austria, or Switzerland who are listing in + a B2B VAT- enabled category on the eBay Germany (DE), Austria + (AT), or Switzerland (CH) sites. The seller must have a valid + VAT ID registered with eBay. This must be set to true if + RestrictedToBusiness is true. It has no effect (and it's not returned) + if RestrictedToBusiness is false. If an item was not qualified as a + business item when originally listed, but meets the conditions for + business items when the item is revised or relisted, the seller can + convert the item to a business item by specifying the appropriate + VAT details. See the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Sites-IntlDiffsVATB2B.html#ModifyingBusinessItems"> + eBay Features Guide</a> for more information and additional rules. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + If true, this indicates that the seller elects to offer the + item exclusively to business users. If false (or not returned), + this indicates that the seller elects to offer the item to all users. + Applicable only to business sellers residing in Germany, + Austria, or Switzerland who are listing in a B2B VAT-enabled + category on the eBay Germany (DE), Austria (AT), or Switzerland + (CH) sites. If this argument is true, the seller must have a + valid VAT-ID registered with eBay, and BusinessSeller must also + be true. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + VAT rate for the item, if any. When the VATPercent is specified, the + item's VAT information appears on the item's listing page. In + addition, the seller can choose to print an invoice that + includes the item's net price, VAT percent, VAT amount, and + total price. Since VAT rates vary + depending on the item and on the user's country of residence, a + seller is responsible for entering the correct VAT rate; it is + not calculated by eBay. To specify a VATPercent, a seller must + have a VAT-ID registered with eBay and must be listing the item on a + VAT-enabled site. Max applicable length is 6 characters, + including the decimal (e.g., 12.345). The scale is 3 decimal places. + (If you pass in 12.3456, eBay may round up the value to 12.346.) + Note: The View Item page may display the precision to 2 decimal places + with no trailing zeros. However, the full value you send in is stored. + + + 6 + 0 + 30 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetBidderList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + Displays the VatSite Id of the seller (in a business + card format) as part of the data returned in the + GetItem call if the seller's SellerBusinessCodeType + is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + Displays the VatSite Id of the seller (in a business + card format) as part of the data returned in the + GetItem call if the seller's SellerBusinessCodeType + is set to 'Commercial'. + + + + GetItem + GetSellingManagerTemplates + Conditionally +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ + + + + + + + + + + + Type defining the <b>VATRateType</b> container, which is used by + <b>ReviseSellingManagerSaleRecord</b> to modify the VAT percentage for an + order line item. This container is also retrieved by + <b>GetSellingManagerSaleRecord</b> if Value-Added Tax has been applied to + the order line item. + + + + + + + Unique identifier for an eBay item listing. A listing can have multiple + order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be + paired up with a corresponding <b>TransactionID</b> and used as an input filter for + <b>ReviseSellingManagerSaleRecord</b>. However, if <b>OrderID</b> is passed in as an input + filter for <b>ReviseSellingManagerSaleRecord</b>, the <b>ItemID</b>/<b>TransactionID</b> pair is + ignored. + + + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + Unique identifier for an eBay order line item (transaction). An order line + item is created once there is a commitment from a buyer to purchase an item. + Since an auction listing can only have one order line item + during the duration of the listing, the <b>TransactionID</b> for auction listings + is always 0. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used + and referenced during an order checkout flow and after checkout has been + completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be used as an input filter for + <b>ReviseSellingManagerSaleRecord</b>. However, if <b>OrderID</b> is passed in as an input + filter for <b>ReviseSellingManagerSaleRecord</b>, the <b>ItemID</b>/<b>TransactionID</b> pair is + ignored. + + + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + The VAT (Value-Added Tax) rate for the order line item. When the <b>VATPercent</b> is specified, the + item's VAT information appears on the item's listing page. In + addition, the seller can choose to print an invoice that + includes the item's net price, VAT percent, VAT amount, and + total price. Since VAT rates vary + depending on the item and on the user's country of residence, a + seller is responsible for entering the correct VAT rate; it is + not calculated by eBay. To specify a <b>VATPercent</b>, a seller must + have a VAT-ID registered with eBay and must be listing the item on a + VAT-enabled site. Max applicable length is 6 characters, + including the decimal (e.g., 12.345). The scale is 3 decimal places. + (If you pass in 12.3456, eBay may round up the value to 12.346.) + Note: The View Item page may display the precision to 2 decimal places + with no trailing zeros. However, the full value you send in is stored. + + + 6 + 0 + 30 + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is + based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in + between these two IDs. If a VATRate is specified in the + <b>ReviseSellingManagerSaleRecord</b> request, <b>OrderLineItemID</b> can be used instead + of <b>ItemID</b> and <b>TransactionID</b>. For a single line item order, the + <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field to revise the + corresponding order. + + + 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) + + GetSellingManagerSaleRecord + Conditionally + + + ReviseSellingManagerSaleRecord + No + + + + + + + + + + + + Indicates whether or not the user is subject to VAT. + Users who have registered with eBay as VAT-exempt are not + subject to VAT. See documentation on Value-Added Tax (VAT). + + + + + + + (out) VAT is not applicable + + + + + + + (out) Residence in a country with VAT and user is not registered as VAT-exempt + + + + + + + (out) Residence in a country with VAT and user is registered as VAT-exempt + + + + + + + (out) Reserved for internal or future use + + + + + + + + + + If present, the site defines category settings for when the seller + can provide a Vehicle Identification Number (VIN) for + US, CA, and CAFR eBay Motors sites. VIN is required for cars and trucks + from model year 1981 and later. (The US developed national standards for VIN + values as of 1981.) + + + + + + + + + + + If present, the site defines category settings for whether the seller + can provide a Vehicle Registration Mark (VRM) for a + UK eBay Motors vehicle listing. + + + + + + + + + + + + + For Half.com, use AttributeArray.Attribute.Value.ValueLiteral + in listing requests. + For Half.com, + AttributeArray.Attribute.Value.ValueLiteral is required when + you use AddItem. For the Half.com Notes attribute, the max + length is 500 characters. You can revise + AttributeArray.Attribute.Value.ValueLiteral for Half.com + listings. + + + see description + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + GetItemRecommendations + GetProductSearchResults + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyAddItem + VerifyRelistItem + Conditionally + + + GetItemRecommendations + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Always + + + OrderReport + Always + + + + + + + + Reserved for future use. Suggested alternative text for + ValueLiteral. Multiple SuggestedValueLiteral elements can be + returned in a Value node. Not applicable to Half.com. + + + + + + + Constant value that identifies the attribute or characteristic + in a language-independent way. Unique within the + characteristic set.<br> + <br> + In item-listing requests, if the ID is defined as -3 + or -6 (Other) in GetAttributesCS or GetProductSellingPages, + use ValueLiteral to specify the string value that the + user entered. Otherwise, use ValueID to specify the ID + that is pre-defined in GetAttributesCS or GetProductSellingPages. + In item-listing requests and product searches, + the possible ID values are:<br> + -3 = User entered an arbitrary value (not an "Other" field)<br> + -6 = User entered a value in an "Other" field<br> + -100 = Value not specified (null)<br> + #### (integer) = Identifier for a pre-defined value + that the user selected (e.g., -14 or 1001)<br> + For eBay.com, required if ValueList is specified. + Not applicable to Half.com. + + + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + AddLiveAuctionItem + GetItemRecommendations + GetProductSearchResults + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + ReviseLiveAuctionItem + VerifyAddItem + VerifyRelistItem + AttributeSetArray + Conditionally + + + GetItemRecommendations + Conditionally + + + GetItem + GetSellingManagerTemplates + GetSellingManagerTemplates +
DetailLevel: ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + + Defines the value category feature. If a field of this type is present, + the corresponding feature applies to the site. The field is returned as + an empty element (e.g., a boolean value is not returned). + + + + GetCategoryFeatures +
DetailLevel: none, ReturnSummary, ReturnAll
+ Conditionally + + + + + + + + + + + + The format of a ValueType. The ValueFormatCodeType places additional constraints on the format a value takes + on which are enforceable for validation purposes + + + + + + + A date including the month, day, and year in the following format: + '<em>YYYYMMDD</em>' + + + + + + + A date including the month and year in the following format: '<em>YYYYMM</em>' + + + + + + + A date including only the year in the following format: '<em>YYYY</em>' + + + + + + + Reserved for future or internal use. + + + + + + + + + + Defines the ValuePack feature (a feature pack). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). + + + + + + + + + + + Defines details about recommended values for custom Item Specifics. + + + + + + + A recommended value for the Item Specific. Only returned when + a recommended value is available. + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + Constraints that eBay places on this Item Specific value.<br> + <br> + Only returned when you configure your request to include + relationships and/or confidence, and a recommended value + is available. + (Not returned when ExcludeRelationships is true and + IncludeConfidence is false.) + + + + GetCategorySpecifics + GetItemRecommendations + Conditionally + + + + + + + + + + + + This enumeration type is used by multiple Trading API calls, including <b>GetCategorySpecifics<b> call and order management calls (like <b>GetOrders<b>). + <br/><br/> + The values used by <b>GetCategorySpecifics<b> is the data type of the recommended category specific called out in the <b>NameRecommendation.Name</b> field. + <br/><br/> + The values used by <b>GetOrders<b> (and other order management calls) is the type of tax ID used in the <strong>BuyerTaxIdentifier</strong> container. + + + + + + + This value indicates that the recommended category specific is a decimal, or non-integer number with a possible decimal point, like 3.14159. + Item Specifics are not expressed as float or double types. + + + + + + + This value indicates that the recommended category specific is free-form text. This is the default value. The maximum length of a text-based Item Specific is 50 characters. + + + + + + + This value indicates that the recommended category specific is an International Standard Book Number (ISBN) value. ISBNs can contain either 10 or 13 characters. + + + + + + + This value indicates that the recommended category specific is a Universal Product Code (UPC) value. UPCs contain 12 characters. + + + + + + + This value indicates that the recommended category specific is a European Article Number (EAN). EANs contain 13 characters. + + + + + + + This value indicates that the recommended category specific is a date value, which will should use the date format specified in the <b>ValueFormat</b> field. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Codice Fiscale ID, which is an identifier used by the Italian government to identify taxpayers in Italy. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Spanish National Identity Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. In Spanish, this ID is known as the 'Documento nacional de identidad'. The other tax identifier for Spanish residents is the NIE number, or 'Numero de Identidad de Extranjero'. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Russian Passport number. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Tax Registration Number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro de Pessoas Fisicas', or 'CPF'. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Turkish Identification Number, which is an identifier used by the Turkish government to identify taxpayers in Turkey. In Turkish, this ID is known as the 'Turkiye Cumhuriyeti Kimlik Numarasi', often abbreviated as T.C. Kimlik No. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a NIE Number, which is one identifier used by the Spanish government to identify taxpayers in Spain. 'NIE' stands for 'Numero de Identidad de Extranjero'. The other tax identifier for Spanish residents is the DNI number, or 'Documento nacional de identidad'. Spanish residents can also be identified by their Spanish VAT (Value-Added Tax) number, which is also called the 'Numero de Identificacion Fiscal' or NIF. + + + + + + + This value indicates that the ID in the <b>ID</b> field is an NIF Number, which is also known as their Spanish VAT (Value-Added Tax) number. 'NIF' stands for 'Numero de Identificacion Fiscal'. Spanish residents can also be identified by their DNI ('Documento nacional de identidad') number or their NIE ('Numero de Identidad de Extranjero') number. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a Cedula number, which is an identifier used by the Chilean, Columbian, and Dominican Republic governments to identify taxpayers in those countries. This ID is sometimes referred to as a 'Cedula de Identidad'. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a NIT number, which is an identifier used by the Guatemalan government to identify taxpayers in Guatemala. In Spanish, this ID is known as the 'Numero de identificacion tributaria'. + + + + + + + This value indicates that the identifier in the <b>ID</b> field is a driver's license number. + + + + + + + This value indicates that the tax ID in the <b>ID</b> field is a CNPJ number, which is an identifier used by the Brazilian government to identify taxpayers in Brazil. In Portuguese, this ID is known as the 'Cadastro Nacional da Pessoa Juridica'. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>VariationDetails</b> container that is returned in + <b>GeteBayDetails</b> if <b>VariationDetails</b> is included + in the request as a <b>DetailName</b> filter, or if <b>GeteBayDetails</b> + is called with no <b>DetailName</b> filters. + + + + + + + This value indicates the maximum number of item variations that the site will allow + within one multi-variation listing. + + + + GeteBayDetails + Conditionally + + + + + + + + This value indicates the maximum number of variation specific sets that the site will allow + per listing. Typical variation specific sets for clothing may be 'Color', 'Size', 'Long Sleeve', etc. + + + + GeteBayDetails + Conditionally + + + + + + + + This value indicates the maximum number of values that the site will allow + within one variation specific set. For example, if the variation specific set was + 'Color', the seller could specify as many colors that are available up to this + maximum value. + + + + GeteBayDetails + Conditionally + + + + + + + + Returns the latest version number for this field. The version can be + used to determine if and when to refresh cached client data. + + + + GeteBayDetails + Always + + + + + + + + Gives the time in GMT that the feature flags for the details were last + updated. This timestamp can be used to determine if and when to refresh + cached client data. + + + + GeteBayDetails + Always + + + + + + + + + + + + Used to provide input for ItemID and VariationSpecific + + + + + + + The ID of the item whose variation(s) should be added to or + removed from the watch list. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + AddToWatchList + RemoveFromWatchList + Conditionally + + + + + + + + Name-value pairs that identify a variation within the + listing identified by VariationKey.ItemID. + or that partially match one or more variations. Names may not be duplicated in the same VariationSpecifics container. + If the specified pairs do not match any variation, the call + behaves as if no variations were specified. + + + + AddToWatchList + RemoveFromWatchList + Conditionally + + + + + + + + + + + + Defines the rules for using Item Specifics to classify + variation pictures. + + + + + + + If the name is used in VariationSpecifics, then it must + be used as the Pictures.VariationSpecificName. + + + + + + + If the name is used in VariationSpecifics, then it can + be used as the Pictures.VariationSpecificName. + This is the default for variation-enabled categories. + + + + + + + The name cannot be used as the Pictures.VariationSpecificName. + + + + + + + Reserved for future use. + + + + + + + + + + Type defining the <b>VariationSpecificPictureSet</b> container, which is + used to specify the URL(s) where the picture(s) of the variation specific will be + hosted. If the <b>Variations.Pictures</b> container is used, at least one + <b>VariationSpecificPictureSet</b> container is required. + + + + + + + A value that is associated with VariationSpecificName. For example, + suppose this set of pictures is showing blue shirts, and some of + the variations include Color=Blue in their variation specifics. + If VariationSpecificName is "Color", then VariationSpecificValue would be "Blue". + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + The URL of a picture that is associated with the + <b>VariationSpecificValue</b>. A variation specific picture set can + consist of up to 12 self-hosted or eBay Picture Services (EPS) hosted pictures. eBay Picture + Services and self-hosted images can never be combined into the same variation + specific picture set. To specify more than one image, use + multiple <b>PictureURL</b> fields, passing in a distinct URL in each + of those fields. This field cannot have an empty/null value. + <br><br> + The image specified in the first <b>PictureURL</b> field is also used as the thumbnail image for applicable variations. For example, if the picture set contains pictures of red + shirts (i.e., VariationSpecificName=Color and VariationSpecificValue=Red), the + first picture is used as the thumbnail image for all the red shirt variations. + <br/><br/> + <span class="tablenote"><b>Note: </b> + All images must comply with the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>. + </span> + + You can use Item.PictureDetails to specify additional pictures. + For example, the item-level pictures could include a model wearing a + black shirt, as a typical example of the shirt style. + <br><br> + <span class="tablenote"><b>Note:</b> + If a URI contains spaces, replace them with <code>%20</code>. + For example, <code>http://example.com/my image.jpg</code> must be + submitted as <code>http://example.com/my%20image.jpg</code> to + replace the space in the image file name. + </span> + Variation pictures cannot be added or removed from a fixed-price listing when the listing is scheduled to end within 12 hours or if the item variation has already had transactions. + <br/><br/> + <span class="tablenote"> + <strong>Note:</strong> For some large merchants, there are no limitations on when variation pictures can be added or removed from a fixed-price listing, even when the item variation has had transactions or is set to end within 12 hours. + </span> + + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + No longer used. + + + + + + + + + + Returns the URL of a variation-specific picture that is hosted outside of eBay.<br> + <br> + When you list, revise, or relist a variation, use VariationSpecificPictureSet.PictureURL (not ExternalPictureURL) to specify your self-hosted picture or EPS picture.<br> + <br/> + <span class="tablenote"><b>Note: </b> + All images must comply to the <a href="http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-Intro.html">Picture Requirements</a>. + </span> + This is returned only when the seller used a self-hosted picture for the variation. + + + 150 + + Working with Pictures in an Item Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Pictures-InListing.html#CopyofaSelfHostedPictureToeBayPictureSer + + + GetItem + GetItems + Conditionally +
outputSelector: Variations
+ + + + + + + + Returns the URLs of the seller's self-hosted (hosted outside of eBay) variation specific pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the picture was uploaded. + + + + GetItem + Conditionally + + + + + + + + + + + + Defines option for whether an Item Specific can be used as a variation specific. + + + + + + + The recommended name (and values, if any) can be used + either in the Item Specifics or VariationSpecifics context + in listing calls. + This is the default for variation-enabled categories. + + + + + + + The recommended name/values can't be used in VariationSpecifics + (but they can be used in ItemSpecifics). Typically, this occurs + when the category doesn't support variations, or if the category + requires the name to be the same for all variations + in the listing. + + + + + + + Reserved for future use. + + + + + + + + + + This type defines the <b>Variation</b> container, which provides full + details on each item variation in a multi-variation listing. + + + + + + + A SKU (stock keeping unit) is an identifier defined by a seller. + It is only intended for the seller's use (not for buyers). + Many sellers assign a SKU to an item of a specific type, + size, and color. For the seller's convenience, eBay preserves the + SKU on the variation, and also on corresponding order line items. + This enables you (as a seller) use the SKU to reconcile your + eBay inventory with your own inventory system instead of using the + variation specifics. It is a good idea to track how many items of + each type, size, and color are selling so that you can restock + your shelves or update the variation quantity on eBay according to + customer demand. (eBay does not use the SKU.)<br> + <br> + If specified, all SKU values must be unique within the Variations + node. That is, no two variations within the same listing can have + the same SKU. <br> + <br> + If you set Item.InventoryTrackingMethod to true, + the variation SKU values are required and they must be + unique across all the seller's active listings.<br> + <br> + <b>For GetItem and related calls:</b> Only returned if the + seller specified a SKU for the variation. + + + 80 + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#SettingaSKUtoUniquelyIdentifytheVariatio + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + The fixed price of all items identified by this variation. + For example, a "Blue, Large" variation price could be USD 10.00, + and a "Black, Medium" variation price could be USD 5.00.<br> + <br> + Each variation requires its own price, and the prices can + be different for each variation. This enables sellers to + provide discounts on certain + variations without affecting the price of others. + Required (and always returned) for listings with variations.<br> + <br> + You can revise a variation's price at any time (even if it + has purchases). When you modify a variation during revise or + relist, you need to include both its StartPrice and Quantity. + + + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#SettingtheVariationPrice + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Variations.Variation + Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This value indicates the quantity of items in the specific variation that are + available for purchase. If you set <b>Variation.Quantity</b> to '0' when + you create, revise, or relist an item listing, the variation is dropped from + the listing. To prevent this, you can set + <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/ebay/SetUserPreferences.html#Request.OutOfStockControlPreference">SetUserPreferences.OutOfStockControlPreference</a> to 'true'. + <br/><br/> + For <b>GetItem</b> (and other related calls that retrieve the Item + object), the <b>Variation.Quantity</b> value indicates the total number + of items associated with the variation, including the quantity available and the + quantity sold. To calculate the quantity available for sale, subtract + <b>SellingStatus.QuantitySold</b> from this value.<br> + <br> + <b>For RelistFixedPriceItem:</b> + Previously in <b>RelistFixedPriceItem</b>, the <b>Variation.Quantity</b> field retained its value from the previous listing unless you specifically changed it by including the field in a relist call and giving it a new value. And this value was often not accurate with the variation quantity that was really still available for purchase. As of March 13, 2014, this behavior has been changed in the following manner: + <ul> + <li>For an item variation that had an available quantity greater than zero when the listing ended, the <b>Quantity</b> value of the item variation for the newly relisted item is set to the actual quantity available. For item variations, there is actually no <b>QuantityAvailable</b> field, but this value may be derived if you look at the corresponding item variation in a <b>GetMyeBaySelling</b>) response and subtract the <b>Variation.QuantitySold</b> value from the <b>Variation.Quantity</b> value, which represents the original <b>Variation.Quantity</b> value at creation time of the previous listing. </li> + <li>For item variations with an available quantity of zero when the listing ended, the relisted item will retain the <b>Variaton.Quantity</b> value that was passed in at creation time of the previous listing. </li> + </ul> + So, if you are relisting an item that had one or more item variations with an available quantity of zero when the listing ended, we strongly recommend that you pass in the correct available quantity through the corresponding <b>Variation.Quantity</b> field of a relist call. Alternatively, you can update the correct quantity available by using a <b>ReviseInventoryStatus</b> call and passing in a <b>Quantity</b> value, while also making sure to pass in the correct <b>SKU</b> value(s) to identify the correct item variation. A <b>ReviseInventoryStatus</b> call can be used to revise the quantity of up to four single item listings and/or item variations (from the same or different listings). + <br> <br> + <b>For ReviseFixedPriceItem:</b> + You can revise a variation's quantity at any time, even if + it has purchases. However, at least one variation must remain + with a non-zero quantity in order for the listing to remain active. + When you modify a variation during revise or + relist, you need to include both its StartPrice and Quantity. + If you revise the Quantity value for a variation after items have + already sold, specify the quantity available for sale. + (eBay will automatically add the + quantity sold to the value you specify.) If you set the quantity to + 0 and the variation has no purchases, the variation may be + dropped from the listing. + <br> <br> + <b>For GetSellerTransactions:</b> See Item.Quantity instead.<br> + <br> + See the <a href="http://developer.ebay.com/Devzone/guides/ebayfeatures/Development/Variations-Updating.html">eBay Features Guide</a> + for more details about setting and modifying a variation's quantity. + <br><br> + <span class="tablenote"><b>Note:</b> + The number in the <b>Variation.Quantity</b> field represents the current quantity of the item variation that is available using the "Ship to home" fulfillment method. This number does not take into account any quantity of the item variation that is available through "local" fulfillment methods such as In-Store Pickup, eBay Now, or Click and Collect. This is due to the fact that there is no current implementation (or API field) where the seller informs eBay about the quantity of item variations available through each local fulfillment method. In the case where a listing is only offering the item variations through a local fulfillment method, this value should default to '0', and the <b>Item.IgnoreQuantity</b> will also be returned as 'True'. + </span> + <br> + + + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#SettingandModifyingaVariationsQuantity + + + Using the Out-of-Stock Feature for more details + ../../../../../guides/ebayfeatures/Development/Listings-UseOutOfStock.html + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + 0 + Yes + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally + 0 +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Variations.Variation + Conditionally + + + + + + + + A list of name/value pairs that uniquely identify the variation within + the listing. All variations must specify the same set of names, and + each variation must provide a unique combination of values for those + names. For example, if the items vary by color and size, then every + variation must specify Color and Size as names, and no two + variations can specify the same combination of color and size values.<br> + <br> + When you revise a listing that includes variations, you can + change names in variation specifics by using ModifyNameList. You can also add, delete, or replace individual variations as needed to match your + current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has + sales, then set the Quantity to 0.<br> + <br> + <b>For GetSellerEvents</b> To keep the GetSellerEvents + response smaller, variation specifics are not returned if the + variation has a SKU. If the variation has no SKU, then + variation specifics are returned instead. Optionally, you can pass + IncludeVariationSpecifics as true in the request to force + variation specifics to be returned, even when the SKU is returned. + + + 2 + 5 + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#SettingItemSpecificsforVariations + + + Revising and Relisting with Variations + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Updating.html + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + Quantity of items in the seller's inventory for this + Selling Manager product. + This is not the same as the quantity available in a listed item. + Required when a Selling Manager product defines variations. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + + + + + + Cost of the Selling Manager product that matches this variation. + + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + + + + + + Contains the variation's quantity sold. + Always returned when variations are present. + + + + GetItem + Conditionally + + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Variations.Variation + Conditionally + + + + + + + + The title of the variation. This is a concatenation of the listing + title plus the values (no names) from the VariationSpecifics. + For example, if the Title is "Polo Shirt" and the variation is + for a medium pink shirt, the variation title could be + "Polo Shirt[Pink,M]. + PayPal may also use this value + to identify item variations(for buyers and sellers). + + + + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Transaction.Variation + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + URL for the variation on eBay. This links to eBay's View Item page, + with the page configured to show details of the specified variation. + The syntax of this URL is similar to Item.ViewItemURL (not optimized + for natural search). + + + + GetSellerTransactions + GetOrderTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Transaction.Variation + Conditionally + + + GetOrders +
DetailLevel: none, ReturnAll
+ Conditionally + + + OrderReport + Conditionally + + + + + + + + Deletes the specified variation from the listing. In general, + a listing with Item Variations must have at least one + variation with a non-zero Quantity in order to remain active. + Additional deletion rules depend + on whether you are revising or relisting.<br> + <br> + <b>For ReviseFixedPriceItem only</b>: + If a variation has any purchases (i.e., an order line item was created + and QuantitySold is greather than 0), you can't + delete the variation, but you can set its quantity to zero. + If a variation has no purchases, you can delete it.<br> + <br> + To replace a varation, you can delete it and add the new + or corrected one. + However, you can't specify the same SKU twice in the + same request (because the intent would be ambiguous). + So, either use a new SKU for the newer variation, + or use the call twice (once to delete the variation, and + once to add the new variation with the same SKU).<br> + <br> + <b>For RelistFixedPriceItem only</b>: + You can delete any variation, as long as the relisted listing + includes at least 1 variation with a non-zero quantity. + (That is, when you relist, you could delete all but one variation, + or you could delete all existing variations and add a new one.) + + + + ReviseFixedPriceItem + RelistFixedPriceItem + Conditionally + + false + + + + + + + Container for statistics about the Selling Manager product + that is associated with this variation. + + + + GetSellingManagerInventory + Conditionally + + + + + + + + The number of watches placed on this variation by eBay users. + + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + A note a user makes on an item with variations in My eBay. + <br> + <br> + For eBay.com, only GetMyeBaySelling (not GetItem) returns this + field, and only if you pass IncludeNotes in the request. + Only visible to the user who created the note.<br> + <br> + Not supported as input in ReviseFixedPriceItem. + Use SetUserNotes instead.<br> + <br> + In SoldList, notes for variations are only returned at the + Item level, not the variation level. + + + + GetMyeBaySelling + ActiveList + DeletedFromUnsoldList + ScheduledList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + + + + + + This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price + (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings. STP is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites, while MAP is available only on the US site. + <br><br> + Discount pricing is available to qualified sellers (and their associated developers) who + participate in the Discount Pricing Program. Once qualified, sellers receive a + "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation + items. Sellers should contact their account manager or Customer Service to + see if they qualify for the Strikethrough Pricing program. + <br><br> + As a seller listing Discount Price items, you are required to maintain records of your discount + pricing in the event you are called upon to substantiate your item pricing. The following + link details your legal obligations when you utilize Discount Pricing to sell items: <a href= + "http://pages.ebay.com/help/sell/strike-through.html">Strikethrough Pricing Requirements + </a> + <br><br> + <b>For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and + VerifyAddFixedPriceItem:</b> + If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation. + + + + Displaying Discount Pricing Information to Buyers + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Items-Retrieving.html + + + AddFixedPriceItem + AddItem + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + VerifyAddFixedPriceItem + VerifyAddItem + VerifyRelistItem + No + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + + + + + Defines the multi-variation listing feature. If the field is present, + the corresponding feature applies to the site. The field is returned as + an empty element (e.g., a boolean value is not returned).<br> + <br> + Multi-variation listings contain items that are logically the same + product, but that vary in their manufacturing details or packaging. + For example, a particular brand and style of shirt could be + available in different sizes and colors, such as "large blue" and + "medium black" variations. + + + + + + + + + + + Variations are multiple similar (but not identical) items in a + single fixed-price listing. + For example, a single listing could contain multiple items of the + same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and + price. For example, a listing could include 10 "Blue, Large" + variations and 20 "Black, Medium" variations. + + + + + + + Contains data that distinguishes one variation from another. + For example, if the items vary by color and size, each Variation + node specifies a combination of one of those colors and + sizes.<br> + <br> + When listing or relisting an item, you are allowed to create a + listing with only one variation if you plan to add more variations + to it in the future. However, if you don't plan to add other + variations, we recommend that you avoid listing with only one + variation, so that you avoid confusing buyers.<br> + <br> + When you modify a variation, it's safest to specify all the fields with the values + you want in the listing. At a minimum, StartPrice and VariationSpecifics are required + to modify an existing variation. If you omit SKU, the existing SKU (if any) is + deleted from the variation. If you omit Quantity, it is set to 0.<br> + <br> + Variation, Pictures, or ModifyNameList (or all) need to be + specified when the Variations node is specified in listing requests. + + + + Multi-Variation Listings + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations.html + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + 1 + 120 + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + GetSellerList +
DetailLevel: ItemReturnDescription, ReturnAll
+ Conditionally + + + GetMyeBayBuying + LostList + WatchList + WonList + DeletedFromWonList + DeletedFromLostList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetMyeBaySelling + ActiveList + DeletedFromSoldList + DeletedFromUnsoldList + ScheduledList + SoldList + UnsoldList +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetSellerEvents +
DetailLevel: none, ReturnAll
+ Conditionally + + + GetItemTransactions +
DetailLevel: none, ItemReturnDescription, ReturnAll
+ Conditionally + + + + + + + + Contains a set of pictures that correspond to one of the + variation specifics, such as Color. For example, if a listing + has blue and black color variations, you could choose Color + for all the pictures, and then include a set of pictures + for the blue variations and another set of pictures for the black + variations.<br> + <br> + We strongly recommend that you also include shared pictures + in Item.PictureDetails, as this results in a better experience + for buyers.<br> + <br> + <b>For ReviseFixedPriceItem only:</b> To replace + or delete individual pictures, pass in the entire Pictures + node with the complete set of variation pictures that you + want in the listing. If the applicable variations have purchases + or the listing ends in less than 12 hours, you can add + pictures, but you can't remove existing pictures.<br> + <br> + Variation, Pictures, or ModifyNameList (or all) need to be + specified when the Variations node is specified in listing requests<br> + <br> + <span class="tablenote"><b>Note:</b> + Only one Pictures node is allowed for a listing. + However, the node has been defined as unbounded (repeatable) in + the schema to allow for different use cases for some calls or sites + in the future.</span> + + + 1 + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#DefiningPicturesforVariations + + + AddFixedPriceItem + ReviseFixedPriceItem + RelistFixedPriceItem + VerifyAddFixedPriceItem + No + + + AddSellingManagerProduct + ReviseSellingManagerProduct + No + + + AddSellingManagerTemplate + ReviseSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + The set of all variation specific names and values that can be + applicable to the listing (at any time in its life cycle). + This must include all names and values specified in the + VariationSpecifics nodes.<br> + <br> + Required when Variations are specified in a new listing, and when you + modify the name of a variation by using ModifyNameList. + When you modify variation specific names, VariationSpecificsSet must + include the new names plus the names that are not changing (but omit the old names), <br> + <br> + This set configures variation selection widgets + that appear on eBay's View Item page. + For example, if you specify Color and Size names in the set, + eBay's View Item page displays Color and Size drop-down lists + to enable a buyer to choose a variation of interest.<br> + <br> + The order in which you specify the names and values also + controls the order in which the selection widgets appear on + the View Item page. + For example, if you specify "Color", then "Size", and then + "Sleeve Style" as names, the View Item page shows drop-down lists + with those labels in that order. For "Size", if you specify + "S", "M", and "L" as values, the View Item page + shows the values in that order in the Size drop-down list.<br> + <br> + Use GetCategorySpecifics to retrieve recommendations for names, + values, and order.<br> + <br> + Required when Variations are specified in a new listing + (e.g., in AddFixedPriceItem). Also required when you change + variation specific names or values in ReviseFixedPriceItem and + RelistFixedPriceItem. + + + + Describing Variations in a Listing + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Configuring.html#ConfiguringVariationSelectionWidgetsforB + + + AddFixedPriceItem + VerifyAddFixedPriceItem + Conditionally + + + ReviseFixedPriceItem + RelistFixedPriceItem + Conditionally + + + AddSellingManagerProduct + No + + + AddSellingManagerTemplate + No + + + GetSellingManagerInventory + Conditionally + + + GetItem + Conditionally +
DetailLevel: none, ItemReturnDescription, + ItemReturnAttributes, ReturnAll
+ + + + + + + + Modifies variation specific names when you revise or + relist items.<br> + <br> + You can modify a variation specific name regardless of the quantity sold (i.e., no restrictions on whether the item has orders or order line items (transactions)).<br> + <br> + (Use VariationSpecifics to modify variation specific values.)<br> + <br> + You are not required to specify SKU, VariationSpecifics, and other variation details in the request when you are only modifying a variation specific name. + <br> + <br> + Variation, Pictures, VariationSpecificsSet, or ModifyNameList (or all) need to be specified when the Variations node is specified in listing requests. + + + + Revising and Relisting with Variations + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/Variations-Updating.html + + + RelistFixedPriceItem + ReviseFixedPriceItem + Conditionally + + + + + + + + + + + + The VeRO reporting status for an item. + + + + + + + (out) The VeRO report request for the item has been received by eBay. + + + + + + + (out) The VeRO report request for the item has been submitted to eBay. + + + + + + + (out) The reported item has been ended by eBay. + + + + + + + (out) The VeRO report request for the item failed. + + + + + + + (out) The VeRO report request for the item has been received by eBay, but + additional clarification is needed before eBay can end the item. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for reason code details for all sites. + + + + + + + Contains reason code details for a site. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + + + + Contains the item information to report. + + + + + + + The unique identifier for the item being reported for alleged infringement. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + VeROReportItems + Yes + + + + + + + + The reason code identifier for the type of claimed infringement. Use + GetVeROReasonCodeDetails to retrieve a list of reason codes for a given site + or for all sites. + + + + + + VeROReportItems + Yes + + + + + + + + Message from the VeRO Program member to the seller of the item being reported. + + + 1000 + + VeROReportItems + Yes + + + + + + + + When set to true, this specifies that the VeRO Program member be copied on + the Notice of Claimed Infringement (NOCI) email sent to sellers of reported + items. + + + true + + VeROReportItems + Conditionally + + + + + + + + Region whose intellectual property laws are being violated. + + + + VeROReportItems + No + + + + + + + + The two-digit code representing the country whose intellectual property laws are + being violated. This field can be used more than once if there a multiple + countries whose intellectual property laws are being violated. + <br><br> + This field is required when the <b>VeROReasonCodeID</b> + is 9037 (Item(s) is unlawful importation of product bearing trademark). + + + + VeROReportItems + Conditionally + + + + + + + + Patent number of the item, required when the VeROReasonCodeID is 9048 (Item(s) + infringes a valid patent). + + + + 15 + VeROReportItems + Conditionally + + + + + + + + Explanatory text from the VeRO Program member. This field is required when the + VeROReasonCodeID is "others." + + + + VeROReportItems + Conditionally + + + + + + + + + + + + Type defining the <b>ReportItems</b> container in the + <b>VeROReportItems</b> request. The <b>ReportItems</b> container + consists of an array of items which, according to the seller, are infringing upon the + seller's copyright, trademark, or intellectual property rights (according to the seller). + + + + + + + Container consisting of details related to the VeRO Report being submitted. + + + + VeROReportItems + Yes + + + + + + + + + + + The status of a set of items (packet) reported for infringement. Packet states + are based on the states of the reported items within the packet. + + + + + + + (out) The packet has been received by eBay. + + + + + + + (out) The packet is being processed by eBay. + + + + + + + (out) The packet has been processed by eBay. Each item within the packet has a status of Removed, SubmissionFailed, or ClarificationRequired. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + Container for a list of reported items. Can contain zero, one, or multiple + VeROReportedItemType objects, each of which conveys the data for one item listing. + + + + + + + Contains the data and status of a reported item. + + + + GetVeROReportStatus + Conditionally + + + + + + + + + + + Type defining the <b>ReportedItem</b> container which is returned in the + <b>GetVeROReportStatus</b> response. The <b>ReportedItem</b> + container consists of the <b>ItemID</b> of the item that has infringed + upon the seller's copyright, trademark, or intellectual property rights, as well as the + submission status of the VeRO Report. + + + + + + + The unique identifier (<b>ItemID</b>) of the item reported for + copyright, trademark, or intellectual property right infringment. + <br><br> + This field is always returned with the <b>ReportedItem</b> container. + + + 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) + + GetVeROReportStatus + Conditionally + + + + + + + + This value indicates the current submission status of the VeRO Report. + <br><br> + This field is always returned with the <b>ReportedItem</b> container. + + + + GetVeROReportStatus + Conditionally + + + + + + + + This text explanation is submitted by eBay when the submission of an VeRO Report + has failed or was blocked. + <br><br> + This field is only returned with the <b>ReportedItem</b> container if + the <b>ItemStatus</b> value is <b>SubmissionFailed</b> or + <b>ClarificationRequired</b>. + + + + GetVeROReportStatus + Conditionally + + + + + + + + + + + + Container for reason code details for a given site. + + + + + + + The site for which reason code details are returned. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + Contains details for a given reason code. + + + + GetVeROReasonCodeDetails + Always + + + + + + + + + + + + Type defining the <b>BuyerRequirementDetails.VerifiedUserRequirements</b> + container that is returned in <b>GeteBayDetails</b>. The + <b>VerifiedUserRequirements</b> container provides the <b>VerifiedUser</b> + and <b>FeedbackScore</b> values that may be used in listing calls to restrict + unverified users who have Feedback scores below the minimum threshold. + + + + + + + For eBay sites that support Verified User Requirements, this boolean is always + returned as 'true'. If a seller uses the + <b>BuyerRequirementDetails.VerifiedUserRequirements</b> in listing calls, + the <b>VerifiedUser</b> field in that container should only be passed + into the request if the seller is only willing to sell items to Verified Users. If + the <b>VerifiedUser</b> field is omitted from the listing call, the + specified <b>FeedbackScore</b> value will only apply to unverified users. + <br/><br/> + Currently, this feature is only supported by the following sites: UK, Australia, + France, Spain, India, Ireland, Malaysia, Philippines, and Singapore. However, this + is subject to change, so it is always a good idea for the seller to call + <b>GeteBayDetails</b> with <b>DetailName</b> set to + <b>BuyerRequirementDetails</b>. + + + + GeteBayDetails + Conditionally + + + + + + + + The values returned in these fields are the values that may be used by the seller + in the <b>BuyerRequirementDetails.VerifiedUserRequirements</b> + container in listing calls. The <b>FeedbackScore</b> value passed into + a listing call request will restrict unverified users with Feedback scores below + the minimum threshold value from buying the item. + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Type defining the <b>VerifiedUserRequirements</b> container, which is used by the seller to block prospective buyers who do not pass a verified user check. + + + + + + + To block non-verified users from buying/bidding on their items, the seller should include this field and set its value to 'true'. + <br/><br/> + The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>, and then look for the <b>BuyerRequirementDetails.VerifiedUserRequirements</b> container. + + + + Field Differences for eBay Sites + http://developer.ebay.com/DevZone/guides/ebayfeatures/Development/IntlDiffs-Fields.html + + false + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + This field is ignored unless the <b>VerifiedUser</b> field is included and set to 'true'. + <br/><br/> + The seller includes this field as a mechanism to block verified users who have a feedback score less than the specified value. + <br/><br/> + The Verified User concept is not applicable to all countries, including the US and Germany. To verify if the Verified User concept is applicable to a specific site, call <b>GeteBayDetails</b> with <b>DetailName</b> set to <b>BuyerRequirementDetails</b>, and then look for the <b>BuyerRequirementDetails.VerifiedUserRequirements</b> container. The valid <b>MinimumFeedbackScore</b> values will be seen in the <b>BuyerRequirementDetails.VerifiedUserRequirements.FeedbackScore</b> fields. + + + + + 5 + + AddFixedPriceItem + AddItem + AddItems + AddSellingManagerTemplate + GetItemRecommendations + RelistFixedPriceItem + RelistItem + ReviseFixedPriceItem + ReviseItem + ReviseSellingManagerTemplate + VerifyAddItem + VerifyRelistItem + No + + + GetBidderList + GetSellerList + Conditionally + + + GetItem + GetSellingManagerTemplates +
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
+ Conditionally + + + + + + + + + + + Container for a list of search result items. Can contain zero, one, or multiple + WantItNowPostType objects, each of which contains data for a single Want It Now + post found by the search. + + + + + + + Contains data for a Want It Now post found by a search. + + + + GetWantItNowSearchResults + Conditionally + + + + + + + + + + + Contains the data describing a single Want It Now post. Buyers create Want It Now + posts to communicate to sellers specific requirements for items they would like to + buy. + + + + + + + ID of the category in which the Want It Now post is listed. + + + 10 + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + Description of a Want It Now post. Description will not be returned for + GetWantItNowSearchResults. + + + + GetWantItNowPost + Always + + + + + + + + ID that uniquely identifies a Want It Now post. + + + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + Site where the Want It Now post is listed. + + + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + Date and time (in GMT) that a Want It Now post was added. + + + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + Number of responses for a Want It Now post. Sellers respond to a Want It + Now post by submitting an item number, so each response corresponds to an item + listing. + + + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + Title of a Want It Now post. + + + + GetWantItNowSearchResults + Conditionally + + + GetWantItNowPost + Always + + + + + + + + + + + Specifies the various warranty durations being offered. + + + + + + + 1 month + + + + + + + 3 months + + + + + + + 6 months + + + + + + + 1 year + + + + + + + 2 years + + + + + + + 3 years + + + + + + + More than 3 years + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + + + + The warranty period. + This value can be passed in the AddItem family of calls. + + + WarrantyDurationOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present a list of warranty durations in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use WarrantyDurationOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Specifies that the warranty is offered for the item by the seller. + + + + + + + A warranty is offered for the item. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + + + + Whether the item includes a warranty. + This value can be passed in the AddItem family of calls. + + + WarrantyOfferedCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present the "warranty offered" options in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use WarrantyOfferedOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + Specifies the various warranty type being offered. + + + + + + + The item will be replaced, if under warranty. + + + + + + + The warranty is offered by the dealer. + + + + + + + The warranty is offered by the manufacturer. + + + + + + + (out) Reserved for internal or future use. + + + + + + + + + + + + + + + + The source or type of the warranty. + This value can be passed in the AddItem family of calls. + + + WarrantyTypeOptionsCodeType + + GeteBayDetails + Conditionally + + + + + + + + Display string that applications can use to present WarrantyTypeOption in + a more user-friendly format (such as in a drop-down list). + Not applicable as input to the AddItem family of calls. (Use WarrantyTypeOption instead.) + + + + GeteBayDetails + Conditionally + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This type is deprecated because the calls that use it are deprected. + + + + + + + + + + + + The name of the XSL file. Store this information to use it + as input to the call in the future. + + + + + + + + + + + + The version number of the XSL file. Store this information to use it + as input to the call in the future. To get the current version value without + retrieving the XSL file, do not pass DetailLevel in the request. + + + + + + + + + + + + Contains a MIME base-64-encoded representation of the XSL file. + See the eBay Web Services Guide for information on decoding + the XSL stylesheet file. If no XSL file is available (or if you passed no detail level), + this property is empty or not returned. + + + + + + + + + + + + + + + Defines the AdFormatEnabled feature. If this field is present, + the corresponding feature applies to the category. The field + is returned as an empty element (e.g., a boolean value is not returned). + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether automatic accept of best offers is allowed for this category. + Returned only if this category overrides the site default. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether automatic decline of best offers is allowed for this category. + Returned only if this category overrides the site default. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether Contact Seller is enabled for Classified Ads. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether the category supports the use of a company name + when contacting the seller about Classified Ad format listings. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether the category supports the use of an address when + contacting the seller about Classified Ad format listings. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether the category supports the use of email to contact the + seller for Classified Ad format listings.Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether the category supports using the telephone as a + contact method. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether counter offers are allowed on best offers for + this category. + Returned only if this category overrides the site default. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates whether the category supports the use of payment method checkOut + for Classified Ad format listings.Added for EbayMotors Pro users. + + + + + + + + + + + Indicates which phone option the category supports + for contacting the seller about Classified Ad format listings. + Added for EbayMotors Pro users. + + + + + + + + + + + Defines the SellerContactDetailsEnabled feature. If this field is present, + the category allows retrieval of seller-level contact information. The + field is returned as an empty element (e.g., a boolean value is not returned). + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates if the category supports shipping options for + Classified Ad format listings. + Added for EbayMotors Pro users. + + + + + + + + + + + Indicates which address option the category supports for + Classified Ad format listings. + Added for EbayMotors Pro users + + + + + + + + + + + This type is no longer used. + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + This field is no longer used. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 917 + + + + + + + \ No newline at end of file diff --git a/tests/resources/ews/messages.xsd b/tests/resources/ews/messages.xsd new file mode 100644 index 0000000..33a6155 --- /dev/null +++ b/tests/resources/ews/messages.xsd @@ -0,0 +1,5977 @@ + + + + + + + + Represents the message keys that can be returned by response error messages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Converts the passed source ids into the destination format. Change keys are not returned. + + + + + + + + + + + + + + + Response type for the ConvertId web method + + + + + + + + + Response Message for a single id conversion in the ConvertId web method. Note that the AlternateId element will be missing in the case of an error. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request type for the FindMailboxStatisticsByKeywords web method. + + + + + + + + + + + + + + + + + + + + + + + + Response type for the FindMailboxStatisticsByKeywords web method. + + + + + + + + + + Response message type for the FindMailboxStatisticsByKeywords web method. + + + + + + + + + + + + + + Request type for the GetSearchableMailboxes web method. + + + + + + + + + + + + + + + Response message type for the GetSearchableMailboxes web method. + + + + + + + + + + + + + + + + Request type for the SearchMailboxes web method. + + + + + + + + + + + + + + + + + + + + + + Response type for the SearchMailboxes web method. + + + + + + + + + + Response message type for the SearchMailboxes web method. + + + + + + + + + + + + + + Request type for the GetDiscoverySearchConfiguration web method. + + + + + + + + + + + + + + + + Response message type for the GetDiscoverySearchConfiguration web method. + + + + + + + + + + + + + + + Request type for the GetHoldOnMailboxes web method. + + + + + + + + + + + + + + Response message type for the GetHoldOnMailboxes web method. + + + + + + + + + + + + + + + Request type for the SetHoldOnMailboxes web method. + + + + + + + + + + + + + + + + + + + + + + Response message type for the SetHoldOnMailboxes web method. + + + + + + + + + + + + + + + Request type for the GetNonIndexableItemStatistics web method. + + + + + + + + + + + + + + + Response message type for the GetNonIndexableItemStatistics web method. + + + + + + + + + + + + + + + Request type for the GetNonIndexableItemDetails web method. + + + + + + + + + + + + + + + + + + Response message type for the GetNonIndexableItemDetails web method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Request type for the GetUserRetentionPolicyTags web method. + + + + + + + + + + + Response message type for the GetUserRetentionPolicyTags web method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/ews/services.wsdl b/tests/resources/ews/services.wsdl new file mode 100644 index 0000000..5453a8d --- /dev/null +++ b/tests/resources/ews/services.wsdl @@ -0,0 +1,2776 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/ews/types.xsd b/tests/resources/ews/types.xsd new file mode 100644 index 0000000..a91d402 --- /dev/null +++ b/tests/resources/ews/types.xsd @@ -0,0 +1,9122 @@ + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + Surfaces the various logon types that are supported for conversion + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + + + + + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + + + + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + Precision for returned DateTime values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifier for a fully resolved email address + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The regular expression captures the standard representation of a GUID + + + + + + + + + Defines the well known property set ids for extended properties. + + + + + + + + + + + + + + + + + + Includes all of the extended property types that we support. Note that Error, Null, Object and Object array can not be used in restrictions, or for setting/getting values. They are only there for error reporting purposes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This type represents the property tag (MINUS the type part). There are two options for representation: 1. Hex ==> 0x3fa4 2. Decimal ==> 0-65535 + + + + + + + + + + + + + Represents an extended property. Note that there are only a couple of valid attribute combinations. Note that all occurances require the PropertyType attribute. 1. (DistinguishedPropertySetId || PropertySetId) + (PropertyName || Property Id) 2. PropertyTag + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents an extended property instance (both its path identifier along with its associated value). + + + + + + + + + + + + + + Types of compliance operation action + + + + + + + + + + + Types of sub-tree traversal for deletion and enumeration + + + + + + + + + + Types of sub-tree traversal for deletion and enumeration + + + + + + + + + Types of sub-tree traversal for deletion and enumeration + + + + + + + + + + Types of sub-tree traversal for conversations + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of conflict resolution to attempt during update + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Utility type which should never appear in user documents + + + + + + + + + URIs for the distinguished folders accessible from a mailbox + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifier for a distinguished folder + + + + + + + + + + + + + + Identifier for a fully resolved folder + + + + + + + + + + + Identifier for a address list + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Types of view filters for finding items/conversations + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compound property for Managed Folder related information for Managed Folders. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Abstract base type for item identifiers. Should never be used in web service calls + + + + + + + + + Identifier for a fully resolved item + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Internal abstract base type for reply objects. Should not appear in client code + + + + + + + + + + + + + Abstract base type for reply objects + + + + + + The name of this reply object class as an English string. The client application is required to translate it if it's running in a different locale + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Allow attributes in the soap namespace to be used here + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This max/min evaluation is applied to the field specified within the group by instance for EACH item within that group. This determines which item from each group is to be selected as the representative for that group. + + + + + + + + + + Represents the field of each item to aggregate on and the qualifier to apply to that field in determining which item will represent the group. + + + + + + + + + + + + + + + + Allows consumers to specify arbitrary groupings for FindItem queries. + + + + + + + + + + + + + + + + + + + Represents standard groupings for GroupBy queries. + + + + + + + + + Allows consumers to access standard groupings for FindItem queries. This is in contrast to the arbitrary (custom) groupings available via the t:GroupByType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Surfaces the various id types that are supported for conversion + + + + + + + + + + + + + Surfaces alternate representations of an item or folder id. No change key is included. + + + + + + + Represents an alternate mailbox folder or item Id. + + + + + + + + + + + + + Represents an alternate public folder Id. + + + + + + + + + + + Represents an alternate public folder item Id. + + + + + + + + + + + A non-empty array of alternate Ids. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A permission on a folder + + + + + + + + + + + + + + + A permission on a folder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The set of permissions on a folder + + + + + + + + + The set of permissions on a folder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the message keys that can be returned for invalid recipients + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Size range type used for the WithinSizeRange rule predicate. + + + + + + + + + Date range type used for the WithinDateRange rule predicate. + + + + + + + + + Flagged for action enumeration, currently used in FlaggedForAction rule predicate + + + + + + + + + + + + + + + + + + Rule predicates, used as rule conditions or exceptions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Rule actions + + + + + + + + + + + + + + + + + + + + Rule type + + + + + + + + + + + + + + + + Array of rule objects + + + + + + + + Rule field URI enumerates all possible rule fields that could trigger validation error + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Rule validation error code describing what failed validation for each rule predicate or action. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a single validation error on a particular rule property value, predicate property value or action property value + + + + + + + + + + + Represents an array of rule validation errors + + + + + + + + Represents a rule operation to be performed + + + + + Represents an array of rule operations to be performed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Array of search item kind enum. + + + + + + + + + User Mailbox. + + + + + + + + Array of user mailbox. + + + + + + + + + Searchable mailbox. + + + + + + + + + + + + + + + Array of searchable mailbox. + + + + + + + + + Keyword statistics search result. + + + + + + + + + + + Array of keyword statistics result. + + + + + + + + + Mailbox statistics search result. + + + + + + + + + + Extended attributes of a target mailbox. + + + + + + + + + + Array of extended attributes of a target mailbox + + + + + + + + + + + + + + + + Set of mailbox, search scope and its extended attributes. + + + + + + + + + + + Array of mailbox and its search scope. + + + + + + + + + Pair of query and a set of mailbox search scopes. + + + + + + + + + + Mailbox information for each preview item. + + + + + + + + + + Array of query and mailboxes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Mailbox search preview item. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Array of search preview item. + + + + + + + + + Mailbox failed on search and its error message. + + + + + + + + + + + + Array of failed mailbox and error message. + + + + + + + + + Mailboxes search result. + + + + + + + + + + + + + + + + + + + Search refiner item. + + + + + + + + + + + + Array of search refiner item. + + + + + + + + + + + OneDrive search result item. + + + + + + + + + + + + + File search result item. + + + + + + + + + + + + + + + + + + + + + + + + + File context properties. + + + + + + + + + + Attachment file search result properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Mailbox statistics item. + + + + + + + + + + + + Array of mailbox statistics item. + + + + + + + + + + + + + + + + + + + + + + + + + Mailbox hold status. + + + + + + + + + + + Array of mailbox hold status. + + + + + + + + + Mailbox hold result. + + + + + + + + + + + + + + + + Non indexable item statistic. + + + + + + + + + + + Array of non indexable item statistics. + + + + + + + + + + + + + + + + + + + + + Non indexable item detail. + + + + + + + + + + + + + + + + + Array of non indexable item details. + + + + + + + + + Non indexable item details result. + + + + + + + + + + Discovery search configuration. + + + + + + + + + + + + + + Array of discovery search configuration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retention policy tag. + + + + + + + + + + + + + + + + + Array of retention policy tags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A Group on the ImContactList, with one or more members + + + + + + + + + + + + + + + + + + + IM Contact List + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + List of possible reasons for disabling the client extension + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifier for a consumer calendar. This is reserved for a select number of server-2-server calls. + + + + + + + + + + + + Shared information about a consumer calendar. This is reserved for a select number of server-2-server calls. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents base unified group + + + + + + + + + + + + Represents a unified group with favorite state + + + + + + + + + + + + + + + + + + + + Represents a set of unified groups in a GetUserUnifiedGroup response + + + + + + + + + + + Represents an array of unified groups sets in a GetUserUnifiedGroups response + + + + + + + + + Represents a set of unified groups in a GetUserUnifiedGroup request + + + + + + + + + + + + Represents an array of unified groups sets in a GetUserUnifiedGroup request + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/image/ImageViewService.local.wsdl b/tests/resources/image/ImageViewService.local.wsdl new file mode 100644 index 0000000..6754a59 --- /dev/null +++ b/tests/resources/image/ImageViewService.local.wsdl @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Image retrieval service + + + + + \ No newline at end of file diff --git a/tests/resources/image/availableImagesRequest.xsd b/tests/resources/image/availableImagesRequest.xsd new file mode 100644 index 0000000..985c51c --- /dev/null +++ b/tests/resources/image/availableImagesRequest.xsd @@ -0,0 +1,20 @@ + + + Request for available images. Copyright 2007 Estes Express Lines, Inc. + + + + + + PRO is deprecated; provided for backward compatibility + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/image/availableImagesResponse.xsd b/tests/resources/image/availableImagesResponse.xsd new file mode 100644 index 0000000..4274b14 --- /dev/null +++ b/tests/resources/image/availableImagesResponse.xsd @@ -0,0 +1,28 @@ + + + Available images response. Copyright 2007 Estes Express Lines, Inc. + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/image/imageViewCommon.xsd b/tests/resources/image/imageViewCommon.xsd new file mode 100644 index 0000000..5b451b4 --- /dev/null +++ b/tests/resources/image/imageViewCommon.xsd @@ -0,0 +1,56 @@ + + + Common elements for image retrieval service. Copyright 2007 Estes Express Lines, Inc. + + + + Document type code + + + + + + + + + + + + + PRO is 10 digits or 11 digits with dash. + + + + + + + + + + + + + + + + + Generic search criteria for image search + + + + + + + + + + + + Image search item + + + + + + + \ No newline at end of file diff --git a/tests/resources/image/imagesRequest.xsd b/tests/resources/image/imagesRequest.xsd new file mode 100644 index 0000000..63e77c6 --- /dev/null +++ b/tests/resources/image/imagesRequest.xsd @@ -0,0 +1,21 @@ + + + Request for document images. Copyright 2007 Estes Express Lines, Inc. + + + + + + PRO is deprecated; provided for backward compatibility + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/image/imagesResponse.xsd b/tests/resources/image/imagesResponse.xsd new file mode 100644 index 0000000..2490cab --- /dev/null +++ b/tests/resources/image/imagesResponse.xsd @@ -0,0 +1,32 @@ + + + Document images response. Copyright 2007 Estes Express Lines, Inc. + + + + + + + + + + + + + + + + + + + + + + + Image file name and Base64 encoded binary source data + + + + + + \ No newline at end of file diff --git a/tests/resources/numeric_enumeration.xml b/tests/resources/numeric_enumeration.xml new file mode 100644 index 0000000..9562e67 --- /dev/null +++ b/tests/resources/numeric_enumeration.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/odigeo.wsdl b/tests/resources/odigeo.wsdl new file mode 100644 index 0000000..9144961 --- /dev/null +++ b/tests/resources/odigeo.wsdl @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.0.xsd b/tests/resources/partner/PartnerService.0.xsd new file mode 100644 index 0000000..d596f31 --- /dev/null +++ b/tests/resources/partner/PartnerService.0.xsd @@ -0,0 +1,157 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.1.xsd b/tests/resources/partner/PartnerService.1.xsd new file mode 100644 index 0000000..f687a06 --- /dev/null +++ b/tests/resources/partner/PartnerService.1.xsd @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.10.xsd b/tests/resources/partner/PartnerService.10.xsd new file mode 100644 index 0000000..5ca3b31 --- /dev/null +++ b/tests/resources/partner/PartnerService.10.xsd @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.11.xsd b/tests/resources/partner/PartnerService.11.xsd new file mode 100644 index 0000000..30e7665 --- /dev/null +++ b/tests/resources/partner/PartnerService.11.xsd @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.12.xsd b/tests/resources/partner/PartnerService.12.xsd new file mode 100644 index 0000000..3d1d825 --- /dev/null +++ b/tests/resources/partner/PartnerService.12.xsd @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.13.xsd b/tests/resources/partner/PartnerService.13.xsd new file mode 100644 index 0000000..e0a5d8c --- /dev/null +++ b/tests/resources/partner/PartnerService.13.xsd @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.14.xsd b/tests/resources/partner/PartnerService.14.xsd new file mode 100644 index 0000000..f5f6718 --- /dev/null +++ b/tests/resources/partner/PartnerService.14.xsd @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.15.xsd b/tests/resources/partner/PartnerService.15.xsd new file mode 100644 index 0000000..100f18c --- /dev/null +++ b/tests/resources/partner/PartnerService.15.xsd @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.16.xsd b/tests/resources/partner/PartnerService.16.xsd new file mode 100644 index 0000000..ba58a92 --- /dev/null +++ b/tests/resources/partner/PartnerService.16.xsd @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.17.xsd b/tests/resources/partner/PartnerService.17.xsd new file mode 100644 index 0000000..566460a --- /dev/null +++ b/tests/resources/partner/PartnerService.17.xsd @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.18.xsd b/tests/resources/partner/PartnerService.18.xsd new file mode 100644 index 0000000..35fcb79 --- /dev/null +++ b/tests/resources/partner/PartnerService.18.xsd @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.2.xsd b/tests/resources/partner/PartnerService.2.xsd new file mode 100644 index 0000000..a5f958a --- /dev/null +++ b/tests/resources/partner/PartnerService.2.xsd @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.3.xsd b/tests/resources/partner/PartnerService.3.xsd new file mode 100644 index 0000000..ecc2af2 --- /dev/null +++ b/tests/resources/partner/PartnerService.3.xsd @@ -0,0 +1,131 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.4.xsd b/tests/resources/partner/PartnerService.4.xsd new file mode 100644 index 0000000..630617e --- /dev/null +++ b/tests/resources/partner/PartnerService.4.xsd @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.5.xsd b/tests/resources/partner/PartnerService.5.xsd new file mode 100644 index 0000000..c397caf --- /dev/null +++ b/tests/resources/partner/PartnerService.5.xsd @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.6.xsd b/tests/resources/partner/PartnerService.6.xsd new file mode 100644 index 0000000..6ee00b1 --- /dev/null +++ b/tests/resources/partner/PartnerService.6.xsd @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.7.xsd b/tests/resources/partner/PartnerService.7.xsd new file mode 100644 index 0000000..cf7b282 --- /dev/null +++ b/tests/resources/partner/PartnerService.7.xsd @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.8.xsd b/tests/resources/partner/PartnerService.8.xsd new file mode 100644 index 0000000..7eef71a --- /dev/null +++ b/tests/resources/partner/PartnerService.8.xsd @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.9.xsd b/tests/resources/partner/PartnerService.9.xsd new file mode 100644 index 0000000..754a9f3 --- /dev/null +++ b/tests/resources/partner/PartnerService.9.xsd @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tests/resources/partner/PartnerService.local.wsdl b/tests/resources/partner/PartnerService.local.wsdl new file mode 100644 index 0000000..ab39433 --- /dev/null +++ b/tests/resources/partner/PartnerService.local.wsdl @@ -0,0 +1,357 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + http://secapp.euroconsumers.org/partnerservice/PartnerService.svc/WS + + + + diff --git a/tests/resources/whl.wsdl b/tests/resources/whl.wsdl new file mode 100644 index 0000000..31bf1eb --- /dev/null +++ b/tests/resources/whl.wsdl @@ -0,0 +1,5459 @@ + + + WHL WSDL document + + + + + Used for codes in the OpenTravel Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. + + + + + + + + + + Used for Character Strings, length 1 to 64. + + + + + + + + + Used for Character Strings, length 0 to 128. + + + + + + + + + Used for Character Strings, length 1 to 128. + + + + + + + + + Used for Character Strings, length 1 to 32. + + + + + + + + + Used for Character Strings, length 0 to 32. + + + + + + + + + Used for Character Strings, length 1 to 16. + + + + + + + + + Used for Character Strings, length 0 to 64. + + + + + + + + + Specifies a 2 character country code as defined in ISO3166. + + + + + + + + Used for an Alpha String, length exactly 3. + + + + + + + + Used for an Upper Alpha String and Numeric, length 2 to 3. + + + + + + + + Used for an Upper Alpha String and Numeric, length 3 to 5. + + + + + + + + Used for Strings, length exactly 3. + + + + + + + + + Used for Character Strings, length 1 to 8. + + + + + + + + + Specifies an amount, max 3 decimals. + + + + + + + + Defines the unit in which the time is expressed (e.g. year, day, hour). + + + + + + + + + + + + + + + Used for Numeric values, from 0 to 999 inclusive. + + + + + + + + + Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). + + + + + + + + + + Used for percentage values. + + + + + + + + + The Reference Place Holder (RPH) is an index code used to identify an instance in a collection of like items (e.g. used to assign individual passengers or clients to particular itinerary items). + + + + + + + + Used for Character Strings, length 1 to 255. + + + + + + + + + The standard code or abbreviation for the state, province, or region. + + + + + + + + Used for Numeric Strings length 1 to 3. + + + + + + + + Used for Numeric Strings, length 1 to 5. + + + + + + + + The 2 digit code that identifies the credit card. + + + + + + + American Express + + + + + Bank Card + + + + + Carte Bleu + + + + + Carte Blanche + + + + + Diners Club + + + + + Discover Card + + + + + Eurocard + + + + + Japanese Credit Bureau Credit Card + + + + + Maestro + + + + + Master Card + + + + + + Universal Air Travel Card + + + + + + Visa + + + + + + + + This is intended to be used when the above enumeration list does not meet your needs. + + + + + + + + Used for an Alpha String, length 1 to 2 (for letter codes). + + + + + + + + Used for Numeric Strings, length 1 to 19. + + + + + + + + Month and year information. + + + + + + + + Used for Numeric Strings, length 1 to 8. + + + + + + + + Used forAlpha-Numeric Strings, length 1 to 19. + + + + + + + + Used for Numeric values, from 1 to 999 inclusive. + + + + + + + + + Allows for the specification of a date time or just time. + + + + + + A construct to validate either a date or a time or a dateTime value. + + + + + + Allows for the specification of a night duration. + + + + + + Provides the ability to define a duration in terms of nights rather than days. + + + + + + + + An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. + + + + + + + + + + + + An enumerated type indicating special conditions with the rate Valid values: ChangeDuringStay, MultipleNights, Exclusive, OnRequest, LimitedAvailability. + + + + + + + Availability is limited based on guest qualification criteria e.g. AAA member or Government Employee + + + + + + + + + + Indicates an issue that precluded the ability to provide the information. + + + + + + + + + Availability is limited based on distribution channel qualification criteria (e.g., Expedia or Sabre). + + + + + The rate plan does not exist. + + + + + + + Identifies the availability status of an item. + + + + + Inventory is available for sale. + + + + + Inventory is not available for sale. + + + + + Inventory is not available for sale to arriving guests. + + + + + Inventory may not be available for sale to arriving guests. + + + + + Inventory may be available. + + + + + Remove Close restriction while keeping other restrictions in place. + + + + + + + + To specify the type of action requested when more than one function could be handled by the message. + + + + + + + + + + + + + Commit the transaction and override the end transaction edits. + + + + + + Perform a price verification. + + + + + A ticket for an event, such as a show or theme park. + + + + + + + Statuses that exist in a property management system (PMS). + + + + + The reservation has been reserved. + + + + + The reservation has been requested but has not yet been reserved. + + + + + The request for the reservation has been denied. + + + + + This reservation is in "no show" status. Typically this means the person for whom this reservation belonged did not check in and the reservation was moved to "no show" status. + + + + + This reservation has been cancelled. + + + + + This reservation has been check in, and is in "in-house" status. + + + + + The guest has checked out and the reservation has been changed to "Checked out" status + + + + + This reservation is in waitlist status and the reservation has not been confirmed. + + + + + + + A union between TransactionActionType and PMS_ResStatusType. Used in messages that communicate between reservation systems as well as between a reservation and property management system. In addition to the TransactionActionType and PMS_ResStatusType, the UpperCaseAlphaLength1to2 may be used for company specifc codes. + + + + + + To specify a status to the transaction, usually in the response message, of the action specifed in the request message. + + + + + + + + + + + + The item that is pending cancellation. + + + + + Purchase of the item is pending. + + + + + The item has been requested. + + + + + The item is reserved. + + + + + The item is not changed due to the most recent action. + + + + + Request denied. + + + + + The item has been ticketed. + + + + + + + + Used to identify an application error by either text, code, or by an online description and also to give the status, tag, and/or identification of the record that may have caused the error. + + + + An abbreviated version of the error in textual format. + + + + + If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR). + + + + + + Identifies language. + + + + The language ID for the associated content. + + + + + + Identifes the primary language preference for the message. + + + + Identifies the primary language preference for the message. The human language is identified by ISO 639 codes. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel messages. + + + + A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. + + + + + Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z). + + + + + Used to indicate whether the request is for the Test or Production system. + + Production + + + + + + + A test system. + + + + + A production system. + + + + + + + + For all OpenTravel versioned messages, the version of the message is indicated by a decimal value. + + + + + Identifes the primary language for the message. + + + + + + Provides detailed information on a company. + + + + Used to provide the company common name. + + + + + Identifies a company by the company code. + + + + + + Provides unique identification information. + + + + URL that identifies the location associated with the record identified by the UniqueID. + + + + + A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). + + + + + Used to provide a required unique identifier. + + + + + Used to identify the source of the identifier (e.g., IATA, ABTA). + + + + + + Used to provide a required unique identifier. + + + + A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + Used to specify the geographic coordinates of a location. + + + + The measure of the angular distance on a meridian north or south of the equator. + + + + + The measure of the angular distance on a meridian east or west of the prime meridian. + + + + + The height of an item, typically above sea level. + + + + + Provides the unit of measure for the altitude (e.g., feet, meters, miles, kilometers). Refer to OpenTravel Code List Unit of Measure Code (UOM). + + + + + Indicates the accuracy of the property’s geo-coding, since the property’s longitude and latitude may not always be exact. Refer to OpenTravel Code List Position Accuracy Code (PAC). + + + + + + Specifies the booking channel types and whether it is the primary means of connectivity of the source. + + + + The type of booking channel (e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), Sales and Catering System (SCS), Property Management System (PMS), Central Reservation System (CRS), Tour Operator System (TOS), Internet and ALL). Refer to OpenTravel Code List Booking Channel Type (BCT). + + + + + Indicates whether the enumerated booking channel is the primary means of connectivity used by the source. + + + + + + An attribute group to be used when the associated item has a required name and an optional code. If the length of the name could exceed 64 characters the complexType LongNameoptionalCodeType should be used. + + + + The name of an item. + + + + + Provides the code identifying the item. + + + + + + This is intended to be used in conjunction with an attribute that uses an OpenTravel Code list. It is used to provide additional information about the code being referenced. + May be used to give further detail on the code or to remove an obsolete item. + + + + May be used to give further detail on the code. + + + + + + The absolute deadline or amount of offset time before a deadline for a payment of cancel goes into effect. + + + + The units of time, e.g.: days, hours, etc., that apply to the deadline. + + + + + The number of units of DeadlineTimeUnit. + + + + + An enumerated type indicating when the deadline drop time goes into effect. + + + + + + + + The deadline information applies from when the reservation was confirmed. In some systems the confirmation time will differ from the booking time. + + + + + The deadline applies after the scheduled arrival time. + + + + + + + + + Defines the fees and/or taxes associated with a charge (e.g. taxes associated with a hotel rate). + + + + Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). + + + + + Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). + + + + + Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). + + + + + Provides a currency code and an amount for the fee or tax. + + + + + + Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed. + + + + A monetary amount. + + + + + Provides a currency code to reflect the currency in which an amount may be expressed as well as the number of decimal places of that currency. + + + + + + Provides a currency code to reflect the currency in which an amount may be expressed. + + + + The code specifying a monetary unit. Use ISO 4217, three alpha code. + + + + + Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces="2" to represent $85). + + + + + + Name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization, etc.). + + + + Code of bank issuing the card. + + + + + + Identifies if the associated data is formatted into its individual pieces, or exists as a single entity. + + + + Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. + + + + + + Allows for control of the sharing of data between parties. + + + + Permission for sharing data for synchronization of information held by other travel service providers. + + + + If the value=Inherit, specifies data sharing permissions for synchronization of information held by other travel service providers. + + + + + + + + + + + Permission for sharing data for marketing purposes. + + + + If the value=Inherit, specifies data sharing permissions for marketing purposes. + + + + + + + + + + + + Provides telephone information details. + + + + Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). + + + + + Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). + + + + + Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT). + + + + + Code assigned by telecommunications authorities for international country access identifier. + + + + + Code assigned for telephones in a specific region, city, or area. + + + + + Telephone number assigned to a single location. + + + + + Extension to reach a specific party at the phone number. + + + + + Additional codes used for pager or telephone access rights. + + + + + A remark associated with the telephone number. + + + + + + Detailed telephone information. + + + + Allows for control of the sharing of telephone information between parties. + + + + + Provides telephone information details. + + + + + Identifies if the associated data is formatted into its individual pieces, or exists as a single entity. + + + + + + Information about a telephone number, including the actual number and its usage. + + + + Detailed telephone information. + + + + + + Indicates that the receiving system should assume the default value if the user specifies no overriding value or action. + + + + When true, indicates a default value should be used. + + + + + + Indicates the start and end date for a payment card. + + + + Indicates the starting date. + + + + + Indicates the ending date. + + + + + + Used to indicate the gender of a person, if known. + + + + Identifies the gender. + + + + + + + + + + + + + Specific information about a multimedia item. + + + + Identifies the language of the multimedia item. + + + + + The code associated with the format of the multimedia item. Refer to OpenTravel Code list Content Format Code (CFC). + + + + + The size of the multimedia file in bytes. + + + + + The name of the multimedia file. + + + + + + Generic information about a multimedia item. + + + + The content ID of a file attachment with the prefix 'cid:'. The value of this can be used to retrieve the corresponding attachment by the receiving system. + + + + + The title of the multimedia object. + + + + + The author of the multimedia object. + + + + + A copyright notice for the multimedia object. + + + + + Owner of the copyright for the multimedia content. + + + + + + Used to define a room (eg. its location, configuration, view). + + + + (Formerly, RoomInventoryCode) A code value that indicates the type of room for which this request is made, e.g.: double, king, etc. Values may use the Hotel Descriptive Content table or a codes specific to the property or hotel brand. + + + + + A string value representing the unique identification of a room if the request is looking for a specific room. + + + + + Bed Type. + + + + + + Used to provide an optional unique identifier. + + + + A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay). + + + + This is the unit for which the charge applies (e.g. room, person, seat). Refer to OpenTravel Code List Charge Type (CHG). + + + + + This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG). + + + + + Number of units permitted before charges are applied (e.g., more than 4 persons). + + + + + ChargeFrequency exemptions before charges are applied (e.g. after 2 nights). + + + + + + The attributes of the OTA DateTimeSpan data type are based on the W3C base data types of timeInstant and timeDuration. The lexical representation for timeDuration is the [ISO 8601] extended format PnYn MnDTnH nMnS, where nY represents the number of years, nM the number of months, nD the number of days, T is the date/time separator, nH the number of hours, nM the number of minutes and nS the number of seconds. The number of seconds can include decimal digits to arbitrary precision. As an example, 7 months, 2 days, 2hours and 30 minutes would be expressed as P0Y7M2DT2H30M0S. Truncated representations are allowed provided they conform to ISO 8601 format. Time periods, i.e. specific durations of time, can be represented by supplying two items of information: a start instant and a duration or a start instant and an end instant or an end instant and a duration. The OTA standards use the XML mapping that provides for two elements to represent + the specific period of time; a startInstant and a duration. + + + + The starting value of the time span. + + + + + The duration datatype represents a combination of year, month, day and time values representing a single duration of time, encoded as a single string. + + + + + The ending value of the time span. + + + + + + Defines the number of guests. + + + + A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). + + + + + Defines the age of a guest. + + + + + The number of guests in one AgeQualifyingCode or Count. + + + + + + + Used to provide a date of birth. + + + + Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format. + + + + + + Used to specify a profile type. + + + + Code to specify a profile such as Customer, Tour Operator, Corporation, etc. Refer to OpenTravel Code List Profile Type (PRT). + + + + + + Name of the (self-professed) country that is claimed for citizenship. + + + + Indicates that the receiving system should assume the default value if the user specifies no overriding value or action. + + + + + A 2 character country code as defined in ISO3166. + + + + + + + Textual information to provide descriptions and/or additional information. + + + + + + Language of the text. + + + + + + + + Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. + + + + + + The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT). + + + + + Details of the error. + + + + + + + + A collection of errors that occurred during the processing of a message. + + + + + An error that occurred during the processing of a message. + + + + + + + Used when a message has been successfully processed to report any warnings or business errors that occurred. + + + + + + The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT). + + + + + Details of the warning. + + + + + + + + Collection of warnings. + + + + + Used in conjunction with the Success element to define a business error. + + + + + + + Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with the Warning Type to report any warnings or business errors. + + + + + Identifies a company by name. + + + + + + Provides detailed information on a company. + + + + + + + + An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). + + + + + Identifies the company that is associated with the UniqueID. + + + + + + + + Information to acknowledge the receipt of a message. + + + + + + + Returning an empty element of this type indicates the successful processing of an OpenTravel message. This is used in conjunction with Warnings to report any warnings or business errors. + + + + + Used when a message has been successfully processed to report any warnings or business errors that occurred. + + + + + + Indicates an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. + + + + + + May be used to return the unique id from the request message. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + Point of Sale (POS) identifies the party or connection channel making the request. + + + + + This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. + + + + + + + Provides information on the source of a request. + + + + + An identifier of the entity making the request (e.g. ATA/IATA/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents.(ABTA)). + + + + + + + This password provides an additional level of security that the recipient can use to validate the sending party's authority to use the message. + + + + + + + + + Specifies the booking channel type and whether it is the primary means of connectivity of the source. + + + + + + Identifies the company that is associated with the booking channel. + + + + + + Specifies the booking channel type and whether it is the primary means of connectivity of the source. + + + + + + + + The currency code in which the reservation will be ticketed. + + + + + + The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller). + + + + + + ISO 3166 code for a country. + + + + + Unique ID of the country + + + + + + + + A collection of errors that occurred during the processing of a message. + + + + + The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller). + + + + + + + The name, id, and country id of a destination. + + + + + + ID of Destination. + + + + + Country ID that the destination belongs to. + + + + + + + + A collection of destinations in the whole network or of a particular country. + + + + + A destination information. + + + + + + + Provides text and indicates whether it is formatted or not. + + + + + + Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text. + + + + + Indicates the format of text used in the description e.g. unformatted or html. + + + + + + Textual data that is in ASCII format. + + + + + HTML formatted text. + + + + + + + + Indicates the name for of text information. + + + + + + + + An indication of a new paragraph for a sub-section of a formatted text message. + + + + + Formatted text content. + + + + + An image for this paragraph. + + + + + A URL for this paragraph. + + + + + Formatted text content and an associated item or sequence number. + + + + + + + The item or sequence number. + + + + + + + + + + + A collection of taxes. + + + + + An individual tax. + + + + + + Used to provide a total of all the taxes. + + + + + + Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. + + + + + Text description of the taxes in a given language. + + + + + + Provides details of the tax. + + + + + + Used to define the types of payments accepted. + + + + + An acceptable form of payment. + + + + + + + Ways of providing funds and guarantees for travel by the individual. + + + + + Details of a debit or credit card. + + + + + Details of a bank account. + + + + + Details of a direct billing arrangement. + + + + + Used to indicate payment in cash. + + + + + If true, this indicates cash is being used. + + true + + + + + + + + + Provides a reference to a specific form of payment. + + + + + + Identification about a specific credit card. + + + + + Name of the card holder. + + + + + Issuer of the card. + + + + + Name of bank or organization issuing the card (e.g., alumni association, bank, fraternal organization). + + + + + + + Card holder's address used for additional authorization checks. + + + + + Card holder's telephone number used for additional authorization checks. + + + + + Used to provide phone numbers for a card holder. + + + + + + + Card holder's email address(es) used for additional authorization checks. + + + + + + Allows for control of the sharing of payment card data between parties. + + + + + Indicates the type of magnetic striped card. Refer to OpenTravel Code List Card Type (CDT). + + + + + The 2 character code of the credit card issuer. + + + + + The name of card. + + + + + Credit card number embossed on the card. + + + + + Verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2 ), card validation code number (CVC2) on credit card. + + + + + Date the card becomes valid for use (optional) and the date the card expires (required) in ISO 8601 prescribed format. + + + + + May be used to send a concealed credit card number (e.g., xxxxxxxxxxxx9922). + + + + + Provides a reference pointer that links the payment card to the payment card holder. + + + + + Code for the country where the credit card was issued. + + + + + A remark associated with this payment card. + + + + + + Provides address information. + + + + + May contain the street number and optionally the street name. + + + + + + + Usually a letter right after the street number (A in 66-A, B in 123-B etc). + + + + + Street direction of an address (e.g., N, E, S, NW, SW). + + + + + Numerical equivalent of a rural township as defined within a given area (e.g., 12, 99). + + + + + + + + + When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. + + + + + City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). + + + + + Post Office Code number. + + + + + County or Region Name (e.g., Fairfax). + + + + + State or Province name (e.g., Texas). + + + + + Country name (e.g., Ireland). + + + + + + Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. + + + + + Allows for control of the sharing of address information between parties. + + + + + Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). + + + + + A remark associated with this address. + + + + + + State, province, or region name or code needed to identify location. + + + + + + The standard code or abbreviation for the state, province, or region. + + + + + + + + Electronic email addresses, in IETF specified format. + + + + + + Allows for control of the sharing of email information between parties. + + + + + Identifies whether or not this is the default email address. + + + + + Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). + + + + + A remark associated with the e-mail address. + + + + + + + + Customer bank accounts for payments, either for paper checks or electronic funds transfer. + + + + + The name the account is held under. + + + + + + Allows for control of the sharing of bank account information between parties. + + + + + Code assigned by authorities to financial institutions; sometimes called bank routing number. + + + + + Describes the bank account used for financing travel (e.g., checking, savings, investment). + + + + + Identifier for the account assigned by the bank. + + + + + If true, checks are accepted. If false, checks are not accepted. + + + + + The number of the check used for payment. + + + + + + Company name and location for sending invoice for remittances for travel services. + + + + + Company name to whom remittance should be directed. + + + + + + + This may be used to pass the name of the contact at the company for which the direct bill applies. + + + + + + + + + Address where remittance should be directed. + + + + + Email address to which remittance should be directed. + + + + + Telephone number associated with company to whom remittance is being directed. + + + + + Information about a telephone number, including the actual number and its usage. + + + + + + + + Allows for control of the sharing of direct bill data between parties. + + + + + Identifier for the organization to be billed directly for travel services. + + + + + The number assigned by the subscriber for billing reconciliation of a corporate account. + + + + + + Information about an address that identifies a location for a specific purposes. + + + + + + Indicates whether or not this is the default address. + + + + + Describes the use of the address (e.g. mailing, delivery, billing, etc.). Refer to OpenTravel Code List Address Use Type (AUT). + + + + + Used elsewhere in the message to reference this specific address. + + + + + + + + Used for non-tax fees and charges (e.g. service charges) . + + + + + Used for taxes on the associated fee. + + + + + Text description of the fees in a given language. + + + + + + Indicates whether taxes are included when figuring the fees. + + + + + Provides details of the fee. + + + + + When true, indicates the fee is mandatory. When false, the fee is not mandatory. + + + + + An index code to identify an instance in a collection of like items. + + + + + Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay). + + + + + When true, indicates that the fee is subject to tax. + + + + + + A collection of fees. + + + + + Fee Amount that is applied to the rate. Fees are used for non tax amounts like service charges. + + + + + + + This provides name information for a person. + + + + + Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) + + + + + Given name, first name or names. + + + + + The middle name of the person name. + + + + + The surname prefix, e.g "van der", "von", "de". + + + + + Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. + + + + + Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) + + + + + Degree or honors (e.g., Ph.D., M.D.) + + + + + + Allows for control of the sharing of person name data between parties. + + + + + Type of name of the individual, such as former, nickname, alternate or alias name. Refer to OpenTravel Code List Name Type (NAM). + + + + + + Web site address, in IETF specified format. + + + + + + Allows for control of the sharing of URL data between parties. + + + + + Defines the purpose of the URL address, such as personal, business, public, etc. + + + + + Indicates whether or not this is the default URL. + + + + + + + + Contains multimedia item(s). + + + + + A multimedia item. + + + + + + + Describes multimedia item(s). + + + + + A collection of video items. + + + + + A collection of image items. + + + + + A collection of text items. + + + + + + Image category: Photo Gallery/Facilities Photo/Host Photo + + + + + Collection ID. A unique identifying value assigned by the creating system. + + + + + Collection Name + + + + + + Collection of video items. + + + + + Each video item represents a specific category. + + + + + + + The language associated with the caption for the video. + + + + + The caption associated to a specific video category which can be provided in different languages. + + + + + + + + + + + Describes a video item. + + + + + A set of video of a given category can be provided in different Format, each format will be described in this element. + + + + + + + Multimedia information for the video file. + + + + + A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + Details for a video of a given category. + + + + + URL of the multimedia item for a specific format. + + + + + + The unit of measure associated with all the dimensions of the multimedia item. Refer to OpenTravel Code list Unit of Measure (UOM). + + + + + The width of the video item (unit specified by unit of measure). + + + + + The height of the video item (unit specified by unit of measure). + + + + + The bit rate of the video item. + + + + + The length of the video item (unit specified by unit of measure). + + + + + Multimedia information for the video item. + + + + + + Collection of image items. + + + + + Image of a given category. + + + + + + + A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + Describes an image item. + + + + + A set of images for a given category which may be provided in multiple formats. + + + + + + + Detailed information about an image. + + + + + The language in which the image text is provided. + + + + + Identifies the format of an image. Refer to OpenTravel Code List Content Format Code (CFC). + + + + + The name of the image file. + + + + + The size of the image file. + + + + + Associates the image size to a given category (e.g., 70x70, 100x100, 480x480, thumbnail). For example, if an image with a dimension of 72x73 is sent, it may be categorized as a 70x70 image. + + + + + + + + + The description associated with the image in a specific language. + + + + + + + The caption associated to a specific image category which can be provided in different languages. + + + + + + + + + + + Details for an image of a given category. + + + + + URL of the multimedia item for a specific format. + + + + + + The unit of measure for the image item. Refer to OpenTravel Code list Unit of Measure (UOM). + + + + + The width of the image item (unit specified by unit of measure). + + + + + The height of the image item (unit specified by unit of measure). + + + + + + Describes a text item. + + + + + The URL for a specific text item. + + + + + The text in a specific language. + + + + + + + Sequence number associated with this description. + + + + + + + + + + Generic information about the text multimedia item. + + + + + + Street name; number on street. + + + + + + Defines a Post Office Box number. + + + + + + + + Collection of text items. + + + + + Text description of a given category. + + + + + + + + + + + + + Used to specify a time window range by either specifying an earliest and latest date for the start date and end date or by giving a date with a time period that can be applied before and/or after the start date. + + + + Defines the date and/or time span. + + + + + + The total amount charged for the service including additional amounts and fees. + + + + + A collection of taxes. + + + + + + The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). + + + + + The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). + + + + + + When true, amounts do not contain additional fees or charges. + + + + + Type of charge. Refer to OpenTravel Code List Charge Type (CHG). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. + + + + + Detailed name information for the customer. + + + + + Information on a telephone number for the customer. + + + + + Information about a telephone number, including the actual number and its usage. + + + + + + + Information on an email address for the customer. + + + + + + + + + + + Detailed information on an address for the customer. + + + + + + + + Identifies a company. + + + + + Name of the person to whom this address relates. + + + + + + + + + + Information on a URL for the customer. + + + + + + + + + + + Name of the (self-professed) country that is claimed for citizenship. + + + + + Name of the (self-professed) country that is claimed for citizenship. + + + + + + + + Identifies the gender of the customer. + + + + + Identifies the birth date of the customer. + + + + + Type of funds preferred for reviewing monetary values, in ISO 4217 codes. + + + + + + A collection of SpecialRequest objects. The collection of all special requests associated with any part of the reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which special requests belong to which part is determined by each object's SpecialRequestRPHs collection. + + + + + The SpecialRequest object indicates special requests for a particular guest, service or reservation. Each of these may be independent of any that are tied to the profile (see Profile Synchronization standard). + + + + + + + + + + + + + A collection of Profile objects or Unique IDs of Profiles. + + + + + A collection of Profiles or Unique IDs of Profiles. + + + + + + Provides detailed information regarding either a company or a customer profile. + + + + + + + + + + Root element for profile content. + + + + + Detailed customer information for this profile. + + + + + + Used to specify a profile type. + + + + + A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). + + + + + + + + HotelReference: The hotel reference identifies a specific hotel by using the Chain Code, the Brand Code, and the Hotel Code. The codes used are agreed upon by trading partners. + + + + The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. + + + + + A text field used to communicate the proper name of the hotel. + + + + + + Describes the status of a restriction on a room and/or rate. + + + + + + + + + + + + + + + + + Used to define the inventory code. + + + + A value that indicates the type of inventory for which this request is made. If the inventory item is a room, typical values could be double, king, etc. + + + + + Specific system inventory type code. If the inventory item is a room, typical values could be room type code, e.g.: A1K, A1Q etc. Values may use the OpenTravel Code list or a code specific to the property or hotel brand. + + + + + Simple indicator to detect if inventory is a room. + + + + + + The RatePlanCode assigned by the receiving system for the inventory item in response to a new rate plan notification. (Implementation Notes: This would only be returned when the notification is of type New and the sender is translating RatePlanCode values. On subsequent transactions for this rate plan, the sender would populate the RatePlanCode attribute with this value returned by the receiver.) + + + + A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, a corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate. + + + + + + Used to indicate to which block codes/rate plans/inventory codes a status should be applied. + + + + + + + + A collection of hotels. + + + + + A colleciton of hotels. + + + + + + + A hotel service or amenity available to the guest such as a business center, concierge, valet parking, massage, newspapers, etc. + + + + + + Refer to OpenTravel Code List Hotel Amenity Code (HAC). + + + + + May be used to give further detail on the code. + + + + + + + + Language details pertaining to the hotel. + + + + + + Language spoken by the hotel staff. + + + + + + + + Collection of language details pertaining to the hotel. + + + + + Language spoken by the staff. + + + + + + + Used to define specific hotel information such as the type, location and architectural style. + + + + + Defines the type of hotel such as luxury, extended stay, economy. + + + + + Refer to OpenTravel Code List Segment Category Code (SEG). + + + + + May be used to give further detail on the code or to remove an obsolete item. + + + + + + + Defines the particular type of hotel (e.g., golf, ski, bed and breakfast). + + + + + Refer to OpenTravel Code List Property Class Type (PCT). + + + + + May be used to give further detail on the code or to remove an obsolete item. + + + + + + + + + General information of hotel: Unique ID, Name, Category, Type, Room Category, ... + + + + + The full name of the hotel. + + + + + + + Concise hotel name + + + + + + + + + Collection of descriptive details about a hotel. + + + + + Collection of hotel and/or renovation information. + + + + + + Short Descriptive text that describes the hotel. + + + + + Full descripotion that describes the hotel. + + + + + Hotel location description. + + + + + Getting there information + + + + + Getting there information (local language). + + + + + Room Genneral Introduction. + + + + + Hotel Disclosures. + + + + + Facilities Description. + + + + + Booking notes. + + + + + Photo gallery introduction + + + + + + + + Describes the geocoded location of the hotel. + + + + + + + + Collection of hotel services and/or amenities available to the guest. + + + + + + + + + + Collection of language details pertaining to the hotel. + + + + + The lowest amount for which this derived rate plan should be sold. + + + + + An image thumbnail of hotel. + + + + + Provides information pertaining to the hotel facitilty itself. + + + + + Host information. + + + + + + Host Title + + + + + Host introduction. + + + + + + + + Caring for destination information. + + + + + + What is/are the main area of focus?(what the accm. Provider is supporting the tourism). + + + + + Commitment / Implementation. + + + + + + Sustainability Rating. + + + + + Third party verification. + + + + + + + + The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. + + + + + Hotel Category. hotel / self-catering. + + + + + Hotel Type: budget, midrange, topend. + + + + + Star Rating of Hotel. + + + + + + The CancelPenalty final class defines the cancellation policy of the hotel facility. + + + + + Cancellation deadline, absolute or relative. + + + + + The absolute deadline or amount of offset time before a deadline for a payment of cancel goes into effect. + + + + + + + Text description of the Penalty in a given language. + + + + + + + Defines the percentage basis for calculating the fee amount or the amount. + + + + + A collection of taxes. + + + + + + Indicates whether taxes are included when figuring the base amount. + + + + + The percentage used to calculate the amount. + + + + + Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed. + + + + + + A collection of required payments. + + + + + Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. + + + + + + Collection of forms of payment accepted for payment. + + + + + Payment expressed as a fixed amount, or a percentage of/or room nights. + + + + + + + + + + + GuaranteeType: GuaranteeType An enumerated type defining the guarantee to be applied to this reservation. + + + + + + + + + + + Indicates prepayment, typically this means payment is required at booking. + + + + + + + + + + + + Describes the policies of the hotel, such as the type of payments, or whether children or pets are accepted. + + + + + Describes the policies of the hotel, such as the type of payments, or whether children or pets are accepted. + + + + + + Defines the cancellation policy of the hotel facility. + + + + + A collection of deposit policies, guarantees policy, and/or accepted forms of payment. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides additional information regarding policy information. + + + + + + The usual check-in time for the hotel. + + + + + The usual check-out time for the hotel. + + + + + + + + + + + + + + Type of value that tax will apply on (Price value: 0, Cost value: 1) + + + + + + + + + + + + Used to define the property's high-level commission policy. + + + + + + + Specifies whether commissions apply to all, none, or some rates. + + + + + + All rates are commissionable. + + + + + No rates are commissionable. + + + + + Some rates are commissionable. + + + + + + + + + + + + A collection of fees that may apply to a reservation. + + + + + + A fee that may apply to a reservation. Fees are used for non tax amounts like service charges. + + + + + + + + + + + + + The HotelDescriptiveContent element contains the descriptive information about a hotel property. + + + + + Contains descriptive information about a hotel. + + + + + Provides information pertaining to the hotel facitilty itself. + + + + + A collection of policy information as it applies to the hotel. + + + + + + + + + + Provides information on area attractions, recreations and reference points. + + + + + Multimedia information about a collection of multimedia objects. + + + + + Provides contact information. + + + + + + + Describes the local time zone in which the hotel is located. This could include additional information regarding time zones (e.g., Daylight Saving Time observed), a proprietary code, the difference between the local time and GMT. + + + + + + A collection of ContactInfo elements that provides detailed contact information. + + + + + Used to define specific contact information such as phone and address. + + + + + + + The ContactInfo final class is used to define the contacts for consumers and technical people at the hotel facility, including various telephone numbers and e-mail addresses, or any respective attribute or affiliation for the hotel. + + + + + + This is a profile identifier for the contact, the type may be defined by the ContactProfileType. + + + + + This defines what type of ContactProfileID is being provided (e.g. IATA, chain specific, etc.) + + + + + The date and time when the contact information for this hotel was last updated. + + + + + + + + Allows multiple pieces of information to be repeated for a single contact (e.g. one employee has mutliple e-mail addresses) and also allows multiple contacts to be associated to a single or multiple piece of information (e.g. all employees working in a restaurant can be reached at the same phone number). + + + + + A collection of Name elements. + + + + + A collection of Address elements. + + + + + A collection of Phone elements. + + + + + A collection of email elements. + + + + + A collection of URL elements. Used to pass detailed URL information + + + + + The name of the company with which this contact is associated. + + + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + The location of the contact (e.g., at a hotel property, at a central office). Refer to OpenTravel Code List Contact Location (CON). + + + + + + Provides detailed name information. + + + + + Used to pass detailed name information regarding a contact. + + + + + + + + + + + + Defines the type of the job title (e.g. regional office postion, corporate, executive). + + + + + + + + + + + The gender of the contact person in the ContactName attribute. This may be useful for purposes of correspondence to the hotel. + + + + + The proper name in the usual order (e.g. used for correspondance Mr. James Smith). + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + The HotelAddress final class defines the addresses at this hotel facility. + + + + + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + Provides detailed phone information. + + + + + Used to pass detailed phone information. + + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + A collection of email elements. + + + + + Used to pass detailed email information. + + + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + The URLs final class identifies URI information. + + + + + Provides a Website address. + + + + + + + The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + + Defines well-known locations and attractions of local interest in the geographical area of the hotel facility as well as other area hotels. + + + + + A collection of Attraction objects identifying the local interest attractions in the vicinity of this hotel facility. + + + + + + This identifies an item of local interest (e.g. theme park, airport, museum, rail station, university). + + + + + + Descriptive text that describes the attraction. + + + + + + The name of the local attraction. + + + + + This may be used to uniquely identify an attraction. + + + + + Used to define the display order. + + + + + Distance from the hotel to the attraction. + + + + + Used to specify the geographic coordinates of a location. + + + + + + + + + + A collection of Recreation objects identifying the different types of recreation facilities available to the guest. + + + + + + A recreation facility available to the guest. These may or may not be operated by the hotel or located at the hotel. + + + + + + This may be used to uniquely identify a recreational facility. + + + + + + + + + + + + The FacilityInfo final class that describes the facilities provided at the hotel, including meeting rooms restaurants. + + + + + Collection of guest room types that are comprised within the hotel. + + + + + + The accommodation occupied by a guest. + + + + + + Describes the guest room type; in composite types there can be multiple occurrences. + + + + + Indicates the usual number of beds for this room type. + + + + + Indicates the usual number of guests that occupy this room. + + + + + Text name of the type of room such as "Two Bedroom Villas". + + + + + Used to define a room (eg., its location, configuration, view). + + + + + + + Collection of room amenity items available to the guest. + + + + + + Tangible room item(s) (e.g., newspaper) available to the guest. + + + + + May be used to give further detail on the code (e.g. if bathroom amenities is selected additional information about what amenities are available in the guest room can be passed here) or to remove an obsolete item. + + + + + A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. + + + + + + + + + + Descriptive text that describes the guest room. + + + + + A note of the guest room. + + + + + + + Maximum number of guests allowed in a room type. + + + + + This may be used to uniquely identify a guest room. + + + + + Rate Type of guest room (Per person/ Per room). 0 is Per Room, 1 is Per Person + + + + + + + + + + + + A collection of CancelPenalty. + + + + + Defines the cancellation penalty of the hotel facility. + + + + + + When true, indicates a cancel policy exits. When false, no cancel policy exists. Typically this indicator is used when details are not being sent. + + + + + + The HotelDescriptiveInfo element contains the descriptive information about a hotel property. + + + + + Is used to indicate whether hotel information is being requested. + + + + + + + + + + Used to identify available room products. + + + + + + + + A collection of GuestCount by age group. + + + + + A recurring element that identifies the number of guests and ages of the guests. + + + + + + + + + + A collection of AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. + + + + + To accommodate the ability to perform multiple requests within one message, the availability request contains the repeating element, AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. + + + + + + Range of dates, or fixed set of dates for Availability Request. Date range can also be specified by using start dates and number of nights (minimum, maximum or fixed). **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.** + + + + + Collection of room stay candidates. **This element is maintained at this level to support those who have implemented this message prior to 2005B. For new implementations consider using this element under HotelSearchCriteria.** + + + + + + Element used to identify available room products. + + + + + + + + + + + + + + Availability search criteria should be specified here for implementations using OpenTravel messages that are LATER than 2005B which was version 1.005 of this message, e.g. 2006A through the current specification. + + + + + + + + + + + + + + + A collection of single search criterion items. + + + + + Child elements that identify a single search criterion by criteria type. Because many of the types include partial matches to string values such as partial addresses (street names without a number) or partial telephone numbers (area code or three-digit prefix area, etc.) a ExactMatch attribute indicates whether the match to the string value must be exact. + + + + + + + + + + + + + A collection of Profile objects or Unique IDs of Profiles. + + + + + + + + + Identifies the criterion for a search. + + + + + Indicates the detail of hotel reference information. + + + + + Detailed hotel information for the search. + + + + + Hotel Unique ID. + + + + + + + + + Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + + + + + A collection of Room Types associated with a particular Room Stay. + The RoomType element is used to contain all the room type information for a single RateType Code (ex A1K) for a given date range. + + + + + + + + + + A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount. + The combination of a given Rate Plan and Room Type. This allows for support for systems where Rate Plans are child of Room Type as well as systems which Room Types are child of Rate Plans. + + + + + + + + + + + + + + + + + A collection of Guest Counts associated with Room Stay. A child Guest Count element is required for each distinct age group. + + + + + The Time Span which covers the Room Stay. + + + + + + The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount. + + + + + Property Information for the Room Stay. + + + + + + + Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. + + + + + Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. + + + + + The description or name of a room rate. + + + + + The total of all rates for this room rate type. + + + + + Property Information for the Room Stay. + + + + + + The number of rooms. + + + + + Used to specify an availability status for the room rate. + + + + + A string value representing the unique identification of a room. + + + + + + Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. + + + + + The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts as well as payment and cancellation policies. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount The applicable period of the the rate are indicated by the effective dates. Restrictions that may apply to that rate, such as the minimum or maximum length of stay, stay-over dates (such as a Saturday night), min/max guests applicable for the rate, and age group (ex Adult) are attributes of Rate. It indicates the number of units that the quoted rate is based upon, as well as the TimeUnits type used that the rate is based upon, e.g.: 3days at $100.00 per day. + + + + + + + Specifies how the room is priced (per night, per person, etc.). + + + + + + + + + + + Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description. + + + + + The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements. + + + + + Discount percentage and/or Amount, code and textual reason for discount + + + + + + + + + + + The total amount charged for this rate including additional occupant amounts and fees. + + + + + Description of the rate associated with the various monetary amounts and policies. + + + + + Collection of additional charges. + + + + + + Indicates the time unit for the rate. + + + + + Indicates the number of rate time units such as "3 Days". + + + + + Indicates the minimum length of stay. + + + + + + Identifies and provides details about the discount. + + + + + + + + + + Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent). + + + + + When true, used to indicate the discount should not be displayed. When false, indicates the discount may be displayed. + + + + + + + + + + Amenities or services to which a charge applies. + + + + + + The amount charged for an amenity or service. + + + + + + + + + Total additional charges before taxes. + + + + + Total additional charges after taxes. + + + + + Currency code and number of decimal places used. + + + + + + An abbreviated short summary of hotel descriptive information. + + + + + + A collection of LengthOfStay. + + + + + A collection of patterns defining allowable lengths of stay (LOS). + + + + + Used in conjunction with the MinMaxMessageType and the TimeUnit to define the length of stay requirements. + + + + + A time unit used to apply this status message to other inventory, and with more granularity than daily. Values: Year, Month, Week, Day, Hour, Minute, Second. + + + + + An enumerated type used to define how the minimum and maximum LOS is applied. + Values: Set Minimum LOS, Remove Minimum LOS, Set Maximum LOS, Remove Maximum LOS, Set Forward Minimum Stay, Remove Forward Minimum Stay, Set Forward Maximum Stay, Remove Forward Maximum Stay. + + + + + + Used to set the minimum length of stay (LOS). + + + + + Used to remove the minimum length of stay (LOS). + + + + + Used to set the maximum length of stay (LOS). + + + + + Used to remove the maximum length of stay (LOS). + + + + + + + + + This indicates the required length of stay (LOS). + + + + + This indicates allowable length of stay (LOS). When used, there is an option to fully define the open and closed status with the attribute FullPatternLOS in the subelement LOS_Pattern. + + + + + Used to specify the minimum length of stay. + + + + + Used to specify the maximum length of stay. + + + + + + + + + + + True indicates that LOS is based on arrival date. False indicates that LOS is based on stay date. + + + + + + The StatusApplicationControl final class is used to indicate to which block codes/rate plans/inventory codes a status should be applied. + + + + + + + + Information on what the AvailStatus Message applies to (i.e. the combination of inventory and rate codes) and the period of application. + + + + + Collection of Length of Stay elements. These LOS elements indicate what LOS restrictions are to be added or removed. Some systems include this information directly with the Availability Status as opposed to the booking restriction. + + + + + The unique identifier element allows the trading partners to uniquely identify each AvailStatusMessage, for tracing of transactions. + + + + + Availability status assigned to the room rate combination. + + + + + + + + + Can be used to communicate back to the sender exactly which transaction may have had a problem (e.g. "Message 214 had an invalid date range"). + + + + + + This is the response message for a reservation request. The response could be as simple as indicating the reservation was made or as complex as echoing back all reservation information. It is used by HotelResRS and HotelResNotifRS to keep them synchronized. + + + + + + + + + + + + + + + + + A Collection of HotelReservationID objects for a given reservation. The collection of all ReservationIDs can include Passenger Name Record (PNR), Guest Name Record (GNR) and Guest Folio numbers. Associated with each can be a Confirmation number which is usually given to the guest. + + + + + The HotelReservationID object contains various unique (ReservationID) and non unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation. + + + + + Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OpenTravel Code List Unique ID Type (UIT). + + + + + This is the actual value associated with ResID_Type as generated by the system that is the source of the ResID_Type. + + + + + A unique identifier to indicate the source system which generated the ResID_Value. + + + + + Date of the creation of this reservation. + + + + + + + + + A grouping of elements including Guest Counts, Time Span, pointers to Res Guests, guest Memberships, Comments and Special Requests and finally finacial information including Guarantee, Deposit and Payyment and Cancellation Penalties. + + + + + A collection of fees that applies to the reservation. + + + + + The total amount charged for the accommodation including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount. + + + + + + + ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. + + + + + + + + + + + + A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. + + + + + + + When true indicates this is the primary guest. + + + + + + A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. + + + + + The ResGuest object contains the information about a guest associated with a reservation. + + + + + + + Provides details regarding rooms, usually guest rooms. + + + + + Indicates the room is a sleeping room when true. + + + + + Provides details of the room type. + + + + + + A collection of RoomStay objects. Room stays associated with this reservation. + + + + + Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + A collection of reference place holders. This is a reference placeholder, used as an index for the reservation guests. + A collection of Hotel Service reference placeholders. + + + + + + + + The SpecialRequest object indicates special requests for the whole Reservation, or a particular Room Stay or Service. + + + + + + + + + + + + The Reservation final class contains the point of sale, reservation identifier, room stay, service, guest, payment, loyalty program, comments, confirmation and queue information for the reservation being created or modify. + + + + + Collection of room stays. + + + + + Collection of guests associated with the reservation. + + + + + ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. + + + + + + Boolean True if this reservation is reserving rooms. False if it is only reserving services. + + + + + Indicates the status of the reservation. + + + + + + A collection of hotel reservations. + + + + + Contains a hotel reservation. + + + + + + + This is a request message for creating a reservation. It is used by HotelResRQ and HotelResNotifRQ to keep them synchronized. + + + + + The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message. + + + + + + + Hotel reservation information, including a collection of reservations, routing hops and confirmation information. + + + + + + + + Indicates the status of the reservation represented by the message. + + + + + + + + This message sends a request for getting a list of standard countries. + + + + + + Point of sale information about the message initiator. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of standard countries. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + List of standard countries. + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of WHL countries. + + + + + + Point of sale information about the message initiator. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of WHL countries. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + List of WHl countries. + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + Message allows a trading partner to query for specific hotel descriptive data. + + + + + + The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message. + + + + + Collection of items for data from multiple hotels. + + + + + + + + + + This message sends a request for getting a list of WHL countries. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + Message allows a trading partner to query for specific hotel descriptive data. + + + + + + The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message. + + + + + + + + + + + This message sends a request for getting a list of WHL countries. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of destinations. + + + + + + Point of sale information about the message initiator. + + + + + ID of a WHL country. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of WHL Destination. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + List of WHl Destintions. + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of hotel. + + + + + + Point of sale information about the message initiator. + + + + + Destination ID. + + + + + + The OTA_PayloadStdAttributes defines the standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + This message sends a request for getting a list of Hotels. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + List of Hotels. + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + Message allows a trading partner to query for specific hotel descriptive data. + + + + + + The point-of-sale data, contained in the POS element, communicates the information that allows the receiving system to identify the trading partner that is sending the request or the response message. + + + + + Collection of items for data from multiple hotels. + + + + + + This allows the requestor to indicate which specific information is requested if complete hotel details are not required. + + + + + + + + + + + + + + + + + + The Hotel Descriptive Info Response is a message used to provide detailed descriptive information about a hotel property. + + + + + + + The presence of the empty Success element explicitly indicates that the OpenTravel message succeeded. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + A collection of hotel descriptive information. + + + + + + Hotel descriptive information. + + + + + + + Used to identify the specific hotel. + + + + + + + + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + Requests availability of hotel properties by specific criteria that may include: dates, date ranges, price range, room types, regular and qualifying rates, and/or services and amenities. The availability message can be used to get an initial availability or to get availability for the purpose of modifying an existing reservation. + + + + + + Point of sale object. + + + + + A collection of AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. + + + + + + + + + + + + + + + + Returns information about hotel availability that meet the requested criteria. + + + + + + + The presence of the empty Success element explicitly indicates that the request message was successful. + + + + + Used in conjunction with the Success element to define one or more business errors. + + + + + A collection of details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + + + + + + Details on the Room Stay including Guest Counts, Time Span of this Room Stay, and financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. + + + + + + + Used to specify an availability status at the room stay level for a property. + + + + + + + + + + + + + Errors are returned if the request was unable to be processed. + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + + + + The OTA_AvailNotifRQ is the message that sends the notification of the availability status of a hotel. + + + + + + POS provides a mechanism to indicate the source of the message. + + + + + The unique identifier element allows the trading partners to uniquely identify each AvailStatusMessageRQ, (i.e. the entire message) for tracing of transactions. + + + + + Container for the individual AvailStatusMessage(s). An OTA_HotelAvailNotifRQ contains the availability statuses for a single hotel. Hotel identification information are the attributes of this element. + + + + + + The AvailStatusMessage. It is here that one indicates whether the inventory is opened, closed, closed on request, etc. + The MinMaxLOSStatusMessage final class communicates the set of minimum and maximum length-of-stay availability status changes to be synchronized with another system. + The RateHurdleStatusMessage final class defines the setting for rate hurdle controls to be synchronized with the central reservation system. + + + + + + + + + + This element defines standard attributes that appear on the root element for all OpenTravel Messages. + + + + + Defines specific content of the message being sent. + + + + + + + + The OTA_HotelAvailNotifRS is the message used to indicate the status of processing the OTA_HotelAvailNotifRQ message. + + + + + + This message sends a request for a reservation to another system.There is no requirement to determine availability prior to sending a reservation request. Travel agencies, or individual guests may send a request to book a reservation from an internet site if all the information required for booking is known. The OTA_HotelResRQ message can initiate the first message in the sequence of booking a reservation. + + + + + + + + + + + + This message could be used to respond to a OTA_HotelResRQ.xsd or the OTA_ReadRQ.xsd. The response to a booking request is either Yes or No based upon the availability. The hotel PMS or CRS system responds back attaching a confirmation number or additional information such as the reservation ID, etc. when the response is affirmative. Additional information, such as the count of Loyalty Program miles or points to be awarded for the hotel stay, can be added to the Reservation object in the return. Supplementary data for the reservation can be added later, once the reservation has been confirmed and the inventory held. + + + + + Generic SOAP Fault + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + WHL XML API Operation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/resources/xmlmime.xml b/tests/resources/xmlmime.xml new file mode 100644 index 0000000..a4a33d2 --- /dev/null +++ b/tests/resources/xmlmime.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file From 027671c8a7bcb11891046a10595013b2dc0ce9c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=C3=ABl=20DELSOL?= Date: Sun, 31 Jan 2021 16:38:20 +0100 Subject: [PATCH 2/4] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a81f94..ab9eb9d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [![StyleCI](https://styleci.io/repos/87977980/shield)](https://styleci.io/repos/87977980) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30/mini.png)](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30) -WsdlHandler uses the [decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) upon [WsdlHandler](https://github.com/WsdlToPhp/WsdlHandler). +WsdlHandler uses the [decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) upon [DomHandler](https://github.com/WsdlToPhp/DomHandler). The source code has been originally created into the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project but it felt that it had the possibility to live by itself and to evolve independtly from the PackageGenerator project if necessary. From b85996ebadda12c0960192da16d9ff66b45e96b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=C3=ABl=20DELSOL?= Date: Sun, 31 Jan 2021 16:41:04 +0100 Subject: [PATCH 3/4] minor fixes --- .gitignore | 1 - README.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 841b5b6..4b8e322 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ vendor composer.lock phpunit.xml -.idea .phpunit.result.cache coverage diff --git a/README.md b/README.md index ab9eb9d..1833464 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Code Coverage](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/badges/coverage.png)](https://scrutinizer-ci.com/g/WsdlToPhp/WsdlHandler/) [![Total Downloads](https://poser.pugx.org/wsdltophp/wsdlhandler/downloads)](https://packagist.org/packages/wsdltophp/wsdlhandler) [![StyleCI](https://styleci.io/repos/87977980/shield)](https://styleci.io/repos/87977980) -[![SensioLabsInsight](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30/mini.png)](https://insight.sensiolabs.com/projects/6bac01d7-5243-4682-9264-8166407c8a30) +[![SymfonyInsight](https://insight.symfony.com/projects/3dd23426-0808-4715-9a11-e51dc84cb0b4/mini.svg)](https://insight.symfony.com/projects/3dd23426-0808-4715-9a11-e51dc84cb0b4) WsdlHandler uses the [decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) upon [DomHandler](https://github.com/WsdlToPhp/DomHandler). From bfcdd1b5d9b2098cd6e5ee5deba084d43fa06de3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=C3=ABl=20DELSOL?= Date: Sun, 31 Jan 2021 16:51:14 +0100 Subject: [PATCH 4/4] update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a65c233..695a36f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ # CHANGELOG -## 1.0.0 - 2021/01/29 +## 1.0.0 - 2021/01/31 - Initial release after exporting source code from the [PackageGenerator](https://github.com/WsdlToPhp/PackageGenerator) project