Retrieves the authenticated user's account profile information. It can be used to let users log into your app or site using eBay, which frees you from needing to store and protect user's PII (Personal Identifiable Information) data.",
+ "contact": {
+ "name": "eBay Inc,"
+ },
+ "license": {
+ "name": "eBay API License Agreement",
+ "url": "https://developer.ebay.com/join/api-license-agreement"
+ },
+ "version": "v2.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://apiz.ebay.com{basePath}",
+ "description": "Production",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/identity/v1"
+ }
+ }
+ },
+ {
+ "url": "https://apiz.sandbox.ebay.com{basePath}",
+ "description": "sandbox server",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/identity/v1"
+ }
+ }
+ }
+ ],
+ "security": [
+ {}
+ ],
+ "paths": {
+ "/user/": {
+ "get": {
+ "tags": [
+ "user"
+ ],
+ "description": "This method retrieves the account profile information for an authenticated user, which requires a User access token. What is returned is controlled by the scopes.
For a business account you use the default scope commerce.identity.readonly, which returns all the fields in the businessAccount container. These are returned because this is all public information.
For an individual account, the fields returned in the individualAccount container are based on the scope you use. Using the default scope, only public information, such as eBay user ID, are returned. For details about what each scope returns, see the Identity API scopes.
",
+ "operationId": "getUser",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "140001": {
+ "domain": "API_IDENTITY",
+ "category": "REQUEST",
+ "description": "The requested user was not found."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "140000": {
+ "domain": "API_IDENTITY",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.status.readonly",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AccountTypeEnum": {
+ "type": "object",
+ "description": "An enumerated type for the values that represent the user's eBay account type. | - **INDIVIDUAL**: Indicates the eBay user's account is not a business but for an individual. - **BUSINESS**: Indicates the eBay user's account is for a business.",
+ "enum": [
+ "INDIVIDUAL",
+ "BUSINESS"
+ ]
+ },
+ "Address": {
+ "type": "object",
+ "properties": {
+ "addressLine1": {
+ "type": "string",
+ "description": "The first line of the street address for the user's location."
+ },
+ "addressLine2": {
+ "type": "string",
+ "description": "The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'."
+ },
+ "city": {
+ "type": "string",
+ "description": "The city of the address."
+ },
+ "country": {
+ "description": "The two-letter ISO 3166 standard of the country of the address.",
+ "$ref": "#/components/schemas/CountryCodeEnum"
+ },
+ "county": {
+ "type": "string",
+ "description": "The county of the address."
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "The postal code of the address."
+ },
+ "stateOrProvince": {
+ "type": "string",
+ "description": "The state or province of the address."
+ }
+ },
+ "description": "The type that defines the fields for an address."
+ },
+ "BusinessAccount": {
+ "type": "object",
+ "properties": {
+ "address": {
+ "description": "The business address associated with the user's eBay business account.",
+ "$ref": "#/components/schemas/Address"
+ },
+ "doingBusinessAs": {
+ "type": "string",
+ "description": "An alternate business name or trade name used by the business on eBay."
+ },
+ "email": {
+ "type": "string",
+ "description": "The email address associated with the business account on eBay."
+ },
+ "name": {
+ "type": "string",
+ "description": "The official name of the business associated with the eBay user's account."
+ },
+ "primaryContact": {
+ "description": "The container that returns the contact details of the person who is the primary contact for this account.",
+ "$ref": "#/components/schemas/Contact"
+ },
+ "primaryPhone": {
+ "description": "The container that returns the primary phone number for the business account.",
+ "$ref": "#/components/schemas/Phone"
+ },
+ "secondaryPhone": {
+ "description": "The container that returns the secondary phone number for the business account.",
+ "$ref": "#/components/schemas/Phone"
+ },
+ "website": {
+ "type": "string",
+ "description": "The business website address associated with the eBay account."
+ }
+ },
+ "description": "The type that defines the fields for the business account information."
+ },
+ "Contact": {
+ "type": "object",
+ "properties": {
+ "firstName": {
+ "type": "string",
+ "description": "The first name of the contact person."
+ },
+ "lastName": {
+ "type": "string",
+ "description": "The last name of the contact person."
+ }
+ },
+ "description": "The type that defines the fields for the information of the contact person for the account."
+ },
+ "CountryCodeEnum": {
+ "type": "object",
+ "description": "The two-letter ISO 3166 standard code representing a country. | - **AD**: Indicates the country is Andorra. - **AE**: Indicates the country is United Arab Emirates. - **AF**: Indicates the country is Afghanistan. - **AG**: Indicates the country is Antigua and Barbuda. - **AI**: Indicates the country is Anguilla. - **AL**: Indicates the country is Albania. - **AM**: Indicates the country is Armenia. - **AN**: Indicates the country is Netherlands Antilles. - **AO**: Indicates the country is Angola. - **AQ**: Indicates the country is Antarctica. - **AR**: Indicates the country is Argentina. - **AS**: Indicates the country is American Samoa. - **AT**: Indicates the country is Austria. - **AU**: Indicates the country is Australia. - **AW**: Indicates the country is Aruba. - **AX**: Indicates the country is Aland Islands - **AZ**: Indicates the country is Azerbaijan. - **BA**: Indicates the country is Bosnia and Herzegovina. - **BB**: Indicates the country is Barbados. - **BD**: Indicates the country is Bangladesh. - **BE**: Indicates the country is Belgium. - **BF**: Indicates the country is Burkina Faso. - **BG**: Indicates the country is Bulgaria. - **BH**: Indicates the country is Bahrain. - **BI**: Indicates the country is Burundi. - **BJ**: Indicates the country is Benin. - **BL**: Indicates the country is Saint Barthelemy. - **BM**: Indicates the country is Bermuda. - **BN**: Indicates the country is Brunei Darussalam. - **BO**: Indicates the country is Bolivia. - **BQ**: Indicates the country is Bonaire, Sint Eustatius, and Saba. - **BR**: Indicates the country is Brazil. - **BS**: Indicates the country is Bahamas. - **BT**: Indicates the country is Bhutan. - **BV**: Indicates the country is Bouvet Island. - **BW**: Indicates the country is Botswana. - **BY**: Indicates the country is Belarus. - **BZ**: Indicates the country is Belize. - **CA**: Indicates the country is Canada. - **CC**: Indicates the country is Cocos (Keeling) Islands. - **CD**: Indicates the country is The Democratic Republic of the Congo. - **CF**: Indicates the country is Central African Republic. - **CG**: Indicates the country is Congo. - **CH**: Indicates the country is Switzerland. - **CI**: Indicates the country is Cote d'Ivoire. - **CK**: Indicates the country is Cook Islands. - **CL**: Indicates the country is Chile. - **CM**: Indicates the country is Cameroon. - **CN**: Indicates the country is China. - **CO**: Indicates the country is Colombia. - **CR**: Indicates the country is Costa Rica. - **CU**: Indicates the country is Cuba. - **CV**: Indicates the country is Cape Verde. - **CW**: Indicates the country is Curacao. - **CX**: Indicates the country is Christmas Island. - **CY**: Indicates the country is Cyprus. - **CZ**: Indicates the country is Czech Republic. - **DE**: Indicates the country is Germany. - **DJ**: Indicates the country is Djibouti. - **DK**: Indicates the country is Denmark. - **DM**: Indicates the country is Dominica. - **DO**: Indicates the country is Dominican Republic. - **DZ**: Indicates the country is Algeria. - **EC**: Indicates the country is Ecuador. - **EE**: Indicates the country is Estonia. - **EG**: Indicates the country is Egypt. - **EH**: Indicates the country is Western Sahara. - **ER**: Indicates the country is Eritrea. - **ES**: Indicates the country is Spain. - **ET**: Indicates the country is Ethiopia. - **FI**: Indicates the country is Finland. - **FJ**: Indicates the country is Fiji. - **FK**: Indicates the country is Falkland Islands (Malvinas). - **FM**: Indicates the country is Federated States of Micronesia. - **FO**: Indicates the country is Faroe Islands. - **FR**: Indicates the country is France. - **GA**: Indicates the country is Gabon. - **GB**: Indicates the country is United Kingdom. - **GD**: Indicates the country is Grenada. - **GE**: Indicates the country is Georgia. - **GF**: Indicates the country is French Guiana. - **GG**: Indicates the country is Guernsey. - **GH**: Indicates the country is Ghana. - **GI**: Indicates the country is Gibraltar. - **GL**: Indicates the country is Greenland. - **GM**: Indicates the country is Gambia. - **GN**: Indicates the country is Guinea. - **GP**: Indicates the country is Guadeloupe. - **GQ**: Indicates the country is Equatorial Guinea. - **GR**: Indicates the country is Greece. - **GS**: Indicates the country is South Georgia and the South Sandwich Islands. - **GT**: Indicates the country is Guatemala. - **GU**: Indicates the country is Guam. - **GW**: Indicates the country is Guinea-Bissau. - **GY**: Indicates the country is Guyana. - **HK**: Indicates the country is Hong Kong. - **HM**: Indicates the country is Heard Island and McDonald Islands. - **HN**: Indicates the country is Honduras. - **HR**: Indicates the country is Croatia. - **HT**: Indicates the country is Haiti. - **HU**: Indicates the country is Hungary. - **ID**: Indicates the country is Indonesia. - **IE**: Indicates the country is Ireland. - **IL**: Indicates the country is Israel. - **IM**: Indicates the country is Isle of Man. - **IN**: Indicates the country is India. - **IO**: Indicates the country is British Indian Ocean Territory. - **IQ**: Indicates the country is Iraq. - **IR**: Indicates the country is Islamic Republic of Iran. - **IS**: Indicates the country is Iceland. - **IT**: Indicates the country is Italy. - **JE**: Indicates the country is Jersey. - **JM**: Indicates the country is Jamaica. - **JO**: Indicates the country is Jordan. - **JP**: Indicates the country is Japan. - **KE**: Indicates the country is Kenya. - **KG**: Indicates the country is Kyrgyzstan. - **KH**: Indicates the country is Cambodia. - **KI**: Indicates the country is Kiribati. - **KM**: Indicates the country is Comoros. - **KN**: Indicates the country is Saint Kitts and Nevis. - **KP**: Indicates the country is Democratic People's Republic of Korea. - **KR**: Indicates the country is Republic of Korea. - **KW**: Indicates the country is Kuwait. - **KY**: Indicates the country is Cayman Islands. - **KZ**: Indicates the country is Kazakhstan. - **LA**: Indicates the country is Lao People's Democratic Republic. - **LB**: Indicates the country is Lebanon. - **LC**: Indicates the country is Saint Lucia. - **LI**: Indicates the country is Liechtenstein. - **LK**: Indicates the country is Sri Lanka. - **LR**: Indicates the country is Liberia. - **LS**: Indicates the country is Lesotho. - **LT**: Indicates the country is Lithuania. - **LU**: Indicates the country is Luxembourg. - **LV**: Indicates the country is Latvia. - **LY**: Indicates the country is Libyan Arab Jamahiriya. - **MA**: Indicates the country is Morocco. - **MC**: Indicates the country is Monaco. - **MD**: Indicates the country is Republic of Moldova. - **ME**: Indicates the country is Montenegro. - **MF**: Indicates the country is Saint Martin (French part). - **MG**: Indicates the country is Madagascar. - **MH**: Indicates the country is Marshall Islands. - **MK**: Indicates the country is The Former Yugoslav Republic of Macedonia. - **ML**: Indicates the country is Mali. - **MM**: Indicates the country is Myanmar. - **MN**: Indicates the country is Mongolia. - **MO**: Indicates the country is Macao. - **MP**: Indicates the country is Northern Mariana Islands. - **MQ**: Indicates the country is Martinique. - **MR**: Indicates the country is Mauritania. - **MS**: Indicates the country is Montserrat. - **MT**: Indicates the country is Malta. - **MU**: Indicates the country is Mauritius. - **MV**: Indicates the country is Maldives. - **MW**: Indicates the country is Malawi. - **MX**: Indicates the country is Mexico. - **MY**: Indicates the country is Malaysia. - **MZ**: Indicates the country is Mozambique. - **NA**: Indicates the country is Namibia. - **NC**: Indicates the country is New Caledonia. - **NE**: Indicates the country is Niger. - **NF**: Indicates the country is Norfolk Island. - **NG**: Indicates the country is Nigeria. - **NI**: Indicates the country is Nicaragua. - **NL**: Indicates the country is Netherlands. - **NO**: Indicates the country is Norway. - **NP**: Indicates the country is Nepal. - **NR**: Indicates the country is Nauru. - **NU**: Indicates the country is Niue. - **NZ**: Indicates the country is New Zealand. - **OM**: Indicates the country is Oman. - **PA**: Indicates the country is Panama. - **PE**: Indicates the country is Peru. - **PF**: Indicates the country is French Polynesia. Includes Tahiti. - **PG**: Indicates the country is Papua New Guinea. - **PH**: Indicates the country is Philippines. - **PK**: Indicates the country is Pakistan. - **PL**: Indicates the country is Poland. - **PM**: Indicates the country is Saint Pierre and Miquelon. - **PN**: Indicates the country is Pitcairn. - **PR**: Indicates the country is Puerto Rico. - **PS**: Indicates the country is Palestinian territory Occupied. - **PT**: Indicates the country is Portugal. - **PW**: Indicates the country is Palau. - **PY**: Indicates the country is Paraguay. - **QA**: Indicates the country is Qatar. - **RE**: Indicates the country is Reunion. - **RO**: Indicates the country is Romania. - **RS**: Indicates the country is Serbia. - **RU**: Indicates the country is Russian Federation. - **RW**: Indicates the country is Rwanda. - **SA**: Indicates the country is Saudi Arabia. - **SB**: Indicates the country is Solomon Islands. - **SC**: Indicates the country is Seychelles. - **SD**: Indicates the country is Sudan. - **SE**: Indicates the country is Sweden. - **SG**: Indicates the country is Singapore. - **SH**: Indicates the country is Saint Helena. - **SI**: Indicates the country is Slovenia. - **SJ**: Indicates the country is Svalbard and Jan Mayen. - **SK**: Indicates the country is Slovakia. - **SL**: Indicates the country is Sierra Leone. - **SM**: Indicates the country is San Marino. - **SN**: Indicates the country is Senegal. - **SO**: Indicates the country is Somalia. - **SR**: Indicates the country is Suriname. - **SS**: Indicates the country is South Sudan. - **ST**: Indicates the country is Sao Tome and Principe. - **SV**: Indicates the country is El Salvador. - **SX**: Indicates the country is Sint Maarten (Dutch part). - **SY**: Indicates the country is Syrian Arab Republic. - **SZ**: Indicates the country is Swaziland. - **TC**: Indicates the country is Turks and Caicos Islands. - **TD**: Indicates the country is Chad. - **TF**: Indicates the country is French Southern Territories. - **TG**: Indicates the country is Togo. - **TH**: Indicates the country is Thailand. - **TJ**: Indicates the country is Tajikistan. - **TK**: Indicates the country is Tokelau. - **TL**: Indicates the country is Timor-Leste. - **TM**: Indicates the country is Turkmenistan. - **TN**: Indicates the country is Tunisia. - **TO**: Indicates the country is Tonga. - **TR**: Indicates the country is Turkey. - **TT**: Indicates the country is Trinidad and Tobago. - **TV**: Indicates the country is Tuvalu. - **TW**: Indicates the country is Taiwan. - **TZ**: Indicates the country is Tanzania. - **UA**: Indicates the country is Ukraine. - **UG**: Indicates the country is Uganda. - **UM**: Indicates the country is United States Minor Outlying Islands. - **US**: Indicates the country is United States. - **UY**: Indicates the country is Uruguay. - **UZ**: Indicates the country is Uzbekistan. - **VA**: Indicates the country is Holy See (Vatican City state). - **VC**: Indicates the country is Saint Vincent and the Grenadines. - **VE**: Indicates the country is Venezuela. - **VG**: Indicates the country is British Virgin Islands. - **VI**: Indicates the country is the U.S. Virgin Islands. - **VN**: Indicates the country is Vietnam. - **VU**: Indicates the country is Vanuatu. - **WF**: Indicates the country is Wallis and Futuna. - **WS**: Indicates the country is Samoa. - **YE**: Indicates the country is Yemen. - **YT**: Indicates the country is Mayotte. - **ZA**: Indicates the country is South Africa. - **ZM**: Indicates the country is Zambia. - **ZW**: Indicates the country is Zimbabwe.",
+ "enum": [
+ "AD",
+ "AE",
+ "AF",
+ "AG",
+ "AI",
+ "AL",
+ "AM",
+ "AN",
+ "AO",
+ "AQ",
+ "AR",
+ "AS",
+ "AT",
+ "AU",
+ "AW",
+ "AX",
+ "AZ",
+ "BA",
+ "BB",
+ "BD",
+ "BE",
+ "BF",
+ "BG",
+ "BH",
+ "BI",
+ "BJ",
+ "BL",
+ "BM",
+ "BN",
+ "BO",
+ "BQ",
+ "BR",
+ "BS",
+ "BT",
+ "BV",
+ "BW",
+ "BY",
+ "BZ",
+ "CA",
+ "CC",
+ "CD",
+ "CF",
+ "CG",
+ "CH",
+ "CI",
+ "CK",
+ "CL",
+ "CM",
+ "CN",
+ "CO",
+ "CR",
+ "CU",
+ "CV",
+ "CW",
+ "CX",
+ "CY",
+ "CZ",
+ "DE",
+ "DJ",
+ "DK",
+ "DM",
+ "DO",
+ "DZ",
+ "EC",
+ "EE",
+ "EG",
+ "EH",
+ "ER",
+ "ES",
+ "ET",
+ "FI",
+ "FJ",
+ "FK",
+ "FM",
+ "FO",
+ "FR",
+ "GA",
+ "GB",
+ "GD",
+ "GE",
+ "GF",
+ "GG",
+ "GH",
+ "GI",
+ "GL",
+ "GM",
+ "GN",
+ "GP",
+ "GQ",
+ "GR",
+ "GS",
+ "GT",
+ "GU",
+ "GW",
+ "GY",
+ "HK",
+ "HM",
+ "HN",
+ "HR",
+ "HT",
+ "HU",
+ "ID",
+ "IE",
+ "IL",
+ "IM",
+ "IN",
+ "IO",
+ "IQ",
+ "IR",
+ "IS",
+ "IT",
+ "JE",
+ "JM",
+ "JO",
+ "JP",
+ "KE",
+ "KG",
+ "KH",
+ "KI",
+ "KM",
+ "KN",
+ "KP",
+ "KR",
+ "KW",
+ "KY",
+ "KZ",
+ "LA",
+ "LB",
+ "LC",
+ "LI",
+ "LK",
+ "LR",
+ "LS",
+ "LT",
+ "LU",
+ "LV",
+ "LY",
+ "MA",
+ "MC",
+ "MD",
+ "ME",
+ "MF",
+ "MG",
+ "MH",
+ "MK",
+ "ML",
+ "MM",
+ "MN",
+ "MO",
+ "MP",
+ "MQ",
+ "MR",
+ "MS",
+ "MT",
+ "MU",
+ "MV",
+ "MW",
+ "MX",
+ "MY",
+ "MZ",
+ "NA",
+ "NC",
+ "NE",
+ "NF",
+ "NG",
+ "NI",
+ "NL",
+ "NO",
+ "NP",
+ "NR",
+ "NU",
+ "NZ",
+ "OM",
+ "PA",
+ "PE",
+ "PF",
+ "PG",
+ "PH",
+ "PK",
+ "PL",
+ "PM",
+ "PN",
+ "PR",
+ "PS",
+ "PT",
+ "PW",
+ "PY",
+ "QA",
+ "RE",
+ "RO",
+ "RS",
+ "RU",
+ "RW",
+ "SA",
+ "SB",
+ "SC",
+ "SD",
+ "SE",
+ "SG",
+ "SH",
+ "SI",
+ "SJ",
+ "SK",
+ "SL",
+ "SM",
+ "SN",
+ "SO",
+ "SR",
+ "SS",
+ "ST",
+ "SV",
+ "SX",
+ "SY",
+ "SZ",
+ "TC",
+ "TD",
+ "TF",
+ "TG",
+ "TH",
+ "TJ",
+ "TK",
+ "TL",
+ "TM",
+ "TN",
+ "TO",
+ "TR",
+ "TT",
+ "TV",
+ "TW",
+ "TZ",
+ "UA",
+ "UG",
+ "UM",
+ "US",
+ "UY",
+ "UZ",
+ "VA",
+ "VC",
+ "VE",
+ "VG",
+ "VI",
+ "VN",
+ "VU",
+ "WF",
+ "WS",
+ "YE",
+ "YT",
+ "ZA",
+ "ZM",
+ "ZW"
+ ]
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "Indicates the classification of the error, such as whether it is a problem with the request, application, or system."
+ },
+ "domain": {
+ "type": "string",
+ "description": "The primary system or service where the error originated. This information is especially relevant for identifying the source of application errors."
+ },
+ "errorId": {
+ "type": "integer",
+ "description": "A unique identifier assigned to each specific error, useful for debugging and support.",
+ "format": "int32"
+ },
+ "inputRefIds": {
+ "type": "array",
+ "description": "An array of request element identifiers most closely associated with the cause of the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "longMessage": {
+ "type": "string",
+ "description": "A longer, more detailed explanation of the error that occurred. This message provides additional context to help with troubleshooting."
+ },
+ "message": {
+ "type": "string",
+ "description": "Information on how to correct the problem, in the end user's terms and language where applicable."
+ },
+ "outputRefIds": {
+ "type": "array",
+ "description": "An array of response elements that are most closely associated with the error, providing additional context for debugging. Hello, this is a test.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "An array of name/value pairs that provide details about the error condition, useful when multiple errors are returned.",
+ "items": {
+ "$ref": "#/components/schemas/ErrorParameter"
+ }
+ },
+ "subdomain": {
+ "type": "string",
+ "description": "Provides additional information about the subsystem where the error occurred, such as Initialization, Security, or Rate Limiting."
+ }
+ },
+ "description": "This type defines the fields that can be returned in an error."
+ },
+ "ErrorParameter": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the request field or entity associated with the error detail.",
+ "examples": [
+ "categoryId"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The value associated with the parameter name that provides specific details about the error.",
+ "examples": [
+ "1234"
+ ]
+ }
+ },
+ "description": "This type contains a name-value pair that provides additional details about the error, useful for conveying which request elements were involved."
+ },
+ "IndividualAccount": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "The eBay user's registration email address."
+ },
+ "firstName": {
+ "type": "string",
+ "description": "The eBay user's first name."
+ },
+ "lastName": {
+ "type": "string",
+ "description": "The eBay user's last name."
+ },
+ "primaryPhone": {
+ "description": "The primary phone number associated with the individual account, if available.",
+ "$ref": "#/components/schemas/Phone"
+ },
+ "registrationAddress": {
+ "description": "The container that returns the eBay user's address information.",
+ "$ref": "#/components/schemas/Address"
+ },
+ "secondaryPhone": {
+ "description": "A secondary phone number registered with the individual eBay account.",
+ "$ref": "#/components/schemas/Phone"
+ }
+ },
+ "description": "The type that defines the fields for information about an individual eBay account."
+ },
+ "MarketplaceIdEnum": {
+ "type": "object",
+ "description": "An enumerated type for the values that represent the unique eBay-assigned IDs for each of the eBay marketplaces. | - **EBAY_AT**: Indicates the eBay marketplace for Austria (https://www.ebay.at). - **EBAY_AU**: Indicates the eBay marketplace for Australia (https://www.ebay.com.au). - **EBAY_BE**: Indicates the eBay marketplace for Belgium (https://www.ebay.be/). - **EBAY_CA**: Indicates the eBay marketplace for Canada (https://www.ebay.ca). - **EBAY_CH**: Indicates the eBay marketplace for Switzerland (https://www.ebay.ch). - **EBAY_CN**: Reserved for future use. - **EBAY_CZ**: Reserved for future use. - **EBAY_DE**: Indicates the eBay marketplace for Germany (https://www.ebay.de). - **EBAY_DK**: Reserved for future use. - **EBAY_ES**: Indicates the eBay marketplace for Spain (https://www.ebay.es). - **EBAY_FI**: Reserved for future use. - **EBAY_FR**: Indicates the eBay marketplace for France (https://www.ebay.fr). - **EBAY_GB**: Indicates the eBay marketplace for Great Britain (https://www.ebay.co.uk). - **EBAY_GR**: Reserved for future use. - **EBAY_HK**: Indicates the eBay marketplace for Hong Kong (https://www.ebay.com.hk). - **EBAY_HU**: Reserved for future use. - **EBAY_ID**: Reserved for future use. - **EBAY_IE**: Indicates the eBay marketplace for Ireland (https://www.ebay.ie). - **EBAY_IL**: Reserved for future use. - **EBAY_IN**: Indicates the eBay marketplace for India (https://www.ebay.in). - **EBAY_IT**: Indicates the eBay marketplace for Italy (https://www.ebay.it). - **EBAY_JP**: Reserved for future use. - **EBAY_MY**: Indicates the eBay marketplace for Malaysia (https://www.ebay.com.my). - **EBAY_NL**: Indicates the eBay marketplace for the Netherlands (https://www.ebay.nl). - **EBAY_NO**: Reserved for future use. - **EBAY_NZ**: Reserved for future use. - **EBAY_PE**: Reserved for future use. - **EBAY_PH**: Indicates the eBay marketplace for the Philippines (https://www.ebay.ph). - **EBAY_PL**: Indicates the eBay marketplace for Poland (https://www.ebay.pl). - **EBAY_PR**: Reserved for future use. - **EBAY_PT**: Reserved for future use. - **EBAY_RU**: Reserved for future use. - **EBAY_SE**: Reserved for future use. - **EBAY_SG**: Indicates the eBay marketplace for Singapore (https://www.ebay.com.sg). - **EBAY_TH**: Indicates the eBay marketplace for Thailand (https://info.ebay.co.th). - **EBAY_TW**: Indicates the eBay marketplace for Taiwan (https://www.ebay.com.tw). - **EBAY_US**: Indicates the eBay marketplace for the United States (https://www.ebay.com). - **EBAY_VN**: Indicates the eBay marketplace for Vietnam (https://www.ebay.vn). - **EBAY_ZA**: Reserved for future use. - **EBAY_HALF_US**: No longer used. - **EBAY_MOTORS_US**: Indicates the parent category for \"Auto Parts and Vehicles\" on the EBAY_US marketplace (https://www.ebay.com/motors).",
+ "enum": [
+ "EBAY_AT",
+ "EBAY_AU",
+ "EBAY_BE",
+ "EBAY_CA",
+ "EBAY_CH",
+ "EBAY_CN",
+ "EBAY_CZ",
+ "EBAY_DE",
+ "EBAY_DK",
+ "EBAY_ES",
+ "EBAY_FI",
+ "EBAY_FR",
+ "EBAY_GB",
+ "EBAY_GR",
+ "EBAY_HK",
+ "EBAY_HU",
+ "EBAY_ID",
+ "EBAY_IE",
+ "EBAY_IL",
+ "EBAY_IN",
+ "EBAY_IT",
+ "EBAY_JP",
+ "EBAY_MY",
+ "EBAY_NL",
+ "EBAY_NO",
+ "EBAY_NZ",
+ "EBAY_PE",
+ "EBAY_PH",
+ "EBAY_PL",
+ "EBAY_PR",
+ "EBAY_PT",
+ "EBAY_RU",
+ "EBAY_SE",
+ "EBAY_SG",
+ "EBAY_TH",
+ "EBAY_TW",
+ "EBAY_US",
+ "EBAY_VN",
+ "EBAY_ZA",
+ "EBAY_HALF_US",
+ "EBAY_MOTORS_US"
+ ]
+ },
+ "Phone": {
+ "type": "object",
+ "properties": {
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter ISO 3166 standard of the country to which the phone number belongs."
+ },
+ "number": {
+ "type": "string",
+ "description": "The numeric string representing the phone number."
+ },
+ "phoneType": {
+ "type": "string",
+ "description": "The type of phone service.
Valid Values: MOBILE or LAND_LINE
Code so that your app gracefully handles any future changes to this list."
+ }
+ },
+ "description": "The type that defines the fields for the details of a phone."
+ },
+ "UserResponse": {
+ "type": "object",
+ "required": [
+ "accountType",
+ "registrationMarketplaceId",
+ "status",
+ "userId",
+ "username"
+ ],
+ "properties": {
+ "accountType": {
+ "description": "Indicates the user account type. This is determined when the user registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following countries:
EBAY_AT
EBAY_BE
EBAY_CH
EBAY_DE
EBAY_ES
EBAY_FR
EBAY_GB
EBAY_IE
EBAY_IT
EBAY_PL
Valid Values:BUSINESS or INDIVIDUAL
Code so that your app gracefully handles any future changes to this list.",
+ "$ref": "#/components/schemas/AccountTypeEnum"
+ },
+ "businessAccount": {
+ "description": "The container that returns the business account information of the user.",
+ "$ref": "#/components/schemas/BusinessAccount"
+ },
+ "individualAccount": {
+ "description": "The account information of the user.",
+ "$ref": "#/components/schemas/IndividualAccount"
+ },
+ "registrationMarketplaceId": {
+ "description": "The unique identifier for the eBay marketplace in which the user registered their account.",
+ "$ref": "#/components/schemas/MarketplaceIdEnum"
+ },
+ "status": {
+ "description": "The current status of the user's eBay account, such as whether it is confirmed, unconfirmed, on hold, or undetermined.",
+ "$ref": "#/components/schemas/UserStatusEnum"
+ },
+ "userId": {
+ "type": "string",
+ "description": "The eBay immutable user ID of the user's account and can always be used to identify the user."
+ },
+ "username": {
+ "type": "string",
+ "description": "The user name, which was specified by the user when they created the account.
Note: This value can be changed by the user. Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
+ }
+ },
+ "description": "The type that defines the fields for the getUser method."
+ },
+ "UserStatusEnum": {
+ "type": "object",
+ "description": "An enumerated type for the values that represent the status of the user's account. | - **CONFIRMED**: Indicates the user's account has been verified by eBay. - **UNCONFIRMED**: Indicates the user's account has not been verified by eBay. - **ACCOUNTONHOLD**: Indicates the user's account has been put on hold by eBay. - **UNDETERMINED**: Indicates the user's account is not in any of the other states.",
+ "enum": [
+ "CONFIRMED",
+ "UNCONFIRMED",
+ "ACCOUNTONHOLD",
+ "UNDETERMINED"
+ ]
+ }
+ },
+ "securitySchemes": {
+ "api_auth": {
+ "type": "oauth2",
+ "description": "The security definitions for this API. Please check individual operations for applicable scopes.",
+ "flows": {
+ "authorizationCode": {
+ "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
+ "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
+ "scopes": {
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly": "View a user's personal email information from their eBay member account",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.status.readonly": "View a user's eBay member account status",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly": "View a user's personal address information from their eBay member account",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.readonly": "View a user's basic information, such as username or business account details, from their eBay member account",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly": "View a user's first and last name from their eBay member account",
+ "https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly": "View a user's personal telephone information from their eBay member account",
+ "ebayUser": "This scope would allow signed in user to read their eBay user profile data."
+ }
+ }
+ }
+ },
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer"
+ }
+ }
+ }
+ }
\ No newline at end of file
diff --git a/specs/openapi/identity.yaml b/specs/openapi/identity.yaml
deleted file mode 100644
index 52404c7..0000000
--- a/specs/openapi/identity.yaml
+++ /dev/null
@@ -1,233 +0,0 @@
-openapi: 3.0.0
-info:
- title: Identity API
- description: Note: Not all the account related fields are returned for an authenticated user. The fields returned in the response are controlled by the scopes and are available only to select developers approved by business units.
Retrieves the authenticated user's account profile information. It can be used to let users log into your app or site using eBay, which frees you from needing to store and protect user's PII (Personal Identifiable Information) data.
- contact:
- name: eBay Inc,
- license:
- name: eBay API License Agreement
- url: https://go.developer.ebay.com/api-license-agreement
- version: v2.0.0
-servers:
- - url: https://apiz.ebay.com{basePath}
- description: Production
- variables:
- basePath:
- default: /commerce/identity/v1
-paths:
- /user/:
- get:
- tags:
- - user
- description: 'This method retrieves the account profile information for an authenticated user, which requires a User access token. What is returned is controlled by the scopes.
For a business account you use the default scope commerce.identity.readonly, which returns all the fields in the businessAccount container. These are returned because this is all public information.
For an individual account, the fields returned in the individualAccount container are based on the scope you use. Using the default scope, only public information, such as eBay user ID, are returned. For details about what each scope returns, see the Identity API Overview.
In the Sandbox, this API returns mock data. Note: You must use the correct scope or scopes for the data you want returned.
'
- operationId: getUser
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UserResponse'
- '404':
- description: Not found
- '500':
- description: Internal Server Error
- x-response-codes:
- errors:
- '140000':
- domain: API_IDENTITY
- category: APPLICATION
- description: There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
- security:
- - api_auth:
- - https://api.ebay.com/oauth/api_scope/commerce.identity.readonly
- - https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly
- - https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly
- - https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly
- - https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly
-components:
- schemas:
- Address:
- type: object
- properties:
- addressLine1:
- type: string
- description: The first line of the street address.
- addressLine2:
- type: string
- description: The second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.
- city:
- type: string
- description: The city of the address.
- country:
- type: string
- description: The two-letter ISO 3166 standard of the country of the address. For implementation help, refer to eBay API documentation
- county:
- type: string
- description: The county of the address.
- postalCode:
- type: string
- description: The postal code of the address.
- stateOrProvince:
- type: string
- description: The state or province of the address.
- description: The type that defines the fields for an address.
- BusinessAccount:
- type: object
- properties:
- address:
- description: 'The container that returns the address of the business account. '
- $ref: '#/components/schemas/Address'
- doingBusinessAs:
- type: string
- description: An additional name that is used for their business on eBay. The business name is returned in the name field.
- email:
- type: string
- description: The email address of the business account.
- name:
- type: string
- description: The business name associated with the user's eBay account.
- primaryContact:
- description: The container that returns the contact details of the person who is the primary contact for this account.
- $ref: '#/components/schemas/Contact'
- primaryPhone:
- description: The container that returns the primary phone number for the business account.
- $ref: '#/components/schemas/Phone'
- secondaryPhone:
- description: The container that returns the secondary phone number for the business account.
- $ref: '#/components/schemas/Phone'
- website:
- type: string
- description: The business website address associated with the eBay account.
- description: The type that defines the fields for the business account information.
- Contact:
- type: object
- properties:
- firstName:
- type: string
- description: The first name of the contact person.
- lastName:
- type: string
- description: The last name of the contact person.
- description: The type that defines the fields for the information of the contact person for the account.
- Error:
- type: object
- properties:
- category:
- type: string
- description: Identifies the type of erro.
- domain:
- type: string
- description: Name for the primary system where the error occurred. This is relevant for application errors.
- errorId:
- type: integer
- description: A unique number to identify the error.
- format: int32
- inputRefIds:
- type: array
- description: An array of request elements most closely associated to the error.
- items:
- type: string
- longMessage:
- type: string
- description: A more detailed explanation of the error.
- message:
- type: string
- description: Information on how to correct the problem, in the end user's terms and language where applicable.
- outputRefIds:
- type: array
- description: An array of request elements most closely associated to the error.
- items:
- type: string
- parameters:
- type: array
- description: An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.
- items:
- $ref: '#/components/schemas/ErrorParameter'
- subdomain:
- type: string
- description: 'Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.'
- description: This type defines the fields that can be returned in an error.
- ErrorParameter:
- type: object
- properties:
- name:
- type: string
- description: The object of the error.
- value:
- type: string
- description: The value of the object.
- IndividualAccount:
- type: object
- properties:
- email:
- type: string
- description: The eBay user's registration email address.
- firstName:
- type: string
- description: The eBay user's first name.
- lastName:
- type: string
- description: The eBay user's last name.
- primaryPhone:
- description: The container that returns the eBay user's primary phone number information.
- $ref: '#/components/schemas/Phone'
- registrationAddress:
- description: The container that returns the eBay user's address information.
- $ref: '#/components/schemas/Address'
- secondaryPhone:
- description: The container that returns the eBay user's secondary phone number information.
- $ref: '#/components/schemas/Phone'
- description: The type that defines the fields for the information of an individual account.
- Phone:
- type: object
- properties:
- countryCode:
- type: string
- description: The two-letter ISO 3166 standard of the country to which the phone number belongs.
- number:
- type: string
- description: The numeric string representing the phone number.
- phoneType:
- type: string
- description: 'The type of phone service.
Valid Values: MOBILE or LAND_LINE
Code so that your app gracefully handles any future changes to this list.'
- description: The type that defines the fields for the details of a phone.
- UserResponse:
- type: object
- properties:
- accountType:
- type: string
- description: 'Indicates the user account type. This is determined when the user registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in the following countries:
Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation'
- businessAccount:
- description: The container that returns the business account information of the user.
- $ref: '#/components/schemas/BusinessAccount'
- individualAccount:
- description: The account information of the user.
- $ref: '#/components/schemas/IndividualAccount'
- registrationMarketplaceId:
- type: string
- description: The eBay site on which the account is registered. For implementation help, refer to eBay API documentation
- status:
- type: string
- description: 'Indicates the user''s account status. Possible values: CONFIRMED, UNCONFIRMED, ACCOUNTONHOLD and UNDETERMINED. For implementation help, refer to eBay API documentation'
- userId:
- type: string
- description: The eBay immutable user ID of the user's account and can always be used to identify the user.
- username:
- type: string
- description: 'The user name, which was specific by the user when they created the account.
Note: This value can be changed by the user.'
- description: The type that defines the fields for the getUser method.
- securitySchemes:
- api_auth:
- type: oauth2
- description: The security definitions for this API. Please check individual operations for applicable scopes.
- flows:
- authorizationCode:
- authorizationUrl: https://auth.ebay.com/oauth2/authorize
- tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
- scopes:
- https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly: View a user's personal email information from their eBay member account
- https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly: View a user's personal address information from their eBay member account
- https://api.ebay.com/oauth/api_scope/commerce.identity.readonly: View a user's basic information, such as username or business account details, from their eBay member account
- https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly: View a user's first and last name from their eBay member account
- https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly: View a user's personal telephone information from their eBay member account
diff --git a/specs/openapi/international-shipping.json b/specs/openapi/international-shipping.json
new file mode 100644
index 0000000..e6cfe13
--- /dev/null
+++ b/specs/openapi/international-shipping.json
@@ -0,0 +1,6097 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "EDIS public shipping API",
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to retrieve the actual weight and cost for one or more packages based on the provided input criteria.
Responses can be filtered by the tracking_numbers query parameter. If this parameter is used, actual costs for each package associated with the provided tracking numbers are returned.
Alternatively, responses can be filtered by the trans_begin_time and trans_end_time query parameters. If these parameters are used, the actual costs of all packages created within this date range are returned.
Only one filtering method can be used per call.",
+ "operationId": "getActualCosts",
+ "parameters": [
+ {
+ "name": "tracking_numbers",
+ "in": "query",
+ "description": "This query parameter specifies the tracking number(s) of the package(s) for which to retrieve the actual weight and cost. Tracking numbers are returned when creating packages through the createPackage method.
Up to 200 tracking numbers can be provided.
Note: This query parameter is required if trans_begin_time and trans_end_time is not provided.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "trans_begin_time",
+ "in": "query",
+ "description": "This query parameter specifies the start time of a transaction in UTC format.
If the the trans_begin_time and trans_end_time query parameters are used, the actual costs of all packages created within this date range are returned.
Note: This query parameter and trans_end_time are required if tracking_numbers is not provided. Format: YYYY-MM-DDTHH:MM:SS.SSSZ",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "trans_end_time",
+ "in": "query",
+ "description": "This query parameter specifies ending time of a transaction in UTC format.
If the the trans_begin_time and trans_end_time query parameters are used, the actual costs of all packages created within this date range are returned.
Note: This query parameter and trans_start_time are required if tracking_numbers is not provided. Format: YYYY-MM-DDTHH:MM:SS.SSSZ",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetActualCostResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355069": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The date format of the trans_begin_time field is incorrect."
+ },
+ "355070": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The date format of the trans_end_time field is incorrect."
+ },
+ "355071": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified tracking number {tracking_number} does not belong to the seller, so cannot be retrieved."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/address_preference": {
+ "get": {
+ "tags": [
+ "address_preference"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve information about all the ship-from and/or return addresses associated with a seller's eDIS account.",
+ "operationId": "getAddressPreferences",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetAddressPreferenceListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "address_preference"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to create an address on your eDIS account.
The following types of addresses can be created through this method:
SHIP_FROM_ADDRESS
RETURN_ADDRESS
The address information for the address, including location details, contact information, and address type, must be provided in the shipFromAddress container. If the call is successful, the addressId for the newly created address will be returned. This identifier can then be used when creating a package to specify the address to use for the shipment.",
+ "operationId": "createAddressPreference",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateAddressPreferenceRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateAddressPreferenceResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355002": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Length of street can not be greater than 50. Please revise it."
+ },
+ "355072": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value for countrycode. Please revise it."
+ },
+ "355073": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value for province. Please revise it."
+ },
+ "355074": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value for city. Please revise it."
+ },
+ "355075": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value for district. Please revise it."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ },
+ "355049": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "Connection failed with logistic service provider system. Please wait and retry."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/agents": {
+ "get": {
+ "tags": [
+ "agents"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve information about the EU Authorized Representative (AR) agent(s) associated with a seller's eDIS account.
An EU AR agent acts as a liaison between non-EU manufacturers and European regulatory authorities to ensure compliance with EU regulations. This method returns contact information about each agent, as well as their eBay ID and the countries that they support.",
+ "operationId": "getAgents",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "This query parameter sets the maximum number of agents to return on each page of the paginated response.
Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.
Max: 200
Default: 50",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "This query parameter specifies the number of agents to skip in the result set before returning the first agent in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.
Default: 0",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetAgentListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355076": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value of pagination parameters. Please revise them."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/battery_qualifications": {
+ "get": {
+ "tags": [
+ "battery_qualifications"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to retrieve all battery qualifications associated with your eDIS account. This includes the type, electronic qualification ID and name, and expiration date for each battery.",
+ "operationId": "getBatteryQualifications",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "This query parameter sets the maximum number of qualifications to return on each page of the paginated response.
Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.
Max: 200
Default: 50",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "This query parameter specifies the number of qualifications to skip in the result set before returning the first qualification in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.
Default: 0",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetBatteryQualListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355076": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value of pagination parameters. Please revise them."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/bundle/{bundle_id}/cancel": {
+ "post": {
+ "tags": [
+ "bundle"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to cancel a bundle.
The bundleId value of the bundle to be canceled must be input as a path parameter in the request.
Note: Bundles cannot be canceled if they are currently being processed.",
+ "operationId": "cancelBundle",
+ "parameters": [
+ {
+ "name": "bundle_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the bundle being canceled.
This ID value is returned when creating a bundle through the createBundle method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355082": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "No permission to access requested data."
+ },
+ "355083": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing or invalid bundle_id value."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/bundle": {
+ "post": {
+ "tags": [
+ "bundle"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to create a bundle for multiple packages in an order.
To create a bundle, the consign address to be associated with the bundle and the tracking numbers of the packages to be used in the bundle must be specified in the request.
If the call is successful, the bundleId for the newly created bundle will be returned.
Note: Sellers should keep track of the returned bundleId, as there is no programmatic way to retrieve this value at this time.",
+ "operationId": "createBundle",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateBundleRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateBundleResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355078": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing consign preference ID. Please check."
+ },
+ "355079": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing tracking numbers. Please check."
+ },
+ "355080": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Please choose packages with same consign preference option."
+ },
+ "355081": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Total weight exceeded. Please check."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/bundle/{bundle_id}": {
+ "get": {
+ "tags": [
+ "bundle"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method is used to retrieved information about a specific bundle based on the provided bundle ID value.
The bundle_id value of the bundle to be retrieved must be input as a path parameter in the request. If the call is successful, information about the bundle is returned, such as its associated consign preference ID and the tracking numbers of each package in the bundle.",
+ "operationId": "getBundle",
+ "parameters": [
+ {
+ "name": "bundle_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the bundle being retrieved.
This ID value is returned when creating a bundle through the createBundle method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BundleDetailResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355082": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "No permission to access requested data."
+ },
+ "355083": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing or invalid bundle_id value."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/bundle/{bundle_id}/label": {
+ "get": {
+ "tags": [
+ "bundle"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve the bundle label for a bundle of packages.
The bundle for which to retrieve a bundle label is specified through the bundleId path parameter.
Bundle labels will be returned as base64 string values which can be converted to PDF files.",
+ "operationId": "getBundleLabel",
+ "parameters": [
+ {
+ "name": "bundle_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the bundle for which to retrieve a label.
This ID value is returned when creating a bundle through the createBundle method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/BundleLabelResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355082": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "No permission to access requested data."
+ },
+ "355083": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing or invalid bundle_id value."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/complaint": {
+ "post": {
+ "tags": [
+ "complaint"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to create a complaint about a shipment order. Complaints can be filed if there is a pickup delay on an order or if an item has been lost in transit.
The complaint reason, complaint type, and the date the issue occurred must be specified in the request. If the complaint is being filed for a missing package, the affected packageId values must also be specified in the affectedPackages array.
If the call was successful, HTTP status code 201 Created will be returned, and the complaint will be created.",
+ "operationId": "createComplaint",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddComplaintRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355060": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Complaint submission is declined on logistic service provider side. Please contact customer service for help."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/consign_preference": {
+ "get": {
+ "tags": [
+ "consign_preference"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve information about all the pickup, drop-off, and/or forward deployment consign addresses associated with a seller's eDIS account.",
+ "operationId": "getConsignPreferences",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetConsignPreferenceListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "consign_preference"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to create a consign address.
The following types of address preferences can be created via this method:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
RDC
CN_POST_DROP_OFF
CN_POST_PICK_UP
HK_POST_DROP_OFF
The address information for the consign address must be provided in the consignAddress container. If the call is successful, the addressId for the newly created address will be returned. This ID can then be used when creating a package to specify the consign address to use for the shipment.",
+ "operationId": "createConsignPreference",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateConsignPreferenceRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateConsignPreferenceResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355050": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid value for type. Please check the document."
+ },
+ "355051": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "pickupTime is missing. Please check."
+ },
+ "355053": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Connection failed with backend service. Please wait and retry."
+ },
+ "355055": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing package address. Please check."
+ },
+ "355056": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing request period. Please check."
+ },
+ "355057": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Missing address ID of dropoff site. Please check."
+ },
+ "355058": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Shipping preference name already exists. Please add a new name."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/cpsc_profiles": {
+ "get": {
+ "tags": [
+ "cpsc_profiles"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve all Consumer Product Safety Committee (CPSC) profiles associated with a user's account.
Pagination query parameters are provided that allow users to control how many profiles are returned in the response.",
+ "operationId": "getCpscProfiles",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "This query parameter sets the maximum number of profiles to return on each page of the paginated response.
Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.
Max: 200
Default: 50",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "This query parameter specifies the number of profiles to skip in the result set before returning the first location in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.
Default: 0",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetCpscProfilesResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355076": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value of pagination parameters. Please revise them."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/dropoff_sites": {
+ "get": {
+ "tags": [
+ "dropoff_sites"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve metadata for one or more drop-off sites associated with a seller's eDIS account.
Pagination query parameters are provided that allow users to control how many drop-off site locations are returned in the response.",
+ "operationId": "getDropoffSites",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "This query parameter sets the maximum number of drop-off site locations to return on each page of the paginated response.
Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.
Max: 200
Default: 50",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "This query parameter specifies the number of drop-off site locations to skip in the result set before returning the first location in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.
Default: 0",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetDropoffSiteListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355076": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value of pagination parameters. Please revise them."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/handover_sheet": {
+ "get": {
+ "tags": [
+ "handover_sheet"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve the handover sheet for one or more packages in a pickup request.
The tracking numbers for the packages for which to retrieve handover sheets are specified through the tracking_numbers query parameter.
The retrieved handover sheet will be returned as a base64 string value, and can be used for confirmation with a pickup contact. Only one handover sheet will be returned for the specified packages.",
+ "operationId": "getHandoverSheet",
+ "parameters": [
+ {
+ "name": "tracking_numbers",
+ "in": "query",
+ "description": "This query parameter specifies an array of tracking numbers for the packages for which to retrieve a handover sheet.
Tracking numbers are returned when creating packages through the createPackage method.
Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters. For example,
tracking_numbers=E***********************N&tracking_numbers=E***********************Q",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetHandoverSheetResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355067": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The field tracking_numbers is required."
+ },
+ "355068": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/labels": {
+ "get": {
+ "tags": [
+ "labels"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve shipping labels for the one or more specified packages.
The packages for which to retrieve shipping labels can be specified through the tracking_numbers query parameter. The page size and print preference settings for the shipping label(s) can also be specified through the query parameters.
Shipping labels are returned as base64 string values which can be converted to PDF files. A separate file will be returned for each tracking number specified in the request.",
+ "operationId": "getLabels",
+ "parameters": [
+ {
+ "name": "page_size",
+ "in": "query",
+ "description": "This query parameter specifies the page size of the retrieved shipping labels.
Valid values:
A4
THERMAL_PAPER
",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "print_preference",
+ "in": "query",
+ "description": "This query parameter specifies one or more printing preferences to be set when retrieving shipping labels. Multiple values can be delimited by a comma.
Valid values:
nameZh
nameEn
remark
skuPrice
skuNo
quantity
listingId
sellerId
buyerId
",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "tracking_numbers",
+ "in": "query",
+ "description": "This query parameter specifies an array of tracking numbers of the packages for which to retrieve shipping labels.
Tracking numbers are returned when creating packages through the createPackage method.
Up to 200 tracking numbers can be provided. Multiple tracking numbers can be input as individual query parameters.For example,
tracking_numbers=E***********************N&tracking_numbers=E***********************Q",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetLabelListResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355067": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The field tracking_numbers is required."
+ },
+ "355068": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again."
+ },
+ "355071": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified tracking number {tracking_number} does not belong to the seller, so cannot be retrieved."
+ },
+ "355077": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid input value for page setting parameters. Please revise it."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/bulk_cancel_packages": {
+ "post": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to cancel multiple packages and their associated tracking numbers.
The package ID values for the packages to be canceled must be input in the packageIds array of the request.
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to confirm the shipping order for multiple packages.
The package ID values for the packages to be confirmed must be input in the packageIds array of the request.
After a package is confirmed, the estimated cost will be frozen in your wallet and the pickup request will be submitted.",
+ "operationId": "bulkConfirmPackages",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ConfirmPackagesRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ConfirmPackagesResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ },
+ "355036": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Package processing. Please try again later."
+ },
+ "355037": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid packageId {packageId}. Please verify and try again."
+ },
+ "355038": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to its current status. Please check the status and try again."
+ },
+ "355039": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to missing or invalid battery qualification. Please update battery qualification and try again."
+ },
+ "355040": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to missing or invalid tracking number. Please add tracking number for package and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/bulk_delete_packages": {
+ "post": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to delete multiple packages.
The package ID values for the packages to be deleted must be input in the packageIds array of the request.
Note: Packages can only be deleted once they have been cancelled through the cancelPackage or bulkCancelPackages methods and no longer have a tracking number associated with them.",
+ "operationId": "bulkDeletePackages",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeletePackagesRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeletePackagesResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ },
+ "355064": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be deleted due to its current status. Please check the status and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/{package_id}/cancel": {
+ "post": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to cancel a package and its associated tracking number.
The packageId value of the package to be canceled must be input as a path parameter in the request.
Note: Packages cannot be canceled if they are currently being processed.",
+ "operationId": "cancelPackage",
+ "parameters": [
+ {
+ "name": "package_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the package being canceled.
This ID value is returned when creating a package through the createPackage method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ },
+ "355036": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Package processing. Please try again later."
+ },
+ "355037": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid packageId {packageId}. Please verify and try again."
+ },
+ "355042": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be cancelled due to its current status. Please check status and try again."
+ },
+ "355044": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Cancel failed on logistic service provider side. Please contact logistic customer service for help."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/{package_id}/clone": {
+ "post": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to clone a package for redelivery, resending the package with the same information input during the createPackage call.
The packageId value of the package to be cloned must be input as a path parameter in the request.",
+ "operationId": "clonePackage",
+ "parameters": [
+ {
+ "name": "package_id",
+ "in": "path",
+ "description": "This path parameter specifies the packageId value of the package to be cloned.
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to confirm the shipping order for a package.
The packageId value of the package to be confirmed must be input as a path parameter in the request.
After confirmation the estimated cost will be frozen in your wallet and the pickup request will be submitted.",
+ "operationId": "confirmPackage",
+ "parameters": [
+ {
+ "name": "package_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the package you wish to be confirmed.
This ID value is returned when creating a package through the createPackage method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ },
+ "355036": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Package processing. Please try again later."
+ },
+ "355037": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid packageId {packageId}. Please verify and try again."
+ },
+ "355038": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to its current status. Please check the status and try again."
+ },
+ "355039": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to missing or invalid battery qualification. Please update battery qualification and try again."
+ },
+ "355040": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be confirmed due to missing or invalid tracking number. Please add tracking number for package and try again."
+ },
+ "355041": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Package processing. Please try again later."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package": {
+ "post": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to create a package for an order.
To create a package, the package's shipping information, such as the dimensions, weight, ship from, and ship to address, as well as information about the item(s) it contains must be specified in the request.
If the call is successful, the packageId and tracking number for the newly created package will be returned.
Note: Sellers should keep track of the returned packageId, as there is no programmatic way to retrieve this value at this time.",
+ "operationId": "createPackage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddPackageRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddPackageResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355003": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Our current system setting is not allowing you to add packages via API. Please change your settings to 'ship via API' and try again."
+ },
+ "355005": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "OrderLineItem {orderLineItemId} has already been assigned to another package, so cannot be added to this one."
+ },
+ "355008": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "OrderLineItem is not matched to your ebayID. Please check."
+ },
+ "355009": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The order has not been synced to the system yet. Please wait and retry."
+ },
+ "355011": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Order has not been paid. Please check."
+ },
+ "355012": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "ServiceId does not exist. Please check the document."
+ },
+ "355013": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The fdcSkus array cannot be empty. Please include this array and add at least one sku and associated quantity for that sku."
+ },
+ "355014": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "You have exceeded the maximum amount of skus allowed under the fdcSkus array."
+ },
+ "355015": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Each sku under fdcSkus array requires skuId and quantity. Please revise them."
+ },
+ "355016": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The skus array has one or more duplicate skuId values. Please remove duplicate skus."
+ },
+ "355017": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Length of skuId can not be greater than 50. Please revise it."
+ },
+ "355018": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The SPECIAL_GOODS_WITH_NO_BATTERY enum value is only allowed when miniPackage is specified as the packagingType value."
+ },
+ "355019": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "User T&C update. Please sign the updated version of the Letter of Commitment for Lithium Battery items."
+ },
+ "355020": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Your elecQualificationId does not exist. Please check your qualification list."
+ },
+ "355021": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The status of elecQualificationId is not available. Please check."
+ },
+ "355022": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Your elecQualificationId is expired. Please update a new one."
+ },
+ "355023": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "LiBatteryType is not matched to battery qualification."
+ },
+ "355024": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "No available shipping service found. Please revise package information and retry."
+ },
+ "355025": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "ServiceId not available. Please revise it and retry."
+ },
+ "355026": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Package is now under processing. Please retry later."
+ },
+ "355030": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The seller's balance could not be accessed to pay for the package. Please contact logistics customer service for help."
+ },
+ "355031": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Account balance is not enough to pay for the package. Please add sufficient funds to balance and try again."
+ },
+ "355063": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "AgentName or agentAddress is missing. Please revise them."
+ },
+ "355084": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The cpscProfileId or exemptionType is required for this shipment."
+ },
+ "355085": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid exemptionType value: ADULT_PRODUCT_USED is not applicable for items with condition 'New'"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ },
+ "355066": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "Concurrent actions on same orderLineItem. Please wait and retry."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/{package_id}": {
+ "get": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve a package based on the provided package ID value.
The packageId value of the package to be retrieved must be input as a path parameter in the request. If the call is successful, information about the package is returned, such as the package's shipping information (its dimensions, weight, ship from, and ship to address) and information about the item(s) it contains.",
+ "operationId": "getPackage",
+ "parameters": [
+ {
+ "name": "package_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the package being retrieved.
This ID value is returned when creating a package through the createPackage method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetPackageDetailResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to delete a package.
The packageId value of the package to be deleted must be input as a path parameter in the request. If the call is successful, HTTP status code 204 No Content will be returned, and the package will be deleted.
Note: Packages can only be deleted once they have been cancelled through the cancelPackage or bulkCancelPackages methods and no longer have a tracking number associated with them.",
+ "operationId": "deletePackage",
+ "parameters": [
+ {
+ "name": "package_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the package being deleted. This package must already be cancelled and have no tracking number associated with it.
This ID value is returned when creating a package through the createPackage method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355004": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified packageId {packageId} is not recognized. Please check and try again."
+ },
+ "355064": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The package cannot be deleted due to its current status. Please check the status and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/package/{order_line_item_id}/item": {
+ "get": {
+ "tags": [
+ "package"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve one or more packages based on the provided order line item ID.
This method can be followed up with getPackage call to retrieve more detailed information about a specific package.",
+ "operationId": "getPackagesByLineItemID",
+ "parameters": [
+ {
+ "name": "order_line_item_id",
+ "in": "path",
+ "description": "This path parameter can be used to specify the unique identifier of the line item that is part of the package being retrieved.
This value is returned in the lineItemId field of the getOrders method of the Fulfillment API or the GetOrders method of the Trading API.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple",
+ "explode": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetItemPackageIdResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355062": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "Invalid orderLineItemId {orderLineitemId}. Please verify and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ },
+ "/services": {
+ "get": {
+ "tags": [
+ "services"
+ ],
+ "description": "
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve metadata on available shipping services, such as the name, description, and directions.",
+ "operationId": "getServices",
+ "parameters": [
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "This query parameter sets the maximum number of shipping services to return on each page of the paginated response.
Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10, the call retrieves orders 11 through 20 from the result set.
Max: 200
Default: 50",
+ "required": false,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "This query parameter specifies the number of shipping services to skip in the result set before returning the first shipping service in the paginated response.
Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call.
Important! This method is only available for Greater-China based sellers with an active eDIS account.
This method can be used to retrieve tracking event details for a package associated with the provided tracking number.
Each tracking event is returned in the trackingDetails array and includes the description, location, time, and status of the event.",
+ "operationId": "getTracking",
+ "parameters": [
+ {
+ "name": "tracking_number",
+ "in": "query",
+ "description": "This query parameter specifies the tracking number for which to retrieve current tracking event details.
This value is returned when creating a package through the createPackage method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetTrackingDetailResponses"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355068": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The specified tracking number {tracking_number} is not recognized. Please check and try again."
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355400": {
+ "domain": "API_EDIS",
+ "category": "REQUEST",
+ "description": "The access token provided in the Authorization header is not for an eBay user account that is currently allowed to call this API. Please go to account settings to add to your account list."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "355000": {
+ "domain": "API_EDIS",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/sell.edelivery"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AddComplaintRequest": {
+ "type": "object",
+ "required": [
+ "complaintRequest"
+ ],
+ "properties": {
+ "complaintRequest": {
+ "description": "This container is used to specify the information included in a complaint request, such as the complaint reason, date, and type.",
+ "$ref": "#/components/schemas/AddComplaintRequestData"
+ }
+ },
+ "description": "This type is used to define the request container of the createComplaint method."
+ },
+ "AddComplaintRequestData": {
+ "type": "object",
+ "required": [
+ "complaintDate",
+ "complaintReason",
+ "complaintType"
+ ],
+ "properties": {
+ "affectedPackages": {
+ "type": "array",
+ "description": "This array specifies a list of packages, specified by their packageId, affected by the issue causing the complaint.
Package ID values are returned when creating a package through the createPackage method
This array is required if the complaint being filed is for a missing package.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "complaintDate": {
+ "type": "string",
+ "description": "The date in which the issue associated with the complaint occurred.
Format:YYYY-MM-DDTHH:MM:SS.SSSZ "
+ },
+ "complaintReason": {
+ "type": "string",
+ "description": "This string specifies the reason the complaint was filed.
Max length: 200 characters"
+ },
+ "complaintType": {
+ "description": "The type of complaint being filed.
Valid values:
ABNORMAL_COLLECTION_COMPLAINT
LOST_PACKAGE_COMPLAINT
",
+ "$ref": "#/components/schemas/ComplaintTypeEnum"
+ },
+ "preferenceId": {
+ "type": "integer",
+ "description": "The unique identifier of the address associated with the complaint.
This field is required if the complain being filed is associated with a specific address.",
+ "format": "int32"
+ },
+ "remark": {
+ "type": "string",
+ "description": "A remark to the seller themselves."
+ }
+ },
+ "description": "This type specifies the information included in a complaint request."
+ },
+ "AddPackageRequest": {
+ "type": "object",
+ "required": [
+ "packageInfo"
+ ],
+ "properties": {
+ "packageInfo": {
+ "description": "This container is used to specify the information needed to create a package.",
+ "$ref": "#/components/schemas/PackageInfoRequest"
+ }
+ },
+ "description": "This type defines the request container used in the createPackage method."
+ },
+ "AddPackageResponses": {
+ "type": "object",
+ "required": [
+ "createPackageResult"
+ ],
+ "properties": {
+ "createPackageResult": {
+ "description": "This container returns information about the newly created package, including its tracking number and packageId value.",
+ "$ref": "#/components/schemas/AddPackageResponsesData"
+ }
+ },
+ "description": "This type defines the response container used in the createPackage method."
+ },
+ "AddPackageResponsesData": {
+ "type": "object",
+ "required": [
+ "estimateCost",
+ "packageId",
+ "trackingNumber"
+ ],
+ "properties": {
+ "estimateCost": {
+ "description": "The estimated shipping cost of the package.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "lastMileTrackingNumber": {
+ "type": "string",
+ "description": "The last-mile tracking number of the package.
This field is only returned if the last-mile tracking number is provided by the carrier."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the created package.
Note: Sellers should keep track of the returned packageId, as there is no programmatic way to retrieve this value at this time."
+ },
+ "paymentCost": {
+ "description": "The actual payment cost of the package.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number of the created package."
+ }
+ },
+ "description": "This type specifies information about the newly created package, such as its estimated costs, tracking number, and package ID value."
+ },
+ "AddressTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the type of an address. | - **SHIP_FROM_ADDRESS**: This enum value indicates that the address is a ship-from address. - **RETURN_ADDRESS**: This enum value indicates that the address is a return address.",
+ "enum": [
+ "SHIP_FROM_ADDRESS",
+ "RETURN_ADDRESS"
+ ]
+ },
+ "AgentInfoData": {
+ "type": "object",
+ "properties": {
+ "agentAddress": {
+ "type": "string",
+ "description": "The address of the EU AR agent."
+ },
+ "agentName": {
+ "type": "string",
+ "description": "The name of the EU AR agent."
+ },
+ "agentPhone": {
+ "type": "string",
+ "description": "The phone number of the EU AR agent."
+ }
+ },
+ "description": "This type defines information about an EU AR agent, such as their address, name, and phone number."
+ },
+ "AgentModelResponses": {
+ "type": "object",
+ "required": [
+ "agentAddress",
+ "agentName",
+ "agentPhone",
+ "agentPreferences",
+ "arName"
+ ],
+ "properties": {
+ "agentAddress": {
+ "type": "string",
+ "description": "The address of the EU AR agent."
+ },
+ "agentName": {
+ "type": "string",
+ "description": "The name of the EU AR agent."
+ },
+ "agentPhone": {
+ "type": "string",
+ "description": "The phone number of the EU AR agent."
+ },
+ "agentPreferences": {
+ "type": "array",
+ "description": "This array returns the supported shipping countries and eBay user IDs associated with the EU AR agent.",
+ "items": {
+ "$ref": "#/components/schemas/AgentPreferenceListResponse"
+ }
+ },
+ "arName": {
+ "type": "string",
+ "description": "The seller-defined setting name of the AR agent."
+ }
+ },
+ "description": "This type defines the fields that describe an EU AR agent."
+ },
+ "AgentPreferenceListResponse": {
+ "type": "object",
+ "required": [
+ "ebayId",
+ "shippingCountry"
+ ],
+ "properties": {
+ "ebayId": {
+ "type": "string",
+ "description": "The eBay ID of the EU AR agent."
+ },
+ "shippingCountry": {
+ "type": "string",
+ "description": "The two-letter ISO 3166 code of the shipping country that an EU AR agent supports."
+ }
+ },
+ "description": "This type defines the fields that describe a EU AR agents preferences."
+ },
+ "Amount": {
+ "type": "object",
+ "properties": {
+ "currency": {
+ "description": "This enum value represents the type of currency being used. Both the value and currency fields are required/always returned when expressing cost.
See the CurrencyCodeEnum type for the full list of supported values.
Both the value and currency fields are required/always returned when expressing cost.",
+ "$ref": "#/components/schemas/CurrencyCodeEnum"
+ },
+ "value": {
+ "type": "string",
+ "description": "The monetary amount, in the currency specified by the currency field.
Both the value and currency fields are required/always returned when expressing cost."
+ }
+ },
+ "description": "This type defines the monetary value of an amount. "
+ },
+ "BatteryQualResponses": {
+ "type": "object",
+ "required": [
+ "batteryType",
+ "elecQualificationId",
+ "elecQualificationName",
+ "expireDate",
+ "remark"
+ ],
+ "properties": {
+ "batteryType": {
+ "description": "The type of the battery.",
+ "$ref": "#/components/schemas/LiBatteryTypeEnum"
+ },
+ "elecQualificationId": {
+ "type": "string",
+ "description": "The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping."
+ },
+ "elecQualificationName": {
+ "type": "string",
+ "description": "The name of the battery's electric qualification."
+ },
+ "expireDate": {
+ "type": "string",
+ "description": "The expiration date of the battery qualification."
+ },
+ "remark": {
+ "type": "string",
+ "description": "A remark to the seller themselves.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ }
+ },
+ "description": "This type defines the fields to describe a battery's qualifications."
+ },
+ "BundleDetailResponse": {
+ "type": "object",
+ "required": [
+ "bundleDetail"
+ ],
+ "properties": {
+ "bundleDetail": {
+ "description": "This container returns information about the retrieved bundle, such as its tracking numbers and consign preference ID.",
+ "$ref": "#/components/schemas/BundleDetailResponseData"
+ }
+ },
+ "description": "This type defines the response payload of the getBundle method."
+ },
+ "BundleDetailResponseData": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId",
+ "trackingNumbers"
+ ],
+ "properties": {
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the consign address associated with the retrieved bundle."
+ },
+ "trackingNumbers": {
+ "type": "array",
+ "description": "This array specifies the tracking numbers of the packages included in the bundle.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "This type is used to specify information, such as the tracking numbers and consign preference ID, of a bundle."
+ },
+ "BundleLabelResponse": {
+ "type": "object",
+ "required": [
+ "label"
+ ],
+ "properties": {
+ "label": {
+ "description": "This container returns the bundle label information, such as the base64 string value, for the specified bundle.",
+ "$ref": "#/components/schemas/BundleLabelResponseData"
+ }
+ },
+ "description": "This type defines the response container of the getBundleLabel method."
+ },
+ "BundleLabelResponseData": {
+ "type": "object",
+ "required": [
+ "base64Str"
+ ],
+ "properties": {
+ "base64Str": {
+ "type": "string",
+ "description": "The base 64 string value for the bundle label.
This string value can be converted into a PDF file."
+ }
+ },
+ "description": "This type defines the base64 string value used to download a bundle label PDF file."
+ },
+ "CancelPackagesRequest": {
+ "type": "object",
+ "required": [
+ "requests"
+ ],
+ "properties": {
+ "requests": {
+ "description": "This container is used to specify the package ID values for the packages being canceled.",
+ "$ref": "#/components/schemas/CancelPackagesRequestData"
+ }
+ },
+ "description": "This type defines the request container for the bulkCancelPackages method."
+ },
+ "CancelPackagesRequestData": {
+ "type": "object",
+ "required": [
+ "packageIds"
+ ],
+ "properties": {
+ "packageIds": {
+ "type": "array",
+ "description": "This comma-delimited array lists the unique identifiers of the packages being canceled.
Up to 200 package IDs can be specified.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "This type indicates the IDs of the packages being canceled."
+ },
+ "CancelPackagesResponses": {
+ "type": "object",
+ "required": [
+ "responses"
+ ],
+ "properties": {
+ "responses": {
+ "type": "array",
+ "description": "This array returns the result code and message for each cancelled package. Each package is denoted by its package ID value.",
+ "items": {
+ "$ref": "#/components/schemas/CancelPackagesResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container of the bulkCancelPackages method."
+ },
+ "CancelPackagesResponsesData": {
+ "type": "object",
+ "required": [
+ "message",
+ "packageId",
+ "resultCode"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "This string returns any additional information about the cancelation of the package."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the canceled package."
+ },
+ "resultCode": {
+ "type": "string",
+ "description": "The result code detailing the results cancelation process.
For example, a result code of 200 indicates that the call was a success and the package and tracking number were canceled."
+ }
+ },
+ "description": "This type indicates the response data returned after canceling multiple packages."
+ },
+ "ClonePackageResponses": {
+ "type": "object",
+ "required": [
+ "clonePackageResult"
+ ],
+ "properties": {
+ "clonePackageResult": {
+ "description": "This container returns the package ID, payment cost, and tracking number for the cloned package.",
+ "$ref": "#/components/schemas/ClonePackageResponsesData"
+ }
+ },
+ "description": "This type defines the response container used in the clonePackage method."
+ },
+ "ClonePackageResponsesData": {
+ "type": "object",
+ "required": [
+ "packageId",
+ "trackingNumber"
+ ],
+ "properties": {
+ "lastMileTrackingNumber": {
+ "type": "string",
+ "description": "The last-mile tracking number of the package.
This field is only returned if the last-mile tracking number is provided by the carrier."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the package. A new packageId value is generated when a package is cloned."
+ },
+ "paymentCost": {
+ "description": "The payment cost for the package.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number for the cloned package."
+ }
+ },
+ "description": "This type specifies the package ID, payment cost, tracking number, and last-mile tracking number (if applicable) for the cloned package."
+ },
+ "ComplaintTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the types of complaints supported by the createComplaint method. | - **ABNORMAL_COLLECTION_COMPLAINT**: This enum value indicates that the complaint is being filed for an abnormal collection. This means there was an issue with the postman collecting the package. - **LOST_PACKAGE_COMPLAINT**: This enum value indicates that the complaint is being filed because a package has been lost in transit.",
+ "enum": [
+ "ABNORMAL_COLLECTION_COMPLAINT",
+ "LOST_PACKAGE_COMPLAINT"
+ ]
+ },
+ "ConfirmPackagesRequest": {
+ "type": "object",
+ "required": [
+ "requests"
+ ],
+ "properties": {
+ "requests": {
+ "description": "This container is used to specify the package ID values of the packages being confirmed.",
+ "$ref": "#/components/schemas/ConfirmPackagesRequestData"
+ }
+ },
+ "description": "This type defines the request container of the bulkConfirmPackages method."
+ },
+ "ConfirmPackagesRequestData": {
+ "type": "object",
+ "required": [
+ "packageIds"
+ ],
+ "properties": {
+ "packageIds": {
+ "type": "array",
+ "description": "This comma-delimited array lists the unique identifiers of the packages being confirmed.
Up to 200 packages can be specified.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "This type specifies the IDs of the packages being confirmed."
+ },
+ "ConfirmPackagesResponses": {
+ "type": "object",
+ "required": [
+ "responses"
+ ],
+ "properties": {
+ "responses": {
+ "type": "array",
+ "description": "This array returns the result code and message for each confirmed package. Each package is denoted by its package ID value.",
+ "items": {
+ "$ref": "#/components/schemas/ConfirmPackagesResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container of the bulkConfirmPackages method."
+ },
+ "ConfirmPackagesResponsesData": {
+ "type": "object",
+ "required": [
+ "message",
+ "packageId",
+ "resultCode"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "This string returns any additional information about the confirmation of the package."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the confirmed package."
+ },
+ "resultCode": {
+ "type": "string",
+ "description": "The result code relating to the confirmation of the package.
For example, a result code of 200 indicates that the call was a success and the package was confirmed."
+ }
+ },
+ "description": "This type indicates the response data after confirming multiple packages."
+ },
+ "ConsignPreferenceInfoResponses": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId",
+ "consignPreferenceName",
+ "pickupAddress",
+ "type"
+ ],
+ "properties": {
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the consign address."
+ },
+ "consignPreferenceName": {
+ "type": "string",
+ "description": "The name of the consign address."
+ },
+ "dropoffSiteId": {
+ "type": "string",
+ "description": "The unique identifier of the drop-off site.
This field is only returned if the consign address is a drop-off location."
+ },
+ "pickupAddress": {
+ "description": "This container returns the address and contact information for a pickup address.
Note: This container is always returned, but will show as null or have an empty value if not defined/applicable.",
+ "$ref": "#/components/schemas/PickupAddressResponsesData"
+ },
+ "pickupTime": {
+ "description": "The supported pickup window that the pickup location supports.
This field is only returned if the consign address is a pickup-from location",
+ "$ref": "#/components/schemas/PickUpTimeTypeEnum"
+ },
+ "type": {
+ "description": "The address type of the consign address.
Valid values:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
",
+ "$ref": "#/components/schemas/ConsignTypeEnum"
+ }
+ },
+ "description": "This type specifies the fields used to create a consign address."
+ },
+ "ConsignTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the type of consign address. | - **PICK_UP**: This enum value indicates that the consign address is a pickup-from address. - **DROP_OFF**: This enum value indicates that the consign address is a drop-off address. - **FORWARD_DEPLOYMENT**: This enum value indicates that the consign address is a forward deployment address. Confirm with customer service before using this method. - **RDC**: This enum value indicates that the consign address is for seller direct drop-off to a SpeedPAKC sorting center. - **CN_POST_DROP_OFF**: This enum value indicates that the consign address is for seller drop-off to a China Post pickup site. - **CN_POST_PICK_UP**: This enum value indicates that the consign address is for seller request China Post pickup service. - **HK_POST_DROP_OFF**: This enum value indicates that the consign address is for seller drop-off to a Hong Kong Postal office site.",
+ "enum": [
+ "PICK_UP",
+ "DROP_OFF",
+ "FORWARD_DEPLOYMENT",
+ "RDC",
+ "CN_POST_DROP_OFF",
+ "CN_POST_PICK_UP",
+ "HK_POST_DROP_OFF"
+ ]
+ },
+ "CpscProfile": {
+ "type": "object",
+ "required": [
+ "cpscProfileId",
+ "name",
+ "type"
+ ],
+ "properties": {
+ "cpscProfileId": {
+ "type": "string",
+ "description": "The unique identifier of the CPSC profile assigned by eDIS.
This ID can be used to associate a SKU with this CPSC profile when creating a package."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CPSC profile."
+ },
+ "type": {
+ "description": "This enum returns the type of the CPSC profile.
Valid values:
REF_PGA
FULL_PGA
",
+ "$ref": "#/components/schemas/CpscTypeEnum"
+ }
+ },
+ "description": "This type defines the fields that provide information about a CPSC profile."
+ },
+ "CpscTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the type of a CPSC profile. | - **REF_PGA**: This enum value indicates that the CPSC profile type is Reference PGA. - **FULL_PGA**: This enum value indicates that the CPSC profile type is Full PGA.",
+ "enum": [
+ "REF_PGA",
+ "FULL_PGA"
+ ]
+ },
+ "CreateAddressPreferenceRequest": {
+ "type": "object",
+ "required": [
+ "shipFromAddress"
+ ],
+ "properties": {
+ "shipFromAddress": {
+ "description": "This container is used to specify the address details used to create an address.",
+ "$ref": "#/components/schemas/CreateAddressPreferenceRequestData"
+ }
+ },
+ "description": "This type is used to define the request container used in the createAddressPreference method."
+ },
+ "CreateAddressPreferenceRequestData": {
+ "type": "object",
+ "required": [
+ "city",
+ "company",
+ "contact",
+ "countryCode",
+ "district",
+ "name",
+ "phone",
+ "postcode",
+ "province",
+ "street1",
+ "type"
+ ],
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name associated with the address.
Max length: 50 characters"
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the address.
Max length: 50 characters"
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the address.
Valid values:
CN
HK
"
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the address.
Max length: 50 characters"
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the address.
Max length: 50 characters"
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line, if applicable, of the street address of the address.
Max length: 50 characters"
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line, if applicable, of the street address of the address.
Max length: 50 characters"
+ },
+ "type": {
+ "description": "The address type of the address being created.
Valid values:
SHIP_FROM_ADDRESS
RETURN_ADRESS
",
+ "$ref": "#/components/schemas/AddressTypeEnum"
+ }
+ },
+ "description": "This type is used to specify the address details used to create an address."
+ },
+ "CreateAddressPreferenceResponses": {
+ "type": "object",
+ "required": [
+ "shipFromAddressId"
+ ],
+ "properties": {
+ "shipFromAddressId": {
+ "description": "This container specifies the unique identifier of the newly created address.",
+ "$ref": "#/components/schemas/CreateAddressPreferenceResponsesData"
+ }
+ },
+ "description": "This type is used to define the response container of the createAddressPreference method."
+ },
+ "CreateAddressPreferenceResponsesData": {
+ "type": "object",
+ "required": [
+ "addressId"
+ ],
+ "properties": {
+ "addressId": {
+ "type": "string",
+ "description": "The unique identifier of the newly-created address.
This ID value can be used when creating a package through the createPackage method to specify the ship-from or return address associated with the package."
+ }
+ },
+ "description": "This type defines the unique identifier of a newly created address."
+ },
+ "CreateBundleRequest": {
+ "type": "object",
+ "required": [
+ "bundle"
+ ],
+ "properties": {
+ "bundle": {
+ "description": "This container is used to specify the information needed to create a bundle, such as the consign address associated with the bundle and the tracking numbers of the packages to be included in the bundle.",
+ "$ref": "#/components/schemas/CreateBundleRequestData"
+ }
+ },
+ "description": "This type defines the request container of the createBundle method."
+ },
+ "CreateBundleRequestData": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId",
+ "trackingNumbers"
+ ],
+ "properties": {
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the consign address to be associated with the bundle.
This ID can be retrieved using the getConsignPreferences method."
+ },
+ "trackingNumbers": {
+ "type": "array",
+ "description": "This array specifies the tracking numbers of the packages to be included in the bundle.
Tracking numbers are returned when creating a package through the createPackage method.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "This type defines the information used to create a bundle."
+ },
+ "CreateBundleResponse": {
+ "type": "object",
+ "required": [
+ "bundle"
+ ],
+ "properties": {
+ "bundle": {
+ "description": "This container returns information about the newly created bundle, such as its bundleId value.",
+ "$ref": "#/components/schemas/CreateBundleResponseData"
+ }
+ },
+ "description": "This type defines the response container of the createBundle method"
+ },
+ "CreateBundleResponseData": {
+ "type": "object",
+ "required": [
+ "bundleId"
+ ],
+ "properties": {
+ "bundleId": {
+ "type": "string",
+ "description": "The unique identifier of the newly created bundle."
+ }
+ },
+ "description": "This type defines the unique identifier of the newly-created bundle."
+ },
+ "CreateConsignPreferenceRequest": {
+ "type": "object",
+ "required": [
+ "consignAddress"
+ ],
+ "properties": {
+ "consignAddress": {
+ "description": "This container is used to specify the address details used to create a consign address.",
+ "$ref": "#/components/schemas/CreateConsignPreferenceRequestData"
+ }
+ },
+ "description": "This type is used to define the request container of the createConsignPreference method."
+ },
+ "CreateConsignPreferenceRequestData": {
+ "type": "object",
+ "required": [
+ "consignPreferenceName",
+ "type"
+ ],
+ "properties": {
+ "consignPreferenceName": {
+ "type": "string",
+ "description": "The name of the consign address."
+ },
+ "dropoffSiteId": {
+ "type": "string",
+ "description": "The unique identifier of a drop-off site location. This value can be retrieved using the getDropoffSites method.
This field is required if the DROPOFF address type is specified."
+ },
+ "pickupAddress": {
+ "description": "This container is used to specify the address details used to create a pickup-from address.
This container is required if the PICK_UP address type is specified.",
+ "$ref": "#/components/schemas/PickupAddressRequestData"
+ },
+ "pickupTime": {
+ "description": "The pickup time that the pickup location supports.
This field is required if the PICK_UP address type is specified.",
+ "$ref": "#/components/schemas/PickUpTimeTypeEnum"
+ },
+ "type": {
+ "description": "The address type of the consign address.
Valid values:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
RDC
CN_POST_DROP_OFF
CN_POST_PICK_UP
HK_POST_DROP_OFF
",
+ "$ref": "#/components/schemas/ConsignTypeEnum"
+ }
+ },
+ "description": "This type is used to specify the address details used to create a consign address."
+ },
+ "CreateConsignPreferenceResponses": {
+ "type": "object",
+ "required": [
+ "consignAddressId"
+ ],
+ "properties": {
+ "consignAddressId": {
+ "description": "This container specifies the unique identifier of the newly created consign address.",
+ "$ref": "#/components/schemas/CreateConsignPreferenceResponsesData"
+ }
+ },
+ "description": "This type defines the response container for the createConsignPreference method."
+ },
+ "CreateConsignPreferenceResponsesData": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId"
+ ],
+ "properties": {
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the newly-created consign address.
This ID can be used when creating a package through the createPackage method to specify the pickup, drop-off, or forward deployment address associated with the package."
+ }
+ },
+ "description": "This type defines the unique identifier of the newly created consign address."
+ },
+ "CurrencyCodeEnum": {
+ "type": "object",
+ "description": "This enumerated type lists the three-letter ISO 4217 code representing the supported world currencies. | - **AED**: United Arab Emirates dirham - **AFN**: Afghan afghani - **ALL**: Albanian lek - **AMD**: Armenian dram - **ANG**: Netherlands Antillean guilder - **AOA**: Angolan kwanza - **ARS**: Argentine peso - **AUD**: Australian dollar - **AWG**: Aruban florin - **AZN**: Azerbaijani manat - **BAM**: Bosnia and Herzegovina convertible mark - **BBD**: Barbados dollar - **BDT**: Bangladeshi taka - **BGN**: Bulgarian lev - **BHD**: Bahraini dinar - **BIF**: Burundian franc - **BMD**: Bermudian dollar - **BND**: Brunei dollar - **BOB**: Bolivian Boliviano - **BRL**: Brazilian real - **BSD**: Bahamian dollar - **BTN**: Bhutanese ngultrum - **BWP**: Botswana pula - **BYR**: Belarusian ruble - **BZD**: Belize dollar - **CAD**: Canadian dollar - **CDF**: Congolese franc - **CHF**: Swiss franc - **CLP**: Chilean peso - **CNY**: Chinese yuan renminbi - **COP**: Colombian peso - **CRC**: Costa Rican colon - **CUP**: Cuban peso - **CVE**: Cape Verde escudo - **CZK**: Czech koruna - **DJF**: Djiboutian franc - **DKK**: Danish krone - **DOP**: Dominican peso - **DZD**: Algerian dinar - **EGP**: Egyptian pound - **ERN**: Eritrean nakfa - **ETB**: Ethiopian birr - **EUR**: European Union euro - **FJD**: Fiji dollar - **FKP**: Falkland Islands pound - **GBP**: British pound sterling - **GEL**: Georgian lari - **GHS**: Ghanaian cedi - **GIP**: Gibraltar pound - **GMD**: Gambian dalasi - **GNF**: Guinean franc - **GTQ**: Guatemalan quetzal - **GYD**: Guyanese dollar - **HKD**: Hong Kong dollar - **HNL**: Honduran lempira - **HRK**: Croatian kuna - **HTG**: Haitian gourde - **HUF**: Hungarian forint - **IDR**: Indonesian rupiah - **ILS**: Israeli new shekel - **INR**: Indian rupee - **IQD**: Iraqi dinar - **IRR**: Iranian rial - **ISK**: Icelandic krona - **JMD**: Jamaican dollar - **JOD**: Jordanian dinar - **JPY**: Japanese yen - **KES**: Kenyan shilling - **KGS**: Kyrgyzstani som - **KHR**: Cambodian riel - **KMF**: Comoro franc - **KPW**: North Korean won - **KRW**: South Korean won - **KWD**: Kuwaiti dinar - **KYD**: Cayman Islands dollar - **KZT**: Kazakhstani tenge - **LAK**: Lao kip - **LBP**: Lebanese pound - **LKR**: Sri Lankan rupee - **LRD**: Liberian dollar - **LSL**: Lesotho loti - **LTL**: Lithuanian litas - **LYD**: Libyan dinar - **MAD**: Moroccan dirham - **MDL**: Moldovan leu - **MGA**: Malagasy ariary - **MKD**: Macedonian denar - **MMK**: Myanmar kyat - **MNT**: Mongolian tugrik - **MOP**: Macanese pataca - **MRO**: Mauritanian ouguiya - **MUR**: Mauritian rupee - **MVR**: Maldivian rufiyaa - **MWK**: Malawian kwacha - **MXN**: Mexican peso - **MYR**: Malaysian ringgit - **MZN**: Mozambican metical - **NAD**: Namibian dollar - **NGN**: Nigerian naira - **NIO**: Nicaraguan cordoba oro - **NOK**: Norwegian krone - **NPR**: Nepalese rupee - **NZD**: New Zealand dollar - **OMR**: Omani rial - **PAB**: Panamanian balboa - **PEN**: Peruvian sol - **PGK**: Papua New Guinean kina - **PHP**: Philippine peso - **PKR**: Pakistani rupee - **PLN**: Polish zloty - **PYG**: Paraguayan guarani - **QAR**: Qatari riyal - **RON**: Romanian leu - **RSD**: Serbian dinar - **RUB**: Russian ruble - **RWF**: Rwandan franc - **SAR**: Saudi riyal - **SBD**: Solomon Islands dollar - **SCR**: Seychelles rupee - **SDG**: Sudanese pound - **SEK**: Swedish krona - **SGD**: Singapore dollar - **SHP**: Saint Helena pound - **SLL**: Sierra Leonean leone - **SOS**: Somali shilling - **SRD**: Surinamese dollar - **STD**: Sao Tome and Principe dobra - **SYP**: Syrian pound - **SZL**: Swazi lilangeni - **THB**: Thai baht - **TJS**: Tajikistani somoni - **TMT**: Turkmenistani manat - **TND**: Tunisian dinar - **TOP**: Tongan pa'anga - **TRY**: Turkish lira - **TTD**: Trinidad and Tobago dollar - **TWD**: New Taiwan dollar - **TZS**: Tanzanian shilling - **UAH**: Ukrainian hryvnia - **UGX**: Ugandan shilling - **USD**: United States dollar - **UYU**: Uruguayan peso - **UZS**: Uzbekistani som - **VEF**: Venezuelan bolivar - **VND**: Vietnamese dong - **VUV**: Vanuatu vatu - **WST**: Samoan tala - **XAF**: CFA franc BEAC - **XCD**: East Caribbean dollar - **XOF**: CFA franc BCEAO - **XPF**: CFP franc - **YER**: Yemeni rial - **ZAR**: South African rand - **ZMW**: Zambian kwacha - **ZWL**: Zimbabwean dollar",
+ "enum": [
+ "AED",
+ "AFN",
+ "ALL",
+ "AMD",
+ "AOA",
+ "ARS",
+ "AWG",
+ "AZN",
+ "BAM",
+ "BBD",
+ "BDT",
+ "BGN",
+ "BHD",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BRL",
+ "BSD",
+ "BTN",
+ "BWP",
+ "BYR",
+ "BZD",
+ "CAD",
+ "CDF",
+ "CLP",
+ "CNY",
+ "COP",
+ "CRC",
+ "CUP",
+ "CVE",
+ "CZK",
+ "DJF",
+ "DOP",
+ "DZD",
+ "EGP",
+ "ERN",
+ "ETB",
+ "FJD",
+ "FKP",
+ "GEL",
+ "GHS",
+ "GIP",
+ "DKK",
+ "GMD",
+ "GNF",
+ "GTQ",
+ "GYD",
+ "HKD",
+ "HNL",
+ "HRK",
+ "HTG",
+ "HUF",
+ "IDR",
+ "INR",
+ "IQD",
+ "IRR",
+ "ISK",
+ "GBP",
+ "JMD",
+ "JOD",
+ "JPY",
+ "KES",
+ "KGS",
+ "KHR",
+ "KMF",
+ "KPW",
+ "KRW",
+ "KWD",
+ "KYD",
+ "KZT",
+ "LAK",
+ "LBP",
+ "CHF",
+ "LKR",
+ "LRD",
+ "LSL",
+ "LTL",
+ "LYD",
+ "MAD",
+ "MDL",
+ "MGA",
+ "MKD",
+ "MMK",
+ "MNT",
+ "MOP",
+ "MRO",
+ "XCD",
+ "MUR",
+ "MVR",
+ "MWK",
+ "MXN",
+ "MYR",
+ "MZN",
+ "NAD",
+ "NGN",
+ "NIO",
+ "NPR",
+ "OMR",
+ "PAB",
+ "PEN",
+ "XPF",
+ "PGK",
+ "PHP",
+ "PKR",
+ "PLN",
+ "ILS",
+ "PYG",
+ "QAR",
+ "RON",
+ "RSD",
+ "RUB",
+ "RWF",
+ "SAR",
+ "SBD",
+ "SCR",
+ "SDG",
+ "SEK",
+ "SGD",
+ "SHP",
+ "NOK",
+ "SLL",
+ "SOS",
+ "SRD",
+ "STD",
+ "ANG",
+ "SYP",
+ "SZL",
+ "XAF",
+ "XOF",
+ "THB",
+ "TJS",
+ "NZD",
+ "TMT",
+ "TND",
+ "TOP",
+ "TRY",
+ "TTD",
+ "AUD",
+ "TWD",
+ "TZS",
+ "UAH",
+ "UGX",
+ "USD",
+ "UYU",
+ "UZS",
+ "VEF",
+ "VND",
+ "VUV",
+ "WST",
+ "YER",
+ "EUR",
+ "ZAR",
+ "ZMW",
+ "ZWL"
+ ]
+ },
+ "DeletePackagesRequest": {
+ "type": "object",
+ "required": [
+ "requests"
+ ],
+ "properties": {
+ "requests": {
+ "description": "This container is used to specify the package ID values for the packages being deleted.",
+ "$ref": "#/components/schemas/DeletePackagesRequestData"
+ }
+ },
+ "description": "This type defines the request container for the bulkDeletePackages method."
+ },
+ "DeletePackagesRequestData": {
+ "description": "This type is used to specify the package ID values for the packages being deleted.",
+ "type": "object",
+ "required": [
+ "packageIds"
+ ],
+ "properties": {
+ "packageIds": {
+ "type": "array",
+ "description": "This comma-delimited array lists the unique identifiers of the packages being deleted. These values must be for packages that have been cancelled and do not have tracking numbers associated with them.
Package ID values are returned when creating a package through the createPackage method.",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "DeletePackagesResponses": {
+ "type": "object",
+ "required": [
+ "responses"
+ ],
+ "properties": {
+ "responses": {
+ "type": "array",
+ "description": "This array returns the result code and message for each deleted package. Each package is denoted by its package ID value.",
+ "items": {
+ "$ref": "#/components/schemas/DeletePackagesResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container of the bulkDeletePackages method."
+ },
+ "DeletePackagesResponsesData": {
+ "type": "object",
+ "required": [
+ "message",
+ "packageId",
+ "resultCode"
+ ],
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "This string returns any additional information about the deletion of the package."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the deleted package."
+ },
+ "resultCode": {
+ "type": "string",
+ "description": "The result code detailing the result of the deletion process.
For example, a result code of 200 indicates that the call was a success and the package was deleted."
+ }
+ },
+ "description": "This type defines the response data after deleting multiple packages."
+ },
+ "DirectionsResponses": {
+ "type": "object",
+ "properties": {
+ "batteryType": {
+ "type": "string",
+ "description": "The supported battery type for the shipping service."
+ },
+ "from": {
+ "type": "string",
+ "description": "The two-letter ISO 3166 ship-from country code."
+ },
+ "to": {
+ "type": "string",
+ "description": "The two-letter ISO 3166 destination country code."
+ }
+ },
+ "description": "This type specifies direction information for a shipping service."
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "Identifies the type of error.",
+ "enum": [
+ "APPLICATION",
+ "BUSINESS",
+ "REQUEST"
+ ]
+ },
+ "domain": {
+ "type": "string",
+ "description": "Name for the primary system where the error occurred. This is relevant for application errors."
+ },
+ "errorId": {
+ "type": "integer",
+ "description": "A unique number to identify the error.",
+ "format": "int32"
+ },
+ "inputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "longMessage": {
+ "type": "string",
+ "description": "A more detailed explanation of the error."
+ },
+ "message": {
+ "type": "string",
+ "description": "Information on how to correct the problem, in the end user's terms and language where applicable."
+ },
+ "outputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
+ "items": {
+ "$ref": "#/components/schemas/ErrorParameter"
+ }
+ },
+ "subdomain": {
+ "type": "string",
+ "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
+ }
+ },
+ "description": "This type defines the fields that can be returned in an error."
+ },
+ "ErrorParameter": {
+ "type": "object",
+ "description": "This type defines the parameters of an error",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The object of the error."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the object."
+ }
+ }
+ },
+ "ExemptionTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the exemption type associated with the CPSC profile. | - **TOY_VINTAGE**: This enum value indicates the exemption option for vintage toys. - **TOY_ANTIQUE**: This enum value indicates the exemption option for antique toys. - **TOY_AGE_LMT**: This enum value indicates the exemption option for toys intended for users over certain age. - **ADULT_PRODUCT_USED**: This enum value indicates the exemption option for used adult products. - **ADULT_APPAREL_SYNTHETIC_OR_WOOL**: This enum value indicates the eemption option for adult apparel with material includes acrylic, modacrylic, nylon, polyamide, olefin, polypropylene, polyester, wool, cashmere, OR polyester. - **ADULT_APPAREL_COTTON_100**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Cotton (100%) - **ADULT_APPAREL_COTTON_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Cotton Blends (any cotton mix). - **ADULT_APPAREL_RAYON_VISCOSE_100**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Rayon/Viscose (100%). - **ADULT_APPAREL_MODAL**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Modal. - **ADULT_APPAREL_BAMBOO**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Bamboo (rayon type). - **ADULT_APPAREL_LINEN_FLAX**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Linein/Flax. - **ADULT_APPAREL_SILK**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Silk (all forms, 100% silk). - **ADULT_APPAREL_ACETATE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Acetate. - **ADULT_APPAREL_SPANDEX_ELASTANE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Spandex/Elastane (alone). - **ADULT_APPAREL_NYLON_SPANDEX_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Nylon/Spandex blends. - **ADULT_APPAREL_POLYESTER_SPANDEX_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Polyester/Spandex blends. - **ADULT_APPAREL_POLYESTER_RAYON_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Polyester/Rayon blends. - **ADULT_APPAREL_WOOL_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Wool blends (with non-exempt fiber). - **ADULT_APPAREL_CASHMERE_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Cashmere blends (with non-exempt fiber). - **ADULT_APPAREL_LINEN_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Linen blends. - **ADULT_APPAREL_MODAL_BLENDS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Modal blends - **ADULT_APPAREL_SATIN**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Satin (fiber unknown). - **ADULT_APPAREL_CHIFFON**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Chiffon (fiber unknown). - **ADULT_APPAREL_LACE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Lace (fiber unknown) - **ADULT_APPAREL_TULLE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Tulle (fiber unknown). - **ADULT_APPAREL_VOILE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Voile. - **ADULT_APPAREL_ORGANZA**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Organza. - **ADULT_APPAREL_GEORGETTE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Georgette. - **ADULT_APPAREL_CREPE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Crepe. - **ADULT_APPAREL_TWILL**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Twill. - **ADULT_APPAREL_JERSEY**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Jersey. - **ADULT_APPAREL_OXFORD_CLOTH**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Oxford Cloth. - **ADULT_APPAREL_MESH_NET**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Mesh/Net. - **ADULT_APPAREL_GAUZE**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Gauze.- **ADULT_APPAREL_CANVAS**: This enum value indicates the exemption option for adult apparel with fabric weight ≥2.6oz/yard AND fabric type is Canvas. - **OTHER_ADULT_PRODUCT**: This enum value indicates the exemption option for other Adult Product.",
+ "enum": [
+ "TOY_VINTAGE",
+ "TOY_ANTIQUE",
+ "TOY_AGE_LMT",
+ "ADULT_PRODUCT_USED",
+ "ADULT_APPAREL_SYNTHETIC_OR_WOOL",
+ "ADULT_APPAREL_COTTON_100",
+ "ADULT_APPAREL_COTTON_BLENDS",
+ "ADULT_APPAREL_RAYON_VISCOSE_100",
+ "ADULT_APPAREL_MODAL",
+ "ADULT_APPAREL_BAMBOO",
+ "ADULT_APPAREL_LINEN_FLAX",
+ "ADULT_APPAREL_SILK",
+ "ADULT_APPAREL_ACETATE",
+ "ADULT_APPAREL_SPANDEX_ELASTANE",
+ "ADULT_APPAREL_NYLON_SPANDEX_BLENDS",
+ "ADULT_APPAREL_POLYESTER_SPANDEX_BLENDS",
+ "ADULT_APPAREL_POLYESTER_RAYON_BLENDS",
+ "ADULT_APPAREL_WOOL_BLENDS",
+ "ADULT_APPAREL_CASHMERE_BLENDS",
+ "ADULT_APPAREL_LINEN_BLENDS",
+ "ADULT_APPAREL_MODAL_BLENDS",
+ "ADULT_APPAREL_SATIN",
+ "ADULT_APPAREL_CHIFFON",
+ "ADULT_APPAREL_LACE",
+ "ADULT_APPAREL_TULLE",
+ "ADULT_APPAREL_VOILE",
+ "ADULT_APPAREL_ORGANZA",
+ "ADULT_APPAREL_GEORGETTE",
+ "ADULT_APPAREL_CREPE",
+ "ADULT_APPAREL_TWILL",
+ "ADULT_APPAREL_JERSEY",
+ "ADULT_APPAREL_OXFORD_CLOTH",
+ "ADULT_APPAREL_MESH_NET",
+ "ADULT_APPAREL_GAUZE",
+ "ADULT_APPAREL_CANVAS",
+ "OTHER_ADULT_PRODUCT"
+ ]
+ },
+ "FDCSkuRequest": {
+ "type": "object",
+ "properties": {
+ "quantity": {
+ "type": "integer",
+ "description": "The quantity of the FDC SKU.",
+ "format": "int32"
+ },
+ "skuId": {
+ "type": "string",
+ "description": "The unique identifier of the FDC SKU."
+ }
+ },
+ "description": "This type specifies FDC SKU information."
+ },
+ "GetActualCostResponses": {
+ "type": "object",
+ "required": [
+ "actualCosts"
+ ],
+ "properties": {
+ "actualCosts": {
+ "type": "array",
+ "description": "This array returns a list of actual costs associated with the packages matching the input criteria.",
+ "items": {
+ "$ref": "#/components/schemas/GetActualCostResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response containers of the getActualCost method."
+ },
+ "GetActualCostResponsesData": {
+ "type": "object",
+ "required": [
+ "actualWeight",
+ "amount",
+ "billingTime",
+ "chargeMode",
+ "chargeWeight",
+ "costType",
+ "message",
+ "remark",
+ "resultCode",
+ "size",
+ "trackingNumber"
+ ],
+ "properties": {
+ "actualWeight": {
+ "type": "number",
+ "description": "The actual weight of the package in grams."
+ },
+ "amount": {
+ "description": "This container specifies the total monetary amount of the actual cost of the package. ",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "billingTime": {
+ "type": "string",
+ "description": "The time the seller was charged for the actual cost of the package in UTC format."
+ },
+ "chargeMode": {
+ "type": "string",
+ "description": "The two-digit charge mode for the package.
Valid values:
01: Actual weight
02: Additional dimension weight
03: Charged by lite mode
"
+ },
+ "chargeWeight": {
+ "type": "number",
+ "description": "The weight, in grams, charged for when shipping the package."
+ },
+ "costType": {
+ "type": "string",
+ "description": "The two-digit cost type of the package. This field indicates any fees associated with the package.
The following values are the typical cost types returned through this field. If an undocumented cost type is returned, check the logistic provider's website for the latest values:
01: Shipping fee
02: Domestic
03: Return fee
04: Domestic burning fee
05: Custom collected fee
06: Weight gap fee
07: Duplication compensation
"
+ },
+ "message": {
+ "type": "string",
+ "description": "A seller-defined message to the buyer regarding the transaction.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "remark": {
+ "type": "string",
+ "description": "A remark to the seller themselves.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "resultCode": {
+ "type": "string",
+ "description": "The result code associated with the call.
For example, a result code of 200 indicates that the call was a success."
+ },
+ "size": {
+ "type": "string",
+ "description": "The size of the package in centimeters. This value is returned in Length*Width*Height format."
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number associated with the package."
+ }
+ },
+ "description": "This type defines the actual weight, cost, and additional information of a specified package or packages."
+ },
+ "GetAddressPreferenceListResponses": {
+ "type": "object",
+ "required": [
+ "addressPreferenceList"
+ ],
+ "properties": {
+ "addressPreferenceList": {
+ "description": "This container returns all ship-from and/or return addresses associated with a seller's eDIS account.",
+ "$ref": "#/components/schemas/GetAddressPreferenceListResponsesData"
+ }
+ },
+ "description": "This type defines the response container associated with the getAddressPreferences method."
+ },
+ "GetAddressPreferenceListResponsesData": {
+ "type": "object",
+ "required": [
+ "addresses"
+ ],
+ "properties": {
+ "addresses": {
+ "type": "array",
+ "description": "This array returns a list of address, contact, and identifier information for each of a seller's ship-from and/or return addresses associated with their eDIS account.",
+ "items": {
+ "$ref": "#/components/schemas/GetAddressPreferencesResponses"
+ }
+ }
+ },
+ "description": "This type defines the list of addresses associated with a eDIS account."
+ },
+ "GetAddressPreferencesResponses": {
+ "type": "object",
+ "required": [
+ "addressId",
+ "city",
+ "cityName",
+ "company",
+ "contact",
+ "countryCode",
+ "countryName",
+ "district",
+ "districtName",
+ "name",
+ "phone",
+ "postcode",
+ "province",
+ "provinceName",
+ "street1",
+ "street2",
+ "street3",
+ "type"
+ ],
+ "properties": {
+ "addressId": {
+ "type": "string",
+ "description": "The unique identifier of the address."
+ },
+ "city": {
+ "type": "string",
+ "description": "The city code of the address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "cityName": {
+ "type": "string",
+ "description": "The city name of the address."
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name associated with the address."
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the address."
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the address."
+ },
+ "countryName": {
+ "type": "string",
+ "description": "The country name of the address."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "districtName": {
+ "type": "string",
+ "description": "The district name of the address."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the address."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "provinceName": {
+ "type": "string",
+ "description": "The province name of the address."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the address."
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line of the street address of the address.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line of the street address of address.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "type": {
+ "description": "The address type of the address.",
+ "$ref": "#/components/schemas/AddressTypeEnum"
+ }
+ },
+ "description": "This type defines the fields associated with a seller's ship-from address, including the location and contact details of the addresses, as well as its unique identifier."
+ },
+ "GetAgentListResponses": {
+ "type": "object",
+ "required": [
+ "agentList"
+ ],
+ "properties": {
+ "agentList": {
+ "description": "This container returns a list of all EU AR agents associated with your eDIS account and their information.",
+ "$ref": "#/components/schemas/GetAgentListResponsesData"
+ }
+ },
+ "description": "This type defines the response container of the getAgents method."
+ },
+ "GetAgentListResponsesData": {
+ "type": "object",
+ "required": [
+ "agents",
+ "href",
+ "limit",
+ "next",
+ "offset",
+ "total"
+ ],
+ "properties": {
+ "agents": {
+ "type": "array",
+ "description": "This array returns information about each EU AR agent associated with a seller's eDIS account, including their contact information, eBay ID, and supported shipping countries.",
+ "items": {
+ "$ref": "#/components/schemas/AgentModelResponses"
+ }
+ },
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the result set."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value of the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "total": {
+ "type": "integer",
+ "description": "The total number of results that match the input criteria.",
+ "format": "int32"
+ }
+ },
+ "description": "This type defines the fields in a paginated result set of agents associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items."
+ },
+ "GetBatteryQualListResponses": {
+ "type": "object",
+ "required": [
+ "batteryQualificationList"
+ ],
+ "properties": {
+ "batteryQualificationList": {
+ "description": "This container returns a list of all battery qualifications associated with an eDIS account.",
+ "$ref": "#/components/schemas/GetBatteryQualListResponsesData"
+ }
+ },
+ "description": "This type defines the response container of the getbatteryQualifications method."
+ },
+ "GetBatteryQualListResponsesData": {
+ "type": "object",
+ "required": [
+ "href",
+ "limit",
+ "offset",
+ "qualifications",
+ "total"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the result set."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value of the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "qualifications": {
+ "type": "array",
+ "description": "This array returns information about each battery qualification associated with an eDIS account, such as the battery type, qualification name, and expiration date.",
+ "items": {
+ "$ref": "#/components/schemas/BatteryQualResponses"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "description": "The total number of results that match the input criteria.",
+ "format": "int32"
+ }
+ },
+ "description": "This type defines the fields in a paginated result set of battery qualifications associated with a seller's eDIS account. The response consists of 0 or more sequenced pages that are returned from the complete result set, where each page consists of 0 or more items."
+ },
+ "GetConsignPreferenceListResponses": {
+ "type": "object",
+ "required": [
+ "consignPreferenceList"
+ ],
+ "properties": {
+ "consignPreferenceList": {
+ "description": "This container returns a list of all consign addresses associated with a seller's eDIS account.",
+ "$ref": "#/components/schemas/GetConsignPreferenceListResponsesData"
+ }
+ },
+ "description": "This type defines the response container of the getConsignPreferences method."
+ },
+ "GetConsignPreferenceListResponsesData": {
+ "type": "object",
+ "required": [
+ "consignPreferences"
+ ],
+ "properties": {
+ "consignPreferences": {
+ "type": "array",
+ "description": "This array returns information about each of a seller's consign addresses associated with their eDIS account.",
+ "items": {
+ "$ref": "#/components/schemas/ConsignPreferenceInfoResponses"
+ }
+ }
+ },
+ "description": "This type defines the fields associated with a seller's consign addresses, including the location and contact details of the address, as well as its unique identifiers."
+ },
+ "GetCpscProfilesResponse": {
+ "type": "object",
+ "description": "This type defines the response payload of the getCpscProfiles method",
+ "required": [],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the result set."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value of the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "profiles": {
+ "type": "array",
+ "description": "This array returns information about each CPSC profiles associated with the seller's eDIS account, including the name, identifier, and type of the profile.",
+ "items": {
+ "$ref": "#/components/schemas/CpscProfile"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "description": "The total number of results that match the input criteria.",
+ "format": "int32"
+ }
+ }
+ },
+ "GetDropoffSiteListResponses": {
+ "type": "object",
+ "required": [
+ "dropoffSiteList"
+ ],
+ "properties": {
+ "dropoffSiteList": {
+ "description": "This container returns a list of all of the drop-off site locations associated with an eDIS account.",
+ "$ref": "#/components/schemas/GetDropoffSitesResponsesData"
+ }
+ },
+ "description": "This type defines the response container associated with the getDropoffSites method."
+ },
+ "GetDropoffSitesResponses": {
+ "type": "object",
+ "required": [
+ "city",
+ "contact",
+ "country",
+ "district",
+ "dropoffSiteId",
+ "name",
+ "phone",
+ "province",
+ "street1",
+ "street2",
+ "street3",
+ "type"
+ ],
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the drop-off site location.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the drop-off site location."
+ },
+ "country": {
+ "type": "string",
+ "description": "The two-letter country code associated with the drop-off site location."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the drop-off site location.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "dropoffSiteId": {
+ "type": "string",
+ "description": "The unique identifier of the drop-off site location."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the drop-off site location."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the drop-off site location."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the drop-off site location.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the drop-off site location."
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line, if applicable, of the street address of the drop-off site location.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line, if applicable, of the street address of the drop-off site location.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the drop-off site location.
Currently, the only valid response is DROP_OFF."
+ }
+ },
+ "description": "This type defines the fields associated with one or more drop-off sites associated with a seller's eDIS account."
+ },
+ "GetDropoffSitesResponsesData": {
+ "type": "object",
+ "required": [
+ "dropoffSites",
+ "href",
+ "limit",
+ "offset",
+ "total"
+ ],
+ "properties": {
+ "dropoffSites": {
+ "type": "array",
+ "description": "This array returns address, contact, and identifier information for each of a seller's drop-off locations associated with their eDIS account.",
+ "items": {
+ "$ref": "#/components/schemas/GetDropoffSitesResponses"
+ }
+ },
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the result set."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value of the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "total": {
+ "type": "integer",
+ "description": "The total number of results that match the input criteria.",
+ "format": "int32"
+ }
+ },
+ "description": "This type defines the list of drop-off site locations associated with an eDIS account."
+ },
+ "GetHandoverSheetResponses": {
+ "type": "object",
+ "required": [
+ "handoverSheet"
+ ],
+ "properties": {
+ "handoverSheet": {
+ "description": "This container returns the base64 string value for a handover sheet.",
+ "$ref": "#/components/schemas/GetHandoverSheetResponsesData"
+ }
+ },
+ "description": "This type is used to define the response container for the getHandoverSheet method."
+ },
+ "GetHandoverSheetResponsesData": {
+ "type": "object",
+ "required": [
+ "base64Str"
+ ],
+ "properties": {
+ "base64Str": {
+ "type": "string",
+ "description": "The base 64 string value for a handover sheet. This string can be converted to a PDF file once it has been retrieved."
+ }
+ },
+ "description": "This type specifies the base64 string value for a handover sheet."
+ },
+ "GetItemPackageIdResponses": {
+ "type": "object",
+ "required": [
+ "itemPackages"
+ ],
+ "properties": {
+ "itemPackages": {
+ "type": "array",
+ "description": "This array returns a list of packages associated with the specified line item ID.",
+ "items": {
+ "$ref": "#/components/schemas/GetItemPackageIdResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container of the getPackageByLineItemID method."
+ },
+ "GetItemPackageIdResponsesData": {
+ "type": "object",
+ "required": [
+ "packageId",
+ "packageStatus",
+ "trackingNumber"
+ ],
+ "properties": {
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the package."
+ },
+ "packageStatus": {
+ "description": "The current status of the package.",
+ "$ref": "#/components/schemas/PackageStatusEnum"
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number of the package."
+ }
+ },
+ "description": "This type returns information on the packages being retrieved based on the specified line item ID. "
+ },
+ "GetLabelListResponses": {
+ "type": "object",
+ "required": [
+ "labels"
+ ],
+ "properties": {
+ "labels": {
+ "type": "array",
+ "description": "This array returns the shipping label information, such as the base64 string value and result code for each specified tracking number.",
+ "items": {
+ "$ref": "#/components/schemas/GetLabelListResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container of the getLabels method."
+ },
+ "GetLabelListResponsesData": {
+ "type": "object",
+ "required": [
+ "base64Str",
+ "message",
+ "resultCode",
+ "trackingNumber"
+ ],
+ "properties": {
+ "base64Str": {
+ "type": "string",
+ "description": "The base 64 string value for a shipping label.
This string value can be converted to a PDF file."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message relating to the status of the shipping label retrieval process."
+ },
+ "resultCode": {
+ "type": "string",
+ "description": "The result code detailing the results of the shipping label retrieval process.
For example, a result code of 200 indicates that at least one shipping label was successfully retrieved."
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number for which the shipping label is being retrieved."
+ }
+ },
+ "description": "This type defines the response payload for the getLabels method."
+ },
+ "GetPackageDetailResponses": {
+ "type": "object",
+ "required": [
+ "packageDetail"
+ ],
+ "properties": {
+ "packageDetail": {
+ "description": "This container returns the details for the specified package.",
+ "$ref": "#/components/schemas/GetPackageDetailResponsesData"
+ }
+ },
+ "description": "This type defines the response container of the getPackage method."
+ },
+ "GetPackageDetailResponsesData": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId",
+ "items",
+ "packageHeight",
+ "packageId",
+ "packageLength",
+ "packageStatus",
+ "packageWeight",
+ "packageWidth",
+ "shipFromAddressId",
+ "shipToAddress",
+ "shippingServiceId"
+ ],
+ "properties": {
+ "agentInfoResponse": {
+ "description": "This container returns EU AR agent information associated with the package.",
+ "$ref": "#/components/schemas/AgentInfoData"
+ },
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the consign address associated with the package."
+ },
+ "incoterm": {
+ "description": "The incoterm information associated with the package.
Supported values:
DDP
DDU
",
+ "$ref": "#/components/schemas/IncotermEnum"
+ },
+ "items": {
+ "type": "array",
+ "description": "This array returns information about the eBay line item(s) that are included in the package.",
+ "items": {
+ "$ref": "#/components/schemas/ItemResponses"
+ }
+ },
+ "lastMileTrackingNumber": {
+ "type": "string",
+ "description": "The last-mile tracking number of the package.
This field is only returned if the last-mile tracking number is provided by the carrier."
+ },
+ "packageComment": {
+ "type": "string",
+ "description": "The seller-defined remark to the buyer associated with the package."
+ },
+ "packageHeight": {
+ "type": "number",
+ "description": "The height of the package in centimeters."
+ },
+ "packageId": {
+ "type": "string",
+ "description": "The unique identifier of the package."
+ },
+ "packageLength": {
+ "type": "number",
+ "description": "The length of the package in centimeters."
+ },
+ "packageStatus": {
+ "description": "The current status of the package.",
+ "$ref": "#/components/schemas/PackageStatusEnum"
+ },
+ "packageWeight": {
+ "type": "number",
+ "description": "The weight of the package in grams."
+ },
+ "packageWidth": {
+ "type": "number",
+ "description": "The width of the package in centimeters."
+ },
+ "paymentCost": {
+ "description": "The actual payment cost of the package.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "shipFromAddressId": {
+ "type": "string",
+ "description": "The unique identifier of the ship-from address associated with the package."
+ },
+ "shippingServiceId": {
+ "type": "string",
+ "description": "The unique identifier of the shipping service used for the package."
+ },
+ "shipToAddress": {
+ "description": "This container returns information about the address the package is being shipped to.",
+ "$ref": "#/components/schemas/ShipToAddressResponsesData"
+ },
+ "specialServiceDetail": {
+ "description": "This container returns any special services associated with this package.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable.",
+ "$ref": "#/components/schemas/SpecialServiceDetail"
+ },
+ "valueForCarriage": {
+ "type": "string",
+ "description": "The declared value of the package."
+ }
+ },
+ "description": "This type specifies the details returned for the specified package."
+ },
+ "GetServiceListResponses": {
+ "type": "object",
+ "required": [
+ "serviceList"
+ ],
+ "properties": {
+ "serviceList": {
+ "description": "This container returns shipping service metadata associated with a seller's eDIS account.",
+ "$ref": "#/components/schemas/GetServiceListResponsesData"
+ }
+ },
+ "description": "This type defines the response container of the getService method."
+ },
+ "GetServiceListResponsesData": {
+ "type": "object",
+ "required": [
+ "href",
+ "limit",
+ "offset",
+ "services",
+ "total"
+ ],
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the result set."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value of the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "services": {
+ "type": "array",
+ "description": "This array returns a list of available shipping services, as well as the descriptions, directions, and identifiers of each service.",
+ "items": {
+ "$ref": "#/components/schemas/ServiceInfoResponses"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "description": "The total number of shipping services being displayed on the current results page.",
+ "format": "int32"
+ }
+ },
+ "description": "This type defines the details returned for the retrieved shipping service(s)."
+ },
+ "GetTrackingDetailResponses": {
+ "type": "object",
+ "required": [
+ "trackingDetails"
+ ],
+ "properties": {
+ "trackingDetails": {
+ "type": "array",
+ "description": "This array returns a list of tracking event details for the specified tracking number.",
+ "items": {
+ "$ref": "#/components/schemas/GetTrackingDetailResponsesData"
+ }
+ }
+ },
+ "description": "This type defines the response container for the getTracking method."
+ },
+ "GetTrackingDetailResponsesData": {
+ "type": "object",
+ "required": [
+ "city",
+ "country",
+ "descriptionEn",
+ "descriptionZh",
+ "district",
+ "eventPostalCode",
+ "eventTime",
+ "province",
+ "status",
+ "trackingNumber"
+ ],
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code in which the tracking event occurred.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "country": {
+ "type": "string",
+ "description": "The two-letter ISO 3166 country code where the tracking event occurred."
+ },
+ "descriptionEn": {
+ "type": "string",
+ "description": "The English description of the tracking event."
+ },
+ "descriptionZh": {
+ "type": "string",
+ "description": "The Chinese description of the tracking event."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code where the tracking event occurred.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "eventPostalCode": {
+ "type": "string",
+ "description": "The postal code of where the tracking event occurred.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "eventTime": {
+ "type": "string",
+ "description": "This timestamp the time and date the tracking event occurred."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code where the tracking event occurred.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the shipment."
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "The tracking number specified in the request."
+ }
+ },
+ "description": "This type specifies the tracking event details for the specified tracking number."
+ },
+ "IncotermEnum": {
+ "description": "This enumerated type defines the incoterm for a shipping service. | - **DDP**: This enum value indicates that the incoterm is Delivery Duty Paid and the seller pays the import tax. - **DDU**: This enum value indicates that the incoterm is Delivery Duty Unpaid and the buyer pays the import tax.",
+ "enum": [
+ "DDP",
+ "DDU"
+ ],
+ "type": "string"
+ },
+ "ItemRequest": {
+ "type": "object",
+ "required": [
+ "orderId",
+ "postedQuantity",
+ "soldDate",
+ "soldPrice",
+ "soldQuantity"
+ ],
+ "properties": {
+ "buyerId": {
+ "type": "string",
+ "description": "The buyer's eBay user ID.
Note: Effective September 26, 2025, both usernames and public user IDs will be accepted in this field. For more information, please refer to Data Handling Compliance."
+ },
+ "buyerTaxId": {
+ "type": "string",
+ "description": "The tax ID for the buyer. The type of Tax ID is specified in the buyerTaxIdType field."
+ },
+ "buyerTaxType": {
+ "type": "string",
+ "description": "The type of tax ID that was supplied by the buyer during the checkout process."
+ },
+ "ebayCollectAndRemitTax": {
+ "type": "boolean",
+ "description": "This boolean indicates if the corresponding line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf."
+ },
+ "ebayCollectAndRemitTaxesValue": {
+ "type": "string",
+ "description": "The value of the 'Collect and Remit' tax for the order that the line item belongs to."
+ },
+ "email": {
+ "type": "string",
+ "description": "The buyer's email address."
+ },
+ "itemTitle": {
+ "type": "string",
+ "description": "The title of the listing."
+ },
+ "listingId": {
+ "type": "string",
+ "description": "The unique identifier of the eBay listing.
Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message from the seller to the buyer."
+ },
+ "orderId": {
+ "type": "string",
+ "description": "The unique identifier of the eBay order that the line item belongs to."
+ },
+ "orderLineItem": {
+ "type": "string",
+ "description": "The unique identifier of the line item.
Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item."
+ },
+ "paymentDate": {
+ "type": "string",
+ "description": "The date and time the buyer pays for the order.
Format:YYYY-MM-DDTHH:MM:SS.SSSZ"
+ },
+ "payPalEmail": {
+ "type": "string",
+ "description": "The buyer's PayPal email address."
+ },
+ "payPalMessage": {
+ "type": "string",
+ "description": "The buyer's PayPal message."
+ },
+ "postedQuantity": {
+ "type": "integer",
+ "description": "The quantity of the line item that will be shipped with the package. This value can differ from the order quantity in the case of a combined or split shipment.
Min: 1
Max: 999",
+ "format": "int32"
+ },
+ "siteId": {
+ "type": "integer",
+ "description": "The unique identifier of the eBay site in which the order occurred.",
+ "format": "int32"
+ },
+ "sku": {
+ "description": "This container specifies information relating to the item being shipped in the package.",
+ "$ref": "#/components/schemas/SkuRequest"
+ },
+ "soldDate": {
+ "type": "string",
+ "description": "The date the item was sold.
Format: YYYY-MM-DDTHH:MM:SS.SSSZ"
+ },
+ "soldPrice": {
+ "description": "The price for which the item was sold.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "soldQuantity": {
+ "type": "integer",
+ "description": "The quantity of the line item that was sold.",
+ "format": "int32"
+ },
+ "transactionId": {
+ "type": "string",
+ "description": "The unique identifier of the monetary transaction.
Note: Either a listingId and transactionId pair, or an orderLineItem field is required to identify an order line item."
+ }
+ },
+ "description": "This type specifies information about the items being included in a package."
+ },
+ "ItemResponses": {
+ "type": "object",
+ "required": [
+ "buyerId",
+ "itemTitle",
+ "listingId",
+ "orderId",
+ "paymentDate",
+ "siteId",
+ "soldDate",
+ "soldPrice",
+ "soldQuantity",
+ "transactionId"
+ ],
+ "properties": {
+ "buyerId": {
+ "type": "string",
+ "description": "The buyer's eBay ID.
Note: Effective September 26, 2025, select developers will no longer receive username data for U.S. users through this field. Instead, an immutable user ID will be returned in its place. For more information, please refer to Data Handling Compliance. "
+ },
+ "buyerTaxId": {
+ "type": "string",
+ "description": "The buyer's tax ID."
+ },
+ "buyerTaxType": {
+ "type": "string",
+ "description": "The buyer's tax type."
+ },
+ "ebayCollectAndRemitTax": {
+ "type": "boolean",
+ "description": "If returned as true, this boolean indicates that eBay will collect tax for the corresponding line item, and remit the tax to the taxing authority of the buyer's residence. "
+ },
+ "ebayCollectAndRemitTaxesValue": {
+ "type": "string",
+ "description": "The value of the collect and remit tax for the corresponding line item. This field is only returned if collect and remit tax is applied to the line item. "
+ },
+ "email": {
+ "type": "string",
+ "description": "The buyer's eBay email address."
+ },
+ "itemTitle": {
+ "type": "string",
+ "description": "The seller created title of the item."
+ },
+ "listingId": {
+ "type": "string",
+ "description": "The unique identifier of the eBay listing associated with the item."
+ },
+ "message": {
+ "type": "string",
+ "description": "The buyer's eBay message."
+ },
+ "orderId": {
+ "type": "string",
+ "description": "The unique identifier of the eBay order that the line item belongs to."
+ },
+ "orderLineItem": {
+ "type": "string",
+ "description": "The unique identifier of an eBay order line item."
+ },
+ "paymentDate": {
+ "type": "string",
+ "description": "The date and time that the payment was received by the seller. This timestamp is returned in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock."
+ },
+ "payPalEmail": {
+ "type": "string",
+ "description": "The buyer's PayPal email address."
+ },
+ "payPalMessage": {
+ "type": "string",
+ "description": "The buyer's PayPal message"
+ },
+ "postedQuantity": {
+ "type": "integer",
+ "description": "The quantity of the line item shipped with the package.",
+ "format": "int32"
+ },
+ "siteId": {
+ "type": "integer",
+ "description": "The unique identifier of the eBay site in which the order occurred.",
+ "format": "int32"
+ },
+ "sku": {
+ "description": "This container returns SKU-related information relating to the item being shipped in the package.",
+ "$ref": "#/components/schemas/SkuRequest"
+ },
+ "soldDate": {
+ "type": "string",
+ "description": "The date the item was sold."
+ },
+ "soldPrice": {
+ "description": "The price for which the item was sold.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "soldQuantity": {
+ "type": "integer",
+ "description": "The quantity of the line item that was sold.",
+ "format": "int32"
+ },
+ "transactionId": {
+ "type": "string",
+ "description": "The unique identifier of the eBay transaction."
+ }
+ },
+ "description": "This type defines item information for items in a package."
+ },
+ "LiBatteryTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the type of a battery. | - **NO_BATTERY**: This enum value indicates that there is no battery in the package. - **LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT**: This enum value indicates the battery is a lithium ion battery, and is packaged separately from the product. - **LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT**: This enum value indicates that the battery is a lithium ion battery, and is shipped already installed in the product - **LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT**: This enum value indicates that the battery is a lithium metal battery, and is packaged separately from the product. - **LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT**: This enum value indicates that the battery is a lithium metal battery, and is shipped already installed in the product. - **DRY_PACKED_WITH_EQUIPMENT**: This enum value indicates that the battery is dry packed with equipment. - **SPECIAL_GOODS_WITH_NO_BATTERY**: This enum value indicates there are special goods with no batteries in the package.",
+ "enum": [
+ "NO_BATTERY",
+ "LITHIUM_ION_BATTERY_PACKED_WITH_EQUIPMENT",
+ "LITHIUM_ION_BATTERY_CONTAINED_IN_EQUIPMENT",
+ "LITHIUM_METAL_BATTERY_PACKED_WITH_EQUIPMENT",
+ "LITHIUM_METAL_BATTERY_CONTAINED_IN_EQUIPMENT",
+ "DRY_PACKED_WITH_EQUIPMENT",
+ "SPECIAL_GOODS_WITH_NO_BATTERY"
+ ]
+ },
+ "PackageInfoRequest": {
+ "type": "object",
+ "required": [
+ "consignPreferenceId",
+ "items",
+ "packageHeight",
+ "packageLength",
+ "packageWeight",
+ "packageWidth",
+ "shipFromAddressId",
+ "shipToAddress",
+ "shippingServiceId"
+ ],
+ "properties": {
+ "agentInfoRequest": {
+ "description": "This container specifies the EU AR agent information associated with the package.
This information can be retrieved using the getAgents method.",
+ "$ref": "#/components/schemas/AgentInfoData"
+ },
+ "consignPreferenceId": {
+ "type": "string",
+ "description": "The unique identifier of the consign address to be associated with the package.
This ID can be retrieved using the getConsignPreferences method."
+ },
+ "incoterm": {
+ "description": "The incoterm information associated with the package.
Supported values:
DDP
DDU
",
+ "$ref": "#/components/schemas/IncotermEnum"
+ },
+ "items": {
+ "type": "array",
+ "description": "This array is used to specify applicable information about the eBay line item(s) that will be included in the package.",
+ "items": {
+ "$ref": "#/components/schemas/ItemRequest"
+ }
+ },
+ "maxQuantityLimit": {
+ "type": "integer",
+ "description": "This field is used to limit the maximum number of parcels used in a single order. If the order has more than one parcel, revise this value to increase the limit.",
+ "format": "int32"
+ },
+ "packageComment": {
+ "type": "string",
+ "description": "A seller-defined comment about the package."
+ },
+ "packageHeight": {
+ "type": "number",
+ "description": "The height of the package in centimeters."
+ },
+ "packageLength": {
+ "type": "number",
+ "description": "The length of the package in centimeters."
+ },
+ "packageWeight": {
+ "type": "number",
+ "description": "The weight of the package in grams."
+ },
+ "packageWidth": {
+ "type": "number",
+ "description": "The width of the package in centimeters."
+ },
+ "shipFromAddressId": {
+ "type": "string",
+ "description": "The unique identifier of the ship-from address used for the package.
Use the getAddressPreferences method to retrieve valid ship-from addressId values associated with your account."
+ },
+ "shippingServiceId": {
+ "type": "string",
+ "description": "The unique identifier of the shipping service being used for the package.
This value can be retrieved using the getServices method."
+ },
+ "shipToAddress": {
+ "description": "This container specifies the address details of the address ship-to address.",
+ "$ref": "#/components/schemas/ShipToAddressRequestData"
+ },
+ "specialServiceDetail": {
+ "description": "This container specifies any special service details about the package, such as any insurance fee, required signatures, or delivery exceptions.",
+ "$ref": "#/components/schemas/SpecialServiceDetail"
+ },
+ "valueForCarriage": {
+ "type": "string",
+ "description": "The declared value of a large carriage (a combination of several orders together)."
+ }
+ },
+ "description": "This type is used to specify the package information needed to create a package."
+ },
+ "PackageStatusEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the supported package status possible for a package. | - **DECLARED_FAILED**: This enum value indicates the declaration of the package failed. - **PACKAGE_INFO_LACK**: This enum value indicates the package is lacking required information for shipping. - **NO_USEFUL_SHIPPING**: This enum value indicates that the package did not pair with any valid shipping service. - **SELECTED_SHIPPING**: This enum value indicates the package has selected shipping. - **APPLIED_TRACKING_CODE**: This enum value indicates the package has applied the tracking code. - **TO_BE_SHIPPED**: This enum value indicates that the package is waiting to be shipped. - **TO_BE_RECEIVED**: This enum value indicates that the package is waiting to be received. - **DELIVERED**: This enum value indicates that the package has been delivered. - **ON_SHIPPING**: This enum value indicates the package is in transit. - **DELETED**: This enum value indicates that the package has been shipped. - **SHIPPED_ERROR**: This enum value indicates that there was an error when shipping the package. - **DELIVERY_ERROR**: This enum value indicates that there was an error when delivering the package. - **RETURNED**: This enum value indicates that the package has been returned. - **EXCEPTION**: This enum value indicates that the package has a shipping exception. - **FDCVALIDATIONFAILED**: This enum value indicates that FDC validation has failed for the package. - **FDCVALIDATIONINPROGRESS**: This enum value indicates that FDC validation is in progress for the package. - **DELIVERY_EXCEPTION**: This enum value indicates that the package has a delivery exception.",
+ "enum": [
+ "DECLARED_FAILED",
+ "PACKAGE_INFO_LACK",
+ "NO_USEFUL_SHIPPING",
+ "SELECTED_SHIPPING",
+ "APPLIED_TRACKING_CODE",
+ "TO_BE_SHIPPED",
+ "TO_BE_RECEIVED",
+ "DELIVERED",
+ "ON_SHIPPING",
+ "DELETED",
+ "SHIPPED_ERROR",
+ "DELIVERY_ERROR",
+ "RETURNED",
+ "EXCEPTION",
+ "FDCVALIDATIONFAILED",
+ "FDCVALIDATIONINPROGRESS",
+ "DELIVERY_EXCEPTION"
+ ]
+ },
+ "PickUpTimeTypeEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the pickup time window associated with a pickup-from address. | - **TIME_14_16**: This enum value indicates that the pickup window for the consign address is between 14:00 and 16:00. - **TIME_16_18**: This enum value indicates that the pickup window for the consign address is between 16:00 and 18:00. ",
+ "enum": [
+ "TIME_14_16",
+ "TIME_16_18"
+ ]
+ },
+ "PickupAddressRequestData": {
+ "type": "object",
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the pickup address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "company": {
+ "type": "string",
+ "description": "The company name associated with the pickup address.
Max length: 50 characters"
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the pickup address.
Max length: 50 characters"
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the pickup address.
Valid values:
CN
HK
"
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the pickup address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the pickup address.
Max length: 50 characters"
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the pickup address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the pickup address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the the pickup address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the pickup address.
Max length: 50 characters"
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line, if applicable, of the street address of the pickup address.
Max length: 50 characters"
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line, if applicable, of the street address of the pickup address.
Max length: 50 characters"
+ }
+ },
+ "description": "This type defines the field used to create a pickup address."
+ },
+ "PickupAddressResponsesData": {
+ "type": "object",
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the pickup address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "cityName": {
+ "type": "string",
+ "description": "The city name of the pickup address."
+ },
+ "company": {
+ "type": "string",
+ "description": "The name of the company associated with the pickup address."
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the pickup address."
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the pickup address."
+ },
+ "countryName": {
+ "type": "string",
+ "description": "The name of the country of the pickup address."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the pickup address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "districtName": {
+ "type": "string",
+ "description": "The district name of the pickup address."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the pickup address."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the pickup address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the pickup address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the pickup address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "provinceName": {
+ "type": "string",
+ "description": "The name of the province of the pickup address."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the pickup address."
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line, if applicable, of the street address of the pickup address."
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line, if applicable, of the street address of the pickup address."
+ }
+ },
+ "description": "This type defines the fields used to specify location and contact information for a pickup-from consign address associated with a seller's eDIS account."
+ },
+ "ServiceInfoResponses": {
+ "type": "object",
+ "required": [
+ "maxLength",
+ "maxTotalLength",
+ "maxWeight",
+ "shippingServiceId"
+ ],
+ "properties": {
+ "descriptionEn": {
+ "type": "string",
+ "description": "Basic shipping service information in English."
+ },
+ "descriptionHk": {
+ "type": "string",
+ "description": "Basic shipping service information in traditional Chinese."
+ },
+ "descriptionJp": {
+ "type": "string",
+ "description": "Basic shipping service information in Japanese."
+ },
+ "descriptionZh": {
+ "type": "string",
+ "description": "Basic shipping service information in simplified Chinese."
+ },
+ "directions": {
+ "type": "array",
+ "description": "This array lists includes all Ship From/Ship To combinations that the service supports. It also includes the type of batteries that may be shipping using the shipping service.",
+ "items": {
+ "$ref": "#/components/schemas/DirectionsResponses"
+ }
+ },
+ "incoterm": {
+ "description": "The incoterm information associated with the the shipping service.
Supported values:
DDP
DDU
",
+ "$ref": "#/components/schemas/IncotermEnum"
+ },
+ "maxLength": {
+ "type": "number",
+ "description": "This value indicates the maximum length (in centimeters) of the shipping package that the shipping service allows.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "maxTotalLength": {
+ "type": "number",
+ "description": "This value indicates the total maximum value of the length, width, and height of the package.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "maxWeight": {
+ "type": "number",
+ "description": "This value indicates the maximum weight (in grams) of the shipping package that the shipping service allows.
Note: This field is always returned, but will show as null or have an empty value if not defined/applicable."
+ },
+ "nameEn": {
+ "type": "string",
+ "description": "The shipping service name in English"
+ },
+ "nameHk": {
+ "type": "string",
+ "description": "The shipping service name in traditional Chinese"
+ },
+ "nameJp": {
+ "type": "string",
+ "description": "The shipping service name in Japanese."
+ },
+ "nameZh": {
+ "type": "string",
+ "description": "The shipping service name in simplified Chinese"
+ },
+ "shippingServiceId": {
+ "type": "string",
+ "description": "The unique identifier of the shipping service being retrieved.
This value can be input in the shippingServiceId field when creating a package through the the createPackage method."
+ }
+ },
+ "description": "This type specifies the shipping service information."
+ },
+ "ShipToAddressRequestData": {
+ "type": "object",
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the ship-to address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "company": {
+ "type": "string",
+ "description": "The name of the company associated with the ship-to address."
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the the ship-to address."
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the ship-to address."
+ },
+ "countryName": {
+ "type": "string",
+ "description": "The country name of the ship-to address."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the ship-to address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the ship-to address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the ship-to address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the ship-to address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the ship-to address.
Max length: 50 characters"
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line, if applicable, of the street address of the ship-to address.
Max length: 50 characters"
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line, if applicable, of the street address of the ship-to address.
Max length: 50 characters"
+ }
+ },
+ "description": "This type is used to specify the address fields of the ship-to address location."
+ },
+ "ShipToAddressResponsesData": {
+ "type": "object",
+ "required": [
+ "city",
+ "company",
+ "contact",
+ "countryCode",
+ "countryName",
+ "district",
+ "phone",
+ "postcode",
+ "province",
+ "specialServiceDetail",
+ "street1"
+ ],
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The city code of the ship-to address.
See eDIS Address Code Reference Data for valid city codes."
+ },
+ "company": {
+ "type": "string",
+ "description": "The name of the company associated with the ship-to address."
+ },
+ "contact": {
+ "type": "string",
+ "description": "The name of the contact person associated with the ship-to address."
+ },
+ "countryCode": {
+ "type": "string",
+ "description": "The two-letter country code of the ship-to address."
+ },
+ "countryName": {
+ "type": "string",
+ "description": "The country name of the ship-to address."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district code of the ship-to address.
See eDIS Address Code Reference Data for valid district codes."
+ },
+ "phone": {
+ "type": "string",
+ "description": "The phone number associated with the ship-to address."
+ },
+ "postcode": {
+ "type": "string",
+ "description": "The postal code of the ship-to address."
+ },
+ "province": {
+ "type": "string",
+ "description": "The province code of the ship-to address.
See eDIS Address Code Reference Data for valid province codes."
+ },
+ "street1": {
+ "type": "string",
+ "description": "The first line of the street address of the ship-to address."
+ },
+ "street2": {
+ "type": "string",
+ "description": "The second line of the street address of the ship-to address."
+ },
+ "street3": {
+ "type": "string",
+ "description": "The third line of the street address of the ship-to address."
+ }
+ },
+ "description": "This type specifies the ship-to address information for a retrieved package."
+ },
+ "SkuRequest": {
+ "type": "object",
+ "required": [
+ "nameEn",
+ "nameZh",
+ "weight"
+ ],
+ "properties": {
+ "cpscProfileId": {
+ "type": "string",
+ "description": "The unique identifier of a CPSC profile."
+ },
+ "elecQualificationId": {
+ "type": "string",
+ "description": "The unique identifier of the battery's electric qualification, which indicates that the battery has a certificate of approval for global shipping.
This value is returned in the getBatteryQualifications method."
+ },
+ "exemptionType": {
+ "description": "The exemption type associated with the CPSC profile.",
+ "$ref": "#/components/schemas/ExemptionTypeEnum"
+ },
+ "fdcSkus": {
+ "type": "array",
+ "description": "This array lists the FDC SKUs associated with the item. An FDC SKU is the SKU label in a forward deployment center.
Important! Please contact customer service before using these fields.
",
+ "items": {
+ "$ref": "#/components/schemas/FDCSkuRequest"
+ }
+ },
+ "height": {
+ "type": "number",
+ "description": "The height of the item in centimeters."
+ },
+ "isLiBattery": {
+ "type": "boolean",
+ "description": "This boolean indicates if the item contains a battery."
+ },
+ "length": {
+ "type": "number",
+ "description": "The length of the item in centimeters."
+ },
+ "liBatteryType": {
+ "description": "If the item contains a battery, this field indicates the type of battery the item contains.",
+ "$ref": "#/components/schemas/LiBatteryTypeEnum"
+ },
+ "nameEn": {
+ "type": "string",
+ "description": "The English name of the item."
+ },
+ "nameZh": {
+ "type": "string",
+ "description": "The Chinese name of the item."
+ },
+ "origin": {
+ "type": "string",
+ "description": "The country of origin of the item."
+ },
+ "price": {
+ "description": "The declared price of the item.",
+ "$ref": "#/components/schemas/Amount"
+ },
+ "remark": {
+ "type": "string",
+ "description": "A remark to the seller themselves."
+ },
+ "skuNumber": {
+ "type": "string",
+ "description": "The stock keeping unit (SKU) identifier of the item."
+ },
+ "tariffCode": {
+ "type": "string",
+ "description": "The Harmonized System code for custom declaration. This value declares the category of the item.."
+ },
+ "weight": {
+ "type": "number",
+ "description": "The weight of the item in grams."
+ },
+ "width": {
+ "type": "number",
+ "description": "The width of the item in centimeters."
+ }
+ },
+ "description": "This type specifies information relating to the SKU item in a package."
+ },
+ "SpecialServiceDetail": {
+ "type": "object",
+ "properties": {
+ "insuranceFee": {
+ "type": "string",
+ "description": "The insurance fee, if applicable, on the package.
The insurance amount and currency are consistent with the currency of the destination country"
+ },
+ "packagingType": {
+ "type": "string",
+ "description": "The package type.
Valid values:
PAK (limited weight <= 2.5KG)
PACKAGE (limited weight 68KG)
"
+ },
+ "signatureType": {
+ "type": "string",
+ "description": "The signature type, if applicable, for the package.
Valid values:
ISR (Indirect Signature Required)
DSR (Direct Signature Required)
ASR (Adult Signature Required)
"
+ },
+ "specialServiceTypes": {
+ "type": "array",
+ "description": "Any special service types supported for the package.
For example, SATURDAY_DELIVERY indicates that the item is eligible for Saturday delivery.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "This type defines the special service details available for a package."
+ }
+ },
+ "securitySchemes": {
+ "api_auth": {
+ "type": "oauth2",
+ "description": "The security definitions for this API. Please check individual operations for applicable scopes.",
+ "flows": {
+ "clientCredentials": {
+ "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
+ "scopes": {
+ "https://api.ebay.com/oauth/scope/sell.edelivery": "This scope would allow sell.edelivery access to an operation."
+ }
+ },
+ "authorizationCode": {
+ "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
+ "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
+ "scopes": {
+ "https://api.ebay.com/oauth/scope/sell.edelivery": "This scope would allow sell.edelivery access to an operation."
+ }
+ }
+ }
+ },
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/specs/openapi/international-shipping.yaml b/specs/openapi/international-shipping.yaml
deleted file mode 100644
index 817d913..0000000
--- a/specs/openapi/international-shipping.yaml
+++ /dev/null
@@ -1,4059 +0,0 @@
----
-openapi: "3.0.0"
-info:
- title: "EDIS public shipping API"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This API allows 3rd party developers in the Greater-China\
- \ area to process package shipping details."
- contact:
- name: "eBay Inc,"
- license:
- name: "eBay API License Agreement"
- url: "https://developer.ebay.com/join/api-license-agreement"
- version: "1.1.0"
-servers:
-- url: "https://api.ebay.com{basePath}"
- description: "Production"
- variables:
- basePath:
- default: "/sell/edelivery_international_shipping/v1"
-paths:
- /actual_costs:
- get:
- tags:
- - "actual_costs"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method is used to retrieve the actual weight\
- \ and cost for one or more packages based on the provided input criteria.
Responses\
- \ can be filtered by the tracking_numbers query parameter. If this\
- \ parameter is used, actual costs for each package associated with the provided\
- \ tracking numbers are returned.
Alternatively, responses can be filtered\
- \ by the trans_begin_time and trans_end_time query parameters.\
- \ If these parameters are used, the actual costs of all packages created within\
- \ this date range are returned.
Only one filtering method can be used\
- \ per call."
- operationId: "getActualCosts"
- parameters:
- - name: "tracking_numbers"
- in: "query"
- description: "This query parameter specifies the tracking number(s) of the\
- \ package(s) for which to retrieve the actual weight and cost. Tracking\
- \ numbers are returned when creating packages through the createPackage method.
Up to 200 tracking\
- \ numbers can be provided.
Note:\
- \ This query parameter is required if trans_begin_time and trans_end_time\
- \ is not provided."
- required: false
- schema:
- type: "string"
- - name: "trans_begin_time"
- in: "query"
- description: "This query parameter specifies the start time of a transaction\
- \ in UTC format.
If the the trans_begin_time and trans_end_time\
- \ query parameters are used, the actual costs of all packages created within\
- \ this date range are returned.
Note:\
- \ This query parameter and trans_end_time are required if tracking_numbers\
- \ is not provided. Format: YYYY-MM-DDTHH:MM:SS.SSSZ"
- required: false
- schema:
- type: "string"
- - name: "trans_end_time"
- in: "query"
- description: "This query parameter specifies ending time of a transaction\
- \ in UTC format.
If the the trans_begin_time and trans_end_time\
- \ query parameters are used, the actual costs of all packages created within\
- \ this date range are returned.
Note:\
- \ This query parameter and trans_start_time are required if tracking_numbers\
- \ is not provided. Format: YYYY-MM-DDTHH:MM:SS.SSSZ"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetActualCostResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355069:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The date format of the trans_begin_time field is incorrect."
- 355071:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified tracking number {tracking_number} does\
- \ not belong to the seller, so cannot be retrieved."
- 355070:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The date format of the trans_end_time field is incorrect."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /address_preference:
- get:
- tags:
- - "address_preference"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve information\
- \ about all the ship-from and/or return addresses associated with a seller's\
- \ eDIS account."
- operationId: "getAddressPreferences"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetAddressPreferenceListResponses"
- "400":
- description: "Bad Request"
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- post:
- tags:
- - "address_preference"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to create an address\
- \ on your eDIS account.
The following types of addresses can be created\
- \ through this method:
SHIP_FROM_ADDRESS
RETURN_ADDRESS
The\
- \ address information for the address, including location details, contact\
- \ information, and address type, must be provided in the shipFromAddress\
- \ container. If the call is successful, the addressId for the newly\
- \ created address will be returned. This identifier can then be used when\
- \ creating a package to specify the address to use for the shipment."
- operationId: "createAddressPreference"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateAddressPreferenceRequest"
- required: false
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateAddressPreferenceResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355073:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value for province. Please revise it."
- 355072:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value for countrycode. Please revise it."
- 355075:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value for district. Please revise it."
- 355074:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value for city. Please revise it."
- 355002:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Length of street can not be greater than 50. Please\
- \ revise it."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355049:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "Connection failed with logistic service provider system.\
- \ Please wait and retry."
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /agents:
- get:
- tags:
- - "agents"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve information\
- \ about the EU Authorized Representative (AR) agent(s) associated with a seller's\
- \ eDIS account.
An EU AR agent acts as a liaison between non-EU manufacturers\
- \ and European regulatory authorities to ensure compliance with EU regulations.\
- \ This method returns contact information about each agent, as well as their\
- \ eBay ID and the countries that they support."
- operationId: "getAgents"
- parameters:
- - name: "limit"
- in: "query"
- description: "This query parameter sets the maximum number of agents to return\
- \ on each page of the paginated response.
Use this parameter in conjunction\
- \ with the offset parameter to control the pagination of the output.\
- \ For example, if offset is set to 10 and limit\
- \ is set to 10, the call retrieves orders 11 through 20 from\
- \ the result set.
Max: 200
Default:\
- \ 50"
- required: false
- schema:
- type: "string"
- - name: "offset"
- in: "query"
- description: "This query parameter specifies the number of agents to skip\
- \ in the result set before returning the first agent in the paginated response.
Combine\
- \ offset with the limit query parameter to control the items\
- \ returned in the response. For example, if you supply an offset\
- \ of 0 and a limit of 10, the first page\
- \ of the response contains the first 10 items from the complete list of\
- \ items retrieved by the call.
Default: 0"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetAgentListResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355076:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value of pagination parameters. Please\
- \ revise them."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /battery_qualifications:
- get:
- tags:
- - "battery_qualifications"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method is used to retrieve all battery qualifications\
- \ associated with your eDIS account. This includes the type, electronic qualification\
- \ ID and name, and expiration date for each battery."
- operationId: "getBatteryQualifications"
- parameters:
- - name: "limit"
- in: "query"
- description: "This query parameter sets the maximum number of qualifications\
- \ to return on each page of the paginated response.
Use this parameter\
- \ in conjunction with the offset parameter to control the pagination\
- \ of the output. For example, if offset is set to 10\
- \ and limit is set to 10, the call retrieves orders\
- \ 11 through 20 from the result set.
Max: 200
Default:\
- \ 50"
- required: false
- schema:
- type: "string"
- - name: "offset"
- in: "query"
- description: "This query parameter specifies the number of qualifications\
- \ to skip in the result set before returning the first qualification in\
- \ the paginated response.
Combine offset with the limit\
- \ query parameter to control the items returned in the response. For example,\
- \ if you supply an offset of 0 and a limit of\
- \ 10, the first page of the response contains the first 10\
- \ items from the complete list of items retrieved by the call.
Default:\
- \ 0"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetBatteryQualListResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355076:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value of pagination parameters. Please\
- \ revise them."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /bundle/{bundle_id}/cancel:
- post:
- tags:
- - "bundle"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method is used to cancel a bundle.
The\
- \ bundleId value of the bundle to be canceled must be input as a path\
- \ parameter in the request.
Note:\
- \ Bundles cannot be canceled if they are currently being processed."
- operationId: "cancelBundle"
- parameters:
- - name: "bundle_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the bundle\
- \ being canceled.
This ID value is returned when creating a bundle\
- \ through the createBundle method."
- required: true
- schema:
- type: "string"
- responses:
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355083:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing or invalid bundle_id value."
- 355082:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "No permission to access requested data."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "204":
- description: "No Content"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /bundle:
- post:
- tags:
- - "bundle"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method is used to create a bundle for multiple\
- \ packages in an order.
To create a bundle, the consign address to\
- \ be associated with the bundle and the tracking numbers of the packages to\
- \ be used in the bundle must be specified in the request.
If the call\
- \ is successful, the bundleId for the newly created bundle will be\
- \ returned.
Note: Sellers should keep\
- \ track of the returned bundleId, as there is no programmatic way to\
- \ retrieve this value at this time."
- operationId: "createBundle"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateBundleRequest"
- required: false
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateBundleResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355079:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing tracking numbers. Please check."
- 355078:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing consign preference ID. Please check."
- 355081:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Total weight exceeded. Please check."
- 355080:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Please choose packages with same consign preference\
- \ option."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /bundle/{bundle_id}:
- get:
- tags:
- - "bundle"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method is used to retrieved information\
- \ about a specific bundle based on the provided bundle ID value.
The\
- \ bundle_id value of the bundle to be retrieved must be input as a\
- \ path parameter in the request. If the call is successful, information about\
- \ the bundle is returned, such as its associated consign preference ID and\
- \ the tracking numbers of each package in the bundle."
- operationId: "getBundle"
- parameters:
- - name: "bundle_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the bundle\
- \ being retrieved.
This ID value is returned when creating a bundle\
- \ through the createBundle method."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/BundleDetailResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355083:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing or invalid bundle_id value."
- 355082:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "No permission to access requested data."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /bundle/{bundle_id}/label:
- get:
- tags:
- - "bundle"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve the bundle\
- \ label for a bundle of packages.
The bundle for which to retrieve\
- \ a bundle label is specified through the bundleId path parameter.
Bundle\
- \ labels will be returned as base64 string values which can be converted to\
- \ PDF files."
- operationId: "getBundleLabel"
- parameters:
- - name: "bundle_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the bundle\
- \ for which to retrieve a label.
This ID value is returned when creating\
- \ a bundle through the createBundle method."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/BundleLabelResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355083:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing or invalid bundle_id value."
- 355082:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "No permission to access requested data."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /complaint:
- post:
- tags:
- - "complaint"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to create a complaint\
- \ about a shipment order. Complaints can be filed if there is a pickup delay\
- \ on an order or if an item has been lost in transit.
The complaint\
- \ reason, complaint type, and the date the issue occurred must be specified\
- \ in the request. If the complaint is being filed for a missing package, the\
- \ affected packageId values must also be specified in the affectedPackages\
- \ array.
If the call was successful, HTTP status code 201 Created\
- \ will be returned, and the complaint will be created."
- operationId: "createComplaint"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/AddComplaintRequest"
- required: false
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- type: "object"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355060:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Complaint submission is declined on logistic service\
- \ provider side. Please contact customer service for help."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /consign_preference:
- get:
- tags:
- - "consign_preference"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve information\
- \ about all the pickup, drop-off, and/or forward deployment consign addresses\
- \ associated with a seller's eDIS account."
- operationId: "getConsignPreferences"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetConsignPreferenceListResponses"
- "400":
- description: "Bad Request"
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- post:
- tags:
- - "consign_preference"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to create a consign address.
The\
- \ following types of address preferences can be created via this method:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
RDC
CN_POST_DROP_OFF
CN_POST_PICK_UP
HK_POST_DROP_OFF
The\
- \ address information for the consign address must be provided in the consignAddress\
- \ container. If the call is successful, the addressId for the newly\
- \ created address will be returned. This ID can then be used when creating\
- \ a package to specify the consign address to use for the shipment."
- operationId: "createConsignPreference"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateConsignPreferenceRequest"
- required: false
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateConsignPreferenceResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355057:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing address ID of dropoff site. Please check."
- 355056:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing request period. Please check."
- 355058:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Shipping preference name already exists. Please add\
- \ a new name."
- 355053:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Connection failed with backend service. Please wait\
- \ and retry."
- 355055:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Missing package address. Please check."
- 355051:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "pickupTime is missing. Please check."
- 355050:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid value for type. Please check the document."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /dropoff_sites:
- get:
- tags:
- - "dropoff_sites"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve metadata\
- \ for one or more drop-off sites associated with a seller's eDIS account.
Pagination\
- \ query parameters are provided that allow users to control how many drop-off\
- \ site locations are returned in the response."
- operationId: "getDropoffSites"
- parameters:
- - name: "limit"
- in: "query"
- description: "This query parameter sets the maximum number of drop-off site\
- \ locations to return on each page of the paginated response.
Use\
- \ this parameter in conjunction with the offset parameter to control\
- \ the pagination of the output. For example, if offset is set to\
- \ 10 and limit is set to 10, the call retrieves\
- \ orders 11 through 20 from the result set.
Max: 200
Default:\
- \ 50"
- required: false
- schema:
- type: "string"
- - name: "offset"
- in: "query"
- description: "This query parameter specifies the number of drop-off site locations\
- \ to skip in the result set before returning the first location in the paginated\
- \ response.
Combine offset with the limit query parameter\
- \ to control the items returned in the response. For example, if you supply\
- \ an offset of 0 and a limit of 10,\
- \ the first page of the response contains the first 10 items from the complete\
- \ list of items retrieved by the call.
Default: 0"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetDropoffSiteListResponses"
- "400":
- description: "Bad Request"
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /handover_sheet:
- get:
- tags:
- - "handover_sheet"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve the handover\
- \ sheet for one or more packages in a pickup request.
The tracking\
- \ numbers for the packages for which to retrieve handover sheets are specified\
- \ through the tracking_numbers query parameter.
The retrieved\
- \ handover sheet will be returned as a base64 string value, and can be used\
- \ for confirmation with a pickup contact. Only one handover sheet will be\
- \ returned for the specified packages."
- operationId: "getHandoverSheet"
- parameters:
- - name: "tracking_numbers"
- in: "query"
- description: "This query parameter specifies an array of tracking numbers\
- \ for the packages for which to retrieve a handover sheet.
Tracking\
- \ numbers are returned when creating packages through the createPackage method.
Up to 200 tracking\
- \ numbers can be provided. Multiple tracking numbers can be input as individual\
- \ query parameters. For example,
tracking_numbers=E***********************N&tracking_numbers=E***********************Q"
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetHandoverSheetResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355068:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified tracking number {tracking_number} is not\
- \ recognized. Please check and try again."
- 355067:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The field tracking_numbers is required."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /labels:
- get:
- tags:
- - "labels"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve shipping\
- \ labels for the one or more specified packages.
The packages for which\
- \ to retrieve shipping labels can be specified through the tracking_numbers\
- \ query parameter. The page size and print preference settings for the shipping\
- \ label(s) can also be specified through the query parameters.
Shipping\
- \ labels are returned as base64 string values which can be converted to PDF\
- \ files. A separate file will be returned for each tracking number specified\
- \ in the request."
- operationId: "getLabels"
- parameters:
- - name: "page_size"
- in: "query"
- description: "This query parameter specifies the page size of the retrieved\
- \ shipping labels.
Valid values:
A4
THERMAL_PAPER
"
- required: false
- schema:
- type: "string"
- - name: "print_preference"
- in: "query"
- description: "This query parameter specifies one or more printing preferences\
- \ to be set when retrieving shipping labels. Multiple values can be delimited\
- \ by a comma.
Valid values:
nameZh
nameEn
remark
skuPrice
skuNo
quantity
listingId
sellerId
buyerId
"
- required: false
- schema:
- type: "string"
- - name: "tracking_numbers"
- in: "query"
- description: "This query parameter specifies an array of tracking numbers\
- \ of the packages for which to retrieve shipping labels.
Tracking\
- \ numbers are returned when creating packages through the createPackage method.
Up to 200 tracking\
- \ numbers can be provided. Multiple tracking numbers can be input as individual\
- \ query parameters.For example,
tracking_numbers=E***********************N&tracking_numbers=E***********************Q"
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetLabelListResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355077:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value for page setting parameters. Please\
- \ revise it."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified tracking number {tracking_number} is not\
- \ recognized. Please check and try again."
- 355071:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified tracking number {tracking_number} does\
- \ not belong to the seller, so cannot be retrieved."
- 355067:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The field tracking_numbers is required."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/bulk_cancel_packages:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to cancel multiple packages\
- \ and their associated tracking numbers.
The package ID values for\
- \ the packages to be canceled must be input in the packageIds array\
- \ of the request.
Note: Packages cannot\
- \ be cancelled if they are currently being processed. "
- operationId: "bulkCancelPackages"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CancelPackagesRequest"
- required: false
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CancelPackagesResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355044:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Cancel failed on logistic service provider side. Please\
- \ contact logistic customer service for help."
- 355042:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be cancelled due to its current status.\
- \ Please check status and try again."
- 355037:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid packageId {packageId}. Please verify and try\
- \ again."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355036:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package processing. Please try again later."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/bulk_confirm_packages:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to confirm the shipping\
- \ order for multiple packages.
The package ID values for the packages\
- \ to be confirmed must be input in the packageIds array of the request.
After\
- \ a package is confirmed, the estimated cost will be frozen in your wallet\
- \ and the pickup request will be submitted."
- operationId: "bulkConfirmPackages"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ConfirmPackagesRequest"
- required: false
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ConfirmPackagesResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355040:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to missing or invalid\
- \ tracking number. Please add tracking number for package and try\
- \ again."
- 355037:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Unrecognized packageId. Please check."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355036:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package processing. Please try again later."
- 355039:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to missing or invalid\
- \ battery qualification. Please update battery qualification and\
- \ try again."
- 355038:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to its current status.\
- \ Please check the status and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/bulk_delete_packages:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to delete multiple packages.
The\
- \ package ID values for the packages to be deleted must be input in the packageIds\
- \ array of the request.
Note: Packages\
- \ can only be deleted once they have been cancelled through the cancelPackage\
- \ or bulkCancelPackages methods and no longer have a tracking number\
- \ associated with them."
- operationId: "bulkDeletePackages"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/DeletePackagesRequest"
- required: false
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/DeletePackagesResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355064:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be deleted due to its current status.\
- \ Please check the status and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/{package_id}/cancel:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to cancel a package and\
- \ its associated tracking number.
The packageId value of the\
- \ package to be canceled must be input as a path parameter in the request.
Note: Packages cannot be canceled if they are\
- \ currently being processed."
- operationId: "cancelPackage"
- parameters:
- - name: "package_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the package\
- \ being canceled.
This ID value is returned when creating a package\
- \ through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355044:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Cancel failed on logistic service provider side. Please\
- \ contact logistic customer service for help."
- 355042:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be cancelled due to its current status.\
- \ Please check status and try again."
- 355037:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid packageId {packageId}. Please verify and try\
- \ again."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355036:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package processing. Please try again later."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- "204":
- description: "No Content"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/{package_id}/clone:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to clone a package for\
- \ redelivery, resending the package with the same information input during\
- \ the createPackage call.
The packageId value of the\
- \ package to be cloned must be input as a path parameter in the request."
- operationId: "clonePackage"
- parameters:
- - name: "package_id"
- in: "path"
- description: "This path parameter specifies the packageId value of\
- \ the package to be cloned.
This ID value is returned when creating\
- \ a package through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ClonePackageResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355045:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Current package status does not support re-ship function.\
- \ Please check."
- 355046:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "This package have exceeded the limit of re-ship times."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/{package_id}/confirm:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to confirm the shipping\
- \ order for a package.
The packageId value of the package to\
- \ be confirmed must be input as a path parameter in the request.
After\
- \ confirmation the estimated cost will be frozen in your wallet and the pickup\
- \ request will be submitted."
- operationId: "confirmPackage"
- parameters:
- - name: "package_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the package\
- \ you wish to be confirmed.
This ID value is returned when creating\
- \ a package through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355041:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package processing. Please try again later."
- 355040:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to missing or invalid\
- \ tracking number. Please add tracking number for package and try\
- \ again."
- 355037:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Unrecognized packageId. Please check."
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355036:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package processing. Please try again later."
- 355039:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to missing or invalid\
- \ battery qualification. Please update battery qualification and\
- \ try again."
- 355038:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be confirmed due to its current status.\
- \ Please check the status and try again."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "204":
- description: "No Content"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package:
- post:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to create a package for\
- \ an order.
To create a package, the package's shipping information,\
- \ such as the dimensions, weight, ship from, and ship to address, as well\
- \ as information about the item(s) it contains must be specified in the request.
If\
- \ the call is successful, the packageId and tracking number for the\
- \ newly created package will be returned.
Note: Sellers should keep track of the returned packageId,\
- \ as there is no programmatic way to retrieve this value at this time."
- operationId: "createPackage"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/AddPackageRequest"
- required: false
- responses:
- "201":
- description: "Created"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/AddPackageResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355013:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The fdcSkus array cannot be empty. Please include this\
- \ array and add at least one sku and associated quantity for that\
- \ sku."
- 355012:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "ServiceId does not exist. Please check the document."
- 355015:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Each sku under fdcSkus array requires skuId and quantity.\
- \ Please revise them."
- 355014:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "You have exceeded the maximum amount of skus allowed\
- \ under the fdcSkus array."
- 355009:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Order not synced to system yet. Please wait and retry."
- 355008:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "OrderLineItem is not matched to your ebayID. Please\
- \ check."
- 355011:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Order has not been paid. Please check."
- 355021:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The status of elecQualificationId is not avaliable.\
- \ Please check."
- 355020:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Your elecQualificationId does not exist. Please check\
- \ your qualification list.\t"
- 355023:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "LiBatteryType is not matched to battery qualification."
- 355022:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Your elecQualificationId is expired. Please update a\
- \ new one."
- 355017:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Length of skuId can not be greater than 50. Please revise\
- \ it."
- 355016:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The skus array has one or more duplicate skuId values.\
- \ Please remove duplicate skus."
- 355019:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "User T&C update. Please sign the updated version of\
- \ the Letter of Commitment for Lithium Battery items."
- 355018:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The SPECIAL_GOODS_WITH_NO_BATTERY enum value is only\
- \ allowed when miniPackage is specified as the packagingType value."
- 355063:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "AgentName or agentAddress is missing. Please revise\
- \ them."
- 355031:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Account balance is not enough to pay for the package.\
- \ Please add sufficient funds to balance and try again."
- 355030:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The seller's balance could not be accessed to to pay\
- \ for the package. Please contact logistics customer service for\
- \ help."
- 355025:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "ServiceId not available. Please revise it and retry."
- 355024:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "No available shipping service found. Please revise package\
- \ information and retry."
- 355026:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Package is now under processing. Please retry later."
- 355005:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "OrderLineItem {orderLineItemId} has already been assigned\
- \ to another package, so cannot be added to this one."
- 355003:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Our current system setting is not allowing you to add\
- \ packages via API. Please change your settings to ‘ship via API’\
- \ and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- 355066:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "Concurrent actions on same orderLineItem. Please wait\
- \ and retry."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/{package_id}:
- get:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve a package\
- \ based on the provided package ID value.
The packageId value\
- \ of the package to be retrieved must be input as a path parameter in the\
- \ request. If the call is successful, information about the package is returned,\
- \ such as the package's shipping information (its dimensions, weight, ship\
- \ from, and ship to address) and information about the item(s) it contains."
- operationId: "getPackage"
- parameters:
- - name: "package_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the package\
- \ being retrieved.
This ID value is returned when creating a package\
- \ through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetPackageDetailResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- delete:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to delete a package.
The\
- \ packageId value of the package to be deleted must be input as a path\
- \ parameter in the request. If the call is successful, HTTP status code 204\
- \ No Content will be returned, and the package will be deleted.
Note: Packages can only be deleted once they\
- \ have been cancelled through the cancelPackage or bulkCancelPackages\
- \ methods and no longer have a tracking number associated with them."
- operationId: "deletePackage"
- parameters:
- - name: "package_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the package\
- \ being deleted. This package must already be cancelled and have no tracking\
- \ number associated with it.
This ID value is returned when creating\
- \ a package through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified packageId {packageId} is not recognized.\
- \ Please check and try again."
- 355064:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The package cannot be deleted due to its current status.\
- \ Please check the status and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "204":
- description: "No Content"
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /package/{order_line_item_id}/item:
- get:
- tags:
- - "package"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve one or more\
- \ packages based on the provided order line item ID.
This method can\
- \ be followed up with getPackage call to retrieve more detailed information\
- \ about a specific package."
- operationId: "getPackagesByLineItemID"
- parameters:
- - name: "order_line_item_id"
- in: "path"
- description: "This path parameter can be used to specify the unique identifier\
- \ of the line item that is part of the package being retrieved.
This\
- \ value is returned in the lineItemId field of the getOrders method of the Fulfillment API or\
- \ the GetOrders method of the Trading API."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetItemPackageIdResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355062:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid orderLineItemId {orderLineitemId}. Please verify\
- \ and try again."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /services:
- get:
- tags:
- - "services"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve metadata\
- \ on available shipping services, such as the name, description, and directions."
- operationId: "getServices"
- parameters:
- - name: "limit"
- in: "query"
- description: "This query parameter sets the maximum number of shipping services\
- \ to return on each page of the paginated response.
Use this parameter\
- \ in conjunction with the offset parameter to control the pagination\
- \ of the output. For example, if offset is set to 10\
- \ and limit is set to 10, the call retrieves orders\
- \ 11 through 20 from the result set.
Max: 200
Default:\
- \ 50"
- required: false
- schema:
- type: "string"
- - name: "offset"
- in: "query"
- description: "This query parameter specifies the number of shipping services\
- \ to skip in the result set before returning the first shipping service\
- \ in the paginated response.
Combine offset with the limit\
- \ query parameter to control the items returned in the response. For example,\
- \ if you supply an offset of 0 and a limit of\
- \ 10, the first page of the response contains the first 10\
- \ items from the complete list of items retrieved by the call.
Default:\
- \ 0"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetServiceListResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355076:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "Invalid input value of pagination parameters. Please\
- \ revise them."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
- /tracking:
- get:
- tags:
- - "tracking"
- description: "
Important!\
- \ This method is only available for Greater-China based sellers with an active\
- \ eDIS account.
This method can be used to retrieve tracking\
- \ event details for a package associated with the provided tracking number.
Each\
- \ tracking event is returned in the trackingDetails array and includes\
- \ the description, location, time, and status of the event."
- operationId: "getTracking"
- parameters:
- - name: "tracking_number"
- in: "query"
- description: "This query parameter specifies the tracking number for which\
- \ to retrieve current tracking event details.
This value is returned\
- \ when creating a package through the createPackage method."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/GetTrackingDetailResponses"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 355004:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The specified tracking number {tracking_number} is not\
- \ recognized. Please check and try again."
- "401":
- description: "Unauthorized"
- x-response-codes:
- errors:
- 355400:
- domain: "API_EDIS"
- category: "REQUEST"
- description: "The access token provided in the Authorization header\
- \ is not for an eBay user account that is currently allowed to call\
- \ this API. Please go to account settings to add to your account\
- \ list."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 355000:
- domain: "API_EDIS"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- "404":
- description: "Not found"
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/sell.edelivery"
-components:
- schemas:
- AddComplaintRequest:
- type: "object"
- properties:
- complaintRequest:
- description: "This container is used to specify the information included\
- \ in a complaint request, such as the complaint reason, date, and type."
- $ref: "#/components/schemas/AddComplaintRequestData"
- description: "This type is used to define the request container of the createComplaint\
- \ method."
- AddComplaintRequestData:
- type: "object"
- properties:
- affectedPackages:
- type: "array"
- description: "This array specifies a list of packages, specified by their\
- \ packageId, affected by the issue causing the complaint.
Package\
- \ ID values are returned when creating a package through the createPackage method
This array is required\
- \ if the complaint being filed is for a missing package."
- items:
- type: "string"
- complaintDate:
- type: "string"
- description: "The date in which the issue associated with the complaint\
- \ occurred.
Format:YYYY-MM-DDTHH:MM:SS.SSSZ "
- complaintReason:
- type: "string"
- description: "This string specifies the reason the complaint was filed.
Max\
- \ length: 200 characters"
- complaintType:
- type: "string"
- description: "The type of complaint being filed.
Valid values:
ABNORMAL_COLLECTION_COMPLAINT
LOST_PACKAGE_COMPLAINT
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- preferenceId:
- type: "integer"
- description: "The unique identifier of the address associated with the complaint.
This\
- \ field is required if the complain being filed is associated with a specific\
- \ address."
- format: "int32"
- remark:
- type: "string"
- description: "A remark to the seller themselves."
- description: "This type specifies the information included in a complaint request."
- AddPackageRequest:
- type: "object"
- properties:
- packageInfo:
- description: "This container is used to specify the information needed to\
- \ create a package."
- $ref: "#/components/schemas/PackageInfoRequest"
- description: "This type defines the request container used in the createPackage\
- \ method."
- AddPackageResponses:
- type: "object"
- properties:
- createPackageResult:
- description: "This container returns information about the newly created\
- \ package, including its tracking number and packageId value."
- $ref: "#/components/schemas/AddPackageResponsesData"
- description: "This type defines the response container used in the createPackage\
- \ method."
- AddPackageResponsesData:
- type: "object"
- properties:
- estimateCost:
- description: "The estimated shipping cost of the package."
- $ref: "#/components/schemas/Amount"
- lastMileTrackingNumber:
- type: "string"
- description: "The last-mile tracking number of the package.
This\
- \ field is only returned if the last-mile tracking number is provided\
- \ by the carrier."
- packageId:
- type: "string"
- description: "The unique identifier of the created package.
Note: Sellers should keep track of the returned\
- \ packageId, as there is no programmatic way to retrieve this value\
- \ at this time."
- paymentCost:
- description: "The actual payment cost of the package."
- $ref: "#/components/schemas/Amount"
- trackingNumber:
- type: "string"
- description: "The tracking number of the created package."
- description: "This type specifies information about the newly created package,\
- \ such as its estimated costs, tracking number, and package ID value."
- AgentInfoData:
- type: "object"
- properties:
- agentAddress:
- type: "string"
- description: "The address of the EU AR agent."
- agentName:
- type: "string"
- description: "The name of the EU AR agent."
- agentPhone:
- type: "string"
- description: "The phone number of the EU AR agent."
- description: "This type defines information about an EU AR agent, such as their\
- \ address, name, and phone number."
- AgentModelResponses:
- type: "object"
- properties:
- agentAddress:
- type: "string"
- description: "The address of the EU AR agent."
- agentName:
- type: "string"
- description: "The name of the EU AR agent."
- agentPhone:
- type: "string"
- description: "The phone number of the EU AR agent."
- agentPreferences:
- type: "array"
- description: "This array returns the supported shipping countries and eBay\
- \ user IDs associated with the EU AR agent."
- items:
- $ref: "#/components/schemas/AgentPreferenceListResponse"
- arName:
- type: "string"
- description: "The seller-defined setting name of the AR agent."
- description: "This type defines the fields that describe an EU AR agent."
- AgentPreferenceListResponse:
- type: "object"
- properties:
- ebayId:
- type: "string"
- description: "The eBay ID of the EU AR agent."
- shippingCountry:
- type: "string"
- description: "The two-letter ISO 3166 code of the shipping country that\
- \ an EU AR agent supports."
- description: "This type defines the fields that describe a EU AR agents preferences."
- Amount:
- type: "object"
- properties:
- currency:
- type: "string"
- description: "This enum value represents the type of currency being used.\
- \ Both the value and currency fields are required/always\
- \ returned when expressing cost.
See the CurrencyCodeEnum type for the full list of supported\
- \ values.
Both the value and currency fields are\
- \ required/always returned when expressing cost. For implementation help,\
- \ refer to eBay\
- \ API documentation"
- value:
- type: "string"
- description: "The monetary amount, in the currency specified by the currency\
- \ field.
Both the value and currency fields are required/always\
- \ returned when expressing cost."
- description: "This type defines the monetary value of an amount. "
- BatteryQualResponses:
- type: "object"
- properties:
- batteryType:
- type: "string"
- description: "The type of the battery. For implementation help, refer to\
- \ eBay\
- \ API documentation"
- elecQualificationId:
- type: "string"
- description: "The unique identifier of the battery's electric qualification,\
- \ which indicates that the battery has a certificate of approval for global\
- \ shipping."
- elecQualificationName:
- type: "string"
- description: "The name of the battery's electric qualification."
- expireDate:
- type: "string"
- description: "The expiration date of the battery qualification."
- remark:
- type: "string"
- description: "A remark to the seller themselves.
Note: This field is always returned, but will show as null or\
- \ have an empty value if not defined/applicable."
- description: "This type defines the fields to describe a battery's qualifications."
- BundleDetailResponse:
- type: "object"
- properties:
- bundleDetail:
- description: "This container returns information about the retrieved bundle,\
- \ such as its tracking numbers and consign preference ID."
- $ref: "#/components/schemas/BundleDetailResponseData"
- description: "This type defines the response payload of the getBundle\
- \ method."
- BundleDetailResponseData:
- type: "object"
- properties:
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the consign address associated with\
- \ the retrieved bundle."
- trackingNumbers:
- type: "array"
- description: "This array specifies the tracking numbers of the packages\
- \ included in the bundle."
- items:
- type: "string"
- description: "This type is used to specify information, such as the tracking\
- \ numbers and consign preference ID, of a bundle."
- BundleLabelResponse:
- type: "object"
- properties:
- label:
- description: "This container returns the bundle label information, such\
- \ as the base64 string value, for the specified bundle."
- $ref: "#/components/schemas/BundleLabelResponseData"
- description: "This type defines the response container of the getBundleLabel\
- \ method."
- BundleLabelResponseData:
- type: "object"
- properties:
- base64Str:
- type: "string"
- description: "The base 64 string value for the bundle label.
This\
- \ string value can be converted into a PDF file."
- description: "This type defines the base64 string value used to download a bundle\
- \ label PDF file."
- CancelPackagesRequest:
- type: "object"
- properties:
- requests:
- description: "This container is used to specify the package ID values for\
- \ the packages being canceled."
- $ref: "#/components/schemas/CancelPackagesRequestData"
- description: "This type defines the request container for the bulkCancelPackages\
- \ method."
- CancelPackagesRequestData:
- type: "object"
- properties:
- packageIds:
- type: "array"
- description: "This comma-delimited array lists the unique identifiers of\
- \ the packages being canceled.
Up to 200 package IDs can be specified."
- items:
- type: "string"
- description: "This type indicates the IDs of the packages being canceled."
- CancelPackagesResponses:
- type: "object"
- properties:
- responses:
- type: "array"
- description: "This array returns the result code and message for each cancelled\
- \ package. Each package is denoted by its package ID value."
- items:
- $ref: "#/components/schemas/CancelPackagesResponsesData"
- description: "This type defines the response container of the bulkCancelPackages\
- \ method."
- CancelPackagesResponsesData:
- type: "object"
- properties:
- message:
- type: "string"
- description: "This string returns any additional information about the cancelation\
- \ of the package."
- packageId:
- type: "string"
- description: "The unique identifier of the canceled package."
- resultCode:
- type: "string"
- description: "The result code detailing the results cancelation process.
For\
- \ example, a result code of 200 indicates that the call was\
- \ a success and the package and tracking number were canceled."
- description: "This type indicates the response data returned after canceling\
- \ multiple packages."
- ClonePackageResponses:
- type: "object"
- properties:
- clonePackageResult:
- description: "This container returns the package ID, payment cost, and tracking\
- \ number for the cloned package."
- $ref: "#/components/schemas/ClonePackageResponsesData"
- description: "This type defines the response container used in the clonePackage\
- \ method."
- ClonePackageResponsesData:
- type: "object"
- properties:
- lastMileTrackingNumber:
- type: "string"
- description: "The last-mile tracking number of the package.
This\
- \ field is only returned if the last-mile tracking number is provided\
- \ by the carrier."
- packageId:
- type: "string"
- description: "The unique identifier of the package. A new packageId\
- \ value is generated when a package is cloned."
- paymentCost:
- description: "The payment cost for the package."
- $ref: "#/components/schemas/Amount"
- trackingNumber:
- type: "string"
- description: "The tracking number for the cloned package."
- description: "This type specifies the package ID, payment cost, tracking number,\
- \ and last-mile tracking number (if applicable) for the cloned package."
- ConfirmPackagesRequest:
- type: "object"
- properties:
- requests:
- description: "This container is used to specify the package ID values of\
- \ the packages being confirmed."
- $ref: "#/components/schemas/ConfirmPackagesRequestData"
- description: "This type defines the request container of the bulkConfirmPackages\
- \ method."
- ConfirmPackagesRequestData:
- type: "object"
- properties:
- packageIds:
- type: "array"
- description: "This comma-delimited array lists the unique identifiers of\
- \ the packages being confirmed.
Up to 200 packages can be specified."
- items:
- type: "string"
- description: "This type specifies the IDs of the packages being confirmed."
- ConfirmPackagesResponses:
- type: "object"
- properties:
- responses:
- type: "array"
- description: "This array returns the result code and message for each confirmed\
- \ package. Each package is denoted by its package ID value."
- items:
- $ref: "#/components/schemas/ConfirmPackagesResponsesData"
- description: "This type defines the response container of the bulkConfirmPackages\
- \ method."
- ConfirmPackagesResponsesData:
- type: "object"
- properties:
- message:
- type: "string"
- description: "This string returns any additional information about the confirmation\
- \ of the package."
- packageId:
- type: "string"
- description: "The unique identifier of the confirmed package."
- resultCode:
- type: "string"
- description: "The result code relating to the confirmation of the package.
For\
- \ example, a result code of 200 indicates that the call was\
- \ a success and the package was confirmed."
- description: "This type indicates the response data after confirming multiple\
- \ packages."
- ConsignPreferenceInfoResponses:
- type: "object"
- properties:
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the consign address."
- consignPreferenceName:
- type: "string"
- description: "The name of the consign address."
- dropoffSiteId:
- type: "string"
- description: "The unique identifier of the drop-off site.
This field\
- \ is only returned if the consign address is a drop-off location."
- pickupAddress:
- description: "This container returns the address and contact information\
- \ for a pickup address.
Note:\
- \ This container is always returned, but will show as null or have an\
- \ empty value if not defined/applicable."
- $ref: "#/components/schemas/PickupAddressResponsesData"
- pickupTime:
- type: "string"
- description: "The supported pickup window that the pickup location supports.
This\
- \ field is only returned if the consign address is a pickup-from location\
- \ For implementation help, refer to eBay\
- \ API documentation"
- type:
- type: "string"
- description: "The address type of the consign address.
Valid values:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- description: "This type specifies the fields used to create a consign address."
- CreateAddressPreferenceRequest:
- type: "object"
- properties:
- shipFromAddress:
- description: "This container is used to specify the address details used\
- \ to create an address."
- $ref: "#/components/schemas/CreateAddressPreferenceRequestData"
- description: "This type is used to define the request container used in the\
- \ createAddressPreference method."
- CreateAddressPreferenceRequestData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the address.
See 商户API地址编码主数据 for valid city codes."
- company:
- type: "string"
- description: "The company name associated with the address.
Max\
- \ length: 50 characters"
- contact:
- type: "string"
- description: "The name of the contact person associated with the address.
Max\
- \ length: 50 characters"
- countryCode:
- type: "string"
- description: "The two-letter country code of the address.
Valid\
- \ values:
CN
HK
"
- district:
- type: "string"
- description: "The district code of the address.
See 商户API地址编码主数据 for valid district codes."
- name:
- type: "string"
- description: "The name of the address.
Max length: 50 characters"
- phone:
- type: "string"
- description: "The phone number associated with the address."
- postcode:
- type: "string"
- description: "The postal code of the address."
- province:
- type: "string"
- description: "The province code of the address.
See 商户API地址编码主数据 for valid province codes."
- street1:
- type: "string"
- description: "The first line of the street address of the address.
Max\
- \ length: 50 characters"
- street2:
- type: "string"
- description: "The second line, if applicable, of the street address of the\
- \ address.
Max length: 50 characters"
- street3:
- type: "string"
- description: "The third line, if applicable, of the street address of the\
- \ address.
Max length: 50 characters"
- type:
- type: "string"
- description: "The address type of the address being created.
Valid\
- \ values:
SHIP_FROM_ADDRESS
RETURN_ADRESS
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- description: "This type is used to specify the address details used to create\
- \ an address."
- CreateAddressPreferenceResponses:
- type: "object"
- properties:
- shipFromAddressId:
- description: "This container specifies the unique identifier of the newly\
- \ created address."
- $ref: "#/components/schemas/CreateAddressPreferenceResponsesData"
- description: "This type is used to define the response container of the createAddressPreference\
- \ method."
- CreateAddressPreferenceResponsesData:
- type: "object"
- properties:
- addressId:
- type: "string"
- description: "The unique identifier of the newly-created address.
This\
- \ ID value can be used when creating a package through the createPackage method to specify the ship-from\
- \ or return address associated with the package."
- description: "This type defines the unique identifier of a newly created address."
- CreateBundleRequest:
- type: "object"
- properties:
- bundle:
- description: "This container is used to specify the information needed to\
- \ create a bundle, such as the consign address associated with the bundle\
- \ and the tracking numbers of the packages to be included in the bundle."
- $ref: "#/components/schemas/CreateBundleRequestData"
- description: "This type defines the request container of the createBundle\
- \ method."
- CreateBundleRequestData:
- type: "object"
- properties:
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the consign address to be associated\
- \ with the bundle.
This ID can be retrieved using the getConsignPreferences method."
- trackingNumbers:
- type: "array"
- description: "This array specifies the tracking numbers of the packages\
- \ to be included in the bundle.
Tracking numbers are returned when\
- \ creating a package through the createPackage method."
- items:
- type: "string"
- description: "This type defines the information used to create a bundle."
- CreateBundleResponse:
- type: "object"
- properties:
- bundle:
- description: "This container returns information about the newly created\
- \ bundle, such as its bundleId value."
- $ref: "#/components/schemas/CreateBundleResponseData"
- description: "This type defines the response container of the createBundle\
- \ method"
- CreateBundleResponseData:
- type: "object"
- properties:
- bundleId:
- type: "string"
- description: "The unique identifier of the newly created bundle."
- description: "This type defines the unique identifier of the newly-created bundle."
- CreateConsignPreferenceRequest:
- type: "object"
- properties:
- consignAddress:
- description: "This container is used to specify the address details used\
- \ to create a consign address."
- $ref: "#/components/schemas/CreateConsignPreferenceRequestData"
- description: "This type is used to define the request container of the createConsignPreference\
- \ method."
- CreateConsignPreferenceRequestData:
- type: "object"
- properties:
- consignPreferenceName:
- type: "string"
- description: "The name of the consign address."
- dropoffSiteId:
- type: "string"
- description: "The unique identifier of a drop-off site location. This value\
- \ can be retrieved using the getDropoffSites method.
This field is required\
- \ if the DROPOFF address type is specified."
- pickupAddress:
- description: "This container is used to specify the address details used\
- \ to create a pickup-from address.
This container is required if\
- \ the PICK_UP address type is specified."
- $ref: "#/components/schemas/PickupAddressRequestData"
- pickupTime:
- type: "string"
- description: "The pickup time that the pickup location supports.
This\
- \ field is required if the PICK_UP address type is specified.\
- \ For implementation help, refer to eBay\
- \ API documentation"
- type:
- type: "string"
- description: "The address type of the consign address.
Valid values:
PICK_UP
DROP_OFF
FORWARD_DEPLOYMENT
RDC
CN_POST_DROP_OFF
CN_POST_PICK_UP
HK_POST_DROP_OFF
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- description: "This type is used to specify the address details used to create\
- \ a consign address."
- CreateConsignPreferenceResponses:
- type: "object"
- properties:
- consignAddressId:
- description: "This container specifies the unique identifier of the newly\
- \ created consign address."
- $ref: "#/components/schemas/CreateConsignPreferenceResponsesData"
- description: "This type defines the response container for the createConsignPreference\
- \ method."
- CreateConsignPreferenceResponsesData:
- type: "object"
- properties:
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the newly-created consign address.
This\
- \ ID can be used when creating a package through the createPackage method to specify the pickup, drop-off,\
- \ or forward deployment address associated with the package."
- description: "This type defines the unique identifier of the newly created consign\
- \ address."
- DeletePackagesRequest:
- type: "object"
- properties:
- requests:
- description: "This container is used to specify the package ID values for\
- \ the packages being deleted."
- $ref: "#/components/schemas/DeletePackagesRequestData"
- description: "This type defines the request container for the bulkDeletePackages\
- \ method."
- DeletePackagesRequestData:
- type: "object"
- properties:
- packageIds:
- type: "array"
- description: "This comma-delimited array lists the unique identifiers of\
- \ the packages being deleted. These values must be for packages that have\
- \ been cancelled and do not have tracking numbers associated with them.
Package\
- \ ID values are returned when creating a package through the createPackage method."
- items:
- type: "string"
- description: "DeletePackagesRequestData"
- DeletePackagesResponses:
- type: "object"
- properties:
- responses:
- type: "array"
- description: "This array returns the result code and message for each deleted\
- \ package. Each package is denoted by its package ID value."
- items:
- $ref: "#/components/schemas/DeletePackagesResponsesData"
- description: "This type defines the response container of the bulkDeletePackages\
- \ method."
- DeletePackagesResponsesData:
- type: "object"
- properties:
- message:
- type: "string"
- description: "This string returns any additional information about the deletion\
- \ of the package."
- packageId:
- type: "string"
- description: "The unique identifier of the deleted package."
- resultCode:
- type: "string"
- description: "The result code detailing the result of the deletion process.
For\
- \ example, a result code of 200 indicates that the call was\
- \ a success and the package was deleted."
- description: "This type defines the response data after deleting multiple packages."
- DirectionsResponses:
- type: "object"
- properties:
- batteryType:
- type: "string"
- description: "The supported battery type for the shipping service."
- from:
- type: "string"
- description: "The two-letter ISO 3166 ship-from country code."
- to:
- type: "string"
- description: "The two-letter ISO 3166 destination country code."
- description: "This container specifies direction information for a shipping\
- \ service."
- Error:
- type: "object"
- properties:
- category:
- type: "string"
- description: "Identifies the type of erro."
- domain:
- type: "string"
- description: "Name for the primary system where the error occurred. This\
- \ is relevant for application errors."
- errorId:
- type: "integer"
- description: "A unique number to identify the error."
- format: "int32"
- inputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- longMessage:
- type: "string"
- description: "A more detailed explanation of the error."
- message:
- type: "string"
- description: "Information on how to correct the problem, in the end user's\
- \ terms and language where applicable."
- outputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- parameters:
- type: "array"
- description: "An array of name/value pairs that describe details the error\
- \ condition. These are useful when multiple errors are returned."
- items:
- $ref: "#/components/schemas/ErrorParameter"
- subdomain:
- type: "string"
- description: "Further helps indicate which subsystem the error is coming\
- \ from. System subcategories include: Initialization, Serialization, Security,\
- \ Monitoring, Rate Limiting, etc."
- description: "This type defines the fields that can be returned in an error."
- ErrorParameter:
- type: "object"
- properties:
- name:
- type: "string"
- description: "The object of the error."
- value:
- type: "string"
- description: "The value of the object."
- FDCSkuRequest:
- type: "object"
- properties:
- quantity:
- type: "integer"
- description: "The quantity of the FDC SKU."
- format: "int32"
- skuId:
- type: "string"
- description: "The unique identifier of the FDC SKU."
- description: "This type specifies FDC SKU information."
- GetActualCostResponses:
- type: "object"
- properties:
- actualCosts:
- type: "array"
- description: "This array returns a list of actual costs associated with\
- \ the packages matching the input criteria."
- items:
- $ref: "#/components/schemas/GetActualCostResponsesData"
- description: "This type defines the response containers of the getActualCost\
- \ method."
- GetActualCostResponsesData:
- type: "object"
- properties:
- actualWeight:
- type: "number"
- description: "The actual weight of the package in grams."
- amount:
- description: "This container specifies the total monetary amount of the\
- \ actual cost of the package. "
- $ref: "#/components/schemas/Amount"
- billingTime:
- type: "string"
- description: "The time the seller was charged for the actual cost of the\
- \ package in UTC format."
- chargeMode:
- type: "string"
- description: "The two-digit charge mode for the package.
Valid\
- \ values:
01: Actual weight
02:\
- \ Additional dimension weight
03: Charged by lite\
- \ mode
"
- chargeWeight:
- type: "number"
- description: "The weight, in grams, charged for when shipping the package."
- costType:
- type: "string"
- description: "The two-digit cost type of the package. This field indicates\
- \ any fees associated with the package.
The following values are\
- \ the typical cost types returned through this field. If an undocumented\
- \ cost type is returned, check the logistic provider's website for the\
- \ latest values:
01: Shipping fee
02:\
- \ Domestic
03: Return fee
04:\
- \ Domestic burning fee
05: Custom collected fee
06:\
- \ Weight gap fee
07: Duplication compensation
"
- message:
- type: "string"
- description: "A seller-defined message to the buyer regarding the transaction.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- remark:
- type: "string"
- description: "A remark to the seller themselves.
Note: This field is always returned, but will show as null or\
- \ have an empty value if not defined/applicable."
- resultCode:
- type: "string"
- description: "The result code associated with the call.
For example,\
- \ a result code of 200 indicates that the call was a success."
- size:
- type: "string"
- description: "The size of the package in centimeters. This value is returned\
- \ in Length*Width*Height format."
- trackingNumber:
- type: "string"
- description: "The tracking number associated with the package."
- description: "This type defines the actual weight, cost, and additional information\
- \ of a specified package or packages."
- GetAddressPreferenceListResponses:
- type: "object"
- properties:
- addressPreferenceList:
- description: "This container returns all ship-from and/or return addresses\
- \ associated with a seller's eDIS account."
- $ref: "#/components/schemas/GetAddressPreferenceListResponsesData"
- description: "This type defines the response container associated with the getAddressPreferences\
- \ method."
- GetAddressPreferenceListResponsesData:
- type: "object"
- properties:
- addresses:
- type: "array"
- description: "This array returns a list of address, contact, and identifier\
- \ information for each of a seller's ship-from and/or return addresses\
- \ associated with their eDIS account."
- items:
- $ref: "#/components/schemas/GetAddressPreferencesResponses"
- description: "This type defines the list of addresses associated with a eDIS\
- \ account."
- GetAddressPreferencesResponses:
- type: "object"
- properties:
- addressId:
- type: "string"
- description: "The unique identifier of the address."
- city:
- type: "string"
- description: "The city code of the address.
See 商户API地址编码主数据 for valid city codes."
- cityName:
- type: "string"
- description: "The city name of the address."
- company:
- type: "string"
- description: "The company name associated with the address."
- contact:
- type: "string"
- description: "The name of the contact person associated with the address."
- countryCode:
- type: "string"
- description: "The two-letter country code of the address."
- countryName:
- type: "string"
- description: "The country name of the address."
- district:
- type: "string"
- description: "The district code of the address.
See 商户API地址编码主数据 for valid district codes."
- districtName:
- type: "string"
- description: "The district name of the address."
- name:
- type: "string"
- description: "The name of the address."
- phone:
- type: "string"
- description: "The phone number associated with the address."
- postcode:
- type: "string"
- description: "The postal code of the address."
- province:
- type: "string"
- description: "The province code of the address.
See 商户API地址编码主数据 for valid province codes."
- provinceName:
- type: "string"
- description: "The province name of the address."
- street1:
- type: "string"
- description: "The first line of the street address of the address."
- street2:
- type: "string"
- description: "The second line of the street address of the address.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- street3:
- type: "string"
- description: "The third line of the street address of address.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- type:
- type: "string"
- description: "The address type of the address. For implementation help,\
- \ refer to eBay\
- \ API documentation"
- description: "This type defines the fields associated with a seller's ship-from\
- \ address, including the location and contact details of the addresses, as\
- \ well as its unique identifier."
- GetAgentListResponses:
- type: "object"
- properties:
- agentList:
- description: "This container returns a list of all EU AR agents associated\
- \ with your eDIS account and their information."
- $ref: "#/components/schemas/GetAgentListResponsesData"
- description: "This type defines the response container of the getAgents\
- \ method."
- GetAgentListResponsesData:
- type: "object"
- properties:
- agents:
- type: "array"
- description: "This array returns information about each EU AR agent associated\
- \ with a seller's eDIS account, including their contact information, eBay\
- \ ID, and supported shipping countries."
- items:
- $ref: "#/components/schemas/AgentModelResponses"
- href:
- type: "string"
- description: "The URL to the current page of the result set."
- limit:
- type: "integer"
- description: "The value of the limit parameter submitted in the request."
- format: "int32"
- next:
- type: "string"
- description: "The URI for the next page of results. This value is returned\
- \ if there is an additional page of results to return from the result\
- \ set."
- offset:
- type: "integer"
- description: "The value of the offset parameter submitted in the\
- \ request."
- format: "int32"
- prev:
- type: "string"
- description: "The URI for the previous page of results. This is returned\
- \ if there is a previous page of results from the result set."
- total:
- type: "integer"
- description: "The total number of results that match the input criteria."
- format: "int32"
- description: "This type defines the fields in a paginated result set of agents\
- \ associated with a seller's eDIS account. The response consists of 0 or more\
- \ sequenced pages that are returned from the complete result set, where each\
- \ page consists of 0 or more items."
- GetBatteryQualListResponses:
- type: "object"
- properties:
- batteryQualificationList:
- description: "This container returns a list of all battery qualifications\
- \ associated with an eDIS account."
- $ref: "#/components/schemas/GetBatteryQualListResponsesData"
- description: "This type defines the response container of the getbatteryQualifications\
- \ method."
- GetBatteryQualListResponsesData:
- type: "object"
- properties:
- href:
- type: "string"
- description: "The URL to the current page of the result set."
- limit:
- type: "integer"
- description: "The value of the limit parameter submitted in the request."
- format: "int32"
- next:
- type: "string"
- description: "The URI for the next page of results. This value is returned\
- \ if there is an additional page of results to return from the result\
- \ set."
- offset:
- type: "integer"
- description: "The value of the offset parameter submitted in the\
- \ request."
- format: "int32"
- prev:
- type: "string"
- description: "The URI for the previous page of results. This is returned\
- \ if there is a previous page of results from the result set."
- qualifications:
- type: "array"
- description: "This array returns information about each battery qualification\
- \ associated with an eDIS account, such as the battery type, qualification\
- \ name, and expiration date."
- items:
- $ref: "#/components/schemas/BatteryQualResponses"
- total:
- type: "integer"
- description: "The total number of results that match the input criteria."
- format: "int32"
- description: "This type defines the fields in a paginated result set of battery\
- \ qualifications associated with a seller's eDIS account. The response consists\
- \ of 0 or more sequenced pages that are returned from the complete result\
- \ set, where each page consists of 0 or more items."
- GetConsignPreferenceListResponses:
- type: "object"
- properties:
- consignPreferenceList:
- description: "This container returns a list of all consign addresses associated\
- \ with a seller's eDIS account."
- $ref: "#/components/schemas/GetConsignPreferenceListResponsesData"
- description: "This type defines the response container of the getConsignPreferences\
- \ method."
- GetConsignPreferenceListResponsesData:
- type: "object"
- properties:
- consignPreferences:
- type: "array"
- description: "This array returns information about each of a seller's consign\
- \ addresses associated with their eDIS account."
- items:
- $ref: "#/components/schemas/ConsignPreferenceInfoResponses"
- description: "This type defines the fields associated with a seller's consign\
- \ addresses, including the location and contact details of the address, as\
- \ well as its unique identifiers."
- GetDropoffSiteListResponses:
- type: "object"
- properties:
- dropoffSiteList:
- description: "This container returns a list of all of the drop-off site\
- \ locations associated with an eDIS account."
- $ref: "#/components/schemas/GetDropoffSitesResponsesData"
- description: "This type defines the response container associated with the getDropoffSites\
- \ method."
- GetDropoffSitesResponses:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the drop-off site location.
See 商户API地址编码主数据 for valid city codes."
- contact:
- type: "string"
- description: "The name of the contact person associated with the drop-off\
- \ site location."
- country:
- type: "string"
- description: "The two-letter country code associated with the drop-off site\
- \ location."
- district:
- type: "string"
- description: "The district code of the drop-off site location.
See\
- \ 商户API地址编码主数据 for valid district codes."
- dropoffSiteId:
- type: "string"
- description: "The unique identifier of the drop-off site location."
- name:
- type: "string"
- description: "The name of the drop-off site location."
- phone:
- type: "string"
- description: "The phone number associated with the drop-off site location."
- province:
- type: "string"
- description: "The province code of the drop-off site location.
See\
- \ 商户API地址编码主数据 for valid province codes."
- street1:
- type: "string"
- description: "The first line of the street address of the drop-off site\
- \ location."
- street2:
- type: "string"
- description: "The second line, if applicable, of the street address of the\
- \ drop-off site location.
Note:\
- \ This field is always returned, but will show as null or have an empty\
- \ value if not defined/applicable."
- street3:
- type: "string"
- description: "The third line, if applicable, of the street address of the\
- \ drop-off site location.
Note:\
- \ This field is always returned, but will show as null or have an empty\
- \ value if not defined/applicable."
- type:
- type: "string"
- description: "The type of the drop-off site location.
Currently,\
- \ the only valid response is DROP_OFF."
- description: "This type defines the fields associated with one or more drop-off\
- \ sites associated with a seller's eDIS account."
- GetDropoffSitesResponsesData:
- type: "object"
- properties:
- dropoffSites:
- type: "array"
- description: "This array returns address, contact, and identifier information\
- \ for each of a seller's drop-off locations associated with their eDIS\
- \ account."
- items:
- $ref: "#/components/schemas/GetDropoffSitesResponses"
- href:
- type: "string"
- description: "The URL to the current page of the result set."
- limit:
- type: "integer"
- description: "The value of the limit parameter submitted in the request."
- format: "int32"
- next:
- type: "string"
- description: "The URI for the next page of results. This value is returned\
- \ if there is an additional page of results to return from the result\
- \ set."
- offset:
- type: "integer"
- description: "The value of the offset parameter submitted in the\
- \ request."
- format: "int32"
- prev:
- type: "string"
- description: "The URI for the previous page of results. This is returned\
- \ if there is a previous page of results from the result set."
- total:
- type: "integer"
- description: "The total number of results that match the input criteria."
- format: "int32"
- description: "This type defines the list of drop-off site locations associated\
- \ with an eDIS account."
- GetHandoverSheetResponses:
- type: "object"
- properties:
- handoverSheet:
- description: "This container returns the base64 string value for a handover\
- \ sheet."
- $ref: "#/components/schemas/GetHandoverSheetResponsesData"
- description: "This type is used to define the response container for the getHandoverSheet\
- \ method."
- GetHandoverSheetResponsesData:
- type: "object"
- properties:
- base64Str:
- type: "string"
- description: "The base 64 string value for a handover sheet. This string\
- \ can be converted to a PDF file once it has been retrieved."
- description: "This type specifies the base64 string value for a handover sheet."
- GetItemPackageIdResponses:
- type: "object"
- properties:
- itemPackages:
- type: "array"
- description: "This array returns a list of packages associated with the\
- \ specified line item ID."
- items:
- $ref: "#/components/schemas/GetItemPackageIdResponsesData"
- description: "This type defines the response container of the getPackageByLineItemID\
- \ method."
- GetItemPackageIdResponsesData:
- type: "object"
- properties:
- packageId:
- type: "string"
- description: "The unique identifier of the package."
- packageStatus:
- type: "string"
- description: "The current status of the package. For implementation help,\
- \ refer to eBay\
- \ API documentation"
- trackingNumber:
- type: "string"
- description: "The tracking number of the package."
- description: "This type returns information on the packages being retrieved\
- \ based on the specified line item ID. "
- GetLabelListResponses:
- type: "object"
- properties:
- labels:
- type: "array"
- description: "This array returns the shipping label information, such as\
- \ the base64 string value and result code for each specified tracking\
- \ number."
- items:
- $ref: "#/components/schemas/GetLabelListResponsesData"
- description: "This type defines the response container of the getLabels\
- \ method."
- GetLabelListResponsesData:
- type: "object"
- properties:
- base64Str:
- type: "string"
- description: "The base 64 string value for a shipping label.
This\
- \ string value can be converted to a PDF file."
- message:
- type: "string"
- description: "A message relating to the status of the shipping label retrieval\
- \ process."
- resultCode:
- type: "string"
- description: "The result code detailing the results of the shipping label\
- \ retrieval process.
For example, a result code of 200\
- \ indicates that at least one shipping label was successfully retrieved."
- trackingNumber:
- type: "string"
- description: "The tracking number for which the shipping label is being\
- \ retrieved."
- description: "GetLabelListResponsesData"
- GetPackageDetailResponses:
- type: "object"
- properties:
- packageDetail:
- description: "This container returns the details for the specified package."
- $ref: "#/components/schemas/GetPackageDetailResponsesData"
- description: "This type defines the response container of the getPackage\
- \ method."
- GetPackageDetailResponsesData:
- type: "object"
- properties:
- agentInfoResponse:
- description: "This container returns EU AR agent information associated\
- \ with the package."
- $ref: "#/components/schemas/AgentInfoData"
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the consign address associated with\
- \ the package."
- incoterm:
- type: "string"
- description: "The incoterm information associated with the package.
Supported\
- \ values:
DDP
DDU
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- items:
- type: "array"
- description: "This array returns information about the eBay line item(s)\
- \ that are included in the package."
- items:
- $ref: "#/components/schemas/ItemResponses"
- lastMileTrackingNumber:
- type: "string"
- description: "The last-mile tracking number of the package.
This\
- \ field is only returned if the last-mile tracking number is provided\
- \ by the carrier."
- packageComment:
- type: "string"
- description: "The seller-defined remark to the buyer associated with the\
- \ package."
- packageHeight:
- type: "number"
- description: "The height of the package in centimeters."
- packageId:
- type: "string"
- description: "The unique identifier of the package."
- packageLength:
- type: "number"
- description: "The length of the package in centimeters."
- packageStatus:
- type: "string"
- description: "The current status of the package. For implementation help,\
- \ refer to eBay\
- \ API documentation"
- packageWeight:
- type: "number"
- description: "The weight of the package in grams."
- packageWidth:
- type: "number"
- description: "The width of the package in centimeters."
- paymentCost:
- description: "The actual payment cost of the package."
- $ref: "#/components/schemas/Amount"
- shipFromAddressId:
- type: "string"
- description: "The unique identifier of the ship-from address associated\
- \ with the package."
- shippingServiceId:
- type: "string"
- description: "The unique identifier of the shipping service used for the\
- \ package."
- shipToAddress:
- description: "This container returns information about the address the package\
- \ is being shipped to."
- $ref: "#/components/schemas/ShipToAddressResponsesData"
- specialServiceDetail:
- description: "This container returns any special services associated with\
- \ this package.
Note: This field\
- \ is always returned, but will show as null or have an empty value if\
- \ not defined/applicable."
- $ref: "#/components/schemas/SpecialServiceDetail"
- valueForCarriage:
- type: "string"
- description: "The declared value of the package."
- description: "This type specifies the details returned for the specified package."
- GetServiceListResponses:
- type: "object"
- properties:
- serviceList:
- description: "This container returns shipping service metadata associated\
- \ with a seller's eDIS account."
- $ref: "#/components/schemas/GetServiceListResponsesData"
- description: "This type defines the response container of the getService\
- \ method."
- GetServiceListResponsesData:
- type: "object"
- properties:
- href:
- type: "string"
- description: "The URL to the current page of the result set."
- limit:
- type: "integer"
- description: "The value of the limit parameter submitted in the request."
- format: "int32"
- next:
- type: "string"
- description: "The URI for the next page of results. This value is returned\
- \ if there is an additional page of results to return from the result\
- \ set."
- offset:
- type: "integer"
- description: "The value of the offset parameter submitted in the\
- \ request."
- format: "int32"
- prev:
- type: "string"
- description: "The URI for the previous page of results. This is returned\
- \ if there is a previous page of results from the result set."
- services:
- type: "array"
- description: "This array returns a list of available shipping services,\
- \ as well as the descriptions, directions, and identifiers of each service."
- items:
- $ref: "#/components/schemas/ServiceInfoResponses"
- total:
- type: "integer"
- description: "The total number of shipping services being displayed on the\
- \ current results page."
- format: "int32"
- description: "This type defines the details returned for the retrieved shipping\
- \ service(s)."
- GetTrackingDetailResponses:
- type: "object"
- properties:
- trackingDetails:
- type: "array"
- description: "This array returns a list of tracking event details for the\
- \ specified tracking number."
- items:
- $ref: "#/components/schemas/GetTrackingDetailResponsesData"
- description: "This container defines the response container for the getTracking\
- \ method."
- GetTrackingDetailResponsesData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code in which the tracking event occurred.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- country:
- type: "string"
- description: "The two-letter ISO 3166 country code where the tracking event\
- \ occurred."
- descriptionEn:
- type: "string"
- description: "The English description of the tracking event."
- descriptionZh:
- type: "string"
- description: "The Chinese description of the tracking event."
- district:
- type: "string"
- description: "The district code where the tracking event occurred.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- eventPostalCode:
- type: "string"
- description: "The postal code of where the tracking event occurred.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- eventTime:
- type: "string"
- description: "This timestamp the time and date the tracking event occurred."
- province:
- type: "string"
- description: "The province code where the tracking event occurred.
See\
- \ 商户API地址编码主数据 for province district codes.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- status:
- type: "string"
- description: "The status of the shipment."
- trackingNumber:
- type: "string"
- description: "The tracking number specified in the request."
- description: "This type specifies the tracking event details for the specified\
- \ tracking number."
- ItemRequest:
- type: "object"
- properties:
- buyerId:
- type: "string"
- description: "The buyer's eBay user ID."
- buyerTaxId:
- type: "string"
- description: "The tax ID for the buyer. The type of Tax ID is specified\
- \ in the buyerTaxIdType field."
- buyerTaxType:
- type: "string"
- description: "The type of tax ID that was supplied by the buyer during the\
- \ checkout process."
- ebayCollectAndRemitTax:
- type: "boolean"
- description: "This boolean indicates if the corresponding line item is subject\
- \ to a 'Collect and Remit' tax that eBay will collect and remit to the\
- \ proper taxing authority on the buyer's behalf."
- ebayCollectAndRemitTaxesValue:
- type: "string"
- description: "The value of the 'Collect and Remit' tax for the order that\
- \ the line item belongs to."
- email:
- type: "string"
- description: "The buyer's email address."
- itemTitle:
- type: "string"
- description: "The title of the listing."
- listingId:
- type: "string"
- description: "The unique identifier of the eBay listing.
Note: Either a listingId and transactionId\
- \ pair, or an orderLineItem field is required to identify an order\
- \ line item."
- message:
- type: "string"
- description: "A message from the seller to the buyer."
- orderId:
- type: "string"
- description: "The unique identifier of the eBay order that the line item\
- \ belongs to."
- orderLineItem:
- type: "string"
- description: "The unique identifier of the line item.
Note: Either a listingId and transactionId\
- \ pair, or an orderLineItem field is required to identify an order\
- \ line item."
- paymentDate:
- type: "string"
- description: "The date and time the buyer pays for the order.
Format:\
- \ YYYY-MM-DDTHH:MM:SS.SSSZ"
- payPalEmail:
- type: "string"
- description: "The buyer's PayPal email address."
- payPalMessage:
- type: "string"
- description: "The buyer's PayPal message."
- postedQuantity:
- type: "integer"
- description: "The quantity of the line item that will be shipped with the\
- \ package. This value can differ from the order quantity in the case of\
- \ a combined or split shipment.
Min: 1
Max:\
- \ 999"
- format: "int32"
- siteId:
- type: "integer"
- description: "The unique identifier of the eBay site in which the order\
- \ occurred."
- format: "int32"
- sku:
- description: "This container specifies information relating to the item\
- \ being shipped in the package."
- $ref: "#/components/schemas/SkuRequest"
- soldDate:
- type: "string"
- description: "The date the item was sold.
Format: YYYY-MM-DDTHH:MM:SS.SSSZ"
- soldPrice:
- description: "The price for which the item was sold."
- $ref: "#/components/schemas/Amount"
- soldQuantity:
- type: "integer"
- description: "The quantity of the line item that was sold."
- format: "int32"
- transactionId:
- type: "string"
- description: "The unique identifier of the monetary transaction.
Note: Either a listingId and transactionId\
- \ pair, or an orderLineItem field is required to identify an order\
- \ line item."
- description: "This container specifies information about the items being included\
- \ in a package."
- ItemResponses:
- type: "object"
- properties:
- buyerId:
- type: "string"
- description: "The buyer's eBay ID."
- buyerTaxId:
- type: "string"
- description: "The buyer's tax ID."
- buyerTaxType:
- type: "string"
- description: "The buyer's tax type."
- ebayCollectAndRemitTax:
- type: "boolean"
- description: "If returned as true, this boolean indicates that\
- \ eBay will collect tax for the corresponding line item, and remit the\
- \ tax to the taxing authority of the buyer's residence. "
- ebayCollectAndRemitTaxesValue:
- type: "string"
- description: "The value of the collect and remit tax for the corresponding\
- \ line item. This field is only returned if collect and remit tax is applied\
- \ to the line item. "
- email:
- type: "string"
- description: "The buyer's eBay email address."
- itemTitle:
- type: "string"
- description: "The seller created title of the item."
- listingId:
- type: "string"
- description: "The unique identifier of the eBay listing associated with\
- \ the item."
- message:
- type: "string"
- description: "The buyer's eBay message."
- orderId:
- type: "string"
- description: "The unique identifier of the eBay order that the line item\
- \ belongs to."
- orderLineItem:
- type: "string"
- description: "The unique identifier of an eBay order line item."
- paymentDate:
- type: "string"
- description: "The date and time that the payment was received by the seller.\
- \ This timestamp is returned in ISO 8601 format, which uses the 24-hour\
- \ Universal Coordinated Time (UTC) clock."
- payPalEmail:
- type: "string"
- description: "The buyer's PayPal email address."
- payPalMessage:
- type: "string"
- description: "The buyer's PayPal message"
- postedQuantity:
- type: "integer"
- description: "The quantity of the line item shipped with the package."
- format: "int32"
- siteId:
- type: "integer"
- description: "The unique identifier of the eBay site in which the order\
- \ occurred."
- format: "int32"
- sku:
- description: "This container returns SKU-related information relating to\
- \ the item being shipped in the package."
- $ref: "#/components/schemas/SkuRequest"
- soldDate:
- type: "string"
- description: "The date the item was sold."
- soldPrice:
- description: "The price for which the item was sold."
- $ref: "#/components/schemas/Amount"
- soldQuantity:
- type: "integer"
- description: "The quantity of the line item that was sold."
- format: "int32"
- transactionId:
- type: "string"
- description: "The unique identifier of the eBay transaction."
- description: "This type defines item information for items in a package."
- PackageInfoRequest:
- type: "object"
- properties:
- agentInfoRequest:
- description: "This container specifies the EU AR agent information associated\
- \ with the package.
This information can be retrieved using the\
- \ getAgents method."
- $ref: "#/components/schemas/AgentInfoData"
- consignPreferenceId:
- type: "string"
- description: "The unique identifier of the consign address to be associated\
- \ with the package.
This ID can be retrieved using the getConsignPreferences method."
- incoterm:
- type: "string"
- description: "The incoterm information associated with the package.
Supported\
- \ values:
DDP
DDU
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- items:
- type: "array"
- description: "This array is used to specify applicable information about\
- \ the eBay line item(s) that will be included in the package."
- items:
- $ref: "#/components/schemas/ItemRequest"
- maxQuantityLimit:
- type: "integer"
- description: "This field is used to limit the maximum number of parcels\
- \ used in a single order. If the order has more than one parcel, revise\
- \ this value to increase the limit."
- format: "int32"
- packageComment:
- type: "string"
- description: "A seller-defined comment about the package."
- packageHeight:
- type: "number"
- description: "The height of the package in centimeters."
- packageLength:
- type: "number"
- description: "The length of the package in centimeters."
- packageWeight:
- type: "number"
- description: "The weight of the package in grams."
- packageWidth:
- type: "number"
- description: "The width of the package in centimeters."
- shipFromAddressId:
- type: "string"
- description: "The unique identifier of the ship-from address used for the\
- \ package.
Use the getAddressPreferences method to retrieve valid\
- \ ship-from addressId values associated with your account."
- shippingServiceId:
- type: "string"
- description: "The unique identifier of the shipping service being used for\
- \ the package.
This value can be retrieved using the getServices method."
- shipToAddress:
- description: "This container specifies the address details of the address\
- \ ship-to address."
- $ref: "#/components/schemas/ShipToAddressRequestData"
- specialServiceDetail:
- description: "This container specifies any special service details about\
- \ the package, such as any insurance fee, required signatures, or delivery\
- \ exceptions."
- $ref: "#/components/schemas/SpecialServiceDetail"
- valueForCarriage:
- type: "string"
- description: "The declared value of a large carriage (a combination of several\
- \ orders together)."
- description: "This type is used to specify the package information needed to\
- \ create a package."
- PickupAddressRequestData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the pickup address.
See 商户API地址编码主数据 for valid city codes."
- company:
- type: "string"
- description: "The company name associated with the pickup address.
Max\
- \ length: 50 characters"
- contact:
- type: "string"
- description: "The name of the contact person associated with the pickup\
- \ address.
Max length: 50 characters"
- countryCode:
- type: "string"
- description: "The two-letter country code of the pickup address.
Valid\
- \ values:
CN
HK
"
- district:
- type: "string"
- description: "The district code of the pickup address.
See 商户API地址编码主数据 for valid district codes."
- name:
- type: "string"
- description: "The name of the pickup address.
Max length:\
- \ 50 characters"
- phone:
- type: "string"
- description: "The phone number associated with the pickup address."
- postcode:
- type: "string"
- description: "The postal code of the pickup address."
- province:
- type: "string"
- description: "The province code of the the pickup address.
See 商户API地址编码主数据 for valid province codes."
- street1:
- type: "string"
- description: "The first line of the street address of the pickup address.
Max\
- \ length: 50 characters"
- street2:
- type: "string"
- description: "The second line, if applicable, of the street address of the\
- \ pickup address.
Max length: 50 characters"
- street3:
- type: "string"
- description: "The third line, if applicable, of the street address of the\
- \ pickup address.
Max length: 50 characters"
- description: "This type defines the field used to create a pickup address."
- PickupAddressResponsesData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the pickup address.
See 商户API地址编码主数据 for valid city codes."
- cityName:
- type: "string"
- description: "The city name of the pickup address."
- company:
- type: "string"
- description: "The name of the company associated with the pickup address."
- contact:
- type: "string"
- description: "The name of the contact person associated with the pickup\
- \ address."
- countryCode:
- type: "string"
- description: "The two-letter country code of the pickup address."
- countryName:
- type: "string"
- description: "The name of the country of the pickup address."
- district:
- type: "string"
- description: "The district code of the pickup address.
See 商户API地址编码主数据 for valid district codes."
- districtName:
- type: "string"
- description: "The district name of the pickup address."
- name:
- type: "string"
- description: "The name of the pickup address."
- phone:
- type: "string"
- description: "The phone number associated with the pickup address."
- postcode:
- type: "string"
- description: "The postal code of the pickup address."
- province:
- type: "string"
- description: "The province code of the pickup address.
See 商户API地址编码主数据 for valid province codes."
- provinceName:
- type: "string"
- description: "The name of the province of the pickup address."
- street1:
- type: "string"
- description: "The first line of the street address of the pickup address."
- street2:
- type: "string"
- description: "The second line, if applicable, of the street address of the\
- \ pickup address."
- street3:
- type: "string"
- description: "The third line, if applicable, of the street address of the\
- \ pickup address."
- description: "This type defines the fields used to specify location and contact\
- \ information for a pickup-from consign address associated with a seller's\
- \ eDIS account."
- ServiceInfoResponses:
- type: "object"
- properties:
- descriptionEn:
- type: "string"
- description: "Basic shipping service information in English."
- descriptionHk:
- type: "string"
- description: "Basic shipping service information in traditional Chinese."
- descriptionJp:
- type: "string"
- description: "Basic shipping service information in Japanese."
- descriptionZh:
- type: "string"
- description: "Basic shipping service information in simplified Chinese."
- directions:
- type: "array"
- description: "This array lists includes all Ship From/Ship To combinations\
- \ that the service supports. It also includes the type of batteries that\
- \ may be shipping using the shipping service."
- items:
- $ref: "#/components/schemas/DirectionsResponses"
- incoterm:
- type: "string"
- description: "The incoterm information associated with the the shipping\
- \ service.
Supported values:
DDP
DDU
\
- \ For implementation help, refer to eBay\
- \ API documentation"
- maxLength:
- type: "number"
- description: "This value indicates the maximum length (in centimeters) of\
- \ the shipping package that the shipping service allows.
Note: This field is always returned, but\
- \ will show as null or have an empty value if not defined/applicable."
- maxTotalLength:
- type: "number"
- description: "This value indicates the total maximum value of the length,\
- \ width, and height of the package.
Note:\
- \ This field is always returned, but will show as null or have an empty\
- \ value if not defined/applicable."
- maxWeight:
- type: "number"
- description: "This value indicates the maximum weight (in grams) of the\
- \ shipping package that the shipping service allows.
Note: This field is always returned, but will show\
- \ as null or have an empty value if not defined/applicable."
- nameEn:
- type: "string"
- description: "The shipping service name in English"
- nameHk:
- type: "string"
- description: "The shipping service name in traditional Chinese"
- nameJp:
- type: "string"
- description: "The shipping service name in Japanese."
- nameZh:
- type: "string"
- description: "The shipping service name in simplified Chinese"
- shippingServiceId:
- type: "string"
- description: "The unique identifier of the shipping service being retrieved.
This\
- \ value can be input in the shippingServiceId field when creating a package\
- \ through the the createPackage method."
- description: "This type specifies the shipping service information."
- ShipToAddressRequestData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the ship-to address.
See 商户API地址编码主数据 for valid city codes."
- company:
- type: "string"
- description: "The name of the company associated with the ship-to address."
- contact:
- type: "string"
- description: "The name of the contact person associated with the the ship-to\
- \ address."
- countryCode:
- type: "string"
- description: "The two-letter country code of the ship-to address."
- countryName:
- type: "string"
- description: "The country name of the ship-to address."
- district:
- type: "string"
- description: "The district code of the ship-to address.
See 商户API地址编码主数据 for valid district codes."
- phone:
- type: "string"
- description: "The phone number associated with the ship-to address."
- postcode:
- type: "string"
- description: "The postal code of the ship-to address."
- province:
- type: "string"
- description: "The province code of the ship-to address.
See 商户API地址编码主数据 for valid province codes."
- street1:
- type: "string"
- description: "The first line of the street address of the ship-to address.
Max\
- \ length: 50 characters"
- street2:
- type: "string"
- description: "The second line, if applicable, of the street address of the\
- \ ship-to address.
Max length: 50 characters"
- street3:
- type: "string"
- description: "The third line, if applicable, of the street address of the\
- \ ship-to address.
Max length: 50 characters"
- description: "This type is used to specify the address fields of the ship-to\
- \ address location."
- ShipToAddressResponsesData:
- type: "object"
- properties:
- city:
- type: "string"
- description: "The city code of the ship-to address.
See 商户API地址编码主数据 for valid city codes."
- company:
- type: "string"
- description: "The name of the company associated with the ship-to address."
- contact:
- type: "string"
- description: "The name of the contact person associated with the ship-to\
- \ address."
- countryCode:
- type: "string"
- description: "The two-letter country code of the ship-to address."
- countryName:
- type: "string"
- description: "The country name of the ship-to address."
- district:
- type: "string"
- description: "The district code of the ship-to address.
See 商户API地址编码主数据 for valid district codes."
- phone:
- type: "string"
- description: "The phone number associated with the ship-to address."
- postcode:
- type: "string"
- description: "The postal code of the ship-to address."
- province:
- type: "string"
- description: "The province code of the ship-to address.
See 商户API地址编码主数据 for valid province codes."
- street1:
- type: "string"
- description: "The first line of the street address of the ship-to address."
- street2:
- type: "string"
- description: "The second line of the street address of the ship-to address."
- street3:
- type: "string"
- description: "The third line of the street address of the ship-to address."
- description: "This type specifies the ship-to address information for a retrieved\
- \ package."
- SkuRequest:
- type: "object"
- properties:
- elecQualificationId:
- type: "string"
- description: "The unique identifier of the battery's electric qualification,\
- \ which indicates that the battery has a certificate of approval for global\
- \ shipping.
This value is returned in the getBatteryQualifications method."
- fdcSkus:
- type: "array"
- description: "This array lists the FDC SKUs associated with the item. An\
- \ FDC SKU is the SKU label in a forward deployment center.
Important!\
- \ Please contact customer service before using these fields.
"
- items:
- $ref: "#/components/schemas/FDCSkuRequest"
- height:
- type: "number"
- description: "The height of the item in centimeters."
- isLiBattery:
- type: "boolean"
- description: "This boolean indicates if the item contains a battery."
- length:
- type: "number"
- description: "The length of the item in centimeters."
- liBatteryType:
- type: "string"
- description: "If the item contains a battery, this field indicates the type\
- \ of battery the item contains. For implementation help, refer to eBay\
- \ API documentation"
- nameEn:
- type: "string"
- description: "The English name of the item."
- nameZh:
- type: "string"
- description: "The Chinese name of the item."
- origin:
- type: "string"
- description: "The country of origin of the item."
- price:
- description: "The declared price of the item."
- $ref: "#/components/schemas/Amount"
- remark:
- type: "string"
- description: "A remark to the seller themselves."
- skuNumber:
- type: "string"
- description: "The stock keeping unit (SKU) identifier of the item."
- tariffCode:
- type: "string"
- description: "The Harmonized System code for custom declaration. This value\
- \ declares the category of the item.."
- weight:
- type: "number"
- description: "The weight of the item in grams."
- width:
- type: "number"
- description: "The width of the item in centimeters."
- description: "This type specifies information relating to the SKU item in a\
- \ package."
- SpecialServiceDetail:
- type: "object"
- properties:
- insuranceFee:
- type: "string"
- description: "The insurance fee, if applicable, on the package.
The\
- \ insurance amount and currency are consistent with the currency of the\
- \ destination country"
- packagingType:
- type: "string"
- description: "The package type.
Valid values:
PAK\
- \ (limited weight ≤ 2.5KG)
PACKAGE (limited weight\
- \ 68KG)
"
- signatureType:
- type: "string"
- description: "The signature type, if applicable, for the package.
Valid\
- \ values:
ISR (Indirect Signature Required)
DSR\
- \ (Direct Signature Required)
ASR (Adult Signature\
- \ Required)
"
- specialServiceTypes:
- type: "array"
- description: "Any special service types supported for the package.
\
- \ For example, SATURDAY_DELIVERY indicates that the item\
- \ is eligible for Saturday delivery."
- items:
- type: "string"
- description: "This type defines the special service details available for a\
- \ package."
- securitySchemes:
- api_auth:
- type: "oauth2"
- description: "The security definitions for this API. Please check individual\
- \ operations for applicable scopes."
- flows: {}
diff --git a/specs/openapi/translation.json b/specs/openapi/translation.json
new file mode 100644
index 0000000..7c07187
--- /dev/null
+++ b/specs/openapi/translation.json
@@ -0,0 +1,435 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "Translation API",
+ "description": "This API allows 3rd party developers to translate item titles and item descriptions.",
+ "contact": {
+ "name": "eBay Inc,"
+ },
+ "license": {
+ "name": "eBay API License Agreement",
+ "url": "https://developer.ebay.com/join/api-license-agreement"
+ },
+ "version": "v1_beta.1.6"
+ },
+ "servers": [
+ {
+ "url": "https://api.ebay.com{basePath}",
+ "description": "Production",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/translation/v1_beta"
+ }
+ }
+ }
+ ],
+ "security": [
+ {}
+ ],
+ "paths": {
+ "/translate": {
+ "post": {
+ "tags": [
+ "language"
+ ],
+ "description": "This method translates listing title and listing description text from one language into another. For a full list of supported language translations, see the table.",
+ "operationId": "translate",
+ "parameters": [
+ {
+ "name": "Content-Type",
+ "in": "header",
+ "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.
For more information, refer to HTTP request headers.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TranslateRequest"
+ },
+ "examples": {
+ "translate-example": {
+ "summary": "Translate an item title from English to German",
+ "value": {
+ "from": "en",
+ "to": "de",
+ "text": [
+ "Bernina 790e Pro Embroidery Long Arm Sewing Machine"
+ ],
+ "translationContext": "ITEM_TITLE"
+ }
+ }
+ }
+ }
+ },
+ "required": true,
+ "description": "The request payload containing the text and language settings for translation."
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TranslateResponse"
+ },
+ "examples": {
+ "translate-response": {
+ "summary": "Successful translation response",
+ "value": {
+ "from": "en",
+ "to": "de",
+ "translations": [
+ {
+ "originalText": "Bernina 790e Pro Embroidery Long Arm Sewing Machine",
+ "translatedText": "Bernina 790e Pro Stickerei Langarm N?hmaschine"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "110000": {
+ "domain": "API_TRANSLATION",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ },
+ "110001": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "From language is invalid, missing or not supported. For more information, see the API call reference documentation."
+ },
+ "110002": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "To language is invalid, missing or not supported. For more information, see the API call reference documentation."
+ },
+ "110003": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Context is not supported. For more information, see the API call reference documentation."
+ },
+ "110004": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Maximum number of input text reached. For more information, see the API call reference documentation."
+ },
+ "110005": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Maximum length of input text reached. For more information, see the API call reference documentation."
+ },
+ "110006": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Unsupported from and to combination."
+ },
+ "110007": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Markups are not supported in input texts for title translation context."
+ },
+ "110008": {
+ "domain": "API_TRANSLATION",
+ "category": "REQUEST",
+ "description": "Input text missing."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "110000": {
+ "domain": "API_TRANSLATION",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope"
+ ]
+ }
+ ],
+ "summary": "Translate text from one language to another"
+ },
+ "summary": "Translate listing content"
+ }
+ },
+ "components": {
+ "schemas": {
+ "Error": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "Identifies the type of error."
+ },
+ "domain": {
+ "type": "string",
+ "description": "Name for the primary system where the error occurred. This is relevant for application errors."
+ },
+ "errorId": {
+ "type": "integer",
+ "description": "A unique number to identify the error.",
+ "format": "int32"
+ },
+ "inputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "longMessage": {
+ "type": "string",
+ "description": "A more detailed explanation of the error."
+ },
+ "message": {
+ "type": "string",
+ "description": "Information on how to correct the problem, in the end user's terms and language where applicable."
+ },
+ "outputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
+ "items": {
+ "$ref": "#/components/schemas/ErrorParameter"
+ }
+ },
+ "subdomain": {
+ "type": "string",
+ "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
+ }
+ },
+ "description": "This type defines the fields that can be returned in an error."
+ },
+ "ErrorParameter": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The object of the error.",
+ "examples": [
+ "categoryId"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the object.",
+ "examples": [
+ "1234"
+ ]
+ }
+ },
+ "description": "Used to specify information relevant to the end user/client."
+ },
+ "LanguageEnum": {
+ "type": "string",
+ "description": "This enumeration type lists the languages that are currently supported for either input or output text. For a full list of supported language translations, see the Supported languages table. | - **de**: Indicates the language of the input or output text is German. - **en**: Indicates the language of the input or output text is English. - **es**: Indicates the language of the input or output text is Spanish. - **fr**: Indicates the language of the input or output text is French. - **it**: Indicates the language of the input or output text is Italian. - **ja**: Indicates the language of the input or output text is Japanese. - **pl**: Indicates the language of the input or output text is Polish. - **pt**: Indicates the language of the input or output text is Portuguese. - **ru**: Indicates the language of the input or output text is Russian. - **zh**: Indicates the language of the input or output text is Chinese.",
+ "enum": [
+ "de",
+ "en",
+ "es",
+ "fr",
+ "it",
+ "ja",
+ "pl",
+ "pt",
+ "ru",
+ "zh"
+ ]
+ },
+ "TranslateRequest": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The language of the input text to be translated. Not all LanguageEnum values are supported in this field. For a full list of supported language pairings, see the Supported languages table.",
+ "$ref": "#/components/schemas/LanguageEnum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LanguageEnum"
+ }
+ ],
+ "examples": [
+ "en"
+ ]
+ },
+ "text": {
+ "type": "array",
+ "description": "The input text to translate. The maximum number of characters permitted is determined by the translationContext value:
ITEM_TITLE: 1000 characters maximum
ITEM_DESCRIPTION: 20,000 characters maximum. Note: When translating ITEM_DESCRIPTION text, HTML/CSS markup and links can be included and will not count toward this 20,000 character limit.
Note: Currently, only one input string can be translated per API call. Support for multiple continuous text strings are expected in the future.",
+ "items": {
+ "type": "string",
+ "description": "A text string to be translated."
+ }
+ },
+ "to": {
+ "description": "The target language for the translation of the input text. Not all LanguageEnum values are supported in this field. For a full list of supported language pairings, see the Supported languages table.",
+ "$ref": "#/components/schemas/LanguageEnum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LanguageEnum"
+ }
+ ],
+ "examples": [
+ "de"
+ ]
+ },
+ "translationContext": {
+ "description": "Input the listing entity to be translated.
Valid Values:ITEM_TITLE and ITEM_DESCRIPTION",
+ "$ref": "#/components/schemas/TranslationContextEnum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TranslationContextEnum"
+ }
+ ],
+ "examples": [
+ "ITEM_TITLE"
+ ]
+ }
+ },
+ "description": "This is the base type of the translate method request payload.",
+ "required": [
+ "from",
+ "text",
+ "to",
+ "translationContext"
+ ]
+ },
+ "TranslateResponse": {
+ "type": "object",
+ "properties": {
+ "from": {
+ "description": "The enumeration value indicates the language of the input text.",
+ "$ref": "#/components/schemas/LanguageEnum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LanguageEnum"
+ }
+ ],
+ "examples": [
+ "en"
+ ]
+ },
+ "to": {
+ "description": "The enumeration value indicates the language of the translated text.",
+ "$ref": "#/components/schemas/LanguageEnum",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/LanguageEnum"
+ }
+ ],
+ "examples": [
+ "de"
+ ]
+ },
+ "translations": {
+ "type": "array",
+ "description": "An array showing the input and translated text. Only one input string can be translated at this time. Support for multiple continuous text strings are expected in the future.",
+ "items": {
+ "$ref": "#/components/schemas/Translation"
+ }
+ }
+ },
+ "description": "This is the base type of the translate method response payload.",
+ "required": [
+ "from",
+ "to",
+ "translations"
+ ]
+ },
+ "Translation": {
+ "type": "object",
+ "properties": {
+ "originalText": {
+ "type": "string",
+ "description": "The original text, in the language specified in the from field, that was input into the text field in the request.",
+ "examples": [
+ "Bernina 790e Pro Embroidery Long Arm Sewing Machine"
+ ]
+ },
+ "translatedText": {
+ "type": "string",
+ "description": "The translation of the original text into the language specified in the to field.",
+ "examples": [
+ "Bernina 790e Pro Stickerei Langarm N?hmaschine"
+ ]
+ }
+ },
+ "description": "This type is used by the translations array, which shows the original text supplied by the user in the request payload, and the text translated by eBay.
Only one input string can be translated at this time. Support for multiple continuous text strings are expected in the future.",
+ "required": [
+ "originalText",
+ "translatedText"
+ ]
+ },
+ "TranslationContextEnum": {
+ "type": "string",
+ "description": "This enumeration type indicates the listing entities that may be translated with the Translation API. | - **ITEM_TITLE**: This value is input into the translationContext input field if the user wishes to translate a listing title. - **ITEM_DESCRIPTION**: This value is input into the translationContext input field if the user wishes to translate a listing description.",
+ "enum": [
+ "ITEM_TITLE",
+ "ITEM_DESCRIPTION"
+ ]
+ }
+ },
+ "securitySchemes": {
+ "api_auth": {
+ "type": "oauth2",
+ "description": "The security definitions for this API. Please check individual operations for applicable scopes.",
+ "flows": {
+ "clientCredentials": {
+ "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
+ "scopes": {
+ "https://api.ebay.com/oauth/api_scope": "View public data from eBay"
+ }
+ }
+ }
+ },
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer"
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "language",
+ "description": "Operations for translating listing content."
+ }
+ ]
+}
\ No newline at end of file
diff --git a/specs/openapi/translation.yaml b/specs/openapi/translation.yaml
deleted file mode 100644
index 32c27bd..0000000
--- a/specs/openapi/translation.yaml
+++ /dev/null
@@ -1,245 +0,0 @@
----
-openapi: "3.0.0"
-info:
- title: "Translation API"
- description: "This API allows 3rd party developers to translate item titles."
- contact:
- name: "eBay Inc,"
- license:
- name: "eBay API License Agreement"
- url: "https://developer.ebay.com/join/api-license-agreement"
- version: "v1_beta.1.6"
-servers:
-- url: "https://api.ebay.com{basePath}"
- description: "Production"
- variables:
- basePath:
- default: "/commerce/translation/v1_beta"
-paths:
- /translate:
- post:
- tags:
- - "language"
- description: "This method translates listing title and listing description text\
- \ from one language into another. For a full list of supported language translations,\
- \ see the table."
- operationId: "translate"
- parameters:
- - name: "Content-Type"
- in: "header"
- description: "This header indicates the format of the request body provided\
- \ by the client. Its value should be set to application/json.
\
- \ For more information, refer to HTTP request headers."
- required: true
- schema:
- type: "string"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TranslateRequest"
- required: true
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TranslateResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 110001:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "From language is invalid, missing or not supported.\
- \ For more information, see the API call reference documentation."
- 110003:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Context is not supported. For more information, see\
- \ the API call reference documentation."
- 110002:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "To language is invalid, missing or not supported. For\
- \ more information, see the API call reference documentation."
- 110005:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Maximum length of input text reached. For more information,\
- \ see the API call reference documentation."
- 110004:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Maximum number of input text reached. For more information,\
- \ see the API call reference documentation."
- 110007:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Markups are not supported in input texts for title translation\
- \ context."
- 110006:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Unsupported from and to combination."
- 110008:
- domain: "API_TRANSLATION"
- category: "REQUEST"
- description: "Input text missing."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 110000:
- domain: "API_TRANSLATION"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process. Contact eBay developer support for assistance."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/api_scope"
-components:
- schemas:
- Error:
- type: "object"
- properties:
- category:
- type: "string"
- description: "Identifies the type of erro."
- domain:
- type: "string"
- description: "Name for the primary system where the error occurred. This\
- \ is relevant for application errors."
- errorId:
- type: "integer"
- description: "A unique number to identify the error."
- format: "int32"
- inputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- longMessage:
- type: "string"
- description: "A more detailed explanation of the error."
- message:
- type: "string"
- description: "Information on how to correct the problem, in the end user's\
- \ terms and language where applicable."
- outputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- parameters:
- type: "array"
- description: "An array of name/value pairs that describe details the error\
- \ condition. These are useful when multiple errors are returned."
- items:
- $ref: "#/components/schemas/ErrorParameter"
- subdomain:
- type: "string"
- description: "Further helps indicate which subsystem the error is coming\
- \ from. System subcategories include: Initialization, Serialization, Security,\
- \ Monitoring, Rate Limiting, etc."
- description: "This type defines the fields that can be returned in an error."
- ErrorParameter:
- type: "object"
- properties:
- name:
- type: "string"
- description: "The object of the error."
- value:
- type: "string"
- description: "The value of the object."
- TranslateRequest:
- type: "object"
- properties:
- from:
- type: "string"
- description: "The language of the input text to be translated. Not all LanguageEnum\
- \ values are supported in this field. For a full list of supported language\
- \ pairings, see the Supported languages table. For implementation help, refer to eBay\
- \ API documentation"
- text:
- type: "array"
- description: "The input text to translate. The maximum number of characters\
- \ permitted is determined by the translationContext value:
ITEM_TITLE:\
- \ 1000 characters maximum
ITEM_DESCRIPTION: 20,000\
- \ characters maximum. Note: When translating\
- \ ITEM_DESCRIPTION text, HTML/CSS markup and links can be\
- \ included and will not count toward this 20,000 character limit.
Note: Currently, only one input string can\
- \ be translated per API call. Support for multiple continuous text strings\
- \ is expected in the future."
- items:
- type: "string"
- to:
- type: "string"
- description: "The target language for the translation of the input text.\
- \ Not all LanguageEnum values are supported in this field. For\
- \ a full list of supported language pairings, see the Supported languages\
- \ table. For implementation help, refer to eBay\
- \ API documentation"
- translationContext:
- type: "string"
- description: "Input the listing entity to be translated.
Valid\
- \ Values:ITEM_TITLE and ITEM_DESCRIPTION\
- \ For implementation help, refer to eBay\
- \ API documentation"
- description: "This is the base type of the translate method request payload."
- TranslateResponse:
- type: "object"
- properties:
- from:
- type: "string"
- description: "The enumeration value indicates the language of the input\
- \ text. For implementation help, refer to eBay\
- \ API documentation"
- to:
- type: "string"
- description: "The enumeration value indicates the language of the translated\
- \ text. For implementation help, refer to eBay\
- \ API documentation"
- translations:
- type: "array"
- description: "An array showing the input and translated text. Only one input\
- \ string can be translated at this time. Support for multiple continuous\
- \ text strings is expected in the future."
- items:
- $ref: "#/components/schemas/Translation"
- description: "This is the base type of the translate method response\
- \ payload."
- Translation:
- type: "object"
- properties:
- originalText:
- type: "string"
- description: "The original text, in the language specified in the from\
- \ field, that was input into the text field in the request."
- translatedText:
- type: "string"
- description: "The translation of the original text into the language specified\
- \ in the to field."
- description: "This type is used by the translations array, which shows\
- \ the original text supplied by the user in the request payload, and the text\
- \ translated by eBay.
Only one input string can be translated at this\
- \ time. Support for multiple continuous text strings is expected in the future."
- securitySchemes:
- api_auth:
- type: "oauth2"
- description: "The security definitions for this API. Please check individual\
- \ operations for applicable scopes."
- flows:
- clientCredentials:
- tokenUrl: "https://api.ebay.com/identity/v1/oauth2/token"
- scopes:
- https://api.ebay.com/oauth/api_scope: "View public data from eBay"
diff --git a/specs/openapi/vero-api-v2.json b/specs/openapi/vero-api-v2.json
new file mode 100644
index 0000000..9716d9d
--- /dev/null
+++ b/specs/openapi/vero-api-v2.json
@@ -0,0 +1,1533 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "VeRO Public API's",
+ "description": "The VeRO API has methods that allow owners of an intellectual property to report eBay listings (as well as Live Events and Shoppable Videos) that infringe on their intellectual property rights. It contains methods to report a listing, retrieve supported VeRO reason codes, and retrieve the status of reported violations.",
+ "contact": {
+ "name": "eBay Inc."
+ },
+ "license": {
+ "name": "eBay API License Agreement",
+ "url": "https://developer.ebay.com/join/api-license-agreement"
+ },
+ "version": "2.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://api.ebay.com{basePath}",
+ "description": "This URL targets the production eBay API.",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/vero/v2"
+ }
+ }
+ },
+ {
+ "url": "https://api.sandbox.ebay.com{basePath}",
+ "description": "This URL targets the sandbox eBay API.",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/vero/v2"
+ }
+ }
+ }
+ ],
+ "paths": {
+ "/vero_reason_code/{vero_reason_code_id}": {
+ "get": {
+ "tags": [
+ "vero_reason_code"
+ ],
+ "description": "
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method is used to retrieve the details of a specific VeRO reason code, including a description of the code and the marketplace associated with the code.
The vero_reason_code_id of the VeRO reason code for which to retrieve details is required as a path parameter.",
+ "operationId": "getVeroReasonCode",
+ "parameters": [
+ {
+ "name": "vero_reason_code_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the VeRO reason code that is to be retrieved.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method retrieves the details of an array of VeRO reason codes, including descriptions of each code and the marketplace associated with each code.
If the X-EBAY-C-MARKETPLACE-ID header is present, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned.",
+ "operationId": "getVeroReasonCodes",
+ "parameters": [
+ {
+ "name": "X-EBAY-C-MARKETPLACE-ID",
+ "in": "header",
+ "description": "This header identifies the eBay marketplace for which to retrieve VeRO reason codes. If this header is used, only VeRO reason codes for the specified marketplace will be returned in the response.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to report a violation for an item that allegedly infringes on your copyright, trademark, or other intellectual property rights.
Note: Reporting for shoppable videos will be available in a future release. Live events can only be reported using the VeRO reason code 9731. The request body must include reporterId (the submitting entity's VeRO account identifier), rightsOwnerId (the ID of the Rights Owner from the VeRO Portal), a reportViolations array (with the itemId for each reported item), the veroReasonCodeId of the claimed infringement, and the reportType identifying the kind of content being reported.
You can report one or more items at a time using this method. A maximum of 150 violations can be reported using this method.",
+ "operationId": "reportVeroViolations",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportVeroViolationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "headers": {
+ "Location": {
+ "style": "simple",
+ "explode": false,
+ "schema": {
+ "type": "string",
+ "description": "The Location response header returns the created report resource location."
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportVeroViolationResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235012": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The number of reported items exceeds the maximum limit of 150."
+ },
+ "235013": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The itemId is required for this call."
+ },
+ "235014": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReasonCodeId is required for this call."
+ },
+ "235016": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The specified regions are not allowed."
+ },
+ "235019": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the brand field; it should not exceed 50 characters."
+ },
+ "235022": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the messageToSeller field; it should not exceed 1000 characters."
+ },
+ "235023": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please check the report for duplicate violation reports. A duplicate report is two reports on the same itemId and veroReasonCodeId combination in one packet. The same combination of itemId and veroReasonCodeId can be reported in a different packet."
+ },
+ "235024": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "At least one item or event or video is required for this call."
+ },
+ "235030": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The contactEmail is required for this call."
+ },
+ "235031": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The reportType is required for this call."
+ },
+ "235032": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The infringementDescription is required for this call."
+ },
+ "235033": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The eventId is required when reportType is LIVE_EVENT."
+ },
+ "235034": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The timestamp is required when reportType is LIVE_EVENT or SHOPPABLE_VIDEO."
+ },
+ "235035": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the contactEmail field; it must be a valid email address."
+ },
+ "235036": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the reportedImageUrls field; combined URLs should not exceed 1000 characters."
+ },
+ "235037": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the evidenceOfIp field; it should not exceed 1000 characters."
+ },
+ "235038": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the copyrights field; combined copyright information should not exceed 1000 characters."
+ },
+ "235039": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the registrationNumber field; it should not exceed 1000 characters."
+ },
+ "235040": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Reported image URLs are required for the specified reason code."
+ },
+ "235041": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Copyright entries are required for the specified reason code."
+ },
+ "235042": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Countries are required for this call."
+ },
+ "235043": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the reportedImageUrls field; a maximum of 5 image URLs may be supplied."
+ },
+ "235044": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the copyrights field; a maximum of 5 entries may be supplied."
+ },
+ "235045": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "One or more fields contain markup or patterns that are not allowed (for example HTML tags or script-like content). Remove tags and scripts and try again."
+ },
+ "235046": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The videoId is required when reportType is SHOPPABLE_VIDEO."
+ },
+ "235047": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Multiple events or videos cannot be reported in the same request."
+ },
+ "235048": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The reporterId is required for this call."
+ },
+ "235049": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The reporterId exceeds the maximum length or contains characters that are not allowed."
+ },
+ "235050": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The rightsOwnerId is required for this call."
+ },
+ "235051": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The rightsOwnerId exceeds the maximum length or contains characters that are not allowed."
+ },
+ "235052": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The registrationNumber is required for the specified reason code."
+ },
+ "235053": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The evidenceOfIp is required for this call."
+ },
+ "235054": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify the infringementDescription field; it should not exceed 1000 characters."
+ },
+ "235055": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Reporting violations for SHOPPABLE_VIDEO is not currently supported. This report type is reserved for a future release. Please submit item-based reports using reportType LISTING or live event reports using reportType LIVE_EVENT."
+ },
+ "235056": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReasonCodeId provided is not supported for this call."
+ },
+ "235057": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The brand is required for this call."
+ },
+ "235058": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The messageToSeller is required for this call."
+ },
+ "235059": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The timestamp must be in HH:MM:SS format (for example, 18:42:15)."
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235002": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Subscription missing."
+ },
+ "235003": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Insufficient subscription level."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_report/{vero_report_id}": {
+ "get": {
+ "tags": [
+ "vero_report"
+ ],
+ "description": "
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method retrieves status information about a VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement.
The vero_report_id path parameter is used to specify the eBay report for which to retrieve status information.",
+ "operationId": "getVeroReport",
+ "parameters": [
+ {
+ "name": "include_report_details",
+ "in": "query",
+ "description": "Include this query and set it to true if you want to retrieve the reportedDetails container in the response, which contains status information. This container may be helpful if you have reported violations on more than one eBay item in the report.
By default, this boolean is set to false.",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "vero_report_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the VeRO report being retrieved.
This value is returned when creating a VeRO report through the reportVeroViolations method.",
+ "required": true,
+ "style": "simple",
+ "explode": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReport"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235002": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Subscription missing."
+ },
+ "235003": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Insufficient subscription level."
+ },
+ "235010": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Not authorized to perform this operation. VeRO report creator and requester are different."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235011": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReportId was not found."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_report_items": {
+ "get": {
+ "tags": [
+ "vero_report_items"
+ ],
+ "summary": "Retrieves status for VeRO infringement reports by item and date range.",
+ "description": "
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to retrieve status information about one or more VeRO reported items you have submitted.
Without the use of any query parameters, the default behavior of this method is to return the status of all VeRO reported items submitted by the seller during the last two years. Use the item_id query parameter to see a specific reported item, and use the filter query to retrieve the status of reported items submitted within a specific date range. Pagination is also available to limit the number of reported items that are retrieved per page of data.",
+ "operationId": "getVeroReportItems",
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "description": "This query parameter can be used to filter the result set by a date range. Only items reported within the specified time period will be returned.
This parameter will be ignored if item_id has been specified.
Format:YYYY-MM-DD HH:MM:SS
Example: reportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z].",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "item_id",
+ "in": "query",
+ "description": "This query parameter specifies the unique identifier of an eBay listing. Only the specified reported item will be returned.",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "The maximum number of entries that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.
Note: This feature employs a zero-based list, where the first item in the list has an offset of 0. For example, if offset is set to 10 and limit is set to 10, the call retrieves entries 11 through 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 25",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "The number of reports to skip in the result set before returning the first report in the paginated response. Combine offset with the limit query parameter to control the reports returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 reports from the complete list of reports retrieved by the call. If this query parameter is not set, the default value is used and the first page of reports is returned.
Default: 0",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReportStatusResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235005": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "A filter supplied in the request is invalid: {filterName}."
+ },
+ "235006": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The item_id was not found."
+ },
+ "235007": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please check the date range."
+ },
+ "235009": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The time interval specified is greater than what is allowed (90 days is the maximum)."
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235002": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Subscription missing."
+ },
+ "235003": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Only Registered Verified Rights Owners are allowed. Insufficient subscription level."
+ },
+ "235010": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Not authorized to perform this operation. VeRO report creator and requester are different."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Error": {
+ "type": "object",
+ "description": "This type defines the elements of error and warning messages.",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "The category type for this error or warning. One of APPLICATION (runtime or dependency failure), BUSINESS (business-rule violation), or REQUEST (invalid or unauthorized request).",
+ "enum": [
+ "APPLICATION",
+ "BUSINESS",
+ "REQUEST"
+ ]
+ },
+ "domain": {
+ "type": "string",
+ "description": "Name of the domain, or primary system, of the service or application where the error occurred."
+ },
+ "errorId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms."
+ },
+ "inputRefIds": {
+ "type": "array",
+ "description": "Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "longMessage": {
+ "type": "string",
+ "description": "A more detailed explanation of the error than given in the message error field."
+ },
+ "message": {
+ "type": "string",
+ "description": "Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale."
+ },
+ "outputRefIds": {
+ "type": "array",
+ "description": "Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.",
+ "items": {
+ "$ref": "#/components/schemas/ErrorParameter"
+ }
+ },
+ "subdomain": {
+ "type": "string",
+ "description": "If present, indicates the subsystem in which the error occurred."
+ }
+ },
+ "required": [
+ "category",
+ "domain",
+ "errorId",
+ "message"
+ ]
+ },
+ "ErrorParameter": {
+ "type": "object",
+ "description": "A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the parameter that caused the error."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the parameter that caused the error."
+ }
+ }
+ },
+ "MarketplaceIdEnum": {
+ "type": "string",
+ "description": "This type contains enumerated values of the standard codes that represent each of the eBay marketplaces. | - **EBAY_US**: Indicates the eBay marketplace for the United States. - **EBAY_CA**: Indicates the eBay marketplace for Canada.
Note: When targeting the French locale of the Canadian marketplace, add the Accept-Language request header and pass in fr-CA. If this locale is not specified, the language will default to English. - **EBAY_GB**: Indicates the eBay marketplace for Great Britain (United Kingdom). - **EBAY_AU**: Indicates the eBay marketplace for Australia. - **EBAY_AT**: Indicates the eBay marketplace for Austria. - **EBAY_BE**: Indicates the eBay marketplace for Belgium.
Note: When targeting the French locale of the Belgium marketplace, add the Accept-Language request header and pass in fr-BE. If this locale is not specified, the language will default to Dutch. - **EBAY_DE**: Indicates the eBay marketplace for Germany. - **EBAY_IT**: Indicates the eBay marketplace for Italy. - **EBAY_NL**: Indicates the eBay marketplace for The Netherlands. - **EBAY_ES**: Indicates the eBay marketplace for Spain. - **EBAY_CH**: Indicates the eBay marketplace for Switzerland. - **EBAY_TW**: Indicates the eBay marketplace for Taiwan. - **EBAY_CZ**: Reserved for future use. - **EBAY_DK**: Reserved for future use. - **EBAY_FI**: Reserved for future use. - **EBAY_FR**: Indicates the eBay marketplace for France. - **EBAY_GR**: Reserved for future use. - **EBAY_HK**: Indicates the eBay marketplace for Hong Kong. - **EBAY_HU**: Reserved for future use. - **EBAY_IN**: Indicates the eBay marketplace for India.
Note: eBay India is no longer a functioning eBay marketplace. - **EBAY_ID**: Reserved for future use. - **EBAY_IE**: Indicates the eBay marketplace for Indicates the eBay marketplace for Ireland. - **EBAY_IL**: Reserved for future use. - **EBAY_MY**: Indicates the eBay marketplace for Malaysia. - **EBAY_NZ**: Reserved for future use.. - **EBAY_NO**: Reserved for future use. - **EBAY_PH**: Indicates the eBay marketplace for the Philippines. - **EBAY_PL**: Indicates the eBay marketplace for Poland. - **EBAY_PT**: Reserved for future use. - **EBAY_PR**: Reserved for future use. - **EBAY_RU**: Reserved for future use. - **EBAY_SG**: Indicates the eBay marketplace for Singapore. - **EBAY_ZA**: Reserved for future use. - **EBAY_SE**: Reserved for future use. - **EBAY_TH**: Indicates the eBay marketplace for Thailand. - **EBAY_VN**: Indicates the eBay marketplace for Vietnam. - **EBAY_CN**: Reserved for future use. - **EBAY_JP**: Reserved for future use. - **EBAY_PE**: Reserved for future use. - **EBAY_HALF_US**: No longer used. - **EBAY_MOTORS_US**: Indicates the parent category for \"Auto Parts and Vehicles\" on the EBAY_US marketplace",
+ "enum": [
+ "EBAY_US",
+ "EBAY_CA",
+ "EBAY_GB",
+ "EBAY_AU",
+ "EBAY_AT",
+ "EBAY_BE",
+ "EBAY_DE",
+ "EBAY_IT",
+ "EBAY_NL",
+ "EBAY_ES",
+ "EBAY_CH",
+ "EBAY_TW",
+ "EBAY_CZ",
+ "EBAY_DK",
+ "EBAY_FI",
+ "EBAY_FR",
+ "EBAY_GR",
+ "EBAY_HK",
+ "EBAY_HU",
+ "EBAY_IN",
+ "EBAY_ID",
+ "EBAY_IE",
+ "EBAY_IL",
+ "EBAY_MY",
+ "EBAY_NZ",
+ "EBAY_NO",
+ "EBAY_PH",
+ "EBAY_PL",
+ "EBAY_PT",
+ "EBAY_PR",
+ "EBAY_RU",
+ "EBAY_SG",
+ "EBAY_ZA",
+ "EBAY_SE",
+ "EBAY_TH",
+ "EBAY_VN",
+ "EBAY_CN",
+ "EBAY_JP",
+ "EBAY_PE",
+ "EBAY_MOTORS_US",
+ "EBAY_HALF_US"
+ ]
+ },
+ "ReportTypeEnum": {
+ "type": "string",
+ "description": "This enumerated type identifies the kind of content being reported in a VeRO report.
Note:SHOPPABLE_VIDEO is reserved for a future release and is not currently supported. Submitting a report with these values will return error 235055. | - **LISTING**: This enum value indicates that the content being reported is a listing. - **LIVE_EVENT**: This enum value indicates that the content being reported is a live event. - **SHOPPABLE_VIDEO**: Note: This enum value is not currently supported. This enum value indicates that the content being reported is a shoppable video. ",
+ "enum": [
+ "LISTING",
+ "LIVE_EVENT",
+ "SHOPPABLE_VIDEO"
+ ]
+ },
+ "ReportViolationDetails": {
+ "type": "object",
+ "description": "This type defines the details of the item, live event, or shoppable video being reported for violating a product owner's copyright, trademark, or intellectual property rights.",
+ "properties": {
+ "brand": {
+ "type": "string",
+ "description": "The brand name of the item being reported for VeRO violation.
Max length: 50 characters"
+ },
+ "copyrights": {
+ "type": "array",
+ "description": "This array specifies a list of links to the location of the copyrighted work(s) you claim is being infringed upon. Each link must be specific to where the original work is located, as a link to a general webpage will not suffice.
Up to 20 entries may be supplied.
Max length per entry: 1500 characters",
+ "examples": [
+ [
+ "https://example.com/my-original-work"
+ ]
+ ],
+ "items": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "maxItems": 5
+ },
+ "countries": {
+ "type": "array",
+ "description": "If the infringement type stated in the VeroReasonCodeId has anything to do with which country the item is being shipped to, each country that would trigger this infringement type should be specified in this comma-delimited array.
This field is required when the veroReasonCodeId is 2861 (Item(s) is unlawful importation of product bearing trademark).",
+ "items": {
+ "$ref": "#/components/schemas/CountryCodeEnum"
+ }
+ },
+ "evidenceOfIp": {
+ "type": "string",
+ "description": "A description detailing how and where the rights owner's IP is being infringed upon.
Max length: 1000 characters"
+ },
+ "eventId": {
+ "type": "string",
+ "description": "Note: Not currently available. This field is reserved for a future release when LIVE_EVENT reporting is supported. The eBay live event identifier for the reported infringement.
This field is required when reportType is LIVE_EVENT. This field is not applicable when reportType is LISTING or SHOPPABLE_VIDEO."
+ },
+ "videoId": {
+ "type": "string",
+ "description": "Note: Not currently available. This field is reserved for a future release when SHOPPABLE_VIDEO reporting is supported. The shoppable video identifier for the reported infringement.
This field is required when reportType is SHOPPABLE_VIDEO. This field is not applicable when reportType is LISTING or LIVE_EVENT."
+ },
+ "itemId": {
+ "type": "string",
+ "description": "The unique identifier of the listing being reported for the alleged infringement."
+ },
+ "listingDescriptionHasViolation": {
+ "type": "boolean",
+ "description": "This boolean indicates whether the infringement appears in the item description or not."
+ },
+ "messageToSeller": {
+ "type": "string",
+ "description": "This field is used by the VeRO Program member to provide more details to the seller as to why the item is being reported for the alleged infringement.
Max length: 1000 characters"
+ },
+ "infringementDescription": {
+ "type": "string",
+ "description": "The description of why you believe the item or listing infringes your rights.
Max length: 1000 characters"
+ },
+ "regions": {
+ "type": "array",
+ "description": "If the infringement type stated in the veroReasonCodeId has anything to do with which geographical region the item is being shipped to, each region that would trigger this infringement type should be specified in this comma-delimited array.
This field is required when the veroReasonCodeId is 2861.",
+ "items": {
+ "$ref": "#/components/schemas/WorldRegionEnum"
+ }
+ },
+ "registrationNumber": {
+ "type": "string",
+ "description": "This field can be used to provide registration information if the applicable intellectual property right is registered (for example: registration number, IP office name, or link to registration).
This field is required when veroReasonCodeId is 9031, 9036, 9048, or 9049.
Max length: 1000 characters",
+ "examples": [
+ "US10123456"
+ ],
+ "maxLength": 1000
+ },
+ "reportedImageUrls": {
+ "type": "array",
+ "description": "This array is used to specify a list of URLs for images in the listing that you claim infringe your copyrighted work(s). You may right-click an image in the eBay listing and copy the image URL, or describe the infringing content in the listing.
Up to 20 image URLs may be supplied at any time.
Max length per URL: 1500 characters",
+ "examples": [
+ [
+ "https://i.ebayimg.com/images/g/example1.jpg"
+ ]
+ ],
+ "items": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "maxItems": 5
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "The time stamp indicating where the infringing content appears in the live event or shoppable video (for example, ISO-8601).
This field is required when reportType is LIVE_EVENT or SHOPPABLE_VIDEO."
+ },
+ "veroReasonCodeId": {
+ "type": "string",
+ "description": "The unique identifier for the type of claimed infringement.
Use getVeroReasonCodes to retrieve a list of valid reason codes for a given eBay site."
+ }
+ },
+ "required": [
+ "brand",
+ "infringementDescription",
+ "itemId",
+ "messageToSeller",
+ "veroReasonCodeId"
+ ]
+ },
+ "ReportVeroViolationRequest": {
+ "type": "object",
+ "description": "This type defines the request fields used in the reportVeroViolation method.",
+ "properties": {
+ "reportType": {
+ "description": "The type of content being reported.",
+ "$ref": "#/components/schemas/ReportTypeEnum"
+ },
+ "reporterId": {
+ "type": "string",
+ "description": "The unique identifier associated with the reporter's VeRO account.
This value is the username assigned to the rights owner or authorized representative submitting the report. This identifier is used to authenticate the submission and associate it with the correct VeRO account.",
+ "maxLength": 128
+ },
+ "rightsOwnerId": {
+ "type": "string",
+ "description": "The unique identifier assigned to a Rights Owner within the VeRO Portal.
This ID identifies the Rights Owner whose intellectual property rights are the subject of the report. Reporters submitting on behalf of a Rights Owner, including authorized representatives and third-party agents, must provide the correct Rights Owner ID. The Rights Owner ID can be found in the VeRO Portal.",
+ "maxLength": 128
+ },
+ "contactEmail": {
+ "type": "string",
+ "description": "The reporter's public email through which they wish to be contacted."
+ },
+ "reportViolations": {
+ "type": "array",
+ "description": "This array can be used to report one or more eBay items, live events, or shoppable videos that are allegedly violating the product owner's copyright, trademark, or intellectual property rights.",
+ "items": {
+ "$ref": "#/components/schemas/ReportViolationDetails"
+ }
+ }
+ },
+ "required": [
+ "contactEmail",
+ "reportType",
+ "reportViolations",
+ "reporterId",
+ "rightsOwnerId"
+ ]
+ },
+ "ReportedViolation": {
+ "type": "object",
+ "description": "This type defines the reported content, identifiers, and status of a VeRO report. If applicable, a reason for report failure is also returned.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the listing, live event, or video that is being reported for copyright, trademark, or intellectual right infringement."
+ },
+ "reasonForFailure": {
+ "type": "string",
+ "description": "This text explanation is submitted by eBay when the submission of a VeRO Report has failed or was blocked.
This field is conditionally returned if the status value of the report is CLARIFICATION_REQUIRED or SUBMISSION_FAILED."
+ },
+ "status": {
+ "$ref": "#/components/schemas/VeroReportedViolationStatusEnum",
+ "description": "The current status of the VeRO reported item."
+ }
+ }
+ },
+ "ReportVeroViolationResponse": {
+ "type": "object",
+ "description": "This type defines the response fields used in the reportVeroViolation method.",
+ "properties": {
+ "veroReportId": {
+ "type": "string",
+ "description": "The unique identifier of the VeRO report that the item violations have been added to.
Note: Sellers should keep track of the returned veroReportId, as there is no programmatic way to retrieve this value at this time."
+ },
+ "veroReportStatus": {
+ "description": "The processing status of the requested VeRO report.",
+ "$ref": "#/components/schemas/VeroReportStatusEnum"
+ }
+ }
+ },
+ "VeroReport": {
+ "type": "object",
+ "description": "This type defines the VeRO report resource / entity. It is returned when a report is created via reportVeroViolation and when a report is retrieved via getVeroReport. The reportLineItems array is populated over the report's lifecycle and is only returned by getVeroReport when include_report_details is true.",
+ "properties": {
+ "reportLineItems": {
+ "type": "array",
+ "description": "This array returns the status for each eBay item, live event, or video that was included as part of the report.
This array is only returned if the include_report_details query parameter is set to true.",
+ "items": {
+ "$ref": "#/components/schemas/ReportedViolation"
+ }
+ },
+ "veroReportId": {
+ "type": "string",
+ "description": "The unique packet identifier of the VeRO report."
+ },
+ "veroReportStatus": {
+ "description": "The processing status of the requested VeRO report.",
+ "$ref": "#/components/schemas/VeroReportStatusEnum"
+ },
+ "reportType": {
+ "description": "The type of content being reported.",
+ "$ref": "#/components/schemas/ReportTypeEnum"
+ }
+ }
+ },
+ "VeroReasonCode": {
+ "type": "object",
+ "description": "This type defines the details of a VeRO reason code, including its identifier, the associated marketplace, and the brief and detailed descriptions of the intellectual property right infringement.",
+ "properties": {
+ "veroReasonCodeId": {
+ "type": "string",
+ "description": "The unique identifier of a VeRO reason code."
+ },
+ "marketplaceId": {
+ "description": "The eBay site for which reason code details are returned.",
+ "$ref": "#/components/schemas/MarketplaceIdEnum"
+ },
+ "briefText": {
+ "type": "string",
+ "description": "The short description of the infringement associated with the reason code."
+ },
+ "detailedText": {
+ "type": "string",
+ "description": "The long description of the infringement associated with the reason code."
+ }
+ }
+ },
+ "VeroReasonCodeDetailResponse": {
+ "type": "object",
+ "description": "This type defines the response fields returned in the getVeroReasonCodes method.",
+ "properties": {
+ "veroReasonCodes": {
+ "type": "array",
+ "description": "This array provides a list of VeRO reason codes, including the ID, marketplace, and brief and detailed descriptions of each code, based on the input criteria.
If a X-EBAY-C-MARKETPLACE-ID header is used, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned.",
+ "items": {
+ "$ref": "#/components/schemas/VeroReasonCode"
+ }
+ }
+ }
+ },
+ "VeroReportStatusResponse": {
+ "type": "object",
+ "description": "This type defines the response fields returned by the getVeroReportItems method.",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the VeRO reported item results."
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The value of the limit parameter submitted in the request."
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set."
+ },
+ "offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The value of the offset parameter submitted in the request."
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "reportedItemDetails": {
+ "type": "array",
+ "description": "This array returns the item ID and statuses of the reported items being returned.",
+ "items": {
+ "$ref": "#/components/schemas/ReportedItem"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "format": "int32",
+ "description": "This is the total number of records that match the input criteria."
+ }
+ }
+ },
+ "ReportedItem": {
+ "type": "object",
+ "description": "This type defines the item ID and status of a VeRO report. If applicable, a reason for report failure is also returned.",
+ "properties": {
+ "itemId": {
+ "type": "string",
+ "description": "The unique identifier of the listing that is being reported for copyright, trademark, or intellectual right infringement."
+ },
+ "reasonForFailure": {
+ "type": "string",
+ "description": "This text explanation is submitted by eBay when the submission of a VeRO Report has failed or was blocked.
This field is conditionally returned if the status value of the report is CLARIFICATION_REQUIRED or SUBMISSION_FAILED."
+ },
+ "status": {
+ "$ref": "#/components/schemas/VeroReportedViolationStatusEnum",
+ "description": "The current status of the VeRO reported item."
+ }
+ }
+ },
+ "VeroReportStatusEnum": {
+ "type": "string",
+ "description": "This enumerated type defines the values that represent the status of a VeRO Report packet. | - **RECEIVED**: This enum value indicates that the VeRO Report packet has been received by eBay. - **IN_PROCESS**: This enum value indicates that eBay is in the process of reviewing the VeRO Report packet. - **PROCESSED**: This enum value indicates that the VeRO Report packed has been processed by eBay.",
+ "enum": [
+ "RECEIVED",
+ "IN_PROCESS",
+ "PROCESSED"
+ ]
+ },
+ "VeroReportedViolationStatusEnum": {
+ "type": "string",
+ "description": "This enumerated type defines the current status of the VeRO reported violation. | - **NONE**: This enum value indicates that there is no VeRO report request for the item. - **RECEIVED**: This enum value indicates that the VeRO report request for the item has been received by eBay. - **SUBMITTED**: This enum value indicates that the VeRO report request for the item has been submitted to eBay. - **SUBMISSION_FAILED**: This enum value indicates that the VeRO report request for the item has failed. - **REMOVED**: This enum value indicates that the user has reported an inactive item. - **CLARIFICATION_REQUIRED**: This enum value indicates that the VeRO report request for the item has been received by eBay, but additional clarification is needed before eBay can end the item.",
+ "enum": [
+ "NONE",
+ "RECEIVED",
+ "SUBMITTED",
+ "SUBMISSION_FAILED",
+ "REMOVED",
+ "CLARIFICATION_REQUIRED"
+ ]
+ },
+ "WorldRegionEnum": {
+ "type": "string",
+ "description": "This enumerated type contains of list of world regions. | - **AFRICA**: This enumeration value indicates the world region is Africa. - **AMERICAS**: This enumeration value indicates the world region is the Americas. - **ASIA**: This enumeration value indicates the world region is Asia. - **CARIBBEAN**: This enumeration value indicates the world region is the Caribbean. - **EUROPE**: This enumeration value indicates the world region is Europe. - **EUROPE_UNION**: This enumeration value indicates the world region is the European Union. - **LATIN_AMERICA**: This enumeration value indicates the world region is Latin America. - **MIDDLE_EAST**: This enumeration value indicates the world region is the Middle East. - **NORTH_AMERICA**: This enumeration value indicates the world region is North America. - **OCEANIA**: This enumeration value indicates the world region is Oceania. - **SOUTH_AMERICA**: This enumeration value indicates the world region is South America. - **WORLDWIDE**: This enumeration value indicates the world region is world wide.",
+ "enum": [
+ "AFRICA",
+ "AMERICAS",
+ "ASIA",
+ "CARIBBEAN",
+ "EUROPE",
+ "EUROPE_UNION",
+ "LATIN_AMERICA",
+ "MIDDLE_EAST",
+ "NORTH_AMERICA",
+ "OCEANIA",
+ "SOUTH_AMERICA",
+ "WORLDWIDE"
+ ]
+ },
+ "CountryCodeEnum": {
+ "type": "string",
+ "description": "This enumerated type lists the two-letter ISO 3166-1 country code representing supported countries. | - **AD**: Andorra - **AE**: United Arab Emirates - **AF**: Afghanistan - **AG**: Antigua and Barbuda - **AI**: Anguilla - **AL**: Albania - **AM**: Armenia - **AN**: Netherlands Antilles - **AO**: Angola - **AQ**: Antarctica - **AR**: Argentina - **AS**: American Samoa - **AT**: Austria - **AU**: Australia - **AW**: Aruba - **AX**: Aland Islands - **AZ**: Azerbaijan - **BA**: Bosnia and Herzegovina - **BB**: Barbados - **BD**: Bangladesh - **BE**: Belgium - **BF**: Burkina Faso - **BG**: Bulgaria - **BH**: Bahrain - **BI**: Burundi - **BJ**: Benin - **BL**: Saint Barthelemy - **BM**: Bermuda - **BN**: Brunei Darussalam - **BO**: Bolivia - **BQ**: Bonaire, Sint Eustatius, and Saba - **BR**: Brazil - **BS**: Bahamas - **BT**: Bhutan - **BV**: Bouvet Island - **BW**: Botswana - **BY**: Belarus - **BZ**: Belize - **CA**: Canada - **CC**: Cocos (Keeling) Islands - **CD**: The Democratic Republic of the Congo - **CF**: Central African Republic - **CG**: Congo - **CH**: Switzerland - **CI**: Cote d'Ivoire - **CK**: Cook Islands - **CL**: Chile - **CM**: Cameroon - **CN**: China - **CO**: Colombia - **CR**: Costa Rica - **CU**: Cuba - **CV**: Cape Verde - **CW**: Curacao - **CX**: Christmas Island - **CY**: Cyprus - **CZ**: Czech Republic - **DE**: Germany - **DJ**: Djibouti - **DK**: Denmark - **DM**: Dominica - **DO**: Dominican Republic - **DZ**: Algeria - **EC**: Ecuador - **EE**: Estonia - **EG**: Egypt - **EH**: Western Sahara - **ER**: Eritrea - **ES**: Spain - **ET**: Ethiopia - **FI**: Finland - **FJ**: Fiji - **FK**: Falkland Islands (Malvinas) - **FM**: Federated States of Micronesia - **FO**: Faroe Islands - **FR**: France - **GA**: Gabon - **GB**: United Kingdom - **GD**: Grenada - **GE**: Georgia - **GF**: French Guiana - **GG**: Guernsey - **GH**: Ghana - **GI**: Gibraltar - **GL**: Greenland - **GM**: Gambia - **GN**: Guinea - **GP**: Guadeloupe - **GQ**: Equatorial Guinea - **GR**: Greece - **GS**: South Georgia and the South Sandwich Islands - **GT**: Guatemala - **GU**: Guam - **GW**: Guinea-Bissau - **GY**: Guyana - **HK**: Hong Kong - **HM**: Heard Island and McDonald Islands - **HN**: Honduras - **HR**: Croatia - **HT**: Haiti - **HU**: Hungary - **ID**: Indonesia - **IE**: Ireland - **IL**: Israel - **IM**: Isle of Man - **IN**: India - **IO**: British Indian Ocean Territory - **IQ**: Iraq - **IR**: Islamic Republic of Iran - **IS**: Iceland - **IT**: Italy - **JE**: Jersey - **JM**: Jamaica - **JO**: Jordan - **JP**: Japan - **KE**: Kenya - **KG**: Kyrgyzstan - **KH**: Cambodia - **KI**: Kiribati - **KM**: Comoros - **KN**: Saint Kitts and Nevis - **KP**: Democratic People's Republic of Korea - **KR**: Republic of Korea - **KW**: Kuwait - **KY**: Cayman Islands - **KZ**: Kazakhstan - **LA**: Lao People's Democratic Republic - **LB**: Lebanon - **LC**: Saint Lucia - **LI**: Liechtenstein - **LK**: Sri Lanka - **LR**: Liberia - **LS**: Lesotho - **LT**: Lithuania - **LU**: Luxembourg - **LV**: Latvia - **LY**: Libyan Arab Jamahiriya - **MA**: Morocco - **MC**: Monaco - **MD**: Republic of Moldova - **ME**: Montenegro - **MF**: Saint Martin (French part) - **MG**: Madagascar - **MH**: Marshall Islands - **MK**: The Former Yugoslav Republic of Macedonia - **ML**: Mali - **MM**: Myanmar - **MN**: Mongolia - **MO**: Macao - **MP**: Northern Mariana Islands - **MQ**: Martinique - **MR**: Mauritania - **MS**: Montserrat - **MT**: Malta - **MU**: Mauritius - **MV**: Maldives - **MW**: Malawi - **MX**: Mexico - **MY**: Malaysia - **MZ**: Mozambique - **NA**: Namibia - **NC**: New Caledonia - **NE**: Niger - **NF**: Norfolk Island - **NG**: Nigeria - **NI**: Nicaragua - **NL**: Netherlands - **NO**: Norway - **NP**: Nepal - **NR**: Nauru - **NU**: Niue - **NZ**: New Zealand - **OM**: Oman - **PA**: Panama - **PE**: Peru - **PF**: French Polynesia. Includes Tahiti - **PG**: Papua New Guinea - **PH**: Philippines - **PK**: Pakistan - **PL**: Poland - **PM**: Saint Pierre and Miquelon - **PN**: Pitcairn - **PR**: Puerto Rico - **PS**: Palestinian territory Occupied - **PT**: Portugal - **PW**: Palau - **PY**: Paraguay - **QA**: Qatar - **RE**: Reunion - **RO**: Romania - **RS**: Serbia - **RU**: Russian Federation - **RW**: Rwanda - **SA**: Saudi Arabia - **SB**: Solomon Islands - **SC**: Seychelles - **SD**: Sudan - **SE**: Sweden - **SG**: Singapore - **SH**: Saint Helena - **SI**: Slovenia - **SJ**: Svalbard and Jan Mayen - **SK**: Slovakia - **SL**: Sierra Leone - **SM**: San Marino - **SN**: Senegal - **SO**: Somalia - **SR**: Suriname - **ST**: Sao Tome and Principe - **SV**: El Salvador - **SX**: Sint Maarten (Dutch part) - **SY**: Syrian Arab Republic - **SZ**: Swaziland - **TC**: Turks and Caicos Islands - **TD**: Chad - **TF**: French Southern Territories - **TG**: Togo - **TH**: Thailand - **TJ**: Tajikistan - **TK**: Tokelau - **TL**: Timor-Leste - **TM**: Turkmenistan - **TN**: Tunisia - **TO**: Tonga - **TR**: Turkey - **TT**: Trinidad and Tobago - **TV**: Tuvalu - **TW**: Taiwan - **TZ**: Tanzania - **UA**: Ukraine - **UG**: Uganda - **UM**: United States Minor Outlying Islands - **US**: United States - **UY**: Uruguay - **UZ**: Uzbekistan - **VA**: Holy See (Vatican City state) - **VC**: Saint Vincent and the Grenadines - **VE**: Venezuela - **VG**: British Virgin Islands - **VI**: the U.S. Virgin Islands - **VN**: Vietnam - **VU**: Vanuatu - **WF**: Wallis and Futuna - **WS**: Samoa - **YE**: Yemen - **YT**: Mayotte - **YU**: Yugoslavia - **ZA**: South Africa - **ZM**: Zambia - **ZW**: Zimbabwe",
+ "enum": [
+ "AD",
+ "AE",
+ "AF",
+ "AG",
+ "AI",
+ "AL",
+ "AM",
+ "AN",
+ "AO",
+ "AQ",
+ "AR",
+ "AS",
+ "AT",
+ "AU",
+ "AW",
+ "AX",
+ "AZ",
+ "BA",
+ "BB",
+ "BD",
+ "BE",
+ "BF",
+ "BG",
+ "BH",
+ "BI",
+ "BJ",
+ "BL",
+ "BM",
+ "BN",
+ "BO",
+ "BQ",
+ "BR",
+ "BS",
+ "BT",
+ "BV",
+ "BW",
+ "BY",
+ "BZ",
+ "CA",
+ "CC",
+ "CD",
+ "CF",
+ "CG",
+ "CH",
+ "CI",
+ "CK",
+ "CL",
+ "CM",
+ "CN",
+ "CO",
+ "CR",
+ "CU",
+ "CV",
+ "CW",
+ "CX",
+ "CY",
+ "CZ",
+ "DE",
+ "DJ",
+ "DK",
+ "DM",
+ "DO",
+ "DZ",
+ "EC",
+ "EE",
+ "EG",
+ "EH",
+ "ER",
+ "ES",
+ "ET",
+ "FI",
+ "FJ",
+ "FK",
+ "FM",
+ "FO",
+ "FR",
+ "GA",
+ "GB",
+ "GD",
+ "GE",
+ "GF",
+ "GG",
+ "GH",
+ "GI",
+ "GL",
+ "GM",
+ "GN",
+ "GP",
+ "GQ",
+ "GR",
+ "GS",
+ "GT",
+ "GU",
+ "GW",
+ "GY",
+ "HK",
+ "HM",
+ "HN",
+ "HR",
+ "HT",
+ "HU",
+ "ID",
+ "IE",
+ "IL",
+ "IM",
+ "IN",
+ "IO",
+ "IQ",
+ "IR",
+ "IS",
+ "IT",
+ "JE",
+ "JM",
+ "JO",
+ "JP",
+ "KE",
+ "KG",
+ "KH",
+ "KI",
+ "KM",
+ "KN",
+ "KP",
+ "KR",
+ "KW",
+ "KY",
+ "KZ",
+ "LA",
+ "LB",
+ "LC",
+ "LI",
+ "LK",
+ "LR",
+ "LS",
+ "LT",
+ "LU",
+ "LV",
+ "LY",
+ "MA",
+ "MC",
+ "MD",
+ "ME",
+ "MF",
+ "MG",
+ "MH",
+ "MK",
+ "ML",
+ "MM",
+ "MN",
+ "MO",
+ "MP",
+ "MQ",
+ "MR",
+ "MS",
+ "MT",
+ "MU",
+ "MV",
+ "MW",
+ "MX",
+ "MY",
+ "MZ",
+ "NA",
+ "NC",
+ "NE",
+ "NF",
+ "NG",
+ "NI",
+ "NL",
+ "NO",
+ "NP",
+ "NR",
+ "NU",
+ "NZ",
+ "OM",
+ "PA",
+ "PE",
+ "PF",
+ "PG",
+ "PH",
+ "PK",
+ "PL",
+ "PM",
+ "PN",
+ "PR",
+ "PS",
+ "PT",
+ "PW",
+ "PY",
+ "QA",
+ "RE",
+ "RO",
+ "RS",
+ "RU",
+ "RW",
+ "SA",
+ "SB",
+ "SC",
+ "SD",
+ "SE",
+ "SG",
+ "SH",
+ "SI",
+ "SJ",
+ "SK",
+ "SL",
+ "SM",
+ "SN",
+ "SO",
+ "SR",
+ "SS",
+ "ST",
+ "SV",
+ "SX",
+ "SY",
+ "SZ",
+ "TC",
+ "TD",
+ "TF",
+ "TG",
+ "TH",
+ "TJ",
+ "TK",
+ "TL",
+ "TM",
+ "TN",
+ "TO",
+ "TR",
+ "TT",
+ "TV",
+ "TW",
+ "TZ",
+ "UA",
+ "UG",
+ "UM",
+ "US",
+ "UY",
+ "UZ",
+ "VA",
+ "VC",
+ "VE",
+ "VG",
+ "VI",
+ "VN",
+ "VU",
+ "WF",
+ "WS",
+ "YE",
+ "YT",
+ "YU",
+ "ZA",
+ "ZM",
+ "ZW"
+ ]
+ }
+ },
+ "securitySchemes": {
+ "api_auth": {
+ "type": "oauth2",
+ "description": "The security definitions for this API. Please check individual operations for applicable scopes.",
+ "flows": {
+ "clientCredentials": {
+ "tokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
+ "scopes": {
+ "https://api.ebay.com/oauth/api_scope/commerce.vero": "This scope would allow public access to an operation."
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/specs/openapi/vero.json b/specs/openapi/vero.json
new file mode 100644
index 0000000..b5ef960
--- /dev/null
+++ b/specs/openapi/vero.json
@@ -0,0 +1,1199 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "Vero Public API's",
+ "description": "The VeRO API has methods that allow owners of an intellectual property to report eBay listings that infringe on their intellectual property rights. It contains methods to report a listing, retrieve supported VeRO reason codes, and retrieve the status of reported items.",
+ "contact": {
+ "name": "eBay Inc,"
+ },
+ "license": {
+ "name": "eBay API License Agreement",
+ "url": "https://developer.ebay.com/join/api-license-agreement"
+ },
+ "version": "1.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://api.ebay.com{basePath}",
+ "description": "Production",
+ "variables": {
+ "basePath": {
+ "default": "/commerce/vero/v1"
+ }
+ }
+ }
+ ],
+ "security": [
+ {}
+ ],
+ "paths": {
+ "/vero_reason_code/{vero_reason_code_id}": {
+ "get": {
+ "tags": [
+ "vero_reason_code"
+ ],
+ "description": "Note: All methods of the VeRO API have been deprecated, and will be decommissioned on September 30th, 2026.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method is used to retrieve the details of a specific VeRO reason code, including a description of the code and the marketplace associated with the code.
The vero_reason_code_id of the VeRO reason code for which to retrieve details is required as a path parameter.",
+ "operationId": "getVeroReasonCode",
+ "parameters": [
+ {
+ "name": "vero_reason_code_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the VeRO reason code that is to be retrieved.
Use the getVeroReasonCodes method to retrieve supported VeRO reason code IDs.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReasonCodeResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235001": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReasonCodeId was not found."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_reason_code": {
+ "get": {
+ "tags": [
+ "vero_reason_code"
+ ],
+ "description": "Note: All methods of the VeRO API have been deprecated, and will be decommissioned on September 30th, 2026.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method is used to retrieve the details of an array of VeRO reason codes. This information includes the descriptions of each code, as well as the marketplace associated with each code.
If the X-EBAY-C-MARKETPLACE-ID header is present, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned.",
+ "operationId": "getVeroReasonCodes",
+ "parameters": [
+ {
+ "name": "X-EBAY-C-MARKETPLACE-ID",
+ "in": "header",
+ "description": "This header identifies the eBay marketplace for which to retrieve VeRO reason codes. If this header is used, only VeRO reason codes for the specified marketplace will be returned in the response.
See MarketplaceIdEnum for a list of supported values.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReasonCodeDetailResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_report": {
+ "post": {
+ "tags": [
+ "vero_report"
+ ],
+ "description": "Note: All methods of the VeRO API have been deprecated, and will be decommissioned on September 30th, 2026.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to create a VeRO report for a listing. VeRO reports can be used to report items that your copyright, trademark, or other intellectual property rights.
The itemId of the item being reported must be provided in the request, as well as the veroReasonCodeId of the claimed infringement.
You can report one or more items at a time using this method. A maximum of 150 items can be reported using this method.",
+ "operationId": "createVeroReport",
+ "parameters": [
+ {
+ "name": "Content-Type",
+ "in": "header",
+ "description": "This header indicates the format of the request body provided by the client. Its value should be set to application/json.
For more information, refer to HTTP request headers.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReportItemsRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "headers": {
+ "Location": {
+ "schema": {
+ "type": "string",
+ "description": "The Location response header returns the created report resource location."
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReportItemsResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235012": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Number of reported items exceeds maximum limit of 150 items."
+ },
+ "235013": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The itemId is required for this call."
+ },
+ "235014": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReasonCodeId is required for this call."
+ },
+ "235015": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "At least one country is required for the specified reason code."
+ },
+ "235016": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The Regions specified are not allowed"
+ },
+ "235017": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The patent is required for this call."
+ },
+ "235019": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify brand, it should not exceed 50 characters."
+ },
+ "235020": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The detailedMessage is required for the specified reason code."
+ },
+ "235021": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify detailedMessage, it should not exceed 1000 characters."
+ },
+ "235022": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify messageToSeller, it should not exceed 1000 characters."
+ },
+ "235023": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please check report, there are duplicate item reports. A duplicate report is two report on the same itemId and veroReasonCodeId combination in one packet. The same combination itemId and veroReasonCodeId can be reported in a different packet."
+ },
+ "235024": {
+ "domain": "API_VERO_REPORT",
+ "category": "REQUEST",
+ "description": "At least one item is required for this call."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ },
+ "235018": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please verify patent, it should not exceed 15 characters."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_report/{vero_report_id}": {
+ "get": {
+ "tags": [
+ "vero_report"
+ ],
+ "description": "Note: All methods of the VeRO API have been deprecated, and will be decommissioned on September 30th, 2026.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to retrieve status information about a VeRO report you have submitted to eBay for copyright, trademark, or other intellectual property rights infringement.
The vero_report_id path parameter is used to specify the eBay report for which to retrieve status information.",
+ "operationId": "getVeroReport",
+ "parameters": [
+ {
+ "name": "includeItemDetails",
+ "in": "query",
+ "description": "Include this query and set it to true if you want to retrieve the reportedItemDetails container in the response, which contains item-level status information. This container may be helpful if you have reported violations on more than one eBay item in the report.
By default, this boolean is set to false.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "vero_report_id",
+ "in": "path",
+ "description": "This path parameter specifies the unique identifier of the VeRO report being retrieved.
This value is returned when creating a VeRO report through the createVeroReport method.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportStatusResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235010": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Not authorized to perform this operation. Vero report creator and requester are different."
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235011": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The veroReportId was not found."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/api_scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ },
+ "/vero_report_items": {
+ "get": {
+ "tags": [
+ "vero_report_items"
+ ],
+ "summary": "Retrieves status for VERO infringement reports by Brand.",
+ "description": "Note: All methods of the VeRO API have been deprecated, and will be decommissioned on September 30th, 2026.
Important! You must be a member of the Verified Rights Owner (VeRO) Program to use this call.
This method can be used to retrieve status information about one or more VeRO reported items you have submitted.
Without the use of any query parameters, the default behavior of this method is to return the status of all VeRO reported items submitted by the seller during the last two years. Use the itemId query parameter to see a specific reported item, and use the filter query to retrieve the status of reported items submitted within a specific date range. Pagination is also available to limit the number of reported items that are retrieved per page of data.",
+ "operationId": "getVeroReportItems",
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "description": "This query parameter can be used to filter the result set by a date range. Only items reported within the specified time period will be returned.
This parameter will be ignored if itemId has been specified.
Format:YYYY-MM-DD HH:MM:SS
Example: reportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z].",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "itemId",
+ "in": "query",
+ "description": "This query parameter specifies the unique identifier of an eBay listing. Only the specified reported item will be returned.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "description": "The maximum number of entries that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.
Note: This feature employs a zero-based list, where the first item in the list has an offset of 0. For example, if offset is set to 10 and limit is set to 10, the call retrieves entries 11 through 20 from the result set.
If this parameter is omitted, the default value is used.
Default: 25",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "description": "The number of reports to skip in the result set before returning the first report in the paginated response. Combine offset with the limit query parameter to control the reports returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 reports from the complete list of reports retrieved by the call. If this query parameter is not set, the default value is used and the first page of reports is returned.
Default: 0",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VeroReportStatusResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235005": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "A filter supplied in the request is invalid: {filterName}"
+ },
+ "235006": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The itemId was not found."
+ },
+ "235007": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Please check the date range."
+ },
+ "235009": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "The time interval specified is greater than what is allowed (90 days is the maximum)."
+ },
+ "235010": {
+ "domain": "API_VERO",
+ "category": "REQUEST",
+ "description": "Not authorized to perform this operation. Vero report creator and requester are different."
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error"
+ }
+ }
+ },
+ "x-response-codes": {
+ "errors": {
+ "235000": {
+ "domain": "API_VERO",
+ "category": "APPLICATION",
+ "description": "There was a problem with an eBay internal system or process."
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "api_auth": [
+ "https://api.ebay.com/oauth/scope/commerce.vero"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "CountryCodeEnum": {
+ "type": "object",
+ "description": "This enumerated type lists the two-letter ISO 3166-1 country code representing supported countries. | - **AD**: Andorra - **AE**: United Arab Emirates - **AF**: Afghanistan - **AG**: Antigua and Barbuda - **AI**: Anguilla - **AL**: Albania - **AM**: Armenia - **AN**: Netherlands Antilles - **AO**: Angola - **AQ**: Antarctica - **AR**: Argentina - **AS**: American Samoa - **AT**: Austria - **AU**: Australia - **AW**: Aruba - **AX**: Aland Islands - **AZ**: Azerbaijan - **BA**: Bosnia and Herzegovina - **BB**: Barbados - **BD**: Bangladesh - **BE**: Belgium - **BF**: Burkina Faso - **BG**: Bulgaria - **BH**: Bahrain - **BI**: Burundi - **BJ**: Benin - **BL**: Saint Barthelemy - **BM**: Bermuda - **BN**: Brunei Darussalam - **BO**: Bolivia - **BQ**: Bonaire, Sint Eustatius, and Saba - **BR**: Brazil - **BS**: Bahamas - **BT**: Bhutan - **BV**: Bouvet Island - **BW**: Botswana - **BY**: Belarus - **BZ**: Belize - **CA**: Canada - **CC**: Cocos (Keeling) Islands - **CD**: The Democratic Republic of the Congo - **CF**: Central African Republic - **CG**: Congo - **CH**: Switzerland - **CI**: Cote d'Ivoire - **CK**: Cook Islands - **CL**: Chile - **CM**: Cameroon - **CN**: China - **CO**: Colombia - **CR**: Costa Rica - **CU**: Cuba - **CV**: Cape Verde - **CW**: Curacao - **CX**: Christmas Island - **CY**: Cyprus - **CZ**: Czech Republic - **DE**: Germany - **DJ**: Djibouti - **DK**: Denmark - **DM**: Dominica - **DO**: Dominican Republic - **DZ**: Algeria - **EC**: Ecuador - **EE**: Estonia - **EG**: Egypt - **EH**: Western Sahara - **ER**: Eritrea - **ES**: Spain - **ET**: Ethiopia - **FI**: Finland - **FJ**: Fiji - **FK**: Falkland Islands (Malvinas) - **FM**: Federated States of Micronesia - **FO**: Faroe Islands - **FR**: France - **GA**: Gabon - **GB**: United Kingdom - **GD**: Grenada - **GE**: Georgia - **GF**: French Guiana - **GG**: Guernsey - **GH**: Ghana - **GI**: Gibraltar - **GL**: Greenland - **GM**: Gambia - **GN**: Guinea - **GP**: Guadeloupe - **GQ**: Equatorial Guinea - **GR**: Greece - **GS**: South Georgia and the South Sandwich Islands - **GT**: Guatemala - **GU**: Guam - **GW**: Guinea-Bissau - **GY**: Guyana - **HK**: Hong Kong - **HM**: Heard Island and McDonald Islands - **HN**: Honduras - **HR**: Croatia - **HT**: Haiti - **HU**: Hungary - **ID**: Indonesia - **IE**: Ireland - **IL**: Israel - **IM**: Isle of Man - **IN**: India - **IO**: British Indian Ocean Territory - **IQ**: Iraq - **IR**: Islamic Republic of Iran - **IS**: Iceland - **IT**: Italy - **JE**: Jersey - **JM**: Jamaica - **JO**: Jordan - **JP**: Japan - **KE**: Kenya - **KG**: Kyrgyzstan - **KH**: Cambodia - **KI**: Kiribati - **KM**: Comoros - **KN**: Saint Kitts and Nevis - **KP**: Democratic People's Republic of Korea - **KR**: Republic of Korea - **KW**: Kuwait - **KY**: Cayman Islands - **KZ**: Kazakhstan - **LA**: Lao People's Democratic Republic - **LB**: Lebanon - **LC**: Saint Lucia - **LI**: Liechtenstein - **LK**: Sri Lanka - **LR**: Liberia - **LS**: Lesotho - **LT**: Lithuania - **LU**: Luxembourg - **LV**: Latvia - **LY**: Libyan Arab Jamahiriya - **MA**: Morocco - **MC**: Monaco - **MD**: Republic of Moldova - **ME**: Montenegro - **MF**: Saint Martin (French part) - **MG**: Madagascar - **MH**: Marshall Islands - **MK**: The Former Yugoslav Republic of Macedonia - **ML**: Mali - **MM**: Myanmar - **MN**: Mongolia - **MO**: Macao - **MP**: Northern Mariana Islands - **MQ**: Martinique - **MR**: Mauritania - **MS**: Montserrat - **MT**: Malta - **MU**: Mauritius - **MV**: Maldives - **MW**: Malawi - **MX**: Mexico - **MY**: Malaysia - **MZ**: Mozambique - **NA**: Namibia - **NC**: New Caledonia - **NE**: Niger - **NF**: Norfolk Island - **NG**: Nigeria - **NI**: Nicaragua - **NL**: Netherlands - **NO**: Norway - **NP**: Nepal - **NR**: Nauru - **NU**: Niue - **NZ**: New Zealand - **OM**: Oman - **PA**: Panama - **PE**: Peru - **PF**: French Polynesia. Includes Tahiti - **PG**: Papua New Guinea - **PH**: Philippines - **PK**: Pakistan - **PL**: Poland - **PM**: Saint Pierre and Miquelon - **PN**: Pitcairn - **PR**: Puerto Rico - **PS**: Palestinian territory Occupied - **PT**: Portugal - **PW**: Palau - **PY**: Paraguay - **QA**: Qatar - **RE**: Reunion - **RO**: Romania - **RS**: Serbia - **RU**: Russian Federation - **RW**: Rwanda - **SA**: Saudi Arabia - **SB**: Solomon Islands - **SC**: Seychelles - **SD**: Sudan - **SE**: Sweden - **SG**: Singapore - **SH**: Saint Helena - **SI**: Slovenia - **SJ**: Svalbard and Jan Mayen - **SK**: Slovakia - **SL**: Sierra Leone - **SM**: San Marino - **SN**: Senegal - **SO**: Somalia - **SR**: Suriname - **ST**: Sao Tome and Principe - **SV**: El Salvador - **SX**: Sint Maarten (Dutch part) - **SY**: Syrian Arab Republic - **SZ**: Swaziland - **TC**: Turks and Caicos Islands - **TD**: Chad - **TF**: French Southern Territories - **TG**: Togo - **TH**: Thailand - **TJ**: Tajikistan - **TK**: Tokelau - **TL**: Timor-Leste - **TM**: Turkmenistan - **TN**: Tunisia - **TO**: Tonga - **TR**: Turkey - **TT**: Trinidad and Tobago - **TV**: Tuvalu - **TW**: Taiwan - **TZ**: Tanzania - **UA**: Ukraine - **UG**: Uganda - **UM**: United States Minor Outlying Islands - **US**: United States - **UY**: Uruguay - **UZ**: Uzbekistan - **VA**: Holy See (Vatican City state) - **VC**: Saint Vincent and the Grenadines - **VE**: Venezuela - **VG**: British Virgin Islands - **VI**: the U.S. Virgin Islands - **VN**: Vietnam - **VU**: Vanuatu - **WF**: Wallis and Futuna - **WS**: Samoa - **YE**: Yemen - **YT**: Mayotte - **ZA**: South Africa - **ZM**: Zambia - **ZW**: Zimbabwe",
+ "enum": [
+ "AD",
+ "AE",
+ "AF",
+ "AG",
+ "AI",
+ "AL",
+ "AM",
+ "AN",
+ "AO",
+ "AQ",
+ "AR",
+ "AS",
+ "AT",
+ "AU",
+ "AW",
+ "AX",
+ "AZ",
+ "BA",
+ "BB",
+ "BD",
+ "BE",
+ "BF",
+ "BG",
+ "BH",
+ "BI",
+ "BJ",
+ "BL",
+ "BM",
+ "BN",
+ "BO",
+ "BQ",
+ "BR",
+ "BS",
+ "BT",
+ "BV",
+ "BW",
+ "BY",
+ "BZ",
+ "CA",
+ "CC",
+ "CD",
+ "CF",
+ "CG",
+ "CH",
+ "CI",
+ "CK",
+ "CL",
+ "CM",
+ "CN",
+ "CO",
+ "CR",
+ "CU",
+ "CV",
+ "CW",
+ "CX",
+ "CY",
+ "CZ",
+ "DE",
+ "DJ",
+ "DK",
+ "DM",
+ "DO",
+ "DZ",
+ "EC",
+ "EE",
+ "EG",
+ "EH",
+ "ER",
+ "ES",
+ "ET",
+ "FI",
+ "FJ",
+ "FK",
+ "FM",
+ "FO",
+ "FR",
+ "GA",
+ "GB",
+ "GD",
+ "GE",
+ "GF",
+ "GG",
+ "GH",
+ "GI",
+ "GL",
+ "GM",
+ "GN",
+ "GP",
+ "GQ",
+ "GR",
+ "GS",
+ "GT",
+ "GU",
+ "GW",
+ "GY",
+ "HK",
+ "HM",
+ "HN",
+ "HR",
+ "HT",
+ "HU",
+ "ID",
+ "IE",
+ "IL",
+ "IM",
+ "IN",
+ "IO",
+ "IQ",
+ "IR",
+ "IS",
+ "IT",
+ "JE",
+ "JM",
+ "JO",
+ "JP",
+ "KE",
+ "KG",
+ "KH",
+ "KI",
+ "KM",
+ "KN",
+ "KP",
+ "KR",
+ "KW",
+ "KY",
+ "KZ",
+ "LA",
+ "LB",
+ "LC",
+ "LI",
+ "LK",
+ "LR",
+ "LS",
+ "LT",
+ "LU",
+ "LV",
+ "LY",
+ "MA",
+ "MC",
+ "MD",
+ "ME",
+ "MF",
+ "MG",
+ "MH",
+ "MK",
+ "ML",
+ "MM",
+ "MN",
+ "MO",
+ "MP",
+ "MQ",
+ "MR",
+ "MS",
+ "MT",
+ "MU",
+ "MV",
+ "MW",
+ "MX",
+ "MY",
+ "MZ",
+ "NA",
+ "NC",
+ "NE",
+ "NF",
+ "NG",
+ "NI",
+ "NL",
+ "NO",
+ "NP",
+ "NR",
+ "NU",
+ "NZ",
+ "OM",
+ "PA",
+ "PE",
+ "PF",
+ "PG",
+ "PH",
+ "PK",
+ "PL",
+ "PM",
+ "PN",
+ "PR",
+ "PS",
+ "PT",
+ "PW",
+ "PY",
+ "QA",
+ "RE",
+ "RO",
+ "RS",
+ "RU",
+ "RW",
+ "SA",
+ "SB",
+ "SC",
+ "SD",
+ "SE",
+ "SG",
+ "SH",
+ "SI",
+ "SJ",
+ "SK",
+ "SL",
+ "SM",
+ "SN",
+ "SO",
+ "SR",
+ "ST",
+ "SV",
+ "SX",
+ "SY",
+ "SZ",
+ "TC",
+ "TD",
+ "TF",
+ "TG",
+ "TH",
+ "TJ",
+ "TK",
+ "TL",
+ "TM",
+ "TN",
+ "TO",
+ "TR",
+ "TT",
+ "TV",
+ "TW",
+ "TZ",
+ "UA",
+ "UG",
+ "UM",
+ "US",
+ "UY",
+ "UZ",
+ "VA",
+ "VC",
+ "VE",
+ "VG",
+ "VI",
+ "VN",
+ "VU",
+ "WF",
+ "WS",
+ "YE",
+ "YT",
+ "ZA",
+ "ZM",
+ "ZW"
+ ]
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "Identifies the type of error."
+ },
+ "domain": {
+ "type": "string",
+ "description": "Name for the primary system where the error occurred. This is relevant for application errors."
+ },
+ "errorId": {
+ "type": "integer",
+ "description": "A unique number to identify the error.",
+ "format": "int32"
+ },
+ "inputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "longMessage": {
+ "type": "string",
+ "description": "A more detailed explanation of the error."
+ },
+ "message": {
+ "type": "string",
+ "description": "Information on how to correct the problem, in the end user's terms and language where applicable."
+ },
+ "outputRefIds": {
+ "type": "array",
+ "description": "An array of request elements most closely associated to the error.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "type": "array",
+ "description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
+ "items": {
+ "$ref": "#/components/schemas/ErrorParameter"
+ }
+ },
+ "subdomain": {
+ "type": "string",
+ "description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
+ }
+ },
+ "description": "This type defines the fields that can be returned in an error."
+ },
+ "ErrorParameter": {
+ "type": "object",
+ "description": "This type defines the parameters returned in an error.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The object of the error."
+ },
+ "value": {
+ "type": "string",
+ "description": "The value of the object."
+ }
+ }
+ },
+ "MarketplaceIdEnum": {
+ "type": "object",
+ "description": "This type contains enumerated values of the standard codes that represent each of the eBay marketplaces. | - **EBAY_US**: Indicates the eBay marketplace for the United States. - **EBAY_CA**: Indicates the eBay marketplace for Canada.
Note: When targeting the French locale of the Canadian marketplace, add the Accept-Language request header and pass in fr-CA. If this locale is not specified, the language will default to English. - **EBAY_GB**: Indicates the eBay marketplace for Great Britain (United Kingdom). - **EBAY_AU**: Indicates the eBay marketplace for Australia. - **EBAY_AT**: Indicates the eBay marketplace for Austria. - **EBAY_BE**: Indicates the eBay marketplace for Belgium.
Note: When targeting the French locale of the Belgium marketplace, add the Accept-Language request header and pass in fr-BE. If this locale is not specified, the language will default to Dutch. - **EBAY_DE**: Indicates the eBay marketplace for Germany. - **EBAY_IT**: Indicates the eBay marketplace for Italy. - **EBAY_NL**: Indicates the eBay marketplace for The Netherlands. - **EBAY_ES**: Indicates the eBay marketplace for Spain. - **EBAY_CH**: Indicates the eBay marketplace for Switzerland. - **EBAY_TW**: Indicates the eBay marketplace for Taiwan. - **EBAY_CZ**: Reserved for future use. - **EBAY_DK**: Reserved for future use. - **EBAY_FI**: Reserved for future use. - **EBAY_FR**: Indicates the eBay marketplace for France. - **EBAY_GR**: Reserved for future use. - **EBAY_HK**: Indicates the eBay marketplace for Hong Kong. - **EBAY_HU**: Reserved for future use. - **EBAY_IN**: Indicates the eBay marketplace for India.
Note: eBay India is no longer a functioning eBay marketplace. - **EBAY_ID**: Reserved for future use. - **EBAY_IE**: Indicates the eBay marketplace for Indicates the eBay marketplace for Ireland. - **EBAY_IL**: Reserved for future use. - **EBAY_MY**: Indicates the eBay marketplace for Malaysia. - **EBAY_NZ**: Reserved for future use.. - **EBAY_NO**: Reserved for future use. - **EBAY_PH**: Indicates the eBay marketplace for the Philippines. - **EBAY_PL**: Indicates the eBay marketplace for Poland. - **EBAY_PT**: Reserved for future use. - **EBAY_PR**: Reserved for future use. - **EBAY_RU**: Reserved for future use. - **EBAY_SG**: Indicates the eBay marketplace for Singapore. - **EBAY_ZA**: Reserved for future use. - **EBAY_SE**: Reserved for future use. - **EBAY_TH**: Indicates the eBay marketplace for Thailand. - **EBAY_VN**: Indicates the eBay marketplace for Vietnam. - **EBAY_CN**: Reserved for future use. - **EBAY_JP**: Reserved for future use. - **EBAY_PE**: Reserved for future use. - **EBAY_HALF_US**: No longer used. - **EBAY_MOTORS_US**: Indicates the parent category for \"Auto Parts and Vehicles\" on the EBAY_US marketplace",
+ "enum": [
+ "EBAY_US",
+ "EBAY_CA",
+ "EBAY_GB",
+ "EBAY_AU",
+ "EBAY_AT",
+ "EBAY_BE",
+ "EBAY_DE",
+ "EBAY_IT",
+ "EBAY_NL",
+ "EBAY_ES",
+ "EBAY_CH",
+ "EBAY_TW",
+ "EBAY_CZ",
+ "EBAY_DK",
+ "EBAY_FI",
+ "EBAY_FR",
+ "EBAY_GR",
+ "EBAY_HK",
+ "EBAY_HU",
+ "EBAY_IN",
+ "EBAY_ID",
+ "EBAY_IE",
+ "EBAY_IL",
+ "EBAY_MY",
+ "EBAY_NZ",
+ "EBAY_NO",
+ "EBAY_PH",
+ "EBAY_PL",
+ "EBAY_PT",
+ "EBAY_PR",
+ "EBAY_RU",
+ "EBAY_SG",
+ "EBAY_ZA",
+ "EBAY_SE",
+ "EBAY_TH",
+ "EBAY_VN",
+ "EBAY_CN",
+ "EBAY_JP",
+ "EBAY_PE",
+ "EBAY_HALF_US",
+ "EBAY_MOTORS_US"
+ ]
+ },
+ "ReasonCodeDetailType": {
+ "type": "object",
+ "properties": {
+ "briefText": {
+ "type": "string",
+ "description": "The short description of the infringement associated with the reason code."
+ },
+ "detailedText": {
+ "type": "string",
+ "description": "The long description of the infringement associated with the reason code."
+ },
+ "veroReasonCodeId": {
+ "type": "string",
+ "description": "The unique identifier of a VeRO reason code."
+ }
+ },
+ "description": "This type defines the brief and detailed description of a VeRO infringement, as well as the ID associated with the infringement."
+ },
+ "ReportItemDetails": {
+ "type": "object",
+ "properties": {
+ "brand": {
+ "type": "string",
+ "description": "The brand name of the item being reported for VeRO violation.
Max length: 50 characters"
+ },
+ "copyEmailToRightsOwner": {
+ "type": "boolean",
+ "description": "If the VeRO Program member wants a copy of the Notice of Claimed Infringement (NOCI) document sent to their email address, this field should be included in the request and set to true. This same document is automatically sent to the seller of the reported item.
As this field defaults to true, the report will be automatically emailed if this field is omitted.
Default: true"
+ },
+ "countries": {
+ "type": "array",
+ "description": "If the infringement type stated in the VeroReasonCodeId has anything to do with which country the item is being shipped to, each country that would trigger this infringement type should be specified in this comma-delimited array.
This field is required when the veroReasonCodeId is 9037 (Item(s) is unlawful importation of product bearing trademark).",
+ "items": {
+ "$ref": "#/components/schemas/CountryCodeEnum"
+ }
+ },
+ "detailedMessage": {
+ "type": "string",
+ "description": "This field is used to provide further information about the VeRO reason code.
This field is required when the veroReasonCodeId is 9052 or 7052 (Other - Provide details information in additional information box below).
Max length: 1000 characters"
+ },
+ "itemId": {
+ "type": "string",
+ "description": "The unique identifier of the listing being reported for the alleged infringement."
+ },
+ "messageToSeller": {
+ "type": "string",
+ "description": "This field is used by the VeRO Program member to provide more details to the seller as to why the item is being reported for the alleged infringement.
Max length: 1000 characters"
+ },
+ "patent": {
+ "type": "string",
+ "description": "This field is used to specify the number of a product patent that is being violated.
This field is required when the veroReasonCodeId is 9048 (Item(s) infringes a valid patent).
Max length: 15 characters"
+ },
+ "regions": {
+ "type": "array",
+ "description": "If the infringement type stated in the veroReasonCodeId has anything to do with which geographical region the item is being shipped to, each region that would trigger this infringement type should be specified in this comma-delimited array.",
+ "items": {
+ "$ref": "#/components/schemas/WorldRegionEnum"
+ }
+ },
+ "veroReasonCodeId": {
+ "type": "string",
+ "description": "The unique identifier for the type of claimed infringement.
Use getVeroReasonCodes to retrieve a list of valid reason codes for a given eBay site."
+ }
+ },
+ "description": "This type defines the details of an item being reported for violating a product owner's copyright, trademark, or intellectual property rights."
+ },
+ "ReportStatusResponse": {
+ "type": "object",
+ "properties": {
+ "reportedItemDetails": {
+ "type": "array",
+ "description": "This array returns the status for each eBay item that was included as part of the report.
This array is only returned if the includeItemDetails query parameter is set to true.",
+ "items": {
+ "$ref": "#/components/schemas/ReportedItem"
+ }
+ },
+ "veroReportId": {
+ "type": "string",
+ "description": "The unique packet identifier of the VeRO report."
+ },
+ "veroReportStatus": {
+ "description": "The processing status of the requested VeRO report.",
+ "$ref": "#/components/schemas/VeroReportStatusEnum"
+ }
+ },
+ "description": "This type defines the response fields of the getVeroReport method. "
+ },
+ "ReportedItem": {
+ "type": "object",
+ "properties": {
+ "itemId": {
+ "type": "string",
+ "description": "The unique identifier of the listing that is being reported for copyright, trademark, or intellectual right infringement."
+ },
+ "reasonForFailure": {
+ "type": "string",
+ "description": "This text explanation is submitted by eBay when the submission of a VeRO Report has failed or was blocked.
This field is conditionally returned if the status value of the report is ClarificationRequired or SubmissionFailed."
+ },
+ "status": {
+ "description": "The current status of the VeRO reported item.",
+ "$ref": "#/components/schemas/VeroReportedItemStatusEnum"
+ }
+ },
+ "description": "This type defines the item ID and status of a VeRO report. If applicable, a reason for report failure is also returned."
+ },
+ "VeroReasonCode": {
+ "type": "object",
+ "properties": {
+ "marketplaceId": {
+ "description": "The eBay site for which reason code details are returned.",
+ "$ref": "#/components/schemas/MarketplaceIdEnum"
+ },
+ "reasonCodeDetails": {
+ "type": "array",
+ "description": "This container includes both brief and detailed text descriptions for the VeRO program intellectual property right infringement reason, as well as the ID for the reason code.",
+ "items": {
+ "$ref": "#/components/schemas/ReasonCodeDetailType"
+ }
+ }
+ },
+ "description": "This type is used to define the details of a VeRO reason code for a specific site."
+ },
+ "VeroReasonCodeDetailResponse": {
+ "type": "object",
+ "properties": {
+ "veroReasonCodes": {
+ "type": "array",
+ "description": "This array provides a list of VeRO reason codes, as well as the ID and details of each code, based on the input criteria.
If a X-EBAY-C-MARKETPLACE-ID header is used, only VeRO reason codes for that specific site will be returned. If this header is not included, all reason codes for all sites are returned. ",
+ "items": {
+ "$ref": "#/components/schemas/VeroReasonCode"
+ }
+ }
+ },
+ "description": "This type defines the response fields returned in the getCeroReasonCodes method."
+ },
+ "VeroReasonCodeResponse": {
+ "type": "object",
+ "description": "This type defines the response payload of the getVeroReasonCode method.",
+ "properties": {
+ "marketplaceId": {
+ "description": "The eBay site for which reason code details are returned.",
+ "$ref": "#/components/schemas/MarketplaceIdEnum"
+ },
+ "reasonCodeDetails": {
+ "description": "This container includes both brief and detailed text descriptions for the VeRO program intellectual property right infringement reason, as well as the ID for the reason code",
+ "$ref": "#/components/schemas/ReasonCodeDetailType"
+ }
+ }
+ },
+ "VeroReportItemsRequest": {
+ "type": "object",
+ "properties": {
+ "reportItems": {
+ "type": "array",
+ "description": "This array is used to report one or more eBay items that are allegedly violating the product owner's copyright, trademark, or intellectual property rights.
The itemId and veroReasonCodeId fields are required for each reported violation.
Note: You can report the same item more than once if a different reason code is used each time.",
+ "items": {
+ "$ref": "#/components/schemas/ReportItemDetails"
+ }
+ }
+ },
+ "description": "This type defines the request fields used in the createVeroReport method."
+ },
+ "VeroReportItemsResponse": {
+ "type": "object",
+ "properties": {
+ "veroReportId": {
+ "type": "string",
+ "description": "The unique identifier of the VeRO report that the item violations have been added to.
Note: Users should keep track of the returned veroReportId, as there is no programmatic way to retrieve this value at this time."
+ },
+ "veroReportStatus": {
+ "description": "The processing status of the VeRO report.",
+ "$ref": "#/components/schemas/VeroReportStatusEnum"
+ }
+ },
+ "description": "This type defines the response fields used in the createVeroReport method."
+ },
+ "VeroReportStatusEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the values that represent the status of a VeRO Report packet. | - **RECEIVED**: This enum value indicates that the VeRO Report packet has been received by eBay. - **IN_PROCESS**: This enum value indicates that eBay is in the process of reviewing the VeRO Report packet. - **PROCESSED**: This enum value indicates that the VeRO Report packed has been processed by eBay.",
+ "enum": [
+ "RECEIVED",
+ "IN_PROCESS",
+ "PROCESSED"
+ ]
+ },
+ "VeroReportStatusResponse": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string",
+ "description": "The URL to the current page of the VeRO reported item results."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The value of the limit parameter submitted in the request.",
+ "format": "int32"
+ },
+ "next": {
+ "type": "string",
+ "description": "The URI for the next page of results. This value is returned if there is an additional page of results to return from the result set"
+ },
+ "offset": {
+ "type": "integer",
+ "description": "The value off the offset parameter submitted in the request.",
+ "format": "int32"
+ },
+ "prev": {
+ "type": "string",
+ "description": "The URI for the previous page of results. This is returned if there is a previous page of results from the result set."
+ },
+ "reportedItemDetails": {
+ "type": "array",
+ "description": "This array returns the item ID and statuses of the reported items being returned.",
+ "items": {
+ "$ref": "#/components/schemas/ReportedItem"
+ }
+ },
+ "total": {
+ "type": "integer",
+ "description": "This is the total number of records that match the input criteria.",
+ "format": "int32"
+ }
+ },
+ "description": "This type defines the response fields for the getVeroReports method."
+ },
+ "VeroReportedItemStatusEnum": {
+ "type": "object",
+ "description": "This enumerated type defines the status of a VeRO reported item. | - **NONE**: This enum value indicates that there is no VeRO report request for the item. - **RECEIVED**: This enum value indicates that the VeRO report request for the item has been received by eBay. - **SUBMITTED**: This enum value indicates that the VeRO report request for the item has been submitted to eBay. - **SUBMISSION_FAILED**: This enum value indicates that the VeRO report request for the item has failed. - **REMOVED**: This enum value indicates that the user has reported an inactive item. - **CLARIFICATION_REQUIRED**: This enum value indicates that the VeRO report request for the item has been received by eBay, but additional clarification is needed before eBay can end the item.",
+ "enum": [
+ "NONE",
+ "RECEIVED",
+ "SUBMITTED",
+ "SUBMISSION_FAILED",
+ "REMOVED",
+ "CLARIFICATION_REQUIRED"
+ ]
+ },
+ "WorldRegionEnum": {
+ "type": "object",
+ "description": "This enumerated type contains of list of world regions. | - **AFRICA**: This enumeration value indicates the world region is Africa. - **AMERICAS**: This enumeration value indicates the world region is the Americas. - **ASIA**: This enumeration value indicates the world region is Asia. - **CARIBBEAN**: This enumeration value indicates the world region is the Caribbean. - **EUROPE**: This enumeration value indicates the world region is Europe. - **EUROPE_UNION**: This enumeration value indicates the world region is the European Union. - **LATIN_AMERICA**: This enumeration value indicates the world region is Latin America. - **MIDDLE_EAST**: This enumeration value indicates the world region is the Middle East. - **NORTH_AMERICA**: This enumeration value indicates the world region is North America. - **OCEANIA**: This enumeration value indicates the world region is Oceania. - **SOUTH_AMERICA**: This enumeration value indicates the world region is South America. - **WORLDWIDE**: This enumeration value indicates the world region is world wide.",
+ "enum": [
+ "AFRICA",
+ "AMERICAS",
+ "ASIA",
+ "CARIBBEAN",
+ "EUROPE",
+ "EUROPE_UNION",
+ "LATIN_AMERICA",
+ "MIDDLE_EAST",
+ "NORTH_AMERICA",
+ "OCEANIA",
+ "SOUTH_AMERICA",
+ "WORLDWIDE"
+ ]
+ }
+ },
+ "securitySchemes": {
+ "api_auth": {
+ "type": "oauth2",
+ "description": "The security definitions for this API. Please check individual operations for applicable scopes.",
+ "flows": {}
+ },
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer"
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/specs/openapi/vero.yaml b/specs/openapi/vero.yaml
deleted file mode 100644
index 64db3e3..0000000
--- a/specs/openapi/vero.yaml
+++ /dev/null
@@ -1,719 +0,0 @@
----
-openapi: "3.0.0"
-info:
- title: "Vero Public API's"
- description: "The VeRO API has methods that allow owners of an intellectual property\
- \ to report eBay listings that infringe on their intellectual property rights.\
- \ It contains methods to report a listing, retrieve supported VeRO reason codes,\
- \ and retrieve the status of reported items."
- contact:
- name: "eBay Inc,"
- license:
- name: "eBay API License Agreement"
- url: "https://developer.ebay.com/join/api-license-agreement"
- version: "1.0.0"
-servers:
-- url: "https://api.ebay.com{basePath}"
- description: "Production"
- variables:
- basePath:
- default: "/commerce/vero/v1"
-paths:
- /vero_reason_code/{vero_reason_code_id}:
- get:
- tags:
- - "vero_reason_code"
- description: "
Important!\
- \ You must be a member of the Verified Rights Owner (VeRO) Program to use\
- \ this call.
This method is used to retrieve the details of a\
- \ specific VeRO reason code, including a description of the code and the marketplace\
- \ associated with the code.
The vero_reason_code_id of the VeRO\
- \ reason code for which to retrieve details is required as a path parameter."
- operationId: "getVeroReasonCode"
- parameters:
- - name: "vero_reason_code_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the VeRO\
- \ reason code that is to be retrieved.
Use the getVeroReasonCodes method to retrieve supported\
- \ VeRO reason code IDs."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VeroReasonCodeResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 235001:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The veroReasonCodeId was not found."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 235000:
- domain: "API_VERO"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/api_scope/commerce.vero"
- /vero_reason_code:
- get:
- tags:
- - "vero_reason_code"
- description: "
Important!\
- \ You must be a member of the Verified Rights Owner (VeRO) Program to use\
- \ this call.
This method is used to retrieve the details of an\
- \ array of VeRO reason codes. This information includes the descriptions of\
- \ each code, as well as the marketplace associated with each code.
\
- \ If the X-EBAY-C-MARKETPLACE-ID header is present, only VeRO reason\
- \ codes for that specific site will be returned. If this header is not included,\
- \ all reason codes for all sites are returned."
- operationId: "getVeroReasonCodes"
- parameters:
- - name: "X-EBAY-C-MARKETPLACE-ID"
- in: "header"
- description: "This header identifies the eBay marketplace for which to retrieve\
- \ VeRO reason codes. If this header is used, only VeRO reason codes for\
- \ the specified marketplace will be returned in the response.
See\
- \ MarketplaceIdEnum for a list of supported values."
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VeroReasonCodeDetailResponse"
- "400":
- description: "Bad Request"
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 235000:
- domain: "API_VERO"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/api_scope/commerce.vero"
- /vero_report:
- post:
- tags:
- - "vero_report"
- description: "
Important!\
- \ You must be a member of the Verified Rights Owner (VeRO) Program to use\
- \ this call.
This method can be used to create a VeRO report\
- \ for a listing. VeRO reports can be used to report items that your copyright,\
- \ trademark, or other intellectual property rights.
The itemId\
- \ of the item being reported must be provided in the request, as well as the\
- \ veroReasonCodeId of the claimed infringement.
You can report\
- \ one or more items at a time using this method. A maximum of 150 items can\
- \ be reported using this method."
- operationId: "createVeroReport"
- parameters:
- - name: "Content-Type"
- in: "header"
- description: "This header indicates the format of the request body provided\
- \ by the client. Its value should be set to application/json.
For\
- \ more information, refer to HTTP request headers."
- required: true
- schema:
- type: "string"
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VeroReportItemsRequest"
- required: false
- responses:
- "201":
- description: "Created"
- headers:
- Location:
- schema:
- type: "string"
- description: "The Location response header returns the created\
- \ report resource location."
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VeroReportItemsResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 235024:
- domain: "API_VERO_REPORT"
- category: "REQUEST"
- description: "At least one item is required for this call."
- 235015:
- domain: "API_VERO"
- category: "REQUEST"
- description: "At least one country is required for the specified reason\
- \ code."
- 235014:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The veroReasonCodeId is required for this call."
- 235013:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The itemId is required for this call."
- 235012:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Number of reported items exceeds maximum limit of 150\
- \ items."
- 235019:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please verify brand, it should not exceed 50 characters."
- 235017:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The patent is required for this call."
- 235016:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The Regions specified are not allowed"
- 235023:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please check report, there are duplicate item reports.\
- \ A duplicate report is two report on the same itemId and veroReasonCodeId\
- \ combination in one packet. The same combination itemId and veroReasonCodeId\
- \ can be reported in a different packet."
- 235022:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please verify messageToSeller, it should not exceed\
- \ 1000 characters."
- 235021:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please verify detailedMessage, it should not exceed\
- \ 1000 characters."
- 235020:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The detailedMessage is required for the specified reason\
- \ code."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 235018:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please verify patent, it should not exceed 15 characters."
- 235000:
- domain: "API_VERO"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/api_scope/commerce.vero"
- /vero_report/{vero_report_id}:
- get:
- tags:
- - "vero_report"
- description: "
Important!\
- \ You must be a member of the Verified Rights Owner (VeRO) Program to use\
- \ this call.
This method can be used to retrieve status information\
- \ about a VeRO report you have submitted to eBay for copyright, trademark,\
- \ or other intellectual property rights infringement.
The vero_report_id\
- \ path parameter is used to specify the eBay report for which to retrieve\
- \ status information."
- operationId: "getVeroReport"
- parameters:
- - name: "includeItemDetails"
- in: "query"
- description: "Include this query and set it to true if you want\
- \ to retrieve the reportedItemDetails container in the response,\
- \ which contains item-level status information. This container may be helpful\
- \ if you have reported violations on more than one eBay item in the report.
By\
- \ default, this boolean is set to false."
- required: false
- schema:
- type: "string"
- - name: "vero_report_id"
- in: "path"
- description: "This path parameter specifies the unique identifier of the VeRO\
- \ report being retrieved.
This value is returned when creating a\
- \ VeRO report through the createVeroReport method."
- required: true
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ReportStatusResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 235010:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Not authorized to perform this operation. Vero report\
- \ creator and requester are different."
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 235000:
- domain: "API_VERO"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process."
- "404":
- description: "Not Found"
- x-response-codes:
- errors:
- 235011:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The veroReportId was not found."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/api_scope/commerce.vero"
- /vero_report_items:
- get:
- tags:
- - "vero_report_items"
- summary: "Retrieves status for VERO infringement reports by Brand."
- description: "
Important!\
- \ You must be a member of the Verified Rights Owner (VeRO) Program to use\
- \ this call.
This method can be used to retrieve status information\
- \ about one or more VeRO reported items you have submitted.
Without\
- \ the use of any query parameters, the default behavior of this method is\
- \ to return the status of all VeRO reported items submitted by the seller\
- \ during the last two years. Use the itemId query parameter to see\
- \ a specific reported item, and use the filter query to retrieve the\
- \ status of reported items submitted within a specific date range. Pagination\
- \ is also available to limit the number of reported items that are retrieved\
- \ per page of data."
- operationId: "getVeroReportItems"
- parameters:
- - name: "filter"
- in: "query"
- description: "This query parameter can be used to filter the result set by\
- \ a date range. Only items reported within the specified time period will\
- \ be returned.
This parameter will be ignored if itemId has\
- \ been specified.
Format:YYYY-MM-DD HH:MM:SS
Example:\
- \ reportSubmittedDate:[2024-11-14T07:47:48Z..2024-12-14T07:47:48Z]."
- required: false
- schema:
- type: "string"
- - name: "itemId"
- in: "query"
- description: "This query parameter specifies the unique identifier of an eBay\
- \ listing. Only the specified reported item will be returned."
- required: false
- schema:
- type: "string"
- - name: "limit"
- in: "query"
- description: "The maximum number of entries that can be returned on each page\
- \ of the paginated response. Use this parameter in conjunction with the\
- \ offset parameter to control the pagination of the output.
Note: This feature employs a zero-based list,\
- \ where the first item in the list has an offset of 0. For\
- \ example, if offset is set to 10 and limit is\
- \ set to 10, the call retrieves entries 11 through 20 from\
- \ the result set.
If this parameter is omitted, the default value\
- \ is used.
Default: 25"
- required: false
- schema:
- type: "string"
- - name: "offset"
- in: "query"
- description: "The number of reports to skip in the result set before returning\
- \ the first report in the paginated response. Combine offset with the limit\
- \ query parameter to control the reports returned in the response. For example,\
- \ if you supply an offset of 0 and a limit of\
- \ 10, the first page of the response contains the first 10\
- \ reports from the complete list of reports retrieved by the call. If this\
- \ query parameter is not set, the default value is used and the first page\
- \ of reports is returned.
Default: 0"
- required: false
- schema:
- type: "string"
- responses:
- "200":
- description: "OK"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VeroReportStatusResponse"
- "400":
- description: "Bad Request"
- x-response-codes:
- errors:
- 235010:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Not authorized to perform this operation. Vero report\
- \ creator and requester are different."
- 235009:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The time interval specified is greater than what is\
- \ allowed (90 days is the maximum)."
- 235007:
- domain: "API_VERO"
- category: "REQUEST"
- description: "Please check the date range."
- 235006:
- domain: "API_VERO"
- category: "REQUEST"
- description: "The itemId was not found."
- 235005:
- domain: "API_VERO"
- category: "REQUEST"
- description: "A filter supplied in the request is invalid: {filterName}"
- "500":
- description: "Internal Server Error"
- x-response-codes:
- errors:
- 235000:
- domain: "API_VERO"
- category: "APPLICATION"
- description: "There was a problem with an eBay internal system or\
- \ process."
- security:
- - api_auth:
- - "https://api.ebay.com/oauth/scope/commerce.vero"
-components:
- schemas:
- Error:
- type: "object"
- properties:
- category:
- type: "string"
- description: "Identifies the type of erro."
- domain:
- type: "string"
- description: "Name for the primary system where the error occurred. This\
- \ is relevant for application errors."
- errorId:
- type: "integer"
- description: "A unique number to identify the error."
- format: "int32"
- inputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- longMessage:
- type: "string"
- description: "A more detailed explanation of the error."
- message:
- type: "string"
- description: "Information on how to correct the problem, in the end user's\
- \ terms and language where applicable."
- outputRefIds:
- type: "array"
- description: "An array of request elements most closely associated to the\
- \ error."
- items:
- type: "string"
- parameters:
- type: "array"
- description: "An array of name/value pairs that describe details the error\
- \ condition. These are useful when multiple errors are returned."
- items:
- $ref: "#/components/schemas/ErrorParameter"
- subdomain:
- type: "string"
- description: "Further helps indicate which subsystem the error is coming\
- \ from. System subcategories include: Initialization, Serialization, Security,\
- \ Monitoring, Rate Limiting, etc."
- description: "This type defines the fields that can be returned in an error."
- ErrorParameter:
- type: "object"
- properties:
- name:
- type: "string"
- description: "The object of the error."
- value:
- type: "string"
- description: "The value of the object."
- ReasonCodeDetailType:
- type: "object"
- properties:
- briefText:
- type: "string"
- description: "The short description of the infringement associated with\
- \ the reason code."
- detailedText:
- type: "string"
- description: "The long description of the infringement associated with the\
- \ reason code."
- veroReasonCodeId:
- type: "string"
- description: "The unique identifier of a VeRO reason code."
- description: "This type defines the brief and detailed description of a VeRO\
- \ infringement, as well as the ID associated with the infringement."
- ReportItemDetails:
- type: "object"
- properties:
- brand:
- type: "string"
- description: "The brand name of the item being reported for VeRO violation.
Max\
- \ length: 50 characters"
- copyEmailToRightsOwner:
- type: "boolean"
- description: "If the VeRO Program member wants a copy of the Notice of Claimed\
- \ Infringement (NOCI) document sent to their email address, this field\
- \ should be included in the request and set to true. This\
- \ same document is automatically sent to the seller of the reported item.
As\
- \ this field defaults to true, the report will be automatically\
- \ emailed if this field is omitted.
Default: true"
- countries:
- type: "array"
- description: "If the infringement type stated in the VeroReasonCodeId\
- \ has anything to do with which country the item is being shipped to,\
- \ each country that would trigger this infringement type should be specified\
- \ in this comma-delimited array.
This field is required when the\
- \ veroReasonCodeId is 9037 (Item(s) is unlawful importation\
- \ of product bearing trademark)."
- items:
- type: "string"
- description: " For implementation help, refer to eBay\
- \ API documentation"
- detailedMessage:
- type: "string"
- description: "This field is used to provide further information about the\
- \ VeRO reason code.
This field is required when the veroReasonCodeId\
- \ is 9052 or 7052 (Other - Provide details information\
- \ in additional information box below).
Max length: 1000\
- \ characters"
- itemId:
- type: "string"
- description: "The unique identifier of the listing being reported for the\
- \ alleged infringement."
- messageToSeller:
- type: "string"
- description: "This field is used by the VeRO Program member to provide more\
- \ details to the seller as to why the item is being reported for the alleged\
- \ infringement.
Max length: 1000 characters"
- patent:
- type: "string"
- description: "This field is used to specify the number of a product patent\
- \ that is being violated.
This field is required when the veroReasonCodeId\
- \ is 9048 (Item(s) infringes a valid patent).
Max\
- \ length: 15 characters"
- regions:
- type: "array"
- description: "If the infringement type stated in the veroReasonCodeId\
- \ has anything to do with which geographical region the item is being\
- \ shipped to, each region that would trigger this infringement type should\
- \ be specified in this comma-delimited array."
- items:
- type: "string"
- description: " For implementation help, refer to eBay\
- \ API documentation"
- veroReasonCodeId:
- type: "string"
- description: "The unique identifier for the type of claimed infringement.
Use\
- \ getVeroReasonCodes to retrieve a list of valid\
- \ reason codes for a given eBay site."
- description: "This type defines the details of an item being reported for violating\
- \ a product owner's copyright, trademark, or intellectual property rights."
- ReportStatusResponse:
- type: "object"
- properties:
- reportedItemDetails:
- type: "array"
- description: "This array returns the status for each eBay item that was\
- \ included as part of the report.
This array is only returned if\
- \ the includeItemDetails query parameter is set to true."
- items:
- $ref: "#/components/schemas/ReportedItem"
- veroReportId:
- type: "string"
- description: "The unique packet identifier of the VeRO report."
- veroReportStatus:
- type: "string"
- description: "The processing status of the requested VeRO report. For implementation\
- \ help, refer to eBay\
- \ API documentation"
- description: "This type defines the response fields of the getVeroReport\
- \ method. "
- ReportedItem:
- type: "object"
- properties:
- itemId:
- type: "string"
- description: "The unique identifier of the listing that is being reported\
- \ for copyright, trademark, or intellectual right infringement."
- reasonForFailure:
- type: "string"
- description: "This text explanation is submitted by eBay when the submission\
- \ of a VeRO Report has failed or was blocked.
This field is conditionally\
- \ returned if the status value of the report is ClarificationRequired\
- \ or SubmissionFailed."
- status:
- type: "string"
- description: "The current status of the VeRO reported item. For implementation\
- \ help, refer to eBay\
- \ API documentation"
- description: "This type defines the item ID and status of a VeRO report. If\
- \ applicable, a reason for report failure is also returned."
- VeroReasonCode:
- type: "object"
- properties:
- marketplaceId:
- type: "string"
- description: "The eBay site for which reason code details are returned.\
- \ For implementation help, refer to eBay\
- \ API documentation"
- reasonCodeDetails:
- type: "array"
- description: "This container includes both brief and detailed text descriptions\
- \ for the VeRO program intellectual property right infringement reason,\
- \ as well as the ID for the reason code."
- items:
- $ref: "#/components/schemas/ReasonCodeDetailType"
- description: "This type is used to define the details of a VeRO reason code\
- \ for a specific site."
- VeroReasonCodeDetailResponse:
- type: "object"
- properties:
- veroReasonCodes:
- type: "array"
- description: "This array provides a list of VeRO reason codes, as well as\
- \ the ID and details of each code, based on the input criteria.
If\
- \ a X-EBAY-C-MARKETPLACE-ID header is used, only VeRO reason codes\
- \ for that specific site will be returned. If this header is not included,\
- \ all reason codes for all sites are returned. "
- items:
- $ref: "#/components/schemas/VeroReasonCode"
- description: "This type defines the response fields returned in the getCeroReasonCodes\
- \ method."
- VeroReasonCodeResponse:
- type: "object"
- properties:
- marketplaceId:
- type: "string"
- description: "The eBay site for which reason code details are returned.\
- \ For implementation help, refer to eBay\
- \ API documentation"
- reasonCodeDetails:
- description: "This container includes both brief and detailed text descriptions\
- \ for the VeRO program intellectual property right infringement reason,\
- \ as well as the ID for the reason code"
- $ref: "#/components/schemas/ReasonCodeDetailType"
- VeroReportItemsRequest:
- type: "object"
- properties:
- reportItems:
- type: "array"
- description: "This array is used to report one or more eBay items that are\
- \ allegedly violating the product owner's copyright, trademark, or intellectual\
- \ property rights.
The itemId and veroReasonCodeId\
- \ fields are required for each reported violation.
Note: You can report the same item more than once if\
- \ a different reason code is used each time."
- items:
- $ref: "#/components/schemas/ReportItemDetails"
- description: "This type defines the request fields used in the createVeroReport\
- \ method."
- VeroReportItemsResponse:
- type: "object"
- properties:
- veroReportId:
- type: "string"
- description: "The unique identifier of the VeRO report that the item violations\
- \ have been added to.
Note: Users\
- \ should keep track of the returned veroReportId, as there is no\
- \ programmatic way to retrieve this value at this time."
- veroReportStatus:
- type: "string"
- description: "The processing status of the VeRO report. For implementation\
- \ help, refer to eBay\
- \ API documentation"
- description: "This type defines the response fields used in the createVeroReport\
- \ method."
- VeroReportStatusResponse:
- type: "object"
- properties:
- href:
- type: "string"
- description: "The URL to the current page of the VeRO reported item results."
- limit:
- type: "integer"
- description: "The value of the limit parameter submitted in the request."
- format: "int32"
- next:
- type: "string"
- description: "The URI for the next page of results. This value is returned\
- \ if there is an additional page of results to return from the result\
- \ set"
- offset:
- type: "integer"
- description: "The value off the offset parameter submitted in the\
- \ request."
- format: "int32"
- prev:
- type: "string"
- description: "The URI for the previous page of results. This is returned\
- \ if there is a previous page of results from the result set."
- reportedItemDetails:
- type: "array"
- description: "This array returns the item ID and statuses of the reported\
- \ items being returned."
- items:
- $ref: "#/components/schemas/ReportedItem"
- total:
- type: "integer"
- description: "This is the total number of records that match the input criteria."
- format: "int32"
- description: "This type defines the response fields for the getVeroReports\
- \ method."
- securitySchemes:
- api_auth:
- type: "oauth2"
- description: "The security definitions for this API. Please check individual\
- \ operations for applicable scopes."
- flows: {}
diff --git a/src/main/java/com/ebay/otherapis/OtherApisClient.java b/src/main/java/com/ebay/otherapis/OtherApisClient.java
index 6f80f8d..c37cc13 100644
--- a/src/main/java/com/ebay/otherapis/OtherApisClient.java
+++ b/src/main/java/com/ebay/otherapis/OtherApisClient.java
@@ -17,12 +17,14 @@
import com.ebay.otherapis.clients.rest.IdentityClient;
import com.ebay.otherapis.clients.rest.InternationalShippingClient;
import com.ebay.otherapis.clients.rest.TranslationClient;
+import com.ebay.otherapis.clients.rest.VeroApiV2Client;
import com.ebay.otherapis.clients.rest.VeroClient;
import com.ebay.otherapis.configuration.KiotaAuthProvider;
import com.ebay.otherapis.configuration.OtherApisConfiguration;
import com.ebay.otherapis.generated.identity.IdentityApiClient;
import com.ebay.otherapis.generated.internationalshipping.InternationalShippingApiClient;
import com.ebay.otherapis.generated.translation.TranslationApiClient;
+import com.ebay.otherapis.generated.veroapiv2.VeroApiV2ApiClient;
import com.ebay.otherapis.generated.vero.VeroApiClient;
import com.microsoft.kiota.authentication.BaseBearerTokenAuthenticationProvider;
import com.microsoft.kiota.http.OkHttpRequestAdapter;
@@ -39,6 +41,7 @@ public final class OtherApisClient implements Closeable {
public final IdentityClient identity;
public final InternationalShippingClient internationalShipping;
public final TranslationClient translation;
+ public final VeroApiV2Client veroApiV2;
public final VeroClient vero;
public OtherApisClient(OtherApisConfiguration config) {
@@ -62,6 +65,10 @@ public OtherApisClient(OtherApisConfiguration config) {
translationAdapter.setBaseUrl(config.getTranslationBaseUrl());
this.translation = new TranslationClient(new TranslationApiClient(translationAdapter), config);
+ var veroApiV2Adapter = new OkHttpRequestAdapter(authProvider, null, null, sharedHttpClient);
+ veroApiV2Adapter.setBaseUrl(config.getVeroApiV2BaseUrl());
+ this.veroApiV2 = new VeroApiV2Client(new VeroApiV2ApiClient(veroApiV2Adapter), config);
+
var veroAdapter = new OkHttpRequestAdapter(authProvider, null, null, sharedHttpClient);
veroAdapter.setBaseUrl(config.getVeroBaseUrl());
this.vero = new VeroClient(new VeroApiClient(veroAdapter), config);
diff --git a/src/main/java/com/ebay/otherapis/clients/rest/IdentityClient.java b/src/main/java/com/ebay/otherapis/clients/rest/IdentityClient.java
index 24d01bf..bb9bb34 100644
--- a/src/main/java/com/ebay/otherapis/clients/rest/IdentityClient.java
+++ b/src/main/java/com/ebay/otherapis/clients/rest/IdentityClient.java
@@ -22,6 +22,8 @@
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
+import java.io.InputStream;
+import com.microsoft.kiota.serialization.UntypedNode;
public final class IdentityClient {
private final IdentityApiClient kiota;
diff --git a/src/main/java/com/ebay/otherapis/clients/rest/InternationalShippingClient.java b/src/main/java/com/ebay/otherapis/clients/rest/InternationalShippingClient.java
index e56d370..abfd9ea 100644
--- a/src/main/java/com/ebay/otherapis/clients/rest/InternationalShippingClient.java
+++ b/src/main/java/com/ebay/otherapis/clients/rest/InternationalShippingClient.java
@@ -22,6 +22,8 @@
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
+import java.io.InputStream;
+import com.microsoft.kiota.serialization.UntypedNode;
public final class InternationalShippingClient {
private final InternationalShippingApiClient kiota;
@@ -138,13 +140,14 @@ public CompletableFuture getBundleLabelAsync(
}));
}
- public CompletableFuture