{ "openapi": "3.0.0", "info": { "title": "Account v1 API", "description": "The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions.", "contact": { "name": "eBay Inc," }, "license": { "name": "eBay API License Agreement", "url": "https://developer.ebay.com/join/api-license-agreement" }, "version": "v1.9.3" }, "servers": [ { "url": "https://api.ebay.com{basePath}", "description": "Production", "variables": { "basePath": { "default": "/sell/account/v1" } } } ], "security": [ {} ], "paths": { "/custom_policy/": { "get": { "tags": [ "custom_policy" ], "description": "This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policy_types query parameter.", "operationId": "getCustomPolicies", "parameters": [ { "name": "policy_types", "in": "query", "description": "This query parameter specifies the type of custom policies to be returned.

Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.

Note: Omitting this query parameter from a request will also return policies of all policy types.
See the CustomPolicyTypeEnum type for a list of supported values.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomPolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20411": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing policyTypes {policyType}" }, "20415": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing marketplaceId" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "post": { "tags": [ "custom_policy" ], "description": "This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a policyType. Multiple policies may be created as using the following custom policy types:A successful create policy call returns an HTTP status code of 201 Created with the system-generated policy ID included in the Location response header.", "operationId": "createCustomPolicy", "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": { "description": "Request to create a new Custom Policy.", "content": { "application/json": { "schema": { "description": "Request to create a new Custom Policy.", "$ref": "#/components/schemas/CustomPolicyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "type": "string", "description": "The location response header contains the URL to the newly created custom policy. The URL includes the eBay-assigned custom_policy_id, which can be used to reference the policy." } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20417": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Maximum custom policy per site is reached" }, "20418": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "This policy name is already used" }, "20411": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing policyType {policyType}" }, "20412": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing label" }, "20413": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing name" }, "20414": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing description" }, "20415": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing marketplaceId" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "409": { "description": "Policy Name already used/ Maximum no of policies per site reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/custom_policy/{custom_policy_id}": { "get": { "tags": [ "custom_policy" ], "description": "This method retrieves the custom policy specified by the custom_policy_id path parameter.", "operationId": "getCustomPolicy", "parameters": [ { "name": "custom_policy_id", "in": "path", "description": "This path parameter is the unique identifier of the custom policy to retrieve.

This ID can be retrieved for a custom policy by using the getCustomPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20416": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing customPolicyId" }, "20415": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing marketplaceId" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "put": { "tags": [ "custom_policy" ], "description": "This method updates an existing custom policy specified by the custom_policy_id path parameter. Since this method overwrites the policy's name, label, and description fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being updated.

For example, the value for the label field is to be updated, but the name and description values will remain unchanged. The existing name and description values, as they are defined in the current policy, must also be passed in.

A successful policy update call returns an HTTP status code of 204 No Content.", "operationId": "updateCustomPolicy", "parameters": [ { "name": "custom_policy_id", "in": "path", "description": "This path parameter is the unique identifier of the custom policy to update.

Note: A list of custom policies defined for a seller's account that includes this ID can be retrieved by calling the getCustomPolicies method.", "required": true, "schema": { "type": "string" } }, { "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.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to update a current custom policy.", "content": { "application/json": { "schema": { "description": "Request to update a current custom policy.", "$ref": "#/components/schemas/CustomPolicyRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20416": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing customPolicyId" }, "20418": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "This policy name is already used" }, "20412": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing label" }, "20413": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing name" }, "20414": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing description" }, "20415": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid/Missing marketplaceId" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Policy Name already used/ Maximum no of policies per site reached", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/fulfillment_policy/": { "post": { "tags": [ "fulfillment_policy" ], "description": "This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers.

A successful request returns the getFulfillmentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

", "operationId": "createFulfillmentPolicy", "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.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request to create a seller account fulfillment policy.", "content": { "application/json": { "schema": { "description": "Request to create a seller account fulfillment policy.", "$ref": "#/components/schemas/FulfillmentPolicyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "type": "string", "description": "The location response header contains the URL to the newly created fulfillment policy. The URL includes the eBay-assigned fulfillmentPolicyId, which you can use to reference the policy." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFulfillmentPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" }, "20201": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/fulfillment_policy/{fulfillmentPolicyId}": { "get": { "tags": [ "fulfillment_policy" ], "description": "This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.", "operationId": "getFulfillmentPolicy", "parameters": [ { "name": "fulfillmentPolicyId", "in": "path", "description": "This path parameter specifies the ID of the fulfillment policy you want to retrieve.

This ID can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "put": { "tags": [ "fulfillment_policy" ], "description": "This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.", "operationId": "updateFulfillmentPolicy", "parameters": [ { "name": "fulfillmentPolicyId", "in": "path", "description": "This path parameter specifies the ID of the fulfillment policy you want to update.

This ID can be retrieved for a specific fulfillment policy by using the getFulfillmentPolicies method.", "required": true, "schema": { "type": "string" } }, { "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": { "description": "Fulfillment policy request", "content": { "application/json": { "schema": { "description": "Fulfillment policy request", "$ref": "#/components/schemas/FulfillmentPolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFulfillmentPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" }, "20201": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace." } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] }, "delete": { "tags": [ "fulfillment_policy" ], "description": "This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.", "operationId": "deleteFulfillmentPolicy", "parameters": [ { "name": "fulfillmentPolicyId", "in": "path", "description": "This path parameter specifies the ID of the fulfillment policy to delete.

This ID can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "21409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default for category type. {additionalInfo}" }, "20409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default policy type. {additionalInfo}" }, "22409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid target default policy. {additionalInfo}" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/fulfillment_policy": { "get": { "tags": [ "fulfillment_policy" ], "description": "This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.", "operationId": "getFulfillmentPolicies", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-fulfillment_policy-getfulfillmentpolicies.marketplaceidenum", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentPolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/fulfillment_policy/get_by_policy_name": { "get": { "tags": [ "fulfillment_policy" ], "description": "This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters.", "operationId": "getFulfillmentPolicyByName", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-fulfillment_policy-getfulfillmentpolicybyname.marketplaceidenum", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.

This value can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/payment_policy": { "get": { "tags": [ "payment_policy" ], "description": "This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace_id query parameter.", "operationId": "getPaymentPolicies", "parameters": [ { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-payment_policy-getpaymentpolicies.marketplaceidenum", "required": true, "schema": { "type": "string" } }, { "name": "Content-Language", "in": "header", "description": "Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "post": { "tags": [ "payment_policy" ], "description": "This method creates a new payment policy where the policy encapsulates seller's terms for order payments.

A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

", "operationId": "createPaymentPolicy", "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": { "description": "Payment policy request", "content": { "application/json": { "schema": { "description": "Payment policy request", "$ref": "#/components/schemas/PaymentPolicyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "type": "string", "description": "The location response header contains the URL to the newly created payment policy. The URL includes the eBay-assigned paymentPolicyId, which you can use to reference the policy." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPaymentPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." }, "20405": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid payment method. {fieldName}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/payment_policy/{payment_policy_id}": { "get": { "tags": [ "payment_policy" ], "description": "This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.", "operationId": "getPaymentPolicy", "parameters": [ { "name": "payment_policy_id", "in": "path", "description": "This path parameter specifies the ID of the payment policy you want to retrieve.

This ID can be retrieved for a payment policy by using the getPaymentPolices method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "put": { "tags": [ "payment_policy" ], "description": "This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.", "operationId": "updatePaymentPolicy", "parameters": [ { "name": "payment_policy_id", "in": "path", "description": "This path parameter specifies the ID of the payment policy you want to update.

This ID can be retrieved for a payment policy by using the getPaymentPolices method.", "required": true, "schema": { "type": "string" } }, { "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": { "description": "Payment policy request", "content": { "application/json": { "schema": { "description": "Payment policy request", "$ref": "#/components/schemas/PaymentPolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPaymentPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." }, "20405": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid payment method. {fieldName}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] }, "delete": { "tags": [ "payment_policy" ], "description": "This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. ", "operationId": "deletePaymentPolicy", "parameters": [ { "name": "payment_policy_id", "in": "path", "description": "This path parameter specifies the unique identifier of the payment policy you want to delete.

This ID can be retrieved for a payment policy by using the getPaymentPolices method.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "21409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default for category type. {additionalInfo}" }, "20409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default policy type. {additionalInfo}" }, "22409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid target default policy. {additionalInfo}" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/payment_policy/get_by_policy_name": { "get": { "tags": [ "payment_policy" ], "description": "This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters.", "operationId": "getPaymentPolicyByName", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-payment_policy-getpaymentpolicies.marketplaceidenum", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "This query parameter specifies the seller-defined name of the payment policy you want to retrieve.

This value can be retrieved for a payment policy by using the getPaymentPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/payments_program/{marketplace_id}/{payments_program_type}": { "get": { "tags": [ "payments_program" ], "description": "Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.
This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.", "operationId": "getPaymentsProgram", "parameters": [ { "name": "marketplace_id", "in": "path", "description": "This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.", "required": true, "schema": { "type": "string" } }, { "name": "payments_program_type", "in": "path", "description": "This path parameter specifies the payments program whose status is returned by the call.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentsProgramResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20408": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "No payment program available. The user may not be registered to the specified site or the site may not be supported by the payments program." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Application error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/payments_program/{marketplace_id}/{payments_program_type}/onboarding": { "get": { "tags": [ "onboarding" ], "description": "Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.
This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.", "operationId": "getPaymentsProgramOnboarding", "parameters": [ { "name": "marketplace_id", "in": "path", "description": "The eBay marketplace ID associated with the onboarding status to retrieve.", "required": true, "schema": { "type": "string" } }, { "name": "payments_program_type", "in": "path", "description": "The type of payments program whose status is returned by the method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentsProgramOnboardingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20408": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "No payments program available. The user may not be registered to the specified site or the site may not be supported by the payments program." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Application error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/privilege": { "get": { "tags": [ "privilege" ], "description": "This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimit (the amount and quantity they can sell on a given day).", "operationId": "getPrivileges", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellingPrivileges" } } } }, "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": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/program/get_opted_in_programs": { "get": { "tags": [ "program" ], "description": "This method gets a list of the seller programs that the seller has opted-in to.", "operationId": "getOptedInPrograms", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Programs" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/program/opt_in": { "post": { "tags": [ "program" ], "description": "This method opts the seller in to an eBay seller program. Refer to the ProgramTypeEnum for information about available eBay seller programs.

Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.", "operationId": "optInToProgram", "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": { "description": "Program being opted-in to.", "content": { "application/json": { "schema": { "description": "Program being opted-in to.", "$ref": "#/components/schemas/Program" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "25803": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "{fieldName} already exists." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/program/opt_out": { "post": { "tags": [ "program" ], "description": "This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the getOptedInPrograms method.", "operationId": "optOutOfProgram", "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": { "description": "Program being opted-out of.", "content": { "application/json": { "schema": { "description": "Program being opted-out of.", "$ref": "#/components/schemas/Program" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "25804": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} already exists" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/rate_table": { "get": { "tags": [ "rate_table" ], "description": "This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables.

The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options.

This call currently supports getting rate tables related to the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables.

Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to Shipping rate tables in My eBay to create and update rate tables.", "operationId": "getRateTables", "parameters": [ { "name": "country_code", "in": "query", "description": "This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-rate_table-getratetables.countrycodeenum", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateTableResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/return_policy": { "get": { "tags": [ "return_policy" ], "description": "This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.", "operationId": "getReturnPolicies", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the ID of the eBay marketplace of the policies you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-payment_policy-getpaymentpolicies.marketplaceidenum", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnPolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "post": { "tags": [ "return_policy" ], "description": "This method creates a new return policy where the policy encapsulates seller's terms for returning items.

Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.

A successful request returns the getReturnPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.

Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.

", "operationId": "createReturnPolicy", "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": { "description": "Return policy request", "content": { "application/json": { "schema": { "description": "Return policy request", "$ref": "#/components/schemas/ReturnPolicyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Location": { "schema": { "type": "string", "description": "The location response header contains the URL to the newly created return policy. The URL includes the eBay-assigned returnPolicyId, which you can use to reference the policy." } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetReturnPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field ." }, "20406": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid return option" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/return_policy/{return_policy_id}": { "get": { "tags": [ "return_policy" ], "description": "This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.", "operationId": "getReturnPolicy", "parameters": [ { "name": "return_policy_id", "in": "path", "description": "This path parameter specifies the unique identifier of the return policy you want to retrieve.

This ID can be retrieved for a return policy by using the getReturnPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "put": { "tags": [ "return_policy" ], "description": "This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.", "operationId": "updateReturnPolicy", "parameters": [ { "name": "return_policy_id", "in": "path", "description": "This path parameter specifies the ID of the return policy you want to update.

This ID can be retrieved for a return policy by using the getReturnPolicies method.", "required": true, "schema": { "type": "string" } }, { "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": { "description": "Container for a return policy request.", "content": { "application/json": { "schema": { "description": "Container for a return policy request.", "$ref": "#/components/schemas/ReturnPolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetReturnPolicyResponse" } } }, "x-response-codes": { "errors": { "20200": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Warning. {additionalInfo}" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}." }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." }, "20406": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid return option. {fieldName}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] }, "delete": { "tags": [ "return_policy" ], "description": "This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.", "operationId": "deleteReturnPolicy", "parameters": [ { "name": "return_policy_id", "in": "path", "description": "This path parameter specifies the unique identifier of the return policy you want to delete.

This ID can be retrieved for a return policy by using the getReturnPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20402": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid input. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "21409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default for category type. {additionalInfo}" }, "20409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid default policy type. {additionalInfo}" }, "22409": { "domain": "API_ACCOUNT", "category": "BUSINESS", "description": "Invalid target default policy. {additionalInfo}" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/return_policy/get_by_policy_name": { "get": { "tags": [ "return_policy" ], "description": "This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters.", "operationId": "getReturnPolicyByName", "parameters": [ { "name": "Content-Language", "in": "header", "description": "Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.", "required": false, "schema": { "type": "string" } }, { "name": "marketplace_id", "in": "query", "description": "This query parameter specifies the ID of the eBay marketplace of the policy you want to retrieve. For implementation help, refer to eBay API documentation at https://developer.ebay.com/develop/api/sell/account_api_v1#sell-account_api_v1-payment_policy-getpaymentpolicies.marketplaceidenum", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "This query parameter specifies the seller-defined name of the return policy you want to retrieve.

This value can be retrieved for a return policy by using the getReturnPolicies method.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." }, "20501": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Service unavailable. Please try again in next 24 hours." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/bulk_create_or_replace_sales_tax": { "post": { "tags": [ "sales_tax" ], "description": "This method creates or updates multiple sales-tax table entries.

Sales-tax tables can be set up for countries that support different tax jurisdictions.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
Each sales-tax table entry comprises the following parameters:
Valid jurisdiction IDs are retrieved using getSalesTaxJurisdictions in the Metadata API.

For details about using this call, refer to Establishing sales-tax tables.

Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.

However, sellers may continue to use a sales-tax table to set rates for the following US territories:

For additional information, refer to Taxes and import charges.

", "operationId": "bulkCreateOrReplaceSalesTax", "requestBody": { "description": "List of sales taxes to be updated", "content": { "application/json": { "schema": { "description": "List of sales taxes to be updated", "$ref": "#/components/schemas/BulkSalesTaxInput" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedSalesTaxResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "207": { "description": "partial success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/sales_tax/{countryCode}/{jurisdictionId}": { "get": { "tags": [ "sales_tax" ], "description": "This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters. All four response fields will be returned if a sales-tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.

Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.

However, sellers may continue to use a sales-tax table to set rates for the following US territories:

For additional information, refer to Taxes and import charges.

", "operationId": "getSalesTax", "parameters": [ { "name": "countryCode", "in": "path", "description": "This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:", "required": true, "schema": { "type": "string" } }, { "name": "jurisdictionId", "in": "path", "description": "This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.

Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.

Note: When countryCode is set to US, the only supported values for jurisdictionId are:", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTax" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20407": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Tax table not supported for {fieldName}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "204": { "description": "No content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] }, "put": { "tags": [ "sales_tax" ], "description": "This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId.

A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.

You can set up sales-tax tables for countries that support different tax jurisdictions.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.

For details about using this call, refer to Establishing sales-tax tables.

Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.

However, sellers may continue to use a sales-tax table to set rates for the following US territories:

For additional information, refer to Taxes and import charges.

", "operationId": "createOrReplaceSalesTax", "parameters": [ { "name": "countryCode", "in": "path", "description": "This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create a sales tax table entry.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:", "required": true, "schema": { "type": "string" } }, { "name": "jurisdictionId", "in": "path", "description": "This path parameter specifies the ID of the tax jurisdiction for the table entry to be created.

Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.

Note: When countryCode is set to US, the only supported values for jurisdictionId are:", "required": true, "schema": { "type": "string" } }, { "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": { "description": "A container that describes the how the sales tax is calculated.", "content": { "application/json": { "schema": { "description": "A container that describes the how the sales tax is calculated.", "$ref": "#/components/schemas/SalesTaxBase" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20404": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "{fieldName} not found." }, "20407": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Tax table not supported for {fieldName}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] }, "delete": { "tags": [ "sales_tax" ], "description": "This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.", "operationId": "deleteSalesTax", "parameters": [ { "name": "countryCode", "in": "path", "description": "This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table entry you want to delete.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:", "required": true, "schema": { "type": "string" } }, { "name": "jurisdictionId", "in": "path", "description": "This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.

Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.

Note: When countryCode is set to US, the only supported values for jurisdictionId are:", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" }, "20407": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Tax table not supported for {fieldName}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } }, "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account" ] } ] } }, "/sales_tax": { "get": { "tags": [ "sales_tax" ], "description": "Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria. If no sales tax rates are defined for the specified, a 204 No Content status code is returned with no response payload.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.

Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.

However, sellers may continue to use a sales-tax table to set rates for the following US territories:

For additional information, refer to Taxes and import charges.

", "operationId": "getSalesTaxes", "parameters": [ { "name": "country_code", "in": "query", "description": "This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are: For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTaxes" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request. {additionalInfo}" }, "20401": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Missing field {fieldName}. {additionalInfo}" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/subscription": { "get": { "tags": [ "subscription" ], "description": "This method retrieves a list of subscriptions associated with the seller account.", "operationId": "getSubscription", "parameters": [ { "name": "limit", "in": "query", "description": "This field is for future use.", "required": false, "schema": { "type": "string" } }, { "name": "continuation_token", "in": "query", "description": "This field is for future use.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid request" }, "20403": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid {fieldName}. {additionalInfo}" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "System error." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/kyc": { "get": { "tags": [ "kyc" ], "description": "Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a 204 No Content HTTP status code. ", "operationId": "getKYC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KycResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "21400": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "This marketplace is not supported. Please refer to documentation." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "20500": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } }, "/advertising_eligibility": { "get": { "tags": [ "advertising_eligibility" ], "description": "This method allows developers to check the seller eligibility status for eBay advertising programs.", "operationId": "getAdvertisingEligibility", "parameters": [ { "name": "program_types", "in": "query", "description": "A comma-separated list of eBay advertising programs for which eligibility status will be returned.

See the AdvertisingProgramEnum type for a list of supported values.

If no programs are specified, the results will be returned for all programs.", "required": false, "schema": { "type": "string" } }, { "name": "X-EBAY-C-MARKETPLACE-ID", "in": "header", "description": "The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. This header is required or the call will fail.

See the MarketplaceIdEnum type for the supported marketplace ID values.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerEligibilityMultiProgramResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "50114": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "The HTTP request header 'X-EBAY-C-MARKETPLACE-ID' is required." }, "50116": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid program_type(s) {programTypes}." }, "50117": { "domain": "API_ACCOUNT", "category": "REQUEST", "description": "Invalid marketplaceId in HTTP request header 'X-EBAY-C-MARKETPLACE-ID' {marketplaceId}." } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "x-response-codes": { "errors": { "35001": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance." }, "35002": { "domain": "API_ACCOUNT", "category": "APPLICATION", "description": "Internal error. Please wait a few minutes and try the call again." } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.account", "https://api.ebay.com/oauth/api_scope/sell.account.readonly" ] } ] } } }, "components": { "schemas": { "AdvertisingProgramEnum": { "type": "object", "description": "An enumerated type that defines the eBay advertising program for which a seller may be eligible. | - **PROMOTED_LISTINGS_STANDARD**: This value indicates that the eBay advertising program is Promoted Listings general campaign strategy (formerly Promoted Listings Standard (PLS)). - **PROMOTED_LISTINGS_ADVANCED**: This value indicates that the eBay advertising program is Promoted listings priority campaign strategy (formerly Promoted Listings Advanced (PLA)). - **OFFSITE_ADS**: This value indicates that the eBay advertising program is Promoted Listings Promoted Offsite (formerly Offsite Ads).", "enum": [ "PROMOTED_LISTINGS_STANDARD", "PROMOTED_LISTINGS_ADVANCED", "OFFSITE_ADS" ] }, "Amount": { "type": "object", "properties": { "currency": { "description": "The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.", "$ref": "#/components/schemas/CurrencyCodeEnum" }, "value": { "type": "string", "description": "The monetary amount in the specified currency." } }, "description": "A complex type that describes the value of a monetary amount as represented by a global currency. When passing in an amount in a request payload, both currency and value fields are required, and both fields are also always returned for an amount in a response field." }, "BulkSalesTaxInput": { "type": "object", "properties": { "salesTaxInputList": { "type": "array", "description": "The array of sales-tax table entries to be created or updated.", "items": { "$ref": "#/components/schemas/SalesTaxInput" } } } }, "CategoryType": { "type": "object", "required": ["name"], "properties": { "default": { "type": "boolean", "description": "Note: This field has been deprecated and is no longer used." }, "name": { "description": "The category type to which the policy applies (motor vehicles or non-motor vehicles).

Note: The MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles.", "$ref": "#/components/schemas/CategoryTypeEnum" } }, "description": "The category type discerns whether the policy applies to motor vehicle listings, or to any other items except motor vehicle listings.

Each business policy can be associated with either or both categories ('MOTORS_VEHICLES' and 'ALL_EXCLUDING_MOTORS_VEHICLES'); however, return business policies are not applicable for motor vehicle listings." }, "CategoryTypeEnum": { "type": "object", "description": "An enum type that describes the category type (motor vehicles or non-motor vehicles). | - **MOTORS_VEHICLES**: This values indicates that the business policy applies to motor vehicle listings. - **ALL_EXCLUDING_MOTORS_VEHICLES**: This values indicates that the business policy applies to all listings besides motor vehicle listings.", "enum": [ "MOTORS_VEHICLES", "ALL_EXCLUDING_MOTORS_VEHICLES" ] }, "CompactCustomPolicyResponse": { "type": "object", "required": ["customPolicyId", "label", "name", "policyType"], "properties": { "customPolicyId": { "type": "string", "description": "The unique custom policy identifier for the policy being returned.

Note: This value is automatically assigned by the system when the policy is created." }, "label": { "type": "string", "description": "Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.

Max length: 65" }, "name": { "type": "string", "description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.

Note: This field is visible only to the seller.
Max length: 65" }, "policyType": { "description": "Specifies the type of Custom Policy being returned.", "$ref": "#/components/schemas/CustomPolicyTypeEnum" } }, "description": "The response payload for requests that return a list of custom policies." }, "CountryCodeEnum": { "type": "object", "description": "This enumerated type lists the two-letter ISO 3166‑1 Alpha‑2 code representing a country. | - **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" ] }, "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", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ] }, "CustomPolicy": { "type": "object", "required": ["customPolicyId", "description", "label", "name", "policyType"], "properties": { "customPolicyId": { "type": "string", "description": "The unique custom policy identifier for a policy." }, "description": { "type": "string", "description": "Contains the seller's policy and policy terms. Buyers access this information from the View Item page for items to which the policy has been applied.

Max length: 15,000" }, "label": { "type": "string", "description": "Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.

Max length: 65" }, "name": { "type": "string", "description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.

Note: This field is visible only to the seller.
Max length: 65" }, "policyType": { "description": "Specifies the type of Custom Policy being returned.", "$ref": "#/components/schemas/CustomPolicyTypeEnum" } }, "description": "This container defines a seller's custom policy identified by policy ID for the selected eBay marketplace. A successful call returns the requested policy information." }, "CustomPolicyCreateRequest": { "type": "object", "required": ["description", "label", "name", "policyType"], "properties": { "description": { "type": "string", "description": "Contains the seller's policy and policy terms.

Max length: 15,000" }, "label": { "type": "string", "description": "Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.

Max length: 65" }, "name": { "type": "string", "description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.

Note: This field is visible only to the seller.
Max length: 65" }, "policyType": { "description": "Specifies the type of custom policy being created.

Two Custom Policy types are supported: ", "$ref": "#/components/schemas/CustomPolicyTypeEnum" } }, "description": "This type is used by the request payload of the createCustomPolicy method to define a new custom policy for a specific marketplace." }, "CustomPolicyRequest": { "type": "object", "required": ["description", "label", "name"], "properties": { "description": { "type": "string", "description": "Contains the seller specified policy and policy terms.

Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.
Max length: 15,000" }, "label": { "type": "string", "description": "Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to seller specified policy information.

Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.
Max length: 65" }, "name": { "type": "string", "description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.

Note: This field is visible only to the seller.
Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.
Max length: 65" } }, "description": "This type is used to request a list of custom policies." }, "CustomPolicyResponse": { "type": "object", "required": ["customPolicies"], "properties": { "customPolicies": { "type": "array", "description": "This array contains the custom policies that match the input criteria.", "items": { "$ref": "#/components/schemas/CompactCustomPolicyResponse" } }, "href": { "type": "string", "description": "This field is for future use." }, "limit": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "next": { "type": "string", "description": "This field is for future use." }, "offset": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "prev": { "type": "string", "description": "This field is for future use." }, "total": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "description": "The response payload for requests that return a list of custom policies."} }, "CustomPolicyTypeEnum": { "type": "object", "description": "An enumeration type that defines the supported types of Custom Policies. | - **PRODUCT_COMPLIANCE**: This enumeration value indicates that the custom policy is a product compliance policy. - **TAKE_BACK**: This enumeration value indicates that the custom policy is a product takeback policy.", "enum": [ "PRODUCT_COMPLIANCE", "TAKE_BACK" ] }, "Deposit": { "type": "object", "properties": { "amount": { "description": "This value indicates the initial deposit amount required from the buyer in order to purchase a motor vehicle. This value can be as high as $2,000.00 if immediate payment is not required, and up to $500.00 if immediate payment is required.

Max: 2000.0", "$ref": "#/components/schemas/Amount" }, "dueIn": { "description": "This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid dueIn times are 24, 48, and 72 hours. HOUR is set as the unit value, and 24, 48 or 72 are set in the value field.

Note: The dueIn value is overridden if the seller has set the motor vehicle listing to require immediate payment. If the listing requires immediate payment, the buyer must pay the deposit immediately in order to be eligible to purchase the motor vehicle.
Minimum: 24 (hours)
Maximum: 72 (hours)
Default: 48 (hours)", "$ref": "#/components/schemas/TimeDuration" }, "paymentMethods": { "type": "array", "description": "This array is no longer applicable and should not be used since eBay now manages the electronic payment options available to buyers to pay the deposit.", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "description": "This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing." }, "DetailsType": { "type": "object", "description": "This enumerated type lists the types of details that may be needed for a KYC check. | - **COMPANY_DETAILS**: This enumeration value indicates that the seller is required to provide information about their company. More information about the check is shown in the detailMessage and other applicable, corresponding fields. - **INDIVIDUAL_DETAILS**: This enumeration value indicates that the seller is required to provide personal information. More information about the check is shown in the detailMessage and other applicable, corresponding fields. - **BANK_DETAILS**: This enumeration value indicates that the seller is required to provide information about their bank. More information about the check is shown in the detailMessage and other applicable, corresponding fields.", "enum": [ "COMPANY_DETAILS", "INDIVIDUAL_DETAILS", "BANK_DETAILS" ] }, "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." }, "ErrorDetailV3": { "type": "object", "properties": { "category": { "type": "string", "description": "The category type for this error or warning. It is a string that can have one of three values:" }, "domain": { "type": "string", "description": "Name of the domain ,or primary system, of the service or application where the error occurred." }, "errorId": { "type": "integer", "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.", "format": "int32" }, "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/ErrorParameterV3" } }, "subdomain": { "type": "string", "description": "If present, indicates the subsystem in which the error occurred." } }, "description": "A container that defines the elements of error and warning messages." }, "ErrorParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "The object of the error." }, "value": { "type": "string", "description": "The value of the object." } } }, "ErrorParameterV3": { "type": "object", "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." } }, "description": "A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error." }, "FulfillmentPolicy": { "type": "object", "required": ["categoryTypes", "freightShipping", "fulfillmentPolicyId", "globalShipping", "localPickup", "marketplaceId", "name", "pickupDropOff"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates whether the fulfillment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250" }, "freightShipping": { "type": "boolean", "description": "If returned as true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs." }, "fulfillmentPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created." }, "globalShipping": { "type": "boolean", "description": "Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).
If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations.

eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy." }, "handlingTime": { "description": "Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

If only local pickup or freight shipping is available for the item, this container may not get returned.

", "$ref": "#/components/schemas/TimeDuration" }, "localPickup": { "type": "boolean", "description": "If returned as true, local pickup is available for this policy." }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this fulfillment policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "pickupDropOff": { "type": "boolean", "description": "If returned as true, the seller offers the \"Click and Collect\" option.

Currently, \"Click and Collect\" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces." }, "shippingOptions": { "type": "array", "description": "This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations).

The optionType field indicates whether the ShippingOption object applies to domestic or international shipping, and the costType field indicates whether flat-rate shipping or calculated shipping will be used.

A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option.

", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "shipToLocations": { "description": "This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.", "$ref": "#/components/schemas/RegionSet" } }, "description": "This type is used by the fulfillmentPolicy response container, a container which defines a seller's fulfillment policy for a specific marketplace." }, "FulfillmentPolicyRequest": { "type": "object", "required": ["categoryTypes", "marketplaceId", "name"], "properties": { "categoryTypes": { "type": "array", "description": "This container is used to specify whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250" }, "freightShipping": { "type": "boolean", "description": "This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.

Default: false" }, "globalShipping": { "type": "boolean", "description": "Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).
This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.

A seller can use a combination of the Global Shipping Program and other international shipping services.

If set to false or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in Setting up worldwide shipping.

Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.

eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.

Default: false

" }, "handlingTime": { "description": "This container is used to specify the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

Valid values can vary by site and by category. To obtain the supported values for a site, call GeteBayDetails in the Trading API with DetailName set to DispatchTimeMaxDetails, then inspect the DispatchTimeMaxDetails container in the response for the time values supported by the site (typical handling times are 0, 1, 2, 3, 4, 5, 10, 15, and 20, but these can vary by site and may change over time.)

This field is conditionally required when the seller is offering one or more domestic or international shipping options, but it is not applicable when the item is only available through local pickup (\"localPickup\": \"true\"), or if it will be shipped through a freight shipping service (\"freightShipping\": \"true\").

Note: Top-Rated sellers must offer same-day or one-day handling for a listing in order for that listing to receive a Top Rated Plus seal on the View Item or Search Results pages. To offer zero-day or one-day handling, set field to '0' or '1', respectively.", "$ref": "#/components/schemas/TimeDuration" }, "localPickup": { "type": "boolean", "description": "This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.

With local pickup, the buyer and seller make arrangements for pickup time and location.

Default: false" }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this fulfillment policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "pickupDropOff": { "type": "boolean", "description": "This field should be included and set to true if the seller offers the \"Click and Collect\" feature for an item.

To enable \"Click and Collect\" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.

In addition to setting this field to true, the merchant must also do the following to enable the \"Click and Collect\" option on a listing:

When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the \"Available for Click and Collect\" option on the listing, along with information on the closest store that has the item.

Default: false" }, "shippingOptions": { "type": "array", "description": "This array is used to provide detailed information on the domestic and international shipping options available for the policy.

A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations).

A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option.

", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "shipToLocations": { "description": "This container consists of the regionIncluded and regionExcluded arrays, which are used to define the geographical regions/countries/states or provinces/domestic regions that a seller does and does not ship to for the associated fulfillment policy. Note that this container can be considered the master list of where the seller ships and does not ship, but there is also a shipToLocations container that can be set at the shipping service option level.

Note: Any shipping exclusions specified through this container can be overridden by the eBay International Shipping exclusions toggle located under Shipping Preferences in My eBay. For more information on eBay International Shipping, see eBay International Shipping program.
To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call GeteBayDetails with DetailName value set to ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in both the regionIncluded.regionName and in the regionExcluded.regionName fields.

For valid geographical region names, look for the ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields.

For valid two-digit country codes, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition. For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields.

The STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post.", "$ref": "#/components/schemas/RegionSet" } }, "description": "This root container defines a seller's fulfillment policy for a specific marketplace and category group. This type is used when creating or updating a fulfillment business policy." }, "FulfillmentPolicyResponse": { "type": "object", "required": ["fulfillmentPolicies", "total"], "properties": { "fulfillmentPolicies": { "type": "array", "description": "A list of all of the seller's fulfillment policies defined for the specified marketplace. This array will be returned as empty if no fulfillment policies are defined for the specified marketplace.", "items": { "$ref": "#/components/schemas/FulfillmentPolicy" } }, "href": { "type": "string", "description": "This field is for future use." }, "limit": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "next": { "type": "string", "description": "This field is for future use." }, "offset": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "prev": { "type": "string", "description": "This field is for future use." }, "total": { "type": "integer", "description": "The total number of fulfillment policies retrieved in the result set.

If no fulfillment policies are defined for the specified marketplace, this field is returned with a value of 0.", "format": "int32" } }, "description": "The response payload for the getFulfillmentPolicies method.

Note: Pagination has not yet been enabled for getFulfillmentPolicies, so all of the pagination-related fields are for future use." }, "InternationalReturnOverrideType": { "type": "object", "properties": { "returnMethod": { "description": "This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return.", "$ref": "#/components/schemas/ReturnMethodEnum" }, "returnPeriod": { "description": "This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked \"delivered\" at the buyer's specified ship-to location.

You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods. For a definitive list of return periods for one or more categories, call getReturnPolicies method of the Metadata API.

The TimeDuration type is used to set/indicate the return period, and you set the unit value to DAY and the value field to either 30 or 60 (or other value, as appropriate).

Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.

This field is conditionally required if the internationalOverride.returnsAccepted field is set to true.", "$ref": "#/components/schemas/TimeDuration" }, "returnsAccepted": { "type": "boolean", "description": "If set to true, the seller accepts international returns. If set to false, the seller does not accept international returns.

This field is conditionally required if the seller chooses to have a separate international return policy." }, "returnShippingCostPayer": { "description": "This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for 'significantly not as described' (SNAD) issues.

This field is conditionally required if the internationalOverride.returnsAccepted field is set to true.", "$ref": "#/components/schemas/ReturnShippingCostPayerEnum" } }, "description": "This type defines the fields for a seller's international return policy. Sellers have the ability to set separate domestic and international return policies, but if an international return policy is not set, the same return policy settings specified for the domestic return policy are also used for returns for international buyers. " }, "KycCheck": { "type": "object", "properties": { "dataRequired": { "description": "The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the detailMessage and other applicable, corresponding fields.", "$ref": "#/components/schemas/DetailsType" }, "dueDate": { "type": "string", "description": "The timestamp in this field indicates the date by which the seller should resolve the KYC requirement.

The timestamp in this field uses the UTC date and time format described in the ISO 8601 Standard. See below for this format and an example:

MM-DD-YYYY HH:MM:SS
06-05-2020 10:34:18" }, "remedyUrl": { "type": "string", "description": "If applicable and available, a URL will be returned in this field, and the link will take the seller to an eBay page where they can provide the requested information." }, "alert": { "type": "string", "description": "This field gives a short summary of what is required from the seller. An example might be, 'Upload bank document now.'. The detailMessage field will often provide more details on what is required of the seller." }, "detailMessage": { "type": "string", "description": "This field gives a detailed message about what is required from the seller. An example might be, 'Please upload a bank document by 2020-08-01 to get your account back in good standing.'." } }, "description": "This type is used to provide details about any KYC check that is applicable to the managed payments seller." }, "KycResponse": { "type": "object", "properties": { "kycChecks": { "type": "array", "description": "This array contains one or more KYC checks required from a managed payments seller. The seller may need to provide more documentation and/or information about themselves, their company, or the bank account they are using for seller payouts.

If no KYC checks are currently required from the seller, this array is not returned, and the seller only receives a 204 No Content HTTP status code.", "items": { "$ref": "#/components/schemas/KycCheck" } } }, "description": "This is the base response type of the getKYC method." }, "MarketplaceIdEnum": { "type": "object", "description": "This enumerated type contains a list of the standard codes that represent each of the eBay marketplaces. | - **EBAY_AT**: eBay Austria (ebay.at) - **EBAY_AU**: eBay Australia (ebay.com/au) - **EBAY_BE**: eBay Belgium (ebay.com/sch/Belgium) - **EBAY_CA**: eBay Canada (English) (ebay.ca) - **EBAY_CH**: eBay Switzerland (ebay.ch) - **EBAY_CN**: eBay China (ebay.com/sch/China) - **EBAY_CZ**: eBay Czech Republic (ebay.com/sch/Czech-Republic) - **EBAY_DE**: eBay Germany (ebay.de) - **EBAY_DK**: eBay Denmark (ebay.com/sch/Denmark) - **EBAY_ES**: eBay Spain (ebay.es) - **EBAY_FI**: eBay Finland (ebay.com/sch/Finland) - **EBAY_FR**: eBay France (ebay.fr) - **EBAY_GB**: eBay UK (ebay.co.uk) - **EBAY_GR**: eBay Greece (ebay.com/sch/Greece) - **EBAY_HK**: eBay Hong Kong (ebay.com.hk) - **EBAY_HU**: eBay Hungary (ebay.com/sch/Hungary) - **EBAY_ID**: eBay Indonesia (id.ebay.com) - **EBAY_IE**: eBay Ireland (ebay.ie) - **EBAY_IL**: eBay Israel (ebay.com/sch/Israel) - **EBAY_IN**: eBay India (ebay.in)
Note: eBay India is no longer a functioning eBay marketplace. - **EBAY_IT**: eBay Italy (ebay.it) - **EBAY_JP**: eBay Japan (ebay.co.jp) - **EBAY_MY**: eBay Malaysia (ebay.com/my) - **EBAY_NL**: eBay Netherlands (ebay.nl) - **EBAY_NO**: eBay Norway (ebay.com/sch/Norway) - **EBAY_NZ**: eBay New Zealand (ebay.com/sch/New-Zealand) - **EBAY_PE**: eBay Peru (ebay.com/sch/Peru) - **EBAY_PH**: eBay Philippines (ebay.ph) - **EBAY_PL**: eBay Poland (ebay.pl) - **EBAY_PR**: eBay Puerto Rico (ebay.com/sch/Puerto-Rico) - **EBAY_PT**: eBay Portugal (ebay.com/sch/Portugal) - **EBAY_RU**: eBay Russia (ebay.com/sch/Russia) - **EBAY_SE**: eBay Sweden (ebay.com/sch/Sweden) - **EBAY_SG**: eBay Singapore (ebay.com/sg) - **EBAY_TH**: eBay Thailand (export.ebay.co.th) - **EBAY_TW**: eBay Taiwan (ebay.com/tw) - **EBAY_US**: eBay US (ebay.com) - **EBAY_VN**: eBay Vietnam (ebay.vn) - **EBAY_ZA**: eBay South Africa (ebay.com/sch/South-Africa) - **EBAY_HALF_US**: This enumeration value is no longer applicable as the Half.com site no longer exists. - **EBAY_MOTORS_US**: eBay Motors US (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" ] }, "PaymentInstrumentBrandEnum": { "type": "object", "description": "An enumerated type defining the supported credit card brand names.

Note: This enumeration type and the values defined in it are no longer applicable, since eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. | - **AMERICAN_EXPRESS**: American Express card - **DISCOVER**: Discover card - **MASTERCARD**: MasterCard - **VISA**: Visa card", "enum": [ "AMERICAN_EXPRESS", "DISCOVER", "MASTERCARD", "VISA" ] }, "PaymentMethod": { "type": "object", "properties": { "brands": { "type": "array", "description": "Note: This array is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including any credit card brands accepted. ", "items": { "$ref": "#/components/schemas/PaymentInstrumentBrandEnum" } }, "paymentMethodType": { "description": "This array is only applicable for listings supporting offline payment methods. See the PaymentMethodTypeEnum type for supported offline payment method enum values. If offline payments are enabled for the policy, provide at least one offline payment method.

", "$ref": "#/components/schemas/PaymentMethodTypeEnum" }, "recipientAccountReference": { "description": "Note: This container is no longer applicable and should not be used. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods, including PayPal. ", "$ref": "#/components/schemas/RecipientAccountReference" } }, "description": "This type is used by the paymentMethods container, which is used by the seller to specify one or more offline payment methods.

Note: eBay now controls all electronic payment methods available for a marketplace, so a seller will no longer use this type to specify any electronic payment methods." }, "PaymentMethodTypeEnum": { "type": "object", "description": "An enumeration type that defines the supported payment methods.

Note: eBay manages all electronic payment methods that are available to buyers, so sellers only need to specify one or more offline payment methods for listings that support or require payment that occurs off of the eBay platform. All electronic payment method enum values are no longer applicable, and are marked as such. | - **CASH_IN_PERSON**: This enumeration value indicates that the payment method will be cash, and the transaction will occur in-person. - **CASH_ON_DELIVERY**: This enumeration value indicates that the payment method will be cash, and the transaction will occur after the item is delivered to the buyer. - **CASH_ON_PICKUP**: This enumeration value indicates that the payment method will be cash, and the transaction will occur when the buyer picks up the item. - **CASHIER_CHECK**: This enumeration value indicates that the payment method will be a Cashier Check. - **CREDIT_CARD**: This payment method is no longer valid. - **ESCROW**: This enumeration value indicates that escrow was used as the payment method to pay for the order. This form of payment is used for high-value orders. - **INTEGRATED_MERCHANT_CREDIT_CARD**: This payment method is no longer valid. - **LOAN_CHECK**: This payment method is no longer valid. - **MONEY_ORDER**: This enumeration value indicates that the payment method will be by a Money Order. - **PAISA_PAY**: This payment method is no longer valid. - **PAISA_PAY_ESCROW**: This payment method is no longer valid. - **PAISA_PAY_ESCROW_EMI**: This payment method is no longer valid. - **PAYPAL**: This payment method is no longer valid. - **PERSONAL_CHECK**: This enumeration value indicates that the payment method will be a Personal check. - **OTHER**: This enumeration value indicates that the seller is offering an offline payment method not otherwise covered.", "enum": [ "CASH_IN_PERSON", "CASH_ON_DELIVERY", "CASH_ON_PICKUP", "CASHIER_CHECK", "CREDIT_CARD", "ESCROW", "INTEGRATED_MERCHANT_CREDIT_CARD", "LOAN_CHECK", "MONEY_ORDER", "PAISA_PAY", "PAISA_PAY_ESCROW", "PAISA_PAY_ESCROW_EMI", "PAYPAL", "PERSONAL_CHECK", "OTHER" ] }, "PaymentPolicy": { "type": "object", "required": ["categoryTypes", "immediatePay", "marketplaceId", "name", "paymentMethods", "paymentPolicyId"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates whether the payment policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "deposit": { "description": "This container is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES, and is only returned if the seller requires an initial deposit on motor vehicles.

The container shows the amount due for the deposit and when it is due (within 1-3 days after commitment to purchase, unless the listing requires immediate payment).

Note: The due date that is specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchasing the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing.

", "$ref": "#/components/schemas/Deposit" }, "description": { "type": "string", "description": "A seller-defined description of the payment policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250" }, "fullPaymentDueIn": { "description": "This container applies to motor vehicles listings only and indicates when a final payment for the vehicle is due. This value is always returned if categoryTypes is set to MOTORS_VEHICLES.

This container indicates the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. The period starts when the buyer commits to buy. The valid values, as specified with TimeDuration, are:A MOTORS_VEHICLES) payment business policy must specify at least one of the following paymentMethods values for the final payment: ", "$ref": "#/components/schemas/TimeDuration" }, "immediatePay": { "type": "boolean", "description": "If this field is returned as true, immediate payment is required from the buyer for: It is possible for the seller to set this field as true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller." }, "marketplaceId": { "description": "The ID of the eBay marketplace to which the payment business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "paymentInstructions": { "type": "string", "description": "Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.

Max length: 1000" }, "paymentMethods": { "type": "array", "description": "This container is returned to show the payment methods that are accepted for the payment business policy.

Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported. ", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "paymentPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created." } }, "description": "This type is used by the paymentPolicy response container, a container which defines a seller's payment business policy for a specific marketplace." }, "PaymentPolicyRequest": { "type": "object", "required": ["categoryTypes", "marketplaceId", "name"], "properties": { "categoryTypes": { "type": "array", "description": "This container is used to specify whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "deposit": { "description": "This container is used if the seller wants to require an initial deposit on a motor vehicle listing. In this container, the seller sets the deposit amount and the due date for the deposit.

Because eBay controls all electronic payment methods, sellers do not need to specify a payment method and the deposit.paymentMethods array is not needed.

Note: The 'due date' specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchase the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing. See immediatePay.

", "$ref": "#/components/schemas/Deposit" }, "description": { "type": "string", "description": "A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250" }, "fullPaymentDueIn": { "description": "This container is used to specify the number of days that a buyer has to make their full payment to the seller and close the remaining balance on a motor vehicle transaction. This container must be specified for motor vehicles listings.

The period starts when the buyer commits to buy. The valid values, as specified with TimeDuration, are:In order for a buyer to make a full payment on a motor vehicle, at least one of the following paymentMethods values must be specified for the corresponding payment business policy: Default: 7 DAYS", "$ref": "#/components/schemas/TimeDuration" }, "immediatePay": { "type": "boolean", "description": "This field should be included and set to true if the seller wants to require immediate payment from the buyer for:
Default: False" }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this payment business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "paymentInstructions": { "type": "string", "description": "

Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.

A free-form string field that allows sellers to add detailed payment instructions to their listings." }, "paymentMethods": { "type": "array", "description": "

Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.

This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "description": "This root container defines a seller's payment business policy for a specific marketplace and category group. This type is used when creating or updating a payment business policy." }, "PaymentPolicyResponse": { "type": "object", "required": ["paymentPolicies", "total"], "properties": { "href": { "type": "string", "description": "This field is for future use." }, "limit": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "next": { "type": "string", "description": "This field is for future use." }, "offset": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "paymentPolicies": { "type": "array", "description": "A list of all of the seller's payment business policies defined for the specified marketplace. This array will be returned as empty if no payment business policies are defined for the specified marketplace.", "items": { "$ref": "#/components/schemas/PaymentPolicy" } }, "prev": { "type": "string", "description": "This field is for future use." }, "total": { "type": "integer", "description": "The total number of payment business policies retrieved in the result set.

If no payment business policies are defined for the specified marketplace, this field is returned with a value of 0.", "format": "int32" } }, "description": "The response payload for the getPaymentPolicies method.

Note: Pagination has not yet been enabled for getPaymentPolicies, so all of the pagination-related fields are for future use." }, "PaymentsProgramOnboardingResponse": { "type": "object", "required": ["onboardingStatus", "steps"], "properties": { "onboardingStatus": { "description": "This enumeration value indicates the eligibility of payment onboarding for the registered site.", "$ref": "#/components/schemas/PaymentsProgramOnboardingStatus" }, "steps": { "type": "array", "description": "An array of the active process steps for payment onboarding and the status of each step. This array includes the step name, step status, and a webUrl to the IN_PROGRESS step. The step names are returned in sequential order. ", "items": { "$ref": "#/components/schemas/PaymentsProgramOnboardingSteps" } } }, "description": "Type used by the payments program onboarding response" }, "PaymentsProgramOnboardingStatus": { "type": "object", "description": "This enumeration value indicates the eligibility of payment onboarding for the registered site. | - **ELIGIBLE_TO_ONBOARD**: This enumeration value indicates that the seller can start or continue the onboarding process. When starting the onboarding process, the first step in the registration process is returned in the steps array with a status of NOT_STARTED. A link in the webUrl field opens a page for the seller to complete the first step. When the seller has completed all steps, the payments capability becomes available to the seller. - **NOT_ELIGIBLE**: This enumeration value indicates that the seller's marketplace supports eBay managed payments, but the seller is not yet eligible. Eligibility is determined by eBay daily. Check onboardingStatus regularly. - **PREBOARDED**: This enumeration value indicates that the seller has completed all the necessary onboarding steps for eBay managed payments. The seller must wait for eBay to activate eBay managed payments for their account. - **ONBOARDED**: This enumeration value indicates that the seller is fully onboarded and that eBay managed payments has been activated on the seller's account.", "enum": [ "ELIGIBLE_TO_ONBOARD", "NOT_ELIGIBLE", "PREBOARDED", "ONBOARDED" ] }, "PaymentsProgramOnboardingStepStatus": { "type": "object", "description": "This enumeration value indicates the status of the present onboarding step. | - **NOT_STARTED**: This enumeration value indicates that the present step has not started. - **IN_PROGRESS**: This enumeration value indicates that the present step has started but has not completed. - **COMPLETED**: This enumeration value indicates that the present step has completed.", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "PaymentsProgramOnboardingSteps": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names. " }, "status": { "description": "This enumeration value indicates the status of the associated step.

Note: Only one step can be IN_PROGRESS at a time.

", "$ref": "#/components/schemas/PaymentsProgramOnboardingStepStatus" }, "webUrl": { "type": "string", "description": "This URL provides access to the IN_PROGRESS step." } }, "description": "The payments program onboarding steps, status, and link." }, "PaymentsProgramResponse": { "type": "object", "required": ["marketplaceId", "paymentsProgramType", "status", "wasPreviouslyOptedIn"], "properties": { "marketplaceId": { "description": "The ID of the eBay marketplace to which the payment program applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "paymentsProgramType": { "description": "This parameter specifies the payment program whose status is returned by the call.

Currently the only supported payments program is EBAY_PAYMENTS.", "$ref": "#/components/schemas/PaymentsProgramType" }, "status": { "description": "The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program.", "$ref": "#/components/schemas/PaymentsProgramStatus" }, "wasPreviouslyOptedIn": { "type": "boolean", "description": "If returned as true, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of false indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it.

It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program. It is possible for this field to return true while the status field returns OPTED_IN." } }, "description": "The response object containing the sellers status with regards to the specified payment program." }, "PaymentsProgramStatus": { "type": "object", "description": "This enumerated type defines the different possible statuses relating to whether or not a seller is opted-in to a payments program. | - **OPTED_IN**: Status indicating the seller is opted-in to the associated payment program. - **NOT_OPTED_IN**: Status indicating the seller is not opted-in to the associated payment program.", "enum": [ "OPTED_IN", "NOT_OPTED_IN" ] }, "PaymentsProgramType": { "type": "object", "description": "This enumerated type defines the supported payment programs. | - **EBAY_PAYMENTS**: This value indicates the eBay-managed payments program.", "enum": [ "EBAY_PAYMENTS" ] }, "Program": { "type": "object", "required": ["programType"], "properties": { "programType": { "description": "The seller program to opt in to when part of an optInToProgram request, or out of when part of an optOutOfProgram request. When returned in an getOptedInPrograms response, a separate programType field is returned for each seller program that the seller is opted in to.", "$ref": "#/components/schemas/ProgramTypeEnum" } }, "description": "The seller program to opt in to when part of an optInToProgram request, or out of when part of an optOutOfProgram request." }, "ProgramTypeEnum": { "type": "object", "description": "This enumerated type defines the supported seller programs. | - **OUT_OF_STOCK_CONTROL**: If a seller's account is opted in to the out-of-stock control program, active fixed-price listings will be kept 'alive' (but not surfaced in search results) even when the quantity for the listing has been depleted to 0. This feature allows the seller to update/revise the listing with more quantity, and prevents the seller from having to relist the item. - **PARTNER_MOTORS_DEALER**: The Partner Motors Program that sellers can participate in by opting-in to the program. Sellers must be registered business users to opt-in to this program. - **SELLING_POLICY_MANAGEMENT**: If a seller's account is opted in to this program, sellers can associate business policies (payment, return policy, fulfillment) to their listings. Being opted in to business policies is a requirement for using the Inventory API.", "enum": [ "OUT_OF_STOCK_CONTROL", "PARTNER_MOTORS_DEALER", "SELLING_POLICY_MANAGEMENT" ] }, "Programs": { "type": "object", "required": ["programs"], "properties": { "programs": { "type": "array", "description": "An array of seller programs that the seller's account is opted in to. An empty array is returned if the seller is not opted in to any of the seller programs.", "items": { "$ref": "#/components/schemas/Program" } } }, "description": "The base response type of the getOptedInPrograms method." }, "RateTable": { "type": "object", "required": ["countryCode", "locality", "name", "rateTableId"], "properties": { "countryCode": { "description": "A two-letter ISO 3166 country code representing the eBay marketplace where the shipping rate table is defined.", "$ref": "#/components/schemas/CountryCodeEnum" }, "locality": { "description": "This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table.", "$ref": "#/components/schemas/ShippingOptionTypeEnum" }, "name": { "type": "string", "description": "The seller-defined name for the shipping rate table." }, "rateTableId": { "type": "string", "description": "A unique eBay-assigned ID for a seller's shipping rate table. These rateTableId values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API." } }, "description": "This type is used to provide details about each shipping rate table that is returned in the getRateTables response." }, "RateTableResponse": { "type": "object", "required": ["rateTables"], "properties": { "rateTables": { "type": "array", "description": "An array of all shipping rate tables defined for a marketplace (or all marketplaces if no country_code query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.", "items": { "$ref": "#/components/schemas/RateTable" } } }, "description": "This type is the base response of the getRateTables method." }, "RecipientAccountReference": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods." }, "referenceType": { "description": "Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.", "$ref": "#/components/schemas/RecipientAccountReferenceTypeEnum" } }, "description": "Note: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods." }, "RecipientAccountReferenceTypeEnum": { "type": "object", "description": "Note: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. | - **PAYPAL_EMAIL**: This is the PayPal email address of the seller.", "enum": [ "PAYPAL_EMAIL" ] }, "RefundMethodEnum": { "type": "object", "description": "This enumerated type defines the supported refund types for buyer returns. | - **MERCHANDISE_CREDIT**: Do not use/No longer supported. - **MONEY_BACK**: This enumeration value indicates that the buyer will get their money back (refund) for a returned item.", "enum": [ "MERCHANDISE_CREDIT", "MONEY_BACK" ] }, "Region": { "type": "object", "properties": { "regionName": { "type": "string", "description": "A string that indicates the name of a region, as defined by eBay. A \"region\" can be either a 'world region' (e.g., the \"Middle East\" or \"Southeast Asia\"), a country (represented with a two-letter country code), a state or province (represented with a two-letter code), or a special domestic region within a country.

The GeteBayDetails call in the Trading API can be used to retrieve the world regions and special domestic regions within a specific country. To get these enumeration values, call GeteBayDetails with the DetailName value set to ExcludeShippingLocationDetails." }, "regionType": { "description": "Reserved for future use. ", "$ref": "#/components/schemas/RegionTypeEnum" } }, "description": "This type is used to define specific shipping regions. There are four 'levels' of shipping regions, including large geographical regions (like 'Asia', 'Europe', or 'Middle East'), individual countries, US states or Canadian provinces, and special locations/domestic regions within a country (like 'Alaska/Hawaii' or 'PO Box')." }, "RegionSet": { "type": "object", "required": ["regionExcluded", "regionIncluded"], "properties": { "regionExcluded": { "type": "array", "description": "An array of one or more regionName values that specify the areas to where a seller does not ship. A regionExcluded list should only be set in the top-level shipToLocations container and not within the shippingServices.shipToLocations container used to specify which shipping regions are serviced by each available shipping service option.

Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.

This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.

Note: The regionExcluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.", "items": { "$ref": "#/components/schemas/Region" } }, "regionIncluded": { "type": "array", "description": "An array of one or more regionName fields that specify the areas to where a seller ships.

Each eBay marketplace supports its own set of allowable shipping locations.

Note: The regionIncluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.", "items": { "$ref": "#/components/schemas/Region" } } }, "description": "This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship." }, "RegionTypeEnum": { "type": "object", "description": "This enumerated type defines shipping region types.
Note: These enumeration values are not currently being used by fulfillment policy methods, but may be used in the future. | - **COUNTRY**: A single country. - **COUNTRY_REGION**: A domestic region or special location within a country. In the US, these domestic region/special location include 'Alaska/Hawaii' and 'PO Box'. - **STATE_OR_PROVINCE**: A state or province, such as California (CA) or New York (NY) in the US, or British Columbia (BC) or Ontario (ON) in Canada. - **WORLD_REGION**: A world region, such as Europe, the Middle East, or Southeast Asia. - **WORLDWIDE**: The entire world as we know it.", "enum": [ "COUNTRY", "COUNTRY_REGION", "STATE_OR_PROVINCE", "WORLD_REGION", "WORLDWIDE" ] }, "ReturnMethodEnum": { "type": "object", "description": "This enumerated type lists the return options (other than 'money back') that a seller may offer to the buyer for a return request. | - **EXCHANGE**: Do not use/No longer supported. - **REPLACEMENT**: This value indicates that the seller offers a replacement (identical) item as an alternative to 'money back' when the buyer is returning an item.", "enum": [ "EXCHANGE", "REPLACEMENT" ] }, "ReturnPolicy": { "type": "object", "required": ["categoryTypes", "marketplaceId", "name", "refundMethod", "returnPolicyId", "returnsAccepted"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250" }, "extendedHolidayReturnsOffered": { "type": "boolean", "description": "

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

" }, "internationalOverride": { "description": "This container shows the seller's international return policy settings. This container is only returned if the seller has set a separate international return policy for the business policy. International return policies are optional, even if the seller ships to international locations. If a separate international return policy is not set, all of the domestic return policy settings also apply to international orders.", "$ref": "#/components/schemas/InternationalReturnOverrideType" }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this return business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "refundMethod": { "description": "This field indicates the refund method offered by the seller. Its value will be MONEY_BACK unless the seller is enabled for Buy online, Pickup in Store or Click and Collect, and then it might be MERCHANDISE_CREDIT. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.", "$ref": "#/components/schemas/RefundMethodEnum" }, "restockingFeePercentage": { "type": "string", "description": "

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.

" }, "returnInstructions": { "type": "string", "description": "This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)" }, "returnMethod": { "description": "This field is only returned if the seller is willing to offer a replacement item as an alternative to 'Money Back'.", "$ref": "#/components/schemas/ReturnMethodEnum" }, "returnPeriod": { "description": "This container indicates the number of calendar days that the buyer has to return an item. The return period begins when the item is marked \"delivered\" at the buyer's specified ship-to location.

Most categories support 30-day and 60-day return periods.

Note: Unless the seller has set a separate international return policy through the internationalOverride container, this return period will be valid for domestic and international returns (if the seller ships internationally).", "$ref": "#/components/schemas/TimeDuration" }, "returnPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created." }, "returnsAccepted": { "type": "boolean", "description": "If this field is returned as true, the seller accepts returns. If set to false, the seller does not accept returns.

Note: Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits." }, "returnShippingCostPayer": { "description": "This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.", "$ref": "#/components/schemas/ReturnShippingCostPayerEnum" } }, "description": "This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace." }, "ReturnPolicyRequest": { "type": "object", "required": ["categoryTypes", "marketplaceId", "name", "returnsAccepted"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates which category group that the return policy applies to.

Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.

Max length: 250" }, "extendedHolidayReturnsOffered": { "type": "boolean", "description": "

Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.

" }, "internationalOverride": { "description": "This container is used by the seller to specify a separate international return policy. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders.", "$ref": "#/components/schemas/InternationalReturnOverrideType" }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this return business policy applies. ", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "refundMethod": { "description": "This field sets the refund method to use for returned items. Its value defaults to MONEY_BACK if omitted, so this field is only needed for Buy online, Pickup in Store or Click and Collect items where the seller is willing to offer merchandise credit as an additional refund method to buyers. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.

Important! If this field is not included in a return business policy, it will default to MONEY_BACK.

", "$ref": "#/components/schemas/RefundMethodEnum" }, "restockingFeePercentage": { "type": "string", "description": "

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.

" }, "returnInstructions": { "type": "string", "description": "This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)" }, "returnMethod": { "description": "This field can be used if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'.", "$ref": "#/components/schemas/ReturnMethodEnum" }, "returnPeriod": { "description": "This container is used to specify the number of days that the buyer has to return an item. The return period begins when the item is marked \"delivered\" at the buyer's specified ship-to location.

You must set the value to one that's accepted by the marketplace and category where the item is listed. Most categories support 30-day and 60-day return periods.

Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.


For a definitive list of return periods for one or more categories, call getReturnPolicies method of the Metadata API.

The return period is set using the TimeDuration type, where you set unit to DAY and value to either 30 or 60 (or other value, as appropriate).

Note that this value cannot be modified if the listing has bids or sales, or if the listing ends within 12 hours.

Required if returnsAccepted is set to true.", "$ref": "#/components/schemas/TimeDuration" }, "returnsAccepted": { "type": "boolean", "description": "If set to true, the seller accepts returns. If set to false, the seller does not accept returns.

Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits.

" }, "returnShippingCostPayer": { "description": "This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.


Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This field is conditionally required if returnsAccepted is set to true.", "$ref": "#/components/schemas/ReturnShippingCostPayerEnum" } }, "description": "This root container defines a seller's return business policy for a specific marketplace and category group. This type is used when creating or updating a return business policy." }, "ReturnPolicyResponse": { "type": "object", "required": ["returnPolicies", "total"], "properties": { "href": { "type": "string", "description": "This field is for future use." }, "limit": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "next": { "type": "string", "description": "This field is for future use." }, "offset": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "prev": { "type": "string", "description": "This field is for future use." }, "returnPolicies": { "type": "array", "description": "A list of all of the seller's return business policies defined for the specified marketplace. This array will be returned as empty if no return business policies are defined for the specified marketplace.", "items": { "$ref": "#/components/schemas/ReturnPolicy" } }, "total": { "type": "integer", "description": "The total number of return business policies retrieved in the result set.

If no return business policies are defined for the specified marketplace, this field is returned with a value of 0.", "format": "int32" } }, "description": "The response payload for the getReturnPolicies method.

Note: Pagination has not yet been enabled for getReturnPolicies, so all of the pagination-related fields are for future use." }, "ReturnShippingCostPayerEnum": { "type": "object", "description": "This enumerated type defines who is responsible for the return shipping cost. Note that the seller is always responsible for the return shipping cost of SNAD-related returns. | - **BUYER**: Return shipping cost paid by BUYER. - **SELLER**: Return shipping cost paid by SELLER.", "enum": [ "BUYER", "SELLER" ] }, "SalesTax": { "type": "object", "properties": { "countryCode": { "description": "The country code enumeration value identifies the country to which this sales tax rate applies.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:
  • US
  • CA
", "$ref": "#/components/schemas/CountryCodeEnum" }, "salesTaxJurisdictionId": { "type": "string", "description": "A unique ID that identifies the sales tax jurisdiction to which the sales tax rate applies.

Note: When the returned countryCode is US, the only supported return values for salesTaxJurisdictionId are:
  • AS (American Samoa)
  • GU (Guam
  • MP Northern Mariana Islands
  • PW (Palau)
  • VI (US Virgin Islands)
" }, "salesTaxPercentage": { "type": "string", "description": "The sales tax rate that will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is returned here, such as 7.75" }, "shippingAndHandlingTaxed": { "type": "boolean", "description": "If returned as true, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order." } }, "description": "This type is used to provide sales tax settings for a specific tax jurisdiction." }, "SalesTaxBase": { "type": "object", "required": ["salesTaxPercentage", "shippingAndHandlingTaxed"], "properties": { "salesTaxPercentage": { "type": "string", "description": "This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is set here, such as 7.75." }, "shippingAndHandlingTaxed": { "type": "boolean", "description": "This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false." } }, "description": "This type is used by the base request of the createOrReplaceSalesTax. " }, "SalesTaxInput": { "type": "object", "required": ["countryCode", "salesTaxJurisdictionId", "salesTaxPercentage", "shippingAndHandlingTaxed"], "properties": { "countryCode": { "type": "string", "description": "This parameter specifies the two-letter ISO 3166 code of the country for which a sales-tax table entry is to be created or updated.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:
  • US
  • CA
" }, "salesTaxJurisdictionId": { "type": "string", "description": "This parameter specifies the ID of the tax jurisdiction for which a sales-tax table entry is to be created or updated.

Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.

Note: When countryCode is set to US, the only supported values for jurisdictionId are:
  • AS (American Samoa)
  • GU (Guam)
  • MP (Northern Mariana Islands)
  • PW (Palau)
  • VI (US Virgin Islands)
" }, "salesTaxPercentage": { "type": "string", "description": "This parameter specifies the sales tax rate for the specified salesTaxJurisdictionId. When applicable to an order, this sales tax rate will be applied to the sales price. The shippingAndHandlingTaxed value indicates whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is set here, such as 7.75." }, "shippingAndHandlingTaxed": { "type": "boolean", "description": "This parameter is set to true if the seller wishes to apply sales tax to shipping and handling charges and not just the total sales price of an order. Otherwise, this parameter's value should be set to false." } } }, "SalesTaxes": { "type": "object", "properties": { "salesTaxes": { "type": "array", "description": "An array of one or more sales-tax rate entries for a specified country.

If no sales-tax rate entries are set up, no response payload is returned, but an HTTP status code of 204 No Content is returned.", "items": { "$ref": "#/components/schemas/SalesTax" } } }, "description": "This type is used by the root response of the getSalesTaxes method." }, "SellerEligibilityEnum": { "type": "object", "description": "This enumerated type defines the seller eligibility status for a specified eBay advertising program. | - **ELIGIBLE**: This value indicates that the seller is eligible for the specified eBay advertising program. - **INELIGIBLE**: This value indicates that the seller is ineligible for the specified eBay advertising program.", "enum": [ "ELIGIBLE", "INELIGIBLE" ] }, "SellerEligibilityMultiProgramResponse": { "type": "object", "required": ["advertisingEligibility"], "properties": { "advertisingEligibility": { "type": "array", "description": "An array of response fields that define the seller eligibility for eBay advertising programs.", "items": { "$ref": "#/components/schemas/SellerEligibilityResponse" } } }, "description": "The base response of the getAdvertisingEligibility method that contains the seller eligibility information for one or more advertising programs." }, "SellerEligibilityResponse": { "type": "object", "required": ["programType", "status"], "properties": { "programType": { "description": "The eBay advertising program for which a seller may be eligible.", "$ref": "#/components/schemas/AdvertisingProgramEnum" }, "reason": { "description": "The reason why a seller is ineligible for the specified eBay advertising program.

This field is only returned if the seller is ineligible for the eBay advertising program.", "$ref": "#/components/schemas/SellerIneligibleReasonEnum" }, "status": { "description": "The seller eligibility status for the specified eBay advertising program.", "$ref": "#/components/schemas/SellerEligibilityEnum" } }, "description": "A type that is used to provide the seller's eligibility status for an eBay advertising program." }, "SellerIneligibleReasonEnum": { "type": "object", "description": "This enumerated type defines the reason why a seller is ineligible for an eBay advertising program. | - **NOT_ENOUGH_ACTIVITY**: This value indicates that the seller is ineligible for the eBay advertising program due to lack of activity.

New accounts take a few weeks to become eligible for eBay Promoted Listings. If the seller account is in good standing (Above Standard or Top Rated), the account should become eligible within a few weeks. - **NOT_IN_GOOD_STANDING**: This value indicates that the seller is ineligible for the eBay advertising program because their account is not currently in good standing.

Below Standard sellers cannot use eBay advertising programs to create new campaigns or edit their existing campaigns. Existing campaigns will be paused by the system. - **RESTRICTED**: This value indicates that the seller is currently restricted from using the corresponding eBay advertising program.", "enum": [ "NOT_ENOUGH_ACTIVITY", "NOT_IN_GOOD_STANDING", "RESTRICTED" ] }, "SellingLimit": { "type": "object", "properties": { "amount": { "description": "This container shows the monthly cap for total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total sales amount.", "$ref": "#/components/schemas/Amount" }, "quantity": { "type": "integer", "description": "This field shows the monthly cap for total quantity sold allowed for the seller's account. This field may not be returned if a seller does not have a monthly cap for total quantity sold.", "format": "int32" } }, "description": "Type used by the sellingLimit container, a container that lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account." }, "SellingPrivileges": { "type": "object", "required": ["sellerRegistrationCompleted"], "properties": { "sellerRegistrationCompleted": { "type": "boolean", "description": "If this field is returned as true, the seller's registration is completed. If this field is returned as false, the registration process is not complete." }, "sellingLimit": { "description": "This container lists the monthly cap for the quantity of items sold and total sales amount allowed for the seller's account. This container may not be returned if a seller does not have a monthly cap for total quantity sold and total sales amount.

Note: The selling limit value returned in getPrivileges may vary slightly from the value displayed in Seller Hub. The value in Seller Hub is an abbreviated figure, where rounding is applied.

", "$ref": "#/components/schemas/SellingLimit" } }, "description": "This type is used by the base response of the getPrivileges method." }, "SetFulfillmentPolicyResponse": { "type": "object", "required": ["categoryTypes", "freightShipping", "fulfillmentPolicyId", "globalShipping", "localPickup", "marketplaceId", "name", "pickupDropOff", "shipToLocations", "warnings"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates whether the fulfillment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250" }, "freightShipping": { "type": "boolean", "description": "If returned as true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs." }, "fulfillmentPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created." }, "globalShipping": { "type": "boolean", "description": "Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).
This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.

A seller can use a combination of the Global Shipping Program and other international shipping services.

If set to false or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in Setting up worldwide shipping.

Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.

eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy." }, "handlingTime": { "description": "Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. This time does not include the transit time it takes the shipping carrier to deliver the order.

If only local pickup or freight shipping is available for the item, this container may not get returned.

", "$ref": "#/components/schemas/TimeDuration" }, "localPickup": { "type": "boolean", "description": "If returned as true, local pickup is available for items using this policy." }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this fulfillment business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this fulfillment business policy.

Max length: 64" }, "pickupDropOff": { "type": "boolean", "description": "If returned as true, the seller offers the \"Click and Collect\" option.

Currently, \"Click and Collect\" is available only to large retail merchants the eBay AU, UK, DE, FR, and IT marketplaces." }, "shippingOptions": { "type": "array", "description": "This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations).

The optionType field indicates whether the ShippingOption object applies to domestic or international shipping, and the costType field indicates whether flat-rate shipping or calculated shipping will be used.

A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option.

", "items": { "$ref": "#/components/schemas/ShippingOption" } }, "shipToLocations": { "description": "This container consists of the regionIncluded and regionExcluded containers, which define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.", "$ref": "#/components/schemas/RegionSet" }, "warnings": { "type": "array", "description": "An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "Complex type that that gets populated with a response containing a fulfillment policy." }, "SetPaymentPolicyResponse": { "type": "object", "required": ["categoryTypes", "immediatePay", "marketplaceId", "name", "paymentMethods", "paymentPolicyId", "warnings"], "properties": { "categoryTypes": { "type": "array", "description": "This container indicates whether the payment business policy applies to motor vehicle listings, or if it applies to non-motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "deposit": { "description": "This container is only returned if the seller just created or updated a motor vehicles payment business policy and requires buyers to pay an initial deposit after they commit to buying a motor vehicle.", "$ref": "#/components/schemas/Deposit" }, "description": { "type": "string", "description": "A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250" }, "fullPaymentDueIn": { "description": "The number of days (after the buyer commits to buy) that a buyer has to pay the remaining balance of a motor vehicle transaction. Sellers can set this value to 3, 7, 10, or 14 days.

Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES.

", "$ref": "#/components/schemas/TimeDuration" }, "immediatePay": { "type": "boolean", "description": "The value returned in this field will reflect the value set by the seller in the immediatePay request field. A value of true indicates that immediate payment is required from the buyer for:
  • A fixed-price item
  • An auction item where the buyer is using the 'Buy it Now' option
  • A deposit for a motor vehicle listing
It is possible for the seller to set this field as true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller." }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this payment business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "paymentInstructions": { "type": "string", "description": "

Note: NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.

A free-form string field that allows sellers to add detailed payment instructions to their listings." }, "paymentMethods": { "type": "array", "description": "This array shows the available payment methods that the seller has set for the payment business policy.

Sellers do not have to specify any electronic payment methods for listings, so this array will often be returned empty unless the payment business policy is intended for motor vehicle listings or other items in categories where offline payments are required or supported.", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "paymentPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for a payment business policy. This ID is generated when the policy is created." }, "warnings": { "type": "array", "description": "An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "Complex type that that gets populated with a response containing a payment policy." }, "SetReturnPolicyResponse": { "type": "object", "required": ["categoryTypes", "marketplaceId", "name", "returnPolicyId", "returnsAccepted", "returnShippingCostPayer", "warnings"], "properties": { "categoryTypes": { "type": "array", "description": "This field always returns ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings.", "items": { "$ref": "#/components/schemas/CategoryType" } }, "description": { "type": "string", "description": "A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages. This field is returned if set for the policy.

Max length: 250" }, "extendedHolidayReturnsOffered": { "type": "boolean", "description": "

Important! This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.

" }, "internationalOverride": { "description": "This container is used by the seller to specify a separate international return policy, and will only be returned if the seller has set a separate return policy for international orders. If a separate international return policy is not defined by a seller, all of the domestic return policy settings will also apply to international orders.", "$ref": "#/components/schemas/InternationalReturnOverrideType" }, "marketplaceId": { "description": "The ID of the eBay marketplace to which this return business policy applies.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "name": { "type": "string", "description": "A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.

Max length: 64" }, "refundMethod": { "description": "If a seller indicates that they will accept buyer returns, this value will be MONEY_BACK.", "$ref": "#/components/schemas/RefundMethodEnum" }, "restockingFeePercentage": { "type": "string", "description": "

Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.

" }, "returnInstructions": { "type": "string", "description": "This text-based field provides more details on seller-specified return instructions.

Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.


Max length: 5000 (8000 for DE)" }, "returnMethod": { "description": "This field will be returned if the seller is willing and able to offer a replacement item as an alternative to 'Money Back'.", "$ref": "#/components/schemas/ReturnMethodEnum" }, "returnPeriod": { "description": "This container specifies the amount of days that the buyer has to return the item after receiving it. The return period begins when the item is marked \"delivered\" at the buyer's specified ship-to location. This container will be returned unless the business policy states that the seller does not accept returns.

Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.

", "$ref": "#/components/schemas/TimeDuration" }, "returnPolicyId": { "type": "string", "description": "A unique eBay-assigned ID for a return business policy. This ID is generated when the policy is created." }, "returnsAccepted": { "type": "boolean", "description": "If set to true, the seller accepts returns. If set to false, this field indicates that the seller does not accept returns." }, "returnShippingCostPayer": { "description": "This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details.


Note that the seller is always responsible for return shipping costs for SNAD-related issues.

This container will be returned unless the business policy states that the seller does not accept returns.", "$ref": "#/components/schemas/ReturnShippingCostPayerEnum" }, "warnings": { "type": "array", "description": "An array of one or more errors or warnings that were generated during the processing of the request. If there were no issues with the request, this array will return empty.", "items": { "$ref": "#/components/schemas/ErrorDetailV3" } } }, "description": "A complex type that is populated with a response containing a return policies." }, "ShippingCostTypeEnum": { "type": "object", "description": "This enumerated type defines the shipping cost models. | - **CALCULATED**: This value indicates that calculated shipping is used by the seller. With calculated shipping, the shipping cost varies according to the shipping location and the size and weight of the package. - **FLAT_RATE**: This value indicates that flat-rate shipping is used by the seller. With flat-rate shipping, the shipping cost will be the same for all buyers, or buyers within a specified region if the seller uses shipping rate tables. - **NOT_SPECIFIED**: This value indicates that the shipping cost type has not been specified.", "enum": [ "CALCULATED", "FLAT_RATE", "NOT_SPECIFIED" ] }, "ShippingOption": { "type": "object", "properties": { "costType": { "description": "This field defines whether the shipping cost model is FLAT_RATE (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package).

This field is conditionally required if any shipping service options are specified (domestic and/or international).", "$ref": "#/components/schemas/ShippingCostTypeEnum" }, "insuranceFee": { "description": "This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies.", "$ref": "#/components/schemas/Amount" }, "insuranceOffered": { "type": "boolean", "description": "This field has been deprecated.

Shipping insurance is offered only via a shipping carrier's shipping services and is no longer available via eBay shipping policies." }, "optionType": { "description": "This field is used to indicate if the corresponding shipping service options (under shippingServices array) are domestic or international shipping service options. This field is conditionally required if any shipping service options are specified (domestic and/or international).", "$ref": "#/components/schemas/ShippingOptionTypeEnum" }, "packageHandlingCost": { "description": "This container is used if the seller adds handling charges to domestic and/or international shipments.

Sellers can not specify any domestic handling charges if they offered 'free shipping' in the policy.

This container will only be returned if set for the policy.", "$ref": "#/components/schemas/Amount" }, "rateTableId": { "type": "string", "description": "This field is used if the seller wants to associate a domestic or international shipping rate table to the fulfillment business policy. The getRateTables method can be used to retrieve shipping rate table IDs.

With domestic and international shipping rate tables, the seller can set different shipping costs based on shipping regions and shipping speed/level of service (one-day, expedited, standard, economy). There are also options to add additional per-weight and handling charges.

Sellers need to be careful that shipping rate tables match the corresponding shipping service options. In other words, a domestic shipping rate table must not be specified in the same container where international shipping service options are being specified, and vice versa, and the shipping speed/level of service of the provided shipping service options should match the shipping speed/level of service options that are defined in the shipping rate tables.

For example, if the corresponding shipping rate table defines costs for one-day shipping services, there should be at least one one-day shipping service option specified under the shippingServices array.

This field is returned if set." }, "shippingDiscountProfileId": { "type": "string", "description": "This field is the unique identifier of a seller's domestic or international shipping discount profile. If a buyer satisfies the requirements of the discount rule, this buyer will receive a shipping discount for the order.

The seller can create and manage shipping discount profiles using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay." }, "shippingPromotionOffered": { "type": "boolean", "description": "This boolean indicates whether or not the seller has set up a promotional shipping discount that will be available to buyers who satisfy the requirements of the shipping discount rule.

The seller can create and manage shipping promotional discounts using (Get/Set) ShippingDiscountProfiles calls in the Trading API or through the Shipping Preferences in My eBay." }, "shippingServices": { "type": "array", "description": "This array consists of the domestic or international shipping services options that are defined for the policy. The shipping service options defined under this array should match what is set in the corresponding shippingOptions.optionType field (which controls whether domestic or international shipping service options are being defined). If a shipping rate table is being used, the specified shipping service options should also match the shipping rate table settings (domestic or international, shipping speed/level of service, etc.)

Sellers can specify up to four domestic shipping services and up to five international shipping service options by using separate shippingService containers for each. If the seller is using the Global Shipping Program as an international option, only a total of four international shipping service options (including GSP) can be offered.

See How to set up shipping carrier and shipping service values.

To use the eBay standard envelope service (eSE), see Using eBay standard envelope (eSE) service.

This array is conditionally required if the seller is offering one or more domestic and/or international shipping service options.", "items": { "$ref": "#/components/schemas/ShippingService" } } }, "description": "This type is used by the shippingOptions array, which is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations)." }, "ShippingOptionTypeEnum": { "type": "object", "description": "This enumerated type defines whether the corresponding shipping service options are domestic or international shipping service options. a region that is either domestic (within the country from where the item is listed or shipped) or international (a country outside the country from where the item is listed or shipped). | - **DOMESTIC**: This value indicates that the corresponding shipping service options are domestic shipping service options. - **INTERNATIONAL**: This value indicates that the corresponding shipping service options are international shipping service options.", "enum": [ "DOMESTIC", "INTERNATIONAL" ] }, "ShippingService": { "type": "object", "properties": { "additionalShippingCost": { "description": "This container is used by the seller to cover the use case when a single buyer purchases multiple quantities of the same line item. This cost cannot exceed the corresponding shippingCost value. A seller will generally set this field when he/she wants to pass on a shipping discount to the buyer if that buyer purchases multiple quantities of a line item.

The seller can ship multiple quantities of the line item in the same package and pass on the shipping savings to the buyer.

If this field is not set, and a buyer purchases multiple quantities of an item, the seller can technically charge the same cost set in the shippingCost container for each individual item, but in general, it behooves both the seller and the buyer (and saves both parties money) if they discuss combined shipping.

This field is not applicable to auction listings or single-quantity, fixed-price listings.

This container is returned if set.", "$ref": "#/components/schemas/Amount" }, "buyerResponsibleForPickup": { "type": "boolean", "description": "This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made.

This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false" }, "buyerResponsibleForShipping": { "type": "boolean", "description": "This field should be included and set to true for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a motor vehicle.

This field is only applicable to motor vehicle listings. In the majority of motor vehicle listings, the seller does make the buyer responsible for pickup or shipment of the vehicle.

This field is returned if set.

Default: false" }, "freeShipping": { "type": "boolean", "description": "This field is included and set to true if the seller offers a free domestic shipping option to the buyer.

This field can only be included and set to true for the first domestic shipping service option specified in the shippingServices array (it is ignored if set for subsequent shipping services or for any international shipping service option).

The first specified shipping service option has a sortOrder value of 1 or if the sortOrderId field is not used, it is the shipping service option that's specified first in the shippingServices array.

This container is returned if set." }, "shippingCarrierCode": { "type": "string", "description": "This field sets/indicates the shipping carrier, such as USPS, FedEx, or UPS. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here.

For a full list of shipping carrier enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingCarrierDetails. The enum values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier field in the response payload.

This field is actually optional, as the shipping carrier is also tied into the shippingServiceCode enum value, and that field is required for every specified shipping service option.

This field is returned if set." }, "shippingCost": { "description": "This container is used to set the shipping cost to ship one item using the corresponding shipping service option. This container is conditionally required if the seller is using flat-rate shipping and is not using a domestic or international shipping rate table.

This container is not necessary for calculated shipping, since eBay will calculate the shipping cost and display it in the View Item page based off of the potential buyer's ship-to location.

This value is automatically set to 0.0 for the first specified domestic shipping service option and if the corresponding freeShipping field is set to true.

This container is returned if set for the policy.", "$ref": "#/components/schemas/Amount" }, "shippingServiceCode": { "type": "string", "description": "This field sets/indicates the domestic or international shipping service option, such as USPSPriority, FedEx2Day, or UPS3rdDay. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here.

For a full list of shipping service option enum values for a specified eBay marketplace, the GeteBayDetails call of the Trading API can be used, and the DetailName field's value should be set to ShippingServiceDetails.

The enum values for each shipping service option can be found in each ShippingServiceDetails.ShippingService field in the response payload. The seller must make sure that the shipping service option is still valid, which is indicated by a true value in the corresponding ValidForSellingFlow boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an InternationalService boolean field that reads true.

The InternationalService boolean field is not returned at all for domestic shipping service options.

This field is required for every specified shipping service option." }, "shipToLocations": { "description": "This container is used to set the ship-to locations applicable to the corresponding shipping service option. Although the regionExcluded container is defined for RegionSet type and could technically be used here, it is recommened that only the regionIncluded container be used at the shipping service level. The excluded shipping regions (if any) can instead be set up in the top-level regionExcluded container.

The regionIncluded and regionExcluded containers define the geographical regions/countries/states or provinces/domestic regions where the seller does and doesn't ship to with this fulfillment policy.

To retrieve the valid geographical shipping region values, two-digit country values, or special domestic regions for an eBay marketplace, call GeteBayDetails with DetailName value set to ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in the regionIncluded.regionName field.
  • For valid geographical region names, look for the ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields.
  • For valid two-digit country codes, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition.
  • For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields.
The STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post.", "$ref": "#/components/schemas/RegionSet" }, "sortOrder": { "type": "integer", "description": "The integer value set in this field controls the order of the corresponding domestic or international shipping service option in the View Item and Checkout pages.

If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call.

Minimum: 1
Maximum: 4 (for domestic shipping service) or 5 (for international shipping service).", "format": "int32" }, "surcharge": { "description": " Note: DO NOT USE THIS FIELD. Shipping surcharges for domestic shipping service options can no longer be set with fulfillment business policies, except through shipping rate tables.

To do this, a seller would set up a surcharge-based shipping rate table and specify the surcharge in that table. Then, the seller would need to associate this shipping rate table to the fulfillment business policy by specifying the unique ID of the shipping rate table through the shippingOptions.rateTableId field.
Shipping surcharges cannot be applied at all to international shipping service options.", "$ref": "#/components/schemas/Amount" } }, "description": "This type is used by the shippingServices array, an array that provides details about every domestic and international shipping service option that is defined for the policy." }, "Subscription": { "type": "object", "required": ["marketplaceId", "subscriptionId", "subscriptionLevel", "subscriptionType", "term"], "properties": { "marketplaceId": { "description": "The marketplace with which the subscription is associated.", "$ref": "#/components/schemas/MarketplaceIdEnum" }, "subscriptionId": { "type": "string", "description": "The subscription ID." }, "subscriptionLevel": { "type": "string", "description": "The subscription level. For example, subscription levels for an eBay store include Starter, Basic, Featured, Anchor, and Enterprise levels." }, "subscriptionType": { "description": "The kind of entity with which the subscription is associated, such as an eBay store.", "$ref": "#/components/schemas/SubscriptionTypeEnum" }, "term": { "description": "The term of the subscription plan (typically in months).", "$ref": "#/components/schemas/TimeDuration" } }, "description": "This type is used by the getSubscription response container, which defines the subscription types and levels for the seller account." }, "SubscriptionResponse": { "type": "object", "required": ["subscriptions", "total"], "properties": { "href": { "type": "string", "description": "This field is for future use." }, "limit": { "type": "integer", "description": "This field is for future use.", "format": "int32" }, "next": { "type": "string", "description": "This field is for future use." }, "subscriptions": { "type": "array", "description": "An array of subscriptions associated with the seller account.", "items": { "$ref": "#/components/schemas/Subscription" } }, "total": { "type": "integer", "description": "The total number of subscriptions displayed on the current page of results.", "format": "int32" } }, "description": "This type is used by the response payload for the getSubscription method.

Note: Pagination has not yet been enabled for getSubscription, so all of the pagination-related fields are for future use." }, "SubscriptionTypeEnum": { "type": "object", "description": "This enumerated type defines the types of subscriptions that may be associated with a seller account, such as an eBay store subscription. | - **STORE_PLAN**: This value indicates an eBay store subscription.", "enum": [ "STORE_PLAN" ] }, "TimeDuration": { "type": "object", "properties": { "unit": { "description": "These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.", "$ref": "#/components/schemas/TimeDurationUnitEnum" }, "value": { "type": "integer", "description": "An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.", "format": "int32" } }, "description": "A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned." }, "TimeDurationUnitEnum": { "type": "object", "description": "This enumerated type specifies the time-measurement unit that's used to express a time span. | - **YEAR**: This value indicates that the time measurement unit used is based on a number of years. This enum is not currently used by the Account API v1. - **MONTH**: This value indicates that the time measurement unit used is based on a number of months. This enum is not currently used by the Account API v1. - **DAY**: This value indicates that the time measurement unit used is based on a number of days. This enum is used for handling time in fulfillment business policies, for fullPaymentDueIn field for motor vehicle listing payment business policies, and for the return period for return business policies. - **HOUR**: This value indicates that the time measurement unit used is based on a number of hours. This enum is used for a motor vehicle deposit due date for motor vehicle listing payment business policies. - **CALENDAR_DAY**: This value indicates that the time measurement unit used is based on a number of calendar days, including Saturday and Sunday. This time measurement unit does not exclude holidays. This enum is not currently used by the Account API v1. - **BUSINESS_DAY**: This value indicates that the time measurement unit used is based on a number of business days or 'working days'. This generally excludes Sunday and all holidays (for the marketplace) in the time duration and, depending on the location, can include or exclude Saturday. This enum is not currently used by the Account API v1. - **MINUTE**: This value indicates that the time measurement unit used is based on a number of minutes. This enum is not currently used by the Account API v1. - **SECOND**: This value indicates that the time measurement unit used is based on a number of seconds. This enum is not currently used by the Account API v1. - **MILLISECOND**: This value indicates that the time measurement unit used is based on a number of milliseconds. This enum is not currently used by the Account API v1.", "enum": [ "YEAR", "MONTH", "DAY", "HOUR", "CALENDAR_DAY", "BUSINESS_DAY", "MINUTE", "SECOND", "MILLISECOND" ] }, "UpdatedSalesTaxEntry": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "The two-letter ISO 3166 code of the country associated with the sales-tax table entry." }, "jurisdictionId": { "type": "string", "description": "The ID of the tax jurisdiction associated with the sales-tax table entry." }, "statusCode": { "type": "integer", "description": "The HTTP status code for the call.

Note: The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP statusCode will be listed for all sales-tax table entries returned in the payload.", "format": "int32" } }, "description": "This container stores the array of sales-tax table entries that have been created or updated." }, "UpdatedSalesTaxResponse": { "type": "object", "properties": { "updatedSalesTaxEntries": { "type": "array", "description": "The array of new and updated sales-tax table entries.", "items": { "$ref": "#/components/schemas/UpdatedSalesTaxEntry" } } }, "description": "This type is used to return the list of new and updated sales-tax table entries." } }, "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/sell.account.readonly": "View your account settings", "https://api.ebay.com/oauth/api_scope/sell.account": "View and manage your account settings" } } } }, "bearerAuth": { "type": "http", "scheme": "bearer" } } } }