claudi
389d72a136
- Implement tests for `EbayOAuthClient` to verify authorization URL generation with configured scopes and token reuse logic. - Add tests for `WebhookChallengeHandler` to ensure correct SHA256 response generation and for `WebhookSignatureParser` to validate extraction of known fields from signature strings.
4895 lines
249 KiB
YAML
4895 lines
249 KiB
YAML
---
|
|
openapi: "3.0.0"
|
|
info:
|
|
title: "Account v1 API"
|
|
description: "The <b>Account API</b> 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. <br><br>For details\
|
|
\ on the availability of the methods in this API, see <a href=\"/api-docs/sell/account/overview.html#requirements\"\
|
|
>Account API requirements and restrictions</a>."
|
|
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"
|
|
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 <b>policy_types</b>\
|
|
\ query parameter."
|
|
operationId: "getCustomPolicies"
|
|
parameters:
|
|
- name: "policy_types"
|
|
in: "query"
|
|
description: "This query parameter specifies the type of custom policies to\
|
|
\ be returned.<br><br>Multiple policy types may be requested in a single\
|
|
\ call by providing a comma-delimited set of all policy types to be returned.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> Omitting this query parameter\
|
|
\ from a request will also return policies of all policy types.</span><br>\
|
|
\ See the <a href=\"/api-docs/sell/account/types/api:CustomPolicyTypeEnum\"\
|
|
\ target=\"_blank \">CustomPolicyTypeEnum</a> 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"
|
|
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"
|
|
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 <b>policyType</b>. Multiple policies may be created as using the\
|
|
\ following custom policy types:<ul><li>PRODUCT_COMPLIANCE: Product Compliance\
|
|
\ policies disclose product information as required for regulatory compliance.\
|
|
\ <br/><br/><span class=\"tablenote\"><strong>Note:</strong> A maximum of\
|
|
\ 60 Product Compliance policies per seller may be created.</span></li><li>TAKE_BACK:\
|
|
\ Takeback policies describe the seller's legal obligation to take back a\
|
|
\ previously purchased item when the buyer purchases a new one. <br/><br/><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> A maximum of 18 Takeback policies\
|
|
\ per seller may be created.</span></li></ul>A successful create policy call\
|
|
\ returns an HTTP status code of <b>201 Created</b> 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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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 <b>location</b> response header contains the URL\
|
|
\ to the newly created custom policy. The URL includes the eBay-assigned\
|
|
\ <code>custom_policy_id</code>, which can be used to reference\
|
|
\ the policy."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: "object"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
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 <b>custom_policy_id</b>\
|
|
\ 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.<br><br> This ID can be retrieved for a custom policy by using\
|
|
\ the <a href=\"/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies\"\
|
|
\ target=\"_blank \">getCustomPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/CustomPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"404":
|
|
description: "Not Found"
|
|
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\
|
|
\ <b>custom_policy_id</b> path parameter. Since this method overwrites the\
|
|
\ policy's <b>name</b>, <b>label</b>, and <b>description</b> fields, always\
|
|
\ include the complete and current text of all three policy fields in the\
|
|
\ request payload, even if they are not being updated.<br/> <br/>For example,\
|
|
\ the value for the <b>label</b> field is to be updated, but the <b>name</b>\
|
|
\ and <b>description</b> values will remain unchanged. The existing <b>name</b>\
|
|
\ and <b>description</b> values, as they are defined in the current policy,\
|
|
\ must also be passed in. <br/><br/>A successful policy update call returns\
|
|
\ an HTTP status code of <b>204 No Content</b>."
|
|
operationId: "updateCustomPolicy"
|
|
parameters:
|
|
- name: "custom_policy_id"
|
|
in: "path"
|
|
description: "This path parameter is the unique identifier of the custom policy\
|
|
\ to update.<br><br><span class=\"tablenote\"><b>Note:</b> A list of custom\
|
|
\ policies defined for a seller's account that includes this ID can be retrieved\
|
|
\ by calling the <a href=\"/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicies\"\
|
|
\ target=\"_blank \">getCustomPolicies</a> method.</span>"
|
|
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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"204":
|
|
description: "No Content"
|
|
"404":
|
|
description: "Not Found"
|
|
"409":
|
|
description: "Policy Name already used/ Maximum no of policies per site\
|
|
\ reached"
|
|
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. <br><br>A successful request returns the <b>getFulfillmentPolicy</b>\
|
|
\ URI to the new policy in the <b>Location</b> response header and the ID\
|
|
\ for the new policy is returned in the response payload. <p class=\"tablenote\"\
|
|
><b>Tip:</b> For details on creating and using the business policies supported\
|
|
\ by the Account API, see <a href=\"/api-docs/sell/static/seller-accounts/business-policies.html\"\
|
|
>eBay business policies</a>.</p>"
|
|
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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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 <b>location</b> response header contains the URL\
|
|
\ to the newly created fulfillment policy. The URL includes the\
|
|
\ eBay-assigned <code>fulfillmentPolicyId</code>, 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"
|
|
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"
|
|
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 <b>fulfillmentPolicyId</b>\
|
|
\ path parameter."
|
|
operationId: "getFulfillmentPolicy"
|
|
parameters:
|
|
- name: "fulfillmentPolicyId"
|
|
in: "path"
|
|
description: "This path parameter specifies the ID of the fulfillment policy\
|
|
\ you want to retrieve.<br><br> This ID can be retrieved for a fulfillment\
|
|
\ policy by using the <a href=\"/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies\"\
|
|
\ target=\"_blank \">getFulfillmentPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/FulfillmentPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
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 <b>fulfillment_policy_id</b> 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.<br><br>This ID can be retrieved for a specific fulfillment\
|
|
\ policy by using the <a href=\"/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies\"\
|
|
\ target=\"_blank \">getFulfillmentPolicies</a> 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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
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"
|
|
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 <b>fulfillmentPolicyId</b> path parameter."
|
|
operationId: "deleteFulfillmentPolicy"
|
|
parameters:
|
|
- name: "fulfillmentPolicyId"
|
|
in: "path"
|
|
description: "This path parameter specifies the ID of the fulfillment policy\
|
|
\ to delete.<br><br> This ID can be retrieved for a fulfillment policy by\
|
|
\ using the <a href=\"/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies\"\
|
|
\ target=\"_blank \">getFulfillmentPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
"404":
|
|
description: "Not Found"
|
|
"409":
|
|
description: "Conflict"
|
|
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 <code>marketplace_id</code> query\
|
|
\ parameter."
|
|
operationId: "getFulfillmentPolicies"
|
|
parameters:
|
|
- name: "Content-Language"
|
|
in: "header"
|
|
description: "Get the correct policies for a marketplace that supports multiple\
|
|
\ locales using the <code>Content-Language</code> request header. For example,\
|
|
\ get the policies for the French locale of the Canadian marketplace by\
|
|
\ specifying <code>fr-CA</code> for the <code>Content-Language</code> header.\
|
|
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
|
|
\ <code>Content-Language: nl-BE</code>. For details on header values, see\
|
|
\ <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
|
|
_blank\">HTTP request headers</a>."
|
|
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/api-docs/sell/account/types/ba:MarketplaceIdEnum"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/FulfillmentPolicyResponse"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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 <code>name</code> and its associated\
|
|
\ <code>marketplace_id</code> 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 <code>Content-Language</code> request header. For example,\
|
|
\ get the policies for the French locale of the Canadian marketplace by\
|
|
\ specifying <code>fr-CA</code> for the <code>Content-Language</code> header.\
|
|
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
|
|
\ <code>Content-Language: nl-BE</code>. For details on header values, see\
|
|
\ <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
|
|
_blank\">HTTP request headers</a>."
|
|
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/api-docs/sell/account/types/ba: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.<br><br>This value can be retrieved\
|
|
\ for a fulfillment policy by using the <a href=\"/api-docs/sell/account/resources/fulfillment_policy/methods/getFulfillmentPolicies\"\
|
|
\ target=\"_blank \">getFulfillmentPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/FulfillmentPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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 <code>marketplace_id</code> 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/api-docs/sell/account/types/ba: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 <code>Content-Language</code> request header. For example,\
|
|
\ get the policies for the French locale of the Canadian marketplace by\
|
|
\ specifying <code>fr-CA</code> for the <code>Content-Language</code> header.\
|
|
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
|
|
\ <code>Content-Language: nl-BE</code>. For details on header values, see\
|
|
\ <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
|
|
_blank\">HTTP request headers</a>."
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/PaymentPolicyResponse"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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. <br><br>A successful request returns\
|
|
\ the <b>getPaymentPolicy</b> URI to the new policy in the <b>Location</b>\
|
|
\ response header and the ID for the new policy is returned in the response\
|
|
\ payload. <p class=\"tablenote\"><b>Tip:</b> For details on creating and\
|
|
\ using the business policies supported by the Account API, see <a href=\"\
|
|
/api-docs/sell/static/seller-accounts/business-policies.html\">eBay business\
|
|
\ policies</a>.</p>"
|
|
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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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 <b>location</b> response header contains the URL\
|
|
\ to the newly created payment policy. The URL includes the eBay-assigned\
|
|
\ <code>paymentPolicyId</code>, 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"
|
|
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"
|
|
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 <b>paymentPolicyId</b>\
|
|
\ 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. <br><br> This ID can be retrieved for a payment policy\
|
|
\ by using the <a href=\"/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies\"\
|
|
\ target=\"_blank \">getPaymentPolices</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/PaymentPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
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 <b>payment_policy_id</b> 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. <br><br> This ID can be retrieved for a payment policy\
|
|
\ by using the <a href=\"/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies\"\
|
|
\ target=\"_blank \">getPaymentPolices</a> 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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
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"
|
|
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 <b>paymentPolicyId</b> 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.<br><br> This ID can be retrieved for a payment\
|
|
\ policy by using the <a href=\"/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies\"\
|
|
\ target=\"_blank \">getPaymentPolices</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
"404":
|
|
description: "Not Found"
|
|
"409":
|
|
description: "Conflict"
|
|
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 <code>name</code> and its associated <code>marketplace_id</code>\
|
|
\ 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 <code>Content-Language</code> request header. For example,\
|
|
\ get a policy for the French locale of the Canadian marketplace by specifying\
|
|
\ <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise,\
|
|
\ target the Dutch locale of the Belgium marketplace by setting <code>Content-Language:\
|
|
\ nl-BE</code>. For details on header values, see <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
>HTTP request headers</a>."
|
|
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/api-docs/sell/account/types/ba: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.<br><br> This value can be retrieved\
|
|
\ for a payment policy by using the <a href=\"/api-docs/sell/account/resources/payment_policy/methods/getPaymentPolicies\"\
|
|
\ target=\"_blank \">getPaymentPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/PaymentPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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: "<span class=\"tablenote\"><b>Note:</b> This method is no longer\
|
|
\ applicable, as all seller accounts globally have been enabled for the new\
|
|
\ eBay payment and checkout flow.</span><br>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 <b>marketplace_id</b>\
|
|
\ 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"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "Application error"
|
|
"404":
|
|
description: "Not Found"
|
|
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: "<span class=\"tablenote\"><b>Note:</b> This method is no longer\
|
|
\ applicable, as all seller accounts globally have been enabled for the new\
|
|
\ eBay payment and checkout flow.</span><br>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"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "Application error"
|
|
"404":
|
|
description: "Not Found"
|
|
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 <b>sellingLimit</b> (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"
|
|
"500":
|
|
description: "Internal Server 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"
|
|
x-response-codes:
|
|
errors:
|
|
20404:
|
|
domain: "API_ACCOUNT"
|
|
category: "REQUEST"
|
|
description: "{fieldName} not found."
|
|
"500":
|
|
description: "Internal Server 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"
|
|
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 <a href=\"/api-docs/sell/account/overview.html#opt-in\" target=\"\
|
|
_blank\">Account API overview</a> for information about available eBay seller\
|
|
\ programs.<br><br><span class=\"tablenote\"><b>Note:</b> It can take up to\
|
|
\ 24-hours for eBay to process your request to opt-in to a Seller Program.\
|
|
\ Use the <a href=\"/api-docs/sell/account/resources/program/methods/getOptedInPrograms\"\
|
|
\ target=\"_blank\">getOptedInPrograms</a> call to check the status of your\
|
|
\ request after the processing period has passed.</span>"
|
|
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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20401:
|
|
domain: "API_ACCOUNT"
|
|
category: "REQUEST"
|
|
description: "Missing field {fieldName}. {additionalInfo}"
|
|
"500":
|
|
description: "Internal Server 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"
|
|
"409":
|
|
description: "Conflict"
|
|
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 <b>getOptedInPrograms</b> 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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
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"
|
|
"409":
|
|
description: "Conflict"
|
|
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 <i>shipping rate tables</i> for\
|
|
\ the country specified in the <b>country_code</b> query parameter. If you\
|
|
\ call this method without specifying a country code, the call returns all\
|
|
\ of the seller's shipping rate tables. <br><br>The method's response includes\
|
|
\ a <b>rateTableId</b> for each table defined by the seller. This <b>rateTableId</b>\
|
|
\ 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. <br><br>This call currently\
|
|
\ supports getting rate tables related to the following marketplaces: United\
|
|
\ States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain.\
|
|
\ <span class=\"tablenote\"><b>Note:</b> Rate tables created with the Trading\
|
|
\ API might not have been assigned a <b>rateTableId</b> at the time of their\
|
|
\ creation. This method can assign and return <b>rateTableId</b> values for\
|
|
\ rate tables with missing IDs if you make a request using the <b>country_code</b>\
|
|
\ where the seller has defined rate tables.</span> <br><br>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\
|
|
\ <a href=\"https://www.ebay.com/ship/rt \">Shipping rate tables</a> in <b>My\
|
|
\ eBay</b> to create and update rate tables."
|
|
operationId: "getRateTables"
|
|
parameters:
|
|
- name: "country_code"
|
|
in: "query"
|
|
description: "This query parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> 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/api-docs/sell/account/types/ba:CountryCodeEnum"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/RateTableResponse"
|
|
"400":
|
|
description: "Bad Request"
|
|
x-response-codes:
|
|
errors:
|
|
20403:
|
|
domain: "API_ACCOUNT"
|
|
category: "REQUEST"
|
|
description: "Invalid {fieldName}. {additionalInfo}"
|
|
"500":
|
|
description: "Internal Server 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 <code>marketplace_id</code> query parameter."
|
|
operationId: "getReturnPolicies"
|
|
parameters:
|
|
- name: "Content-Language"
|
|
in: "header"
|
|
description: "Get the correct policies for a marketplace that supports multiple\
|
|
\ locales using the <code>Content-Language</code> request header. For example,\
|
|
\ get the policies for the French locale of the Canadian marketplace by\
|
|
\ specifying <code>fr-CA</code> for the <code>Content-Language</code> header.\
|
|
\ Likewise, target the Dutch locale of the Belgium marketplace by setting\
|
|
\ <code>Content-Language: nl-BE</code>. For details on header values, see\
|
|
\ <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
|
|
_blank\">HTTP request headers</a>."
|
|
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/api-docs/sell/account/types/ba:MarketplaceIdEnum"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/ReturnPolicyResponse"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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. <br><br>Each policy targets a specific\
|
|
\ marketplace, and you can create multiple policies for each marketplace.\
|
|
\ Return policies are not applicable to motor-vehicle listings.<br><br>A successful\
|
|
\ request returns the <b>getReturnPolicy</b> URI to the new policy in the\
|
|
\ <b>Location</b> response header and the ID for the new policy is returned\
|
|
\ in the response payload. <p class=\"tablenote\"><b>Tip:</b> For details\
|
|
\ on creating and using the business policies supported by the Account API,\
|
|
\ see <a href=\"/api-docs/sell/static/seller-accounts/business-policies.html\"\
|
|
>eBay business policies</a>.</p>"
|
|
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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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 <b>location</b> response header contains the URL\
|
|
\ to the newly created return policy. The URL includes the eBay-assigned\
|
|
\ <code>returnPolicyId</code>, 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"
|
|
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"
|
|
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 <b>returnPolicyId</b> 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. <br><br> This ID can be retrieved for a return\
|
|
\ policy by using the <a href=\"/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies\"\
|
|
\ target=\"_blank \">getReturnPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/ReturnPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
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 <b>return_policy_id</b> 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. <br><br> This ID can be retrieved for a return policy\
|
|
\ by using the <a href=\"/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies\"\
|
|
\ target=\"_blank \">getReturnPolicies</a> 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 <b>application/json</b>. <br><br>\
|
|
\ For more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
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"
|
|
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 <b>returnPolicyId</b> 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.<br><br> This ID can be retrieved for a return\
|
|
\ policy by using the <a href=\"/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies\"\
|
|
\ target=\"_blank \">getReturnPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
"404":
|
|
description: "Not Found"
|
|
"409":
|
|
description: "Conflict"
|
|
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 <code>name</code> and its associated <code>marketplace_id</code>\
|
|
\ 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 <code>Content-Language</code> request header. For example,\
|
|
\ get a policy for the French locale of the Canadian marketplace by specifying\
|
|
\ <code>fr-CA</code> for the <code>Content-Language</code> header. Likewise,\
|
|
\ target the Dutch locale of the Belgium marketplace by setting <code>Content-Language:\
|
|
\ nl-BE</code>. For details on header values, see <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
>HTTP request headers</a>."
|
|
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/api-docs/sell/account/types/ba: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.<br><br> This value can be retrieved\
|
|
\ for a return policy by using the <a href=\"/api-docs/sell/account/resources/return_policy/methods/getReturnPolicies\"\
|
|
\ target=\"_blank \">getReturnPolicies</a> method."
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/ReturnPolicy"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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.<br><br><i>Sales-tax\
|
|
\ tables</i> can be set up for countries that support different <i>tax jurisdictions</i>.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note:</b> Sales-tax tables are only available for\
|
|
\ the US (EBAY_US) and Canada (EBAY_CA) marketplaces.</span><br>Each sales-tax\
|
|
\ table entry comprises the following parameters:<ul><li><code>countryCode</code></li><li><code>jurisdictionId</code></li><li><code>salesTaxPercentage</code></li><li><code>shippingAndHandlingTaxed</code></li></ul><br>Valid\
|
|
\ jurisdiction IDs are retrieved using <b><a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank\">getSalesTaxJurisdictions</a></b> in the Metadata API.<br><br>For\
|
|
\ details about using this call, refer to <a href=\"/api-docs/sell/static/seller-accounts/tax-tables.html\"\
|
|
>Establishing sales-tax tables</a>.<br><br><div class=\"msgbox_important\"\
|
|
><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"<b><span style="color:\
|
|
\ #dd1e31;" class="mcFormatColor">Important! </span></b>\"\
|
|
><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
|
|
mcFormatColor\">Important!</span></b></span></span> 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.<br><br>However, sellers may continue\
|
|
\ to use a sales-tax table to set rates for the following US territories:<ul><li>American\
|
|
\ Samoa (AS)</li><li>Guam (GU)</li><li>Northern Mariana Islands (MP)</li><li>Palau\
|
|
\ (PW)</li><li>US Virgin Islands (VI)</li></ul>For additional information,\
|
|
\ refer to <a href=\"https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121\
|
|
\ \" target=\"_blank\">Taxes and import charges</a>.</p></div>"
|
|
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"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"207":
|
|
description: "partial success"
|
|
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 <b>countryCode</b>\
|
|
\ and <b>jurisdictionId</b> 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.<br><br><span class=\"tablenote\"\
|
|
><b>Note:</b> Sales-tax tables are only available for the US (EBAY_US) and\
|
|
\ Canada (EBAY_CA) marketplaces.</span><br><div class=\"msgbox_important\"\
|
|
><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"<b><span style="color:\
|
|
\ #dd1e31;" class="mcFormatColor">Important! </span></b>\"\
|
|
><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
|
|
mcFormatColor\">Important!</span></b></span></span> 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.<br><br>However, sellers may continue\
|
|
\ to use a sales-tax table to set rates for the following US territories:<ul><li>American\
|
|
\ Samoa (AS)</li><li>Guam (GU)</li><li>Northern Mariana Islands (MP)</li><li>Palau\
|
|
\ (PW)</li><li>US Virgin Islands (VI)</li></ul>For additional information,\
|
|
\ refer to <a href=\"https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121\
|
|
\ \" target=\"_blank\">Taxes and import charges</a>.</p></div>"
|
|
operationId: "getSalesTax"
|
|
parameters:
|
|
- name: "countryCode"
|
|
in: "path"
|
|
description: "This path parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
|
|
\ for the country whose sales tax table you want to retrieve.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note:</b> Sales-tax tables are available only for\
|
|
\ the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>"
|
|
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.<br><br>Valid jurisdiction IDs\
|
|
\ can be retrieved using the <a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank \">getSalesTaxJurisdiction</a> method of the Metadata\
|
|
\ API.<br><br><span class=\"tablenote\"><b>Note:</b> When <code>countryCode</code>\
|
|
\ is set to <code>US</code>, the only supported values for <code>jurisdictionId</code>\
|
|
\ are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam</li><li><code>MP</code>\
|
|
\ Northern Mariana Islands</li><li><code>PW (Palau)</li><li><code>VI</code>\
|
|
\ (US Virgin Islands)</li></ul></span>"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"200":
|
|
description: "Success"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/SalesTax"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"204":
|
|
description: "No content"
|
|
"404":
|
|
description: "Not Found"
|
|
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:\
|
|
\ <b>countryCode</b> and <b>jurisdictionId</b>. <br><br>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.<br><br>You can\
|
|
\ set up <i>sales-tax tables</i> for countries that support different <i>tax\
|
|
\ jurisdictions</i>.<br><br><span class=\"tablenote\"><b>Note:</b> Sales-tax\
|
|
\ tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.</span><br>Retrieve\
|
|
\ valid jurisdiction IDs using <b><a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank\">getSalesTaxJurisdictions</a></b> in the Metadata API.<br><br>For\
|
|
\ details about using this call, refer to <a href=\"/api-docs/sell/static/seller-accounts/tax-tables.html\"\
|
|
>Establishing sales-tax tables</a>.<br><br><div class=\"msgbox_important\"\
|
|
><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"<b><span style="color:\
|
|
\ #dd1e31;" class="mcFormatColor">Important! </span></b>\"\
|
|
><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
|
|
mcFormatColor\">Important!</span></b></span></span> 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.<br><br>However, sellers may continue\
|
|
\ to use a sales-tax table to set rates for the following US territories:<ul><li>American\
|
|
\ Samoa (AS)</li><li>Guam (GU)</li><li>Northern Mariana Islands (MP)</li><li>Palau\
|
|
\ (PW)</li><li>US Virgin Islands (VI)</li></ul>For additional information,\
|
|
\ refer to <a href=\"https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121\
|
|
\ \" target=\"_blank\">Taxes and import charges</a>.</p></div>"
|
|
operationId: "createOrReplaceSalesTax"
|
|
parameters:
|
|
- name: "countryCode"
|
|
in: "path"
|
|
description: "This path parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
|
|
\ for the country for which you want to create a sales tax table entry.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note:</b> Sales-tax tables are available only for\
|
|
\ the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>"
|
|
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.<br><br>Valid jurisdiction IDs can be\
|
|
\ retrieved using the <a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank \">getSalesTaxJurisdiction</a> method of the Metadata\
|
|
\ API.<br><br><span class=\"tablenote\"><b>Note:</b> When <code>countryCode</code>\
|
|
\ is set to <code>US</code>, the only supported values for <code>jurisdictionId</code>\
|
|
\ are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam)</li><li><code>MP</code>\
|
|
\ (Northern Mariana Islands)</li><li><code>PW</code> (Palau)</li><li><code>VI</code>\
|
|
\ (US Virgin Islands)</li></ul></span>"
|
|
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 <b>application/json</b>.<br><br>For\
|
|
\ more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
|
|
\ target=\"_blank \">HTTP request headers</a>."
|
|
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"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"204":
|
|
description: "No Content"
|
|
"404":
|
|
description: "Not Found"
|
|
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 <b>countryCode</b> and <b>jurisdictionId</b>\
|
|
\ path parameters.<br><br><span class=\"tablenote\"><b>Note:</b> Sales-tax\
|
|
\ tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.</span>"
|
|
operationId: "deleteSalesTax"
|
|
parameters:
|
|
- name: "countryCode"
|
|
in: "path"
|
|
description: "This path parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
|
|
\ for the country whose sales tax table entry you want to delete.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note:</b> Sales-tax tables are available only for\
|
|
\ the US and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>"
|
|
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.<br><br>Valid jurisdiction IDs can\
|
|
\ be retrieved using the <a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank \">getSalesTaxJurisdiction</a> method of the Metadata\
|
|
\ API.<br><br><span class=\"tablenote\"><b>Note:</b> When <code>countryCode</code>\
|
|
\ is set to <code>US</code>, the only supported values for <code>jurisdictionId</code>\
|
|
\ are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code> (Guam)</li><li><code>MP</code>\
|
|
\ (Northern Mariana Islands)</li><li><code>PW</code> (Palau)</li><li><code>VI</code>\
|
|
\ (US Virgin Islands)</li></ul></span>"
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
responses:
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
x-response-codes:
|
|
errors:
|
|
20500:
|
|
domain: "API_ACCOUNT"
|
|
category: "APPLICATION"
|
|
description: "System error."
|
|
"204":
|
|
description: "Success"
|
|
"404":
|
|
description: "Not Found"
|
|
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 <code>204 No Content</code>\
|
|
\ status code is returned with no response payload.<br><br><span class=\"\
|
|
tablenote\"><b>Note:</b> Sales-tax tables are only available for the US (EBAY_US)\
|
|
\ and Canada (EBAY_CA) marketplaces.</span><br><div class=\"msgbox_important\"\
|
|
><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"<b><span style="color:\
|
|
\ #dd1e31;" class="mcFormatColor">Important! </span></b>\"\
|
|
><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
|
|
mcFormatColor\">Important!</span></b></span></span> 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.<br><br>However, sellers may continue\
|
|
\ to use a sales-tax table to set rates for the following US territories:<ul><li>American\
|
|
\ Samoa (AS)</li><li>Guam (GU)</li><li>Northern Mariana Islands (MP)</li><li>Palau\
|
|
\ (PW)</li><li>US Virgin Islands (VI)</li></ul>For additional information,\
|
|
\ refer to <a href=\"https://www.ebay.com/help/selling/fees-credits-invoices/taxes-import-charges?id=4121\
|
|
\ \" target=\"_blank\">Taxes and import charges</a>.</p></div>"
|
|
operationId: "getSalesTaxes"
|
|
parameters:
|
|
- name: "country_code"
|
|
in: "query"
|
|
description: "This path parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
|
|
\ for the country whose tax table you want to retrieve.<br><br><span class=\"\
|
|
tablenote\"><b>Note:</b> Sales-tax tables are available only for the US\
|
|
\ and Canada marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>\
|
|
\ 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"
|
|
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"
|
|
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"
|
|
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"
|
|
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: "<span class=\"tablenote\"><b>Note:</b> 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 <code>204 No Content</code> HTTP status code. </span>"
|
|
operationId: "getKYC"
|
|
responses:
|
|
"200":
|
|
description: "OK"
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/KycResponse"
|
|
"400":
|
|
description: "Bad Request"
|
|
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"
|
|
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"
|
|
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.<br><br> See the <a href=\"/api-docs/sell/account/types/plser:AdvertisingProgramEnum\"\
|
|
\ target=\"_blank\"> AdvertisingProgramEnum</a> type for a list of supported\
|
|
\ values.<br><br>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.<br><br>See the <a href=\"/api-docs/sell/account/types/ba:MarketplaceIdEnum\
|
|
\ \" target=\"_blank \">MarketplaceIdEnum</a> 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"
|
|
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"
|
|
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:
|
|
Amount:
|
|
type: "object"
|
|
properties:
|
|
currency:
|
|
type: "string"
|
|
description: "The base currency applied to the <b>value</b> field to establish\
|
|
\ a monetary amount. <br><br>The currency is represented as a 3-letter\
|
|
\ <a href=\"https://www.iso.org/iso-4217-currency-codes.html \" title=\"\
|
|
https://www.iso.org \" target=\"_blank\">ISO 4217</a> currency code. For\
|
|
\ example, the code for the Canadian Dollar is <code>CAD</code>.<br><br><b>Default:</b>\
|
|
\ The default currency of the eBay marketplace that hosts the listing.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CurrencyCodeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
value:
|
|
type: "string"
|
|
description: "The monetary amount in the specified <b>currency</b>."
|
|
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 <b>currency</b> and <b>value</b> 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"
|
|
properties:
|
|
default:
|
|
type: "boolean"
|
|
description: "<span class=\"tablenote\"><strong>Note:</strong> This field\
|
|
\ has been deprecated and is no longer used.<ul><li>Do not include this\
|
|
\ field in any <b>create</b> or <b>update</b> method.</li><li>This field\
|
|
\ may be returned within the payload of a <b>get</b> method, but it can\
|
|
\ be ignored.</li></ul></span>"
|
|
name:
|
|
type: "string"
|
|
description: "The category type to which the policy applies (motor vehicles\
|
|
\ or non-motor vehicles). <br><br><span class=\"tablenote\"><strong>Note:</strong>\
|
|
\ The <code>MOTORS_VEHICLES</code> category type is not valid for return\
|
|
\ policies. eBay flows do not support the return of motor vehicles.</span>\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CategoryTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "The category type discerns whether the policy applies to motor\
|
|
\ vehicle listings, or to any other items except motor vehicle listings. <br><br>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."
|
|
CompactCustomPolicyResponse:
|
|
type: "object"
|
|
properties:
|
|
customPolicyId:
|
|
type: "string"
|
|
description: "The unique custom policy identifier for the policy being returned.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> This value is automatically\
|
|
\ assigned by the system when the policy is created.</span>"
|
|
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.<br><br><b>Max\
|
|
\ length:</b> 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.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> This field is visible only\
|
|
\ to the seller. </span><br><b>Max length:</b> 65"
|
|
policyType:
|
|
type: "string"
|
|
description: "Specifies the type of Custom Policy being returned. For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "The response payload for requests that return a list of custom\
|
|
\ policies."
|
|
CustomPolicy:
|
|
type: "object"
|
|
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.<br><br><b>Max length:</b> 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.<br><br><b>Max\
|
|
\ length:</b> 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.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> This field is visible only\
|
|
\ to the seller. </span><br><b>Max length:</b> 65"
|
|
policyType:
|
|
type: "string"
|
|
description: "Specifies the type of Custom Policy being returned. For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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"
|
|
properties:
|
|
description:
|
|
type: "string"
|
|
description: "Contains the seller's policy and policy terms.<br><br><b>Max\
|
|
\ length:</b> 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.<br><br><b>Max\
|
|
\ length:</b> 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.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> This field is visible only\
|
|
\ to the seller. </span><br><b>Max length:</b> 65"
|
|
policyType:
|
|
type: "string"
|
|
description: "Specifies the type of custom policy being created. <br><br>Two\
|
|
\ Custom Policy types are supported: <ul><li>Product Compliance (PRODUCT_COMPLIANCE)</li>\
|
|
\ <li>Takeback (TAKE_BACK)</li></ul> For implementation help, refer to\
|
|
\ <a href='https://developer.ebay.com/api-docs/sell/account/types/api:CustomPolicyTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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"
|
|
properties:
|
|
description:
|
|
type: "string"
|
|
description: "Contains the seller specified policy and policy terms.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> Always supply this field.\
|
|
\ If this field is not specified, any previous value is removed. Call\
|
|
\ the <a href=\"/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy\"\
|
|
>getCustomPolicy</a> method to return the present field value for this\
|
|
\ policy.</span><br><b>Max length:</b> 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.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> Always supply this field.\
|
|
\ If this field is not specified, any previous value is removed. Call\
|
|
\ the <a href=\"/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy\"\
|
|
>getCustomPolicy</a> method to return the present field value for this\
|
|
\ policy.</span><br><b>Max length:</b> 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.<br><br><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong> This field is visible only\
|
|
\ to the seller. </span><br><br><span class=\"tablenote\"><strong>Note:</strong>\
|
|
\ Always supply this field. If this field is not specified, any previous\
|
|
\ value is removed. Call the <a href=\"/api-docs/sell/account/resources/custom_policy/methods/getCustomPolicy\"\
|
|
>getCustomPolicy</a> method to return the present field value for this\
|
|
\ policy.</span><br><b>Max length:</b> 65"
|
|
CustomPolicyResponse:
|
|
type: "object"
|
|
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: "<i>This field is for future use.</i>"
|
|
limit:
|
|
type: "integer"
|
|
description: "<i>This field is for future use.</i>"
|
|
format: "int32"
|
|
next:
|
|
type: "string"
|
|
description: "<i>This field is for future use.</i>"
|
|
offset:
|
|
type: "integer"
|
|
description: "<i>This field is for future use.</i>"
|
|
format: "int32"
|
|
prev:
|
|
type: "string"
|
|
description: "<i>This field is for future use.</i>"
|
|
total:
|
|
type: "integer"
|
|
description: "<i>This field is for future use.</i>"
|
|
format: "int32"
|
|
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.<br><br><b>Max</b>: <code>2000.0</code>"
|
|
$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 <b>dueIn</b> times are 24, 48, and 72 hours. <code>HOUR</code>\
|
|
\ is set as the <b>unit</b> value, and <code>24</code>, <code>48</code>\
|
|
\ or <code>72</code> are set in the <b>value</b> field.<br><br><span class=\"\
|
|
tablenote\"><b>Note</b>: The <b>dueIn</b> 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.</span><br><br><b>Min</b>=24\
|
|
\ (hours)<b>Max</b>=72 (hours), <b>Default</b>=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."
|
|
Error:
|
|
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:<ul><li><code>Application</code>:\
|
|
\ Indicates an exception or error occurred in the application code or\
|
|
\ at runtime. Examples include catching an exception in a service's business\
|
|
\ logic, system failures, or request errors from a dependency.</li><li><code>Business</code>:\
|
|
\ Used when your service or a dependent service refused to continue processing\
|
|
\ on the resource because of a business rule violation such as \"Seller\
|
|
\ does not ship item to Antarctica\" or \"Buyer ineligible to purchase\
|
|
\ an alcoholic item\". Business errors are not syntactical input errors.</li><li><code>Request</code>:\
|
|
\ Used when there is anything wrong with the request, such as authentication,\
|
|
\ syntactical errors, rate limiting or missing headers, bad HTTP header\
|
|
\ values, and so on.</li></ul>"
|
|
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 <i>JSONPath</i>\
|
|
\ notation."
|
|
items:
|
|
type: "string"
|
|
longMessage:
|
|
type: "string"
|
|
description: "A more detailed explanation of the error than given in the\
|
|
\ <code>message</code> 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 <code>inputRefId</code>."
|
|
items:
|
|
type: "string"
|
|
parameters:
|
|
type: "array"
|
|
description: "This optional list of name/value pairs that contain context-specific\
|
|
\ <code>ErrorParameter</code> objects, with each item in the list being\
|
|
\ a parameter (or input field name) that caused an error condition. Each\
|
|
\ <code>ErrorParameter</code> object consists of two fields, a <code>name</code>\
|
|
\ and a <code>value</code>."
|
|
items:
|
|
$ref: "#/components/schemas/ErrorParameter"
|
|
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: "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"
|
|
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. <br><br><b>Max\
|
|
\ length</b>: 250"
|
|
freightShipping:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, 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: "<span class=\"tablenote\"><b>Note</b>: This field is only\
|
|
\ applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>If\
|
|
\ returned as <code>true</code>, eBay's Global Shipping Program will be\
|
|
\ used by the seller to ship items to international locations.<br><br>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. <p>If only local pickup or\
|
|
\ freight shipping is available for the item, this container may not get\
|
|
\ returned.</p>"
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
localPickup:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, local pickup is available\
|
|
\ for this policy."
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this fulfillment policy\
|
|
\ applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this fulfillment policy. Names must\
|
|
\ be unique for policies assigned to the same marketplace. <br><br><b>Max\
|
|
\ length</b>: 64"
|
|
pickupDropOff:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, the seller offers the \"\
|
|
Click and Collect\" option. <br><br>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 <b>ShippingOption</b> object covers domestic shipping service\
|
|
\ options and international shipping service options (if the seller ships\
|
|
\ to international locations). <br><br>The <b>optionType</b> field indicates\
|
|
\ whether the <b>ShippingOption</b> object applies to domestic or international\
|
|
\ shipping, and the <b>costType</b> field indicates whether flat-rate\
|
|
\ shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b>\
|
|
\ object is used to specify cost and other details for every available\
|
|
\ domestic and international shipping service option. </p>"
|
|
items:
|
|
$ref: "#/components/schemas/ShippingOption"
|
|
shipToLocations:
|
|
description: "This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b>\
|
|
\ 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 <b>fulfillmentPolicy</b> response container,\
|
|
\ a container which defines a seller's fulfillment policy for a specific marketplace."
|
|
FulfillmentPolicyRequest:
|
|
type: "object"
|
|
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. <br><br><b>Max length</b>: 250"
|
|
freightShipping:
|
|
type: "boolean"
|
|
description: "This field is included and set to <code>true</code> if freight\
|
|
\ shipping is available for the item. Freight shipping can be used for\
|
|
\ large items over 150 lbs.<br><br><b>Default</b>: false"
|
|
globalShipping:
|
|
type: "boolean"
|
|
description: "<span class=\"tablenote\"><b>Note</b>: This field is only\
|
|
\ applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This\
|
|
\ field is included and set to <code>true</code> if the seller wants to\
|
|
\ use the Global Shipping Program for international shipments. See the\
|
|
\ <a href=\"https://pages.ebay.com/help/sell/shipping-globally.html \"\
|
|
>Global Shipping Program</a> help topic for more details and requirements\
|
|
\ on the Global Shipping Program.<br><br>A seller can use a combination\
|
|
\ of the Global Shipping Program and other international shipping services.\
|
|
\ <br><br>If set to <code>false</code> or if the field is omitted, the\
|
|
\ seller has to manually specifying individual international shipping\
|
|
\ services (if the seller ships internationally), as described in <a href=\"\
|
|
https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html\
|
|
\ \">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out\
|
|
\ of the Global Shipping Program through the Shipping preferences in My\
|
|
\ eBay.<br><br>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.<p><b>Default</b>:\
|
|
\ false</p>"
|
|
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.<br><br>Valid\
|
|
\ values can vary by site and by category. To obtain the supported values\
|
|
\ for a site, call <a href=\"/devzone/xml/docs/reference/ebay/GeteBayDetails.html\"\
|
|
>GeteBayDetails</a> in the Trading API with <b>DetailName</b> set to <code>DispatchTimeMaxDetails</code>,\
|
|
\ then inspect the <b>DispatchTimeMaxDetails</b> container in the response\
|
|
\ for the time values supported by the site (typical handling times are\
|
|
\ <code>0</code>, <code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>,\
|
|
\ <code>5</code>, <code>10</code>, <code>15</code>, and <code>20</code>,\
|
|
\ but these can vary by site and may change over time.) <p>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 (<code>\"localPickup\":\
|
|
\ \"true\"</code>), or if it will be shipped through a freight shipping\
|
|
\ service (<code>\"freightShipping\": \"true\"</code>). </p> <span class=\"\
|
|
tablenote\"><b>Note: </b> 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.</span>"
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
localPickup:
|
|
type: "boolean"
|
|
description: "This field should be included and set to <code>true</code>\
|
|
\ 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.<br><br>With local pickup, the\
|
|
\ buyer and seller make arrangements for pickup time and location.<br><br><b>Default</b>:\
|
|
\ <code>false</code>"
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this fulfillment policy\
|
|
\ applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this fulfillment policy. Names must\
|
|
\ be unique for policies assigned to the same marketplace. <br><br><b>Max\
|
|
\ length</b>: 64"
|
|
pickupDropOff:
|
|
type: "boolean"
|
|
description: "This field should be included and set to <code>true</code>\
|
|
\ if the seller offers the \"Click and Collect\" feature for an item.\
|
|
\ <p>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.</p> <p>In addition to setting this field to <code>true</code>,\
|
|
\ the merchant must also do the following to enable the \"Click and Collect\"\
|
|
\ option on a listing: <ul><li>Have inventory for the product at one or\
|
|
\ more physical stores tied to the merchant's account. <p>Sellers can\
|
|
\ use the <b>createInventoryLocation</b> method in the Inventory API to\
|
|
\ associate physical stores to their account and they can then add inventory\
|
|
\ to specific store locations.</p></li><li>Set an immediate payment requirement\
|
|
\ on the item. The immediate payment feature requires the seller to: <ul><li>Set\
|
|
\ the <b>immediatePay</b> flag in the payment policy to 'true'.</li><li>Have\
|
|
\ a valid store location with a complete street address.</li></ul></li></ul><p>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.</p><b>Default</b>: false"
|
|
shippingOptions:
|
|
type: "array"
|
|
description: "This array is used to provide detailed information on the\
|
|
\ domestic and international shipping options available for the policy.\
|
|
\ <br><br>A separate <b>ShippingOption</b> object is required for domestic\
|
|
\ shipping service options and for international shipping service options\
|
|
\ (if the seller ships to international locations). <ul><li>The <b>optionType</b>\
|
|
\ field is used to indicate whether the <b>ShippingOption</b> object applies\
|
|
\ to domestic or international shipping, and the <b>costType</b> field\
|
|
\ is used to indicate whether flat-rate shipping or calculated shipping\
|
|
\ will be used.</li> <li>The <b>rateTableId</b> field can be used to associate\
|
|
\ a defined shipping rate table to the policy, and the <b>packageHandlingCost</b>\
|
|
\ container can be used to set a handling charge for the policy.</li></ul>\
|
|
\ <p>A separate <b>ShippingServices</b> object will be used to specify\
|
|
\ cost and other details for every available domestic and international\
|
|
\ shipping service option. </p>"
|
|
items:
|
|
$ref: "#/components/schemas/ShippingOption"
|
|
shipToLocations:
|
|
description: "This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b>\
|
|
\ 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 <b>shipToLocations</b> container that can\
|
|
\ be set at the shipping service option level.<br><br><span class=\"tablenote\"\
|
|
><b>Note:</b> Any shipping exclusions specified through this container\
|
|
\ can be overridden by the eBay International Shipping exclusions toggle\
|
|
\ located under <b>Shipping Preferences</b> in <b>My eBay</b>. For more\
|
|
\ information on eBay International Shipping, see <a href=\"https://www.ebay.com/help/selling/shipping-items/setting-shipping-options/ebay-international-shipping-program?id=5348\"\
|
|
\ target=\"_blank\">eBay International Shipping program</a>.</span><br>To\
|
|
\ retrieve the valid geographical shipping region values, two-digit country\
|
|
\ values, or special domestic regions for an eBay marketplace, call <a\
|
|
\ href=\"/devzone/xml/docs/reference/ebay/GeteBayDetails.html\">GeteBayDetails</a>\
|
|
\ with <b>DetailName</b> value set to <code>ExcludeShippingLocationDetails</code>,\
|
|
\ then review the <b>ExcludeShippingLocationDetails</b> containers in\
|
|
\ the response for the strings you use in both the <b>regionIncluded.regionName</b>\
|
|
\ and in the <b>regionExcluded.regionName</b> fields. <br><br>For valid\
|
|
\ geographical region names, look for the <code>ExcludeShippingLocationDetails</code>\
|
|
\ containers in the <b>GeteBayDetails</b> response where the <b>Region</b>\
|
|
\ value is <code>Worldwide</code>, and the valid values will be shown\
|
|
\ in the corresponding <b>Location</b> fields. <br><br>For valid two-digit\
|
|
\ country codes, look for <code>ExcludeShippingLocationDetails</code>\
|
|
\ in the <b>GeteBayDetails</b> response where the <b>Region</b> value\
|
|
\ is one of the defined geographical regions, and the valid values will\
|
|
\ be shown in the corresponding <b>Location</b> fields. Alternatively,\
|
|
\ you can find the two-digit country code values in the <a href=\"/api-docs/sell/account/types/ba:CountryCodeEnum\"\
|
|
>CountryCodeEnum</a> type definition. For valid domestic region values,\
|
|
\ look for <code>ExcludeShippingLocationDetails</code> in the <b>GeteBayDetails</b>\
|
|
\ response where the <b>Region</b> value is either <code>Domestic Location</code>\
|
|
\ or <code>Additional Locations</code>, and the valid values will be shown\
|
|
\ in the corresponding <b>Location</b> fields. <br><br>The <code>STATE_OR_PROVINCE</code>\
|
|
\ region type is only applicable to the US and Canada, and valid values\
|
|
\ for US states are the same <a href=\"https://about.usps.com/who-we-are/postal-history/state-abbreviations.htm\
|
|
\ \">two-digit abbreviations</a> used by the United States Postal Service,\
|
|
\ and valid values for Canadian provinces and territories are the same\
|
|
\ <a href=\"https://www.canadapost-postescanada.ca/cpc/en/support/articles/addressing-guidelines/symbols-and-abbreviations.page\
|
|
\ \">two-digit abbreviations</a> 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"
|
|
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. <br><br>If no fulfillment policies are defined for the\
|
|
\ specified marketplace, this field is returned with a value of <code>0</code>."
|
|
format: "int32"
|
|
description: "The response payload for the <b>getFulfillmentPolicies</b> method.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note</b>: Pagination has not yet been enabled for\
|
|
\ <b>getFulfillmentPolicies</b>, so all of the pagination-related fields are\
|
|
\ for future use.</span>"
|
|
InternationalReturnOverrideType:
|
|
type: "object"
|
|
properties:
|
|
returnMethod:
|
|
type: "string"
|
|
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. For implementation help, refer\
|
|
\ to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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. \
|
|
\ <br><br>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 <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\"\
|
|
>getReturnPolicies</a> method of the <b>Metadata API</b>. <br><br>The\
|
|
\ <b>TimeDuration</b> type is used to set/indicate the return period,\
|
|
\ and you set the <b>unit</b> value to <code>DAY</code> and the <b>value</b>\
|
|
\ field to either <code>30</code> or <code>60</code> (or other value,\
|
|
\ as appropriate). <br><br>Note that this value cannot be modified if\
|
|
\ the listing has bids or sales, or if the listing ends within 12 hours.\
|
|
\ <br><br>This field is conditionally required if the <b>internationalOverride.returnsAccepted</b>\
|
|
\ field is set to <code>true</code>."
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
returnsAccepted:
|
|
type: "boolean"
|
|
description: "If set to <code>true</code>, the seller accepts international\
|
|
\ returns. If set to <code>false</code>, the seller does not accept international\
|
|
\ returns. <br><br>This field is conditionally required if the seller\
|
|
\ chooses to have a separate international return policy."
|
|
returnShippingCostPayer:
|
|
type: "string"
|
|
description: "This field indicates who is responsible for paying for the\
|
|
\ shipping charges for returned items. The field can be set to either\
|
|
\ <code>BUYER</code> or <code>SELLER</code>. <br><br>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. <br><br>This field is conditionally required\
|
|
\ if the <b>internationalOverride.returnsAccepted</b> field is set to\
|
|
\ <code>true</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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:
|
|
type: "string"
|
|
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 <b>detailMessage</b> and other applicable, corresponding\
|
|
\ fields. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/kyc:DetailsType'>eBay\
|
|
\ API documentation</a>"
|
|
dueDate:
|
|
type: "string"
|
|
description: "The timestamp in this field indicates the date by which the\
|
|
\ seller should resolve the KYC requirement.<br><br>The timestamp in this\
|
|
\ field uses the UTC date and time format described in the <a href=\"\
|
|
https://www.iso.org/iso-8601-date-and-time-format.html\" target=\"_blank\"\
|
|
>ISO 8601 Standard</a>. See below for this format and an example: <br><br><i>MM-DD-YYYY\
|
|
\ HH:MM:SS</i><br/><code>06-05-2020 10:34:18</code>"
|
|
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, '<code>Upload bank document now.</code>'.\
|
|
\ The <b>detailMessage</b> 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, '<code>Please upload a bank document\
|
|
\ by 2020-08-01 to get your account back in good standing.</code>'."
|
|
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.<br/><br/>If no KYC checks are currently\
|
|
\ required from the seller, this array is not returned, and the seller\
|
|
\ only receives a <code>204 No Content</code> HTTP status code."
|
|
items:
|
|
$ref: "#/components/schemas/KycCheck"
|
|
description: "This is the base response type of the <b>getKYC</b> method."
|
|
PaymentMethod:
|
|
type: "object"
|
|
properties:
|
|
brands:
|
|
type: "array"
|
|
description: "<span class=\"tablenote\"><b>Note</b>: 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. </span>"
|
|
items:
|
|
type: "string"
|
|
description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentInstrumentBrandEnum'>eBay\
|
|
\ API documentation</a>"
|
|
paymentMethodType:
|
|
type: "string"
|
|
description: "This array is only applicable for listings supporting offline\
|
|
\ payment methods. See the <b>PaymentMethodTypeEnum</b> type for supported\
|
|
\ offline payment method enum values. If offline payments are enabled\
|
|
\ for the policy, provide at least one offline payment method.</p> For\
|
|
\ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentMethodTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
recipientAccountReference:
|
|
description: "<span class=\"tablenote\"><b>Note</b>: 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. </span>"
|
|
$ref: "#/components/schemas/RecipientAccountReference"
|
|
description: "This type is used by the <b>paymentMethods</b> container, which\
|
|
\ is used by the seller to specify one or more offline payment methods. <br><br>\
|
|
\ <span class=\"tablenote\"><b>Note</b>: 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.</span>"
|
|
PaymentPolicy:
|
|
type: "object"
|
|
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 <b>categoryTypes.name</b>\
|
|
\ field is set to <code>MOTORS_VEHICLES</code>, and is only returned if\
|
|
\ the seller requires an initial deposit on motor vehicles.<br><br>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). <p class=\"tablenote\"><b>Note:</b> The due date that is specified\
|
|
\ in the <b>deposit</b> 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. </p>"
|
|
$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.\
|
|
\ <br><br><b>Max length</b>: 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 <b>categoryTypes</b> is set to <code>MOTORS_VEHICLES</code>.\
|
|
\ <br><br>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 <b>TimeDuration</b>, are:<ul><li>3\
|
|
\ DAYS</li><li>7 DAYS (the default)</li><li>10 DAYS</li><li>14 DAYS</li></ul>A\
|
|
\ <code>MOTORS_VEHICLES</code>) payment business policy must specify at\
|
|
\ least one of the following <b>paymentMethods</b> values for the final\
|
|
\ payment: <ul> <li>CASH_ON_PICKUP<br><br><span class=\"tablenote\"><b>Note:</b>\
|
|
\ This payment method is only available to sellers outside the US.</span></li>\
|
|
\ <li>CASHIER_CHECK</li> <li>MONEY_ORDER</li><li>PERSONAL_CHECK</li></ul>"
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
immediatePay:
|
|
type: "boolean"
|
|
description: "If this field is returned as <code>true</code>, immediate\
|
|
\ payment is required from the buyer for: <ul><li>A fixed-price item</li><li>An\
|
|
\ auction item where the buyer uses the 'Buy it Now' option</li><li>A\
|
|
\ deposit for a motor vehicle listing</li></ul><br>It is possible for\
|
|
\ the seller to set this field as <code>true</code> 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:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which the payment business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this payment policy. Names must\
|
|
\ be unique for policies assigned to the same marketplace. <br><br><b>Max\
|
|
\ length</b>: 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. <br><br><b>Max length</b>: 1000"
|
|
paymentMethods:
|
|
type: "array"
|
|
description: "This container is returned to show the payment methods that\
|
|
\ are accepted for the payment business policy. <br><br>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 <b>paymentPolicy</b> response container,\
|
|
\ a container which defines a seller's payment business policy for a specific\
|
|
\ marketplace."
|
|
PaymentPolicyRequest:
|
|
type: "object"
|
|
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.<br><br>Because\
|
|
\ eBay controls all electronic payment methods, sellers do not need to\
|
|
\ specify a payment method and the <b>deposit.paymentMethods</b> array\
|
|
\ is not needed.<p class=\"tablenote\"><b>Note: </b>The 'due date' specified\
|
|
\ in the <b>deposit</b> 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\
|
|
\ <a href=\"/api-docs/sell/account/resources/payment_policy/methods/createPaymentPolicy#request.immediatePay\"\
|
|
>immediatePay</a>.</p>"
|
|
$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. <br><br><b>Max length</b>: 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. <br><br>The period starts when the buyer\
|
|
\ commits to buy. The valid values, as specified with <b>TimeDuration</b>,\
|
|
\ are:<ul><li><code>3 DAYS</code></li><li><code>7 DAYS</code> (the default)</li><li><code>10\
|
|
\ DAYS</code></li><li><code>14 DAYS</code></li></ul>In order for a buyer\
|
|
\ to make a full payment on a motor vehicle, at least one of the following\
|
|
\ <b>paymentMethods</b> values must be specified for the corresponding\
|
|
\ payment business policy: <ul> <li><code>CASH_ON_PICKUP</code></li> <li><code>CASHIER_CHECK</code></li>\
|
|
\ <li><code>MONEY_ORDER</code></li> <li><code>PERSONAL_CHECK</code></li></ul><b>Default:</b>\
|
|
\ <code>7 DAYS</code>"
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
immediatePay:
|
|
type: "boolean"
|
|
description: "This field should be included and set to <code>true</code>\
|
|
\ if the seller wants to require immediate payment from the buyer for:\
|
|
\ <ul><li>A fixed-price item</li><li>An auction item where the buyer is\
|
|
\ using the 'Buy it Now' option</li><li>A deposit for a motor vehicle\
|
|
\ listing</li></ul><br><b>Default:</b> False"
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this payment business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this payment business policy. Names\
|
|
\ must be unique for policies assigned to the same marketplace.<br><br><b>Max\
|
|
\ length:</b> 64"
|
|
paymentInstructions:
|
|
type: "string"
|
|
description: "<p class=\"tablenote\"><b>Note:</b> DO NOT USE THIS FIELD.\
|
|
\ Payment instructions are no longer supported by payment business policies.</p>A\
|
|
\ free-form string field that allows sellers to add detailed payment instructions\
|
|
\ to their listings."
|
|
paymentMethods:
|
|
type: "array"
|
|
description: "<p class=\"tablenote\"><b>Note:</b> 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.</p>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"
|
|
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. <br><br>If no payment business policies are defined\
|
|
\ for the specified marketplace, this field is returned with a value of\
|
|
\ <code>0</code>."
|
|
format: "int32"
|
|
description: "The response payload for the <b>getPaymentPolicies</b> method.\
|
|
\ <br><br><span class=\"tablenote\"><b>Note</b>: Pagination has not yet been\
|
|
\ enabled for <b>getPaymentPolicies</b>, so all of the pagination-related\
|
|
\ fields are for future use.</span>"
|
|
PaymentsProgramOnboardingResponse:
|
|
type: "object"
|
|
properties:
|
|
onboardingStatus:
|
|
type: "string"
|
|
description: "This enumeration value indicates the eligibility of payment\
|
|
\ onboarding for the registered site. For implementation help, refer to\
|
|
\ <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStatus'>eBay\
|
|
\ API documentation</a>"
|
|
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 <strong>name</strong>,\
|
|
\ step <strong>status</strong>, and a <strong>webUrl</strong> to the <code>IN_PROGRESS</code>\
|
|
\ step. The step names are returned in sequential order. "
|
|
items:
|
|
$ref: "#/components/schemas/PaymentsProgramOnboardingSteps"
|
|
description: "Type used by the payments program onboarding response"
|
|
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:
|
|
type: "string"
|
|
description: "This enumeration value indicates the status of the associated\
|
|
\ step. <p> <span class=\"tablenote\"><strong>Note:</strong> Only one\
|
|
\ step can be <code>IN_PROGRESS</code> at a time.</span></p> For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStepStatus'>eBay\
|
|
\ API documentation</a>"
|
|
webUrl:
|
|
type: "string"
|
|
description: "This URL provides access to the <code>IN_PROGRESS</code> step."
|
|
description: "The payments program onboarding steps, status, and link."
|
|
PaymentsProgramResponse:
|
|
type: "object"
|
|
properties:
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which the payment program\
|
|
\ applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
paymentsProgramType:
|
|
type: "string"
|
|
description: "This parameter specifies the payment program whose status\
|
|
\ is returned by the call. <br><br>Currently the only supported payments\
|
|
\ program is <code>EBAY_PAYMENTS</code>. For implementation help, refer\
|
|
\ to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramType'>eBay\
|
|
\ API documentation</a>"
|
|
status:
|
|
type: "string"
|
|
description: "The enumeration value returned in this field indicates whether\
|
|
\ or not the seller's account is enabled for the payments program. For\
|
|
\ implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramStatus'>eBay\
|
|
\ API documentation</a>"
|
|
wasPreviouslyOptedIn:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, the seller was at one point\
|
|
\ opted-in to the associated payment program, but they later opted out\
|
|
\ of the program. A value of <code>false</code> indicates the seller never\
|
|
\ opted-in to the program or if they did opt-in to the program, they never\
|
|
\ opted-out of it. <br><br>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 <code>true</code>\
|
|
\ while the <b>status</b> field returns <code>OPTED_IN</code>."
|
|
description: "The response object containing the sellers status with regards\
|
|
\ to the specified payment program."
|
|
Program:
|
|
type: "object"
|
|
properties:
|
|
programType:
|
|
type: "string"
|
|
description: "The seller program to opt in to when part of an <b>optInToProgram</b>\
|
|
\ request, or out of when part of an <b>optOutOfProgram</b> request.\
|
|
\ When returned in an <b>getOptedInPrograms</b> response, a separate <b>programType</b>\
|
|
\ field is returned for each seller program that the seller is opted in\
|
|
\ to. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ProgramTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "The seller program to opt in to when part of an <b>optInToProgram</b>\
|
|
\ request, or out of when part of an <b>optOutOfProgram</b> request."
|
|
Programs:
|
|
type: "object"
|
|
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 <b>getOptedInPrograms</b> method."
|
|
RateTable:
|
|
type: "object"
|
|
properties:
|
|
countryCode:
|
|
type: "string"
|
|
description: "A two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> country\
|
|
\ code representing the eBay marketplace where the shipping rate table\
|
|
\ is defined. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
locality:
|
|
type: "string"
|
|
description: "This enumeration value returned here indicates whether the\
|
|
\ shipping rate table is a domestic or international shipping rate table.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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 <b>rateTableId</b> 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 <b>getRateTables</b> response."
|
|
RateTableResponse:
|
|
type: "object"
|
|
properties:
|
|
rateTables:
|
|
type: "array"
|
|
description: "An array of all shipping rate tables defined for a marketplace\
|
|
\ (or all marketplaces if no <b>country_code</b> 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 <b>getRateTables</b> method."
|
|
RecipientAccountReference:
|
|
type: "object"
|
|
properties:
|
|
referenceId:
|
|
type: "string"
|
|
description: "<span class=\"tablenote\"><b>Note</b>: 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.</span>"
|
|
referenceType:
|
|
type: "string"
|
|
description: "<span class=\"tablenote\"><b>Note</b>: 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.</span>\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RecipientAccountReferenceTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "<span class=\"tablenote\"><b>Note</b>: 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.</span>"
|
|
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. <br><br>The <a href=\"\
|
|
/devzone/xml/docs/reference/ebay/GeteBayDetails.html\">GeteBayDetails</a>\
|
|
\ 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 <b>GeteBayDetails</b> with the <b>DetailName</b> value\
|
|
\ set to <b>ExcludeShippingLocationDetails</b>."
|
|
regionType:
|
|
type: "string"
|
|
description: "Reserved for future use. <!--The region's type, which can\
|
|
\ be one of the following: 'COUNTRY', 'COUNTRY_REGION', 'STATE_OR_PROVINCE',\
|
|
\ 'WORLD_REGION', or 'WORLDWIDE'.--> For implementation help, refer to\
|
|
\ <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:RegionTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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"
|
|
properties:
|
|
regionExcluded:
|
|
type: "array"
|
|
description: "An array of one or more <b>regionName</b> values that specify\
|
|
\ the areas to where a seller does not ship. A <b>regionExcluded</b> list\
|
|
\ should only be set in the top-level <b>shipToLocations</b> container\
|
|
\ and not within the <b>shippingServices.shipToLocations</b> container\
|
|
\ used to specify which shipping regions are serviced by each available\
|
|
\ shipping service option. <p>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.<br><br>This\
|
|
\ array will be returned as empty if no shipping regions are excluded\
|
|
\ with the fulfillment business policy.<br> <br><span class=\"tablenote\"\
|
|
><b>Note: </b> The <b>regionExcluded</b> array is not applicable for motor\
|
|
\ vehicle business policies on the US, CA, or UK marketplaces. If this\
|
|
\ array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b>\
|
|
\ request, it will be ignored.</span>"
|
|
items:
|
|
$ref: "#/components/schemas/Region"
|
|
regionIncluded:
|
|
type: "array"
|
|
description: "An array of one or more <b>regionName</b> fields that specify\
|
|
\ the areas to where a seller ships. <br>Each eBay marketplace supports\
|
|
\ its own set of allowable shipping locations.<br> <br><span class=\"\
|
|
tablenote\"><b>Note: </b> The <b>regionIncluded</b> array is not applicable\
|
|
\ for motor vehicle business policies on the US, CA, or UK marketplaces.\
|
|
\ If this array is used in a <b>createFulfillmentPolicy</b> or <b>updateFulfillmentPolicy</b>\
|
|
\ request, it will be ignored.</span>"
|
|
items:
|
|
$ref: "#/components/schemas/Region"
|
|
description: "This type consists of the <b>regionIncluded</b> and <b>regionExcluded</b>\
|
|
\ arrays, which indicate the areas to where the seller does and doesn't ship."
|
|
ReturnPolicy:
|
|
type: "object"
|
|
properties:
|
|
categoryTypes:
|
|
type: "array"
|
|
description: "This container indicates which category group that the return\
|
|
\ policy applies to.<br><br><span class=\"tablenote\"><b>Note</b>: Return\
|
|
\ business policies are not applicable to motor vehicle listings, so the\
|
|
\ <b>categoryTypes.name</b> value will always be <code>ALL_EXCLUDING_MOTORS_VEHICLES</code>\
|
|
\ for return business policies.</span>"
|
|
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. <br><br><b>Max length</b>: 250"
|
|
extendedHolidayReturnsOffered:
|
|
type: "boolean"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ This field is deprecated, since eBay no longer supports extended holiday\
|
|
\ returns. Any value supplied in this field is neither read nor returned.</p> "
|
|
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:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this return business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this return business policy. Names\
|
|
\ must be unique for policies assigned to the same marketplace.<br><br><b>Max\
|
|
\ length:</b> 64"
|
|
refundMethod:
|
|
type: "string"
|
|
description: "This field indicates the refund method offered by the seller.\
|
|
\ Its value will be <code>MONEY_BACK</code> unless the seller is enabled\
|
|
\ for <b>Buy online, Pickup in Store</b> or <b>Click and Collect</b>,\
|
|
\ and then it might be <code>MERCHANDISE_CREDIT</code>. Getting their\
|
|
\ money back for returned items is always an option for buyers, regardless\
|
|
\ of what the seller sets in this field. For implementation help, refer\
|
|
\ to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
restockingFeePercentage:
|
|
type: "string"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ 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.</p>"
|
|
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.<br><p class=\"tablenote\"><span style=\"color: #dd1e31;\"\
|
|
><b>Important!</b></span> This field is no longer supported on many eBay\
|
|
\ marketplaces. To see if a marketplace and eBay category does support\
|
|
\ this field, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\"\
|
|
>getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will\
|
|
\ look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code>\
|
|
\ for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for\
|
|
\ DE)"
|
|
returnMethod:
|
|
type: "string"
|
|
description: "This field is only returned if the seller is willing to offer\
|
|
\ a replacement item as an alternative to 'Money Back'. For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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. \
|
|
\ <br><br>Most categories support 30-day and 60-day return periods.<br><br><span\
|
|
\ class=\"tablenote\"><b>Note</b>: Unless the seller has set a separate\
|
|
\ international return policy through the <b>internationalOverride</b>\
|
|
\ container, this return period will be valid for domestic and international\
|
|
\ returns (if the seller ships internationally).</span>"
|
|
$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 <code>true</code>, the seller\
|
|
\ accepts returns. If set to <code>false</code>, the seller does not accept\
|
|
\ returns.<br><br><span class=\"tablenote\"><strong>Note:</strong> Top-Rated\
|
|
\ sellers must accept item returns and the <b>handlingTime</b> 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 <a href=\"https://pages.ebay.com/help/sell/top-rated.html\
|
|
\ \">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span>"
|
|
returnShippingCostPayer:
|
|
type: "string"
|
|
description: "This field indicates who is responsible for paying for the\
|
|
\ shipping charges for returned items. The field can be set to either\
|
|
\ <code>BUYER</code> or <code>SELLER</code>. <br><br>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.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "This type is used by the <b>returnPolicy</b> response container,\
|
|
\ a container which defines a seller's return business policy for a specific\
|
|
\ marketplace."
|
|
ReturnPolicyRequest:
|
|
type: "object"
|
|
properties:
|
|
categoryTypes:
|
|
type: "array"
|
|
description: "This container indicates which category group that the return\
|
|
\ policy applies to.<br><br><span class=\"tablenote\"><b>Note</b>: Return\
|
|
\ business policies are not applicable to motor vehicle listings, so the\
|
|
\ <b>categoryTypes.name</b> value must be set to <code>ALL_EXCLUDING_MOTORS_VEHICLES</code>\
|
|
\ for return business policies.</span>"
|
|
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. <br><br><b>Max length</b>: 250"
|
|
extendedHolidayReturnsOffered:
|
|
type: "boolean"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ This field is deprecated, since eBay no longer supports extended holiday\
|
|
\ returns. Any value supplied in this field is neither read nor returned.</p> "
|
|
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:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this return business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this return business policy. Names\
|
|
\ must be unique for policies assigned to the same marketplace. <br><br><b>Max\
|
|
\ length</b>: 64"
|
|
refundMethod:
|
|
type: "string"
|
|
description: "This field sets the refund method to use for returned items.\
|
|
\ Its value defaults to <code>MONEY_BACK</code> if omitted, so this field\
|
|
\ is only needed for <b>Buy online, Pickup in Store</b> or <b>Click and\
|
|
\ Collect</b> 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.<p class=\"tablenote\"><span style=\"color:\
|
|
\ #dd1e31;\"><b>Important!</b></span> If this field is not included in\
|
|
\ a return business policy, it will default to <code>MONEY_BACK</code>.</p>\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
restockingFeePercentage:
|
|
type: "string"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ 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.</p>"
|
|
returnInstructions:
|
|
type: "string"
|
|
description: "This text-based field provides more details on seller-specified\
|
|
\ return instructions. <br><p class=\"tablenote\"><span style=\"color:\
|
|
\ #dd1e31;\"><b>Important!</b></span> This field is no longer supported\
|
|
\ on many eBay marketplaces. To see if a marketplace and eBay category\
|
|
\ does support this field, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\"\
|
|
>getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will\
|
|
\ look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code>\
|
|
\ for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for\
|
|
\ DE)"
|
|
returnMethod:
|
|
type: "string"
|
|
description: "This field can be used if the seller is willing and able to\
|
|
\ offer a replacement item as an alternative to 'Money Back'. For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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. \
|
|
\ <br><br>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. <p><span class=\"tablenote\"><span style=\"\
|
|
color:#004680\"><strong>Note: </strong>Eligible Parts & Accessories (P&A)\
|
|
\ listings require sellers to offer buyers free returns with a minimum\
|
|
\ return period of 30 days. See <a href=\"/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html\"\
|
|
\ target=\"_blank\">Support for easy returns in Parts and Accessories</a>\
|
|
\ for details.</span></p> <br>For a definitive list of return periods\
|
|
\ for one or more categories, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\"\
|
|
>getReturnPolicies</a> method of the <b>Metadata API</b>.<br><br>The return\
|
|
\ period is set using the <b>TimeDuration</b> type, where you set <b>unit</b>\
|
|
\ to <code>DAY</code> and <b>value</b> to either <code>30</code> or <code>60</code>\
|
|
\ (or other value, as appropriate). <br><br>Note that this value cannot\
|
|
\ be modified if the listing has bids or sales, or if the listing ends\
|
|
\ within 12 hours. <br><br><i>Required if </i> <b>returnsAccepted</b>\
|
|
\ is set to <code>true</code>."
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
returnsAccepted:
|
|
type: "boolean"
|
|
description: "If set to <code>true</code>, the seller accepts returns. If\
|
|
\ set to <code>false</code>, the seller does not accept returns.<br><p><span\
|
|
\ class=\"tablenote\"><strong>Note:</strong>Top-Rated sellers must accept\
|
|
\ item returns and the <b>handlingTime</b> 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 <a href=\"http://pages.ebay.com/help/sell/top-rated.html\
|
|
\ \">Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits</a>.</span></p>"
|
|
returnShippingCostPayer:
|
|
type: "string"
|
|
description: "This field indicates who is responsible for paying for the\
|
|
\ shipping charges for returned items. The field can be set to either\
|
|
\ <code>BUYER</code> or <code>SELLER</code>. <p><span class=\"tablenote\"\
|
|
><span style=\"color:#004680\"><strong>Note: </strong>Eligible Parts &\
|
|
\ Accessories (P&A) listings require sellers to offer buyers free returns\
|
|
\ with a minimum return period of 30 days. See <a href=\"/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html\"\
|
|
\ target=\"_blank\">Support for easy returns in Parts and Accessories</a>\
|
|
\ for details.</span></p> <br>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. <br><br>This field\
|
|
\ is conditionally required if <b>returnsAccepted</b> is set to <code>true</code>.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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"
|
|
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. <br><br>If no return business policies are defined\
|
|
\ for the specified marketplace, this field is returned with a value of\
|
|
\ <code>0</code>."
|
|
format: "int32"
|
|
description: "The response payload for the <b>getReturnPolicies</b> method.\
|
|
\ <br><br><span class=\"tablenote\"><b>Note</b>: Pagination has not yet been\
|
|
\ enabled for <b>getReturnPolicies</b>, so all of the pagination-related fields\
|
|
\ are for future use.</span>"
|
|
SalesTax:
|
|
type: "object"
|
|
properties:
|
|
countryCode:
|
|
type: "string"
|
|
description: "The country code enumeration value identifies the country\
|
|
\ to which this sales tax rate applies.<br><br><span class=\"tablenote\"\
|
|
><b>Note:</b> Sales-tax tables are available only for the US and Canada\
|
|
\ marketplaces. Therefore, the only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
salesTaxJurisdictionId:
|
|
type: "string"
|
|
description: "A unique ID that identifies the sales tax jurisdiction to\
|
|
\ which the sales tax rate applies.<br><br><span class=\"tablenote\"><b>Note:</b>\
|
|
\ When the returned <code>countryCode</code> is <code>US</code>, the only\
|
|
\ supported return values for <code>salesTaxJurisdictionId</code> are:<ul><li><code>AS</code>\
|
|
\ (American Samoa)</li><li><code>GU</code> (Guam</li><li><code>MP</code>\
|
|
\ Northern Mariana Islands</li><li><code>PW (Palau)</li><li><code>VI</code>\
|
|
\ (US Virgin Islands)</li></ul></span>"
|
|
salesTaxPercentage:
|
|
type: "string"
|
|
description: "The sales tax rate that will be applied to sales price. The\
|
|
\ <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales\
|
|
\ tax is also applied to shipping and handling charges<br><br>Although\
|
|
\ it is a string, a percentage value is returned here, such as <code>7.75</code>"
|
|
shippingAndHandlingTaxed:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, 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"
|
|
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 <b>shippingAndHandlingTaxed</b>\
|
|
\ value will indicate whether or not sales tax is also applied to shipping\
|
|
\ and handling charges<br><br>Although it is a string, a percentage value\
|
|
\ is set here, such as <code>7.75</code>."
|
|
shippingAndHandlingTaxed:
|
|
type: "boolean"
|
|
description: "This field is set to <code>true</code> 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 <code>false</code>."
|
|
description: "This type is used by the base request of the <b>createOrReplaceSalesTax</b>. "
|
|
SalesTaxInput:
|
|
type: "object"
|
|
properties:
|
|
countryCode:
|
|
type: "string"
|
|
description: "This parameter specifies the two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> code\
|
|
\ of the country for which a sales-tax table entry is to be created or\
|
|
\ updated.<br><br><span class=\"tablenote\"><b>Note:</b> Sales-tax tables\
|
|
\ are available only for the US and Canada marketplaces. Therefore, the\
|
|
\ only supported values are:<ul><li><code>US</code></li><li><code>CA</code></li></ul></span>"
|
|
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.<br><br>Valid\
|
|
\ jurisdiction IDs can be retrieved using the <a href=\"/api-docs/sell/metadata/resources/country/methods/getSalesTaxJurisdictions\"\
|
|
\ target=\"_blank \">getSalesTaxJurisdiction</a> method of the Metadata\
|
|
\ API.<br><br><span class=\"tablenote\"><b>Note:</b> When <code>countryCode</code>\
|
|
\ is set to <code>US</code>, the only supported values for <code>jurisdictionId</code>\
|
|
\ are:<ul><li><code>AS</code> (American Samoa)</li><li><code>GU</code>\
|
|
\ (Guam)</li><li><code>MP</code> (Northern Mariana Islands)</li><li><code>PW</code>\
|
|
\ (Palau)</li><li><code>VI</code> (US Virgin Islands)</li></ul></span>"
|
|
salesTaxPercentage:
|
|
type: "string"
|
|
description: "This parameter specifies the sales tax rate for the specified\
|
|
\ <b>salesTaxJurisdictionId</b>. When applicable to an order, this sales\
|
|
\ tax rate will be applied to the sales price. The <b>shippingAndHandlingTaxed</b>\
|
|
\ value indicates whether or not sales tax is also applied to shipping\
|
|
\ and handling charges<br><br>Although it is a string, a percentage value\
|
|
\ is set here, such as <code>7.75</code>."
|
|
shippingAndHandlingTaxed:
|
|
type: "boolean"
|
|
description: "This parameter is set to <code>true</code> 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 <code>false</code>."
|
|
SalesTaxes:
|
|
type: "object"
|
|
properties:
|
|
salesTaxes:
|
|
type: "array"
|
|
description: "An array of one or more sales-tax rate entries for a specified\
|
|
\ country.<br><br>If no sales-tax rate entries are set up, no response\
|
|
\ payload is returned, but an HTTP status code of <code>204 No Content</code>\
|
|
\ is returned."
|
|
items:
|
|
$ref: "#/components/schemas/SalesTax"
|
|
description: "This type is used by the root response of the <b>getSalesTaxes</b>\
|
|
\ method."
|
|
SellerEligibilityMultiProgramResponse:
|
|
type: "object"
|
|
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 <b>getAdvertisingEligibility</b> method\
|
|
\ that contains the seller eligibility information for one or more advertising\
|
|
\ programs."
|
|
SellerEligibilityResponse:
|
|
type: "object"
|
|
properties:
|
|
programType:
|
|
type: "string"
|
|
description: "The eBay advertising program for which a seller may be eligible.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:AdvertisingProgramEnum'>eBay\
|
|
\ API documentation</a>"
|
|
reason:
|
|
type: "string"
|
|
description: "The reason why a seller is ineligible for the specified eBay\
|
|
\ advertising program.<br /><br />This field is only returned if the seller\
|
|
\ is ineligible for the eBay advertising program. For implementation help,\
|
|
\ refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/plser:SellerIneligibleReasonEnum'>eBay\
|
|
\ API documentation</a>"
|
|
status:
|
|
type: "string"
|
|
description: "The seller eligibility status for the specified eBay advertising\
|
|
\ program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/cmlib:SellerEligibilityEnum'>eBay\
|
|
\ API documentation</a>"
|
|
description: "A type that is used to provide the seller's eligibility status\
|
|
\ for an eBay advertising program."
|
|
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 <b>sellingLimit</b> 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"
|
|
properties:
|
|
sellerRegistrationCompleted:
|
|
type: "boolean"
|
|
description: "If this field is returned as <code>true</code>, the seller's\
|
|
\ registration is completed. If this field is returned as <code>false</code>,\
|
|
\ 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. <p><span class=\"tablenote\"><span\
|
|
\ style=\"color:#004680\"><strong>Note: </strong>The selling limit value\
|
|
\ returned in <b>getPrivileges</b> may vary slightly from the value displayed\
|
|
\ in Seller Hub. The value in Seller Hub is an abbreviated figure, where\
|
|
\ rounding is applied.</span></p>"
|
|
$ref: "#/components/schemas/SellingLimit"
|
|
description: "This type is used by the base response of the <b>getPrivileges</b>\
|
|
\ method."
|
|
SetFulfillmentPolicyResponse:
|
|
type: "object"
|
|
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. <br><br><b>Max\
|
|
\ length</b>: 250"
|
|
freightShipping:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, 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: "<span class=\"tablenote\"><b>Note</b>: This field is only\
|
|
\ applicable for the eBay United Kingdom marketplace (<code>EBAY_GB</code>).</span><br>This\
|
|
\ field is included and set to <code>true</code> if the seller wants to\
|
|
\ use the Global Shipping Program for international shipments. See the\
|
|
\ <a href=\"https://pages.ebay.com/help/sell/shipping-globally.html \"\
|
|
>Global Shipping Program</a> help topic for more details and requirements\
|
|
\ on the Global Shipping Program.<br><br>A seller can use a combination\
|
|
\ of the Global Shipping Program and other international shipping services.\
|
|
\ <br><br>If set to <code>false</code> or if the field is omitted, the\
|
|
\ seller has to manually specifying individual international shipping\
|
|
\ services (if the seller ships internationally), as described in <a href=\"\
|
|
https://developer.ebay.com/api-docs/sell/static/seller-accounts/ht_shipping-worldwide.html\
|
|
\ \">Setting up worldwide shipping</a>. <br><br>Sellers opt in or out\
|
|
\ of the Global Shipping Program through the Shipping preferences in My\
|
|
\ eBay.<br><br>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.</span>"
|
|
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. <p>If only local pickup or\
|
|
\ freight shipping is available for the item, this container may not get\
|
|
\ returned.</p>"
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
localPickup:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, local pickup is available\
|
|
\ for items using this policy."
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this fulfillment business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this fulfillment business policy.\
|
|
\ <br><br><b>Max length</b>: 64"
|
|
pickupDropOff:
|
|
type: "boolean"
|
|
description: "If returned as <code>true</code>, the seller offers the \"\
|
|
Click and Collect\" option. <br><br>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 <b>ShippingOption</b> object covers domestic shipping service\
|
|
\ options and international shipping service options (if the seller ships\
|
|
\ to international locations). <br><br>The <b>optionType</b> field indicates\
|
|
\ whether the <b>ShippingOption</b> object applies to domestic or international\
|
|
\ shipping, and the <b>costType</b> field indicates whether flat-rate\
|
|
\ shipping or calculated shipping will be used. <p>A separate <b>ShippingServices</b>\
|
|
\ object is used to specify cost and other details for every available\
|
|
\ domestic and international shipping service option. </p>"
|
|
items:
|
|
$ref: "#/components/schemas/ShippingOption"
|
|
shipToLocations:
|
|
description: "This container consists of the <b>regionIncluded</b> and <b>regionExcluded</b>\
|
|
\ 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/Error"
|
|
description: "Complex type that that gets populated with a response containing\
|
|
\ a fulfillment policy."
|
|
SetPaymentPolicyResponse:
|
|
type: "object"
|
|
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. <br><br><b>Max\
|
|
\ length</b>: 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.<p class=\"tablenote\"\
|
|
><b>Note:</b> This value is always returned if <b>categoryTypes</b> is\
|
|
\ set to <code>MOTORS_VEHICLES</code>.</p> "
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
immediatePay:
|
|
type: "boolean"
|
|
description: "The value returned in this field will reflect the value set\
|
|
\ by the seller in the <b>immediatePay</b> request field. A value of <code>true</code>\
|
|
\ indicates that immediate payment is required from the buyer for: <ul><li>A\
|
|
\ fixed-price item</li><li>An auction item where the buyer is using the\
|
|
\ 'Buy it Now' option</li><li>A deposit for a motor vehicle listing</li></ul><br>It\
|
|
\ is possible for the seller to set this field as <code>true</code> 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:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this payment business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this payment business policy. Names\
|
|
\ must be unique for policies assigned to the same marketplace.<br><br><b>Max\
|
|
\ length:</b> 64"
|
|
paymentInstructions:
|
|
type: "string"
|
|
description: "<p class=\"tablenote\"><b>Note:</b> 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.</p>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.<br><br>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/Error"
|
|
description: "Complex type that that gets populated with a response containing\
|
|
\ a payment policy."
|
|
SetReturnPolicyResponse:
|
|
type: "object"
|
|
properties:
|
|
categoryTypes:
|
|
type: "array"
|
|
description: "This field always returns <code>ALL_EXCLUDING_MOTORS_VEHICLES</code>\
|
|
\ 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. <br><br><b>Max\
|
|
\ length</b>: 250"
|
|
extendedHolidayReturnsOffered:
|
|
type: "boolean"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ This field is deprecated, since eBay no longer supports extended holiday\
|
|
\ returns. This field should no longer be returned.</p> "
|
|
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:
|
|
type: "string"
|
|
description: "The ID of the eBay marketplace to which this return business\
|
|
\ policy applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
name:
|
|
type: "string"
|
|
description: "A seller-defined name for this return business policy. Names\
|
|
\ must be unique for policies assigned to the same marketplace.<br><br><b>Max\
|
|
\ length:</b> 64"
|
|
refundMethod:
|
|
type: "string"
|
|
description: "If a seller indicates that they will accept buyer returns,\
|
|
\ this value will be <code>MONEY_BACK</code>. For implementation help,\
|
|
\ refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:RefundMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
restockingFeePercentage:
|
|
type: "string"
|
|
description: "<p class=\"tablenote\"><span style=\"color: #dd1e31;\"><b>Important!</b></span>\
|
|
\ This field is deprecated, since eBay no longer allows sellers to charge\
|
|
\ a restocking fee for buyer remorse returns.</p>"
|
|
returnInstructions:
|
|
type: "string"
|
|
description: "This text-based field provides more details on seller-specified\
|
|
\ return instructions. <br><p class=\"tablenote\"><span style=\"color:\
|
|
\ #dd1e31;\"><b>Important!</b></span> This field is no longer supported\
|
|
\ on many eBay marketplaces. To see if a marketplace and eBay category\
|
|
\ does support this field, call <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getReturnPolicies\"\
|
|
>getReturnPolicies</a> method of the <b>Metadata API</b>. Then you will\
|
|
\ look for the <b>policyDescriptionEnabled</b> field with a value of <code>true</code>\
|
|
\ for the eBay category.</span></p><br><b>Max length</b>: 5000 (8000 for\
|
|
\ DE)"
|
|
returnMethod:
|
|
type: "string"
|
|
description: "This field will be returned if the seller is willing and able\
|
|
\ to offer a replacement item as an alternative to 'Money Back'. For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnMethodEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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. <br><p><span class=\"\
|
|
tablenote\"><span style=\"color:#004680\"><strong>Note: </strong>Eligible\
|
|
\ Parts & Accessories (P&A) listings require sellers to offer buyers free\
|
|
\ returns with a minimum return period of 30 days. See <a href=\"/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html\"\
|
|
\ target=\"_blank\">Support for easy returns in Parts and Accessories</a>\
|
|
\ for details.</span></p>"
|
|
$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 <code>true</code>, the seller accepts returns. If\
|
|
\ set to <code>false</code>, this field indicates that the seller does\
|
|
\ not accept returns."
|
|
returnShippingCostPayer:
|
|
type: "string"
|
|
description: "This field indicates who is responsible for paying for the\
|
|
\ shipping charges for returned items. The field can be set to either\
|
|
\ <code>BUYER</code> or <code>SELLER</code>. <p><span class=\"tablenote\"\
|
|
><span style=\"color:#004680\"><strong>Note: </strong>Eligible Parts &\
|
|
\ Accessories (P&A) listings require sellers to offer buyers free returns\
|
|
\ with a minimum return period of 30 days. See <a href=\"/api-docs/user-guides/static/trading-user-guide/ebay-motors-parts-accessories-easy-returns.html\"\
|
|
\ target=\"_blank\">Support for easy returns in Parts and Accessories</a>\
|
|
\ for details.</span></p> <br>Note that the seller is always responsible\
|
|
\ for return shipping costs for SNAD-related issues. <br><br>This container\
|
|
\ will be returned unless the business policy states that the seller does\
|
|
\ not accept returns. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ReturnShippingCostPayerEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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/Error"
|
|
description: "A complex type that is populated with a response containing a\
|
|
\ return policies."
|
|
ShippingOption:
|
|
type: "object"
|
|
properties:
|
|
costType:
|
|
type: "string"
|
|
description: "This field defines whether the shipping cost model is <code>FLAT_RATE</code>\
|
|
\ (the same rate for all buyers, or buyers within a region if shipping\
|
|
\ rate tables are used) or <code>CALCULATED</code> (the shipping rate\
|
|
\ varies by the ship-to location and size and weight of the package).\
|
|
\ <br><br>This field is conditionally required if any shipping service\
|
|
\ options are specified (domestic and/or international). For implementation\
|
|
\ help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingCostTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
insuranceFee:
|
|
description: "This field has been deprecated. <br><br>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. <br><br>Shipping insurance\
|
|
\ is offered only via a shipping carrier's shipping services and is no\
|
|
\ longer available via eBay shipping policies."
|
|
optionType:
|
|
type: "string"
|
|
description: "This field is used to indicate if the corresponding shipping\
|
|
\ service options (under <b>shippingServices</b> array) are domestic or\
|
|
\ international shipping service options. This field is conditionally\
|
|
\ required if any shipping service options are specified (domestic and/or\
|
|
\ international). For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
packageHandlingCost:
|
|
description: "This container is used if the seller adds handling charges\
|
|
\ to domestic and/or international shipments. <br><br>Sellers can not\
|
|
\ specify any domestic handling charges if they offered 'free shipping'\
|
|
\ in the policy.<br><br>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 <a href=\"/api-docs/sell/account/resources/rate_table/methods/getRateTables\"\
|
|
>getRateTables</a> method can be used to retrieve shipping rate table\
|
|
\ IDs.<br><br>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.<br><br>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. <br><br>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 <b>shippingServices</b> array.<br><br>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. <br><br>The seller can create and manage shipping\
|
|
\ discount profiles using (Get/Set) <b>ShippingDiscountProfiles</b> calls\
|
|
\ in the <b>Trading API</b> or through the <b>Shipping Preferences</b>\
|
|
\ in <b>My eBay</b>."
|
|
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. <br><br>The\
|
|
\ seller can create and manage shipping promotional discounts using (Get/Set)\
|
|
\ <b>ShippingDiscountProfiles</b> calls in the <b>Trading API</b> or through\
|
|
\ the <b>Shipping Preferences</b> in <b>My eBay</b>."
|
|
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\
|
|
\ <b>shippingOptions.optionType</b> 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.) <br><br>Sellers can specify up\
|
|
\ to four domestic shipping services and up to five international shipping\
|
|
\ service options by using separate <b>shippingService</b> 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. <br><br> See <a href=\"/api-docs/sell/static/seller-accounts/ht_shipping-setting-shipping-carrier-and-service-values.html\"\
|
|
\ target=\"_blank\">How to set up shipping carrier and shipping service\
|
|
\ values</a>. <br><br>To use the eBay standard envelope service (eSE),\
|
|
\ see <a href=\"/api-docs/sell/static/seller-accounts/using-the-ebay-standard-envelope-service.html\"\
|
|
\ target=\"_blank\">Using eBay standard envelope (eSE) service</a>.<br><br>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 <b>shippingOptions</b> array, which is\
|
|
\ used to provide detailed information on the domestic and international shipping\
|
|
\ options available for the policy. A separate <b>ShippingOption</b> object\
|
|
\ covers domestic shipping service options and international shipping service\
|
|
\ options (if the seller ships to international locations)."
|
|
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 <b>shippingCost</b> 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. <br><br>The seller can ship multiple quantities of the\
|
|
\ line item in the same package and pass on the shipping savings to the\
|
|
\ buyer.<br><br>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 <b>shippingCost</b> 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.<br><br>This field\
|
|
\ is not applicable to auction listings or single-quantity, fixed-price\
|
|
\ listings.<br><br>This container is returned if set."
|
|
$ref: "#/components/schemas/Amount"
|
|
buyerResponsibleForPickup:
|
|
type: "boolean"
|
|
description: "This field should be included and set to <code>true</code>\
|
|
\ 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. <br><br>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. <br><br>This field is returned\
|
|
\ if set.<br><br><b>Default</b>: false"
|
|
buyerResponsibleForShipping:
|
|
type: "boolean"
|
|
description: "This field should be included and set to <code>true</code>\
|
|
\ for a motor vehicle listing if it will be the buyer's responsibility\
|
|
\ to arrange for shipment of a motor vehicle. <br><br>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. <br><br>This field is returned if set.<br><br><b>Default</b>:\
|
|
\ false"
|
|
freeShipping:
|
|
type: "boolean"
|
|
description: "This field is included and set to <code>true</code> if the\
|
|
\ seller offers a free domestic shipping option to the buyer. <br><br>This\
|
|
\ field can only be included and set to <code>true</code> for the first\
|
|
\ domestic shipping service option specified in the <b>shippingServices</b>\
|
|
\ array (it is ignored if set for subsequent shipping services or for\
|
|
\ any international shipping service option). <br><br>The first specified\
|
|
\ shipping service option has a <b>sortOrder</b> value of <code>1</code>\
|
|
\ or if the <b>sortOrderId</b> field is not used, it is the shipping service\
|
|
\ option that's specified first in the <b>shippingServices</b> array.<br><br>This\
|
|
\ container is returned if set."
|
|
shippingCarrierCode:
|
|
type: "string"
|
|
description: "This field sets/indicates the shipping carrier, such as <code>USPS</code>,\
|
|
\ <code>FedEx</code>, or <code>UPS</code>. Although this field uses the\
|
|
\ <b>string</b> type, the seller must pass in a pre-defined enumeration\
|
|
\ value here. <br><br>For a full list of shipping carrier enum values\
|
|
\ for a specified eBay marketplace, the <a href=\"/devzone/xml/docs/reference/ebay/GeteBayDetails.html\"\
|
|
>GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the\
|
|
\ <b>DetailName</b> field's value should be set to <code>ShippingCarrierDetails</code>.\
|
|
\ The enum values for each shipping carriers can be found in each <b>ShippingCarrierDetails.ShippingCarrier</b>\
|
|
\ field in the response payload.<br><br> This field is actually optional,\
|
|
\ as the shipping carrier is also tied into the <b>shippingServiceCode</b>\
|
|
\ enum value, and that field is required for every specified shipping\
|
|
\ service option.<br><br>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. <br><br>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.<br><br>This value is\
|
|
\ automatically set to <code>0.0</code> for the first specified domestic\
|
|
\ shipping service option and if the corresponding <b>freeShipping</b>\
|
|
\ field is set to <code>true</code>. <br><br>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 <code>USPSPriority</code>, <code>FedEx2Day</code>,\
|
|
\ or <code>UPS3rdDay</code>. Although this field uses the <b>string</b>\
|
|
\ type, the seller must pass in a pre-defined enumeration value here.\
|
|
\ <br><br>For a full list of shipping service option enum values for a\
|
|
\ specified eBay marketplace, the <a href=\"/devzone/xml/docs/reference/ebay/GeteBayDetails.html\"\
|
|
>GeteBayDetails</a> call of the <b>Trading API</b> can be used, and the\
|
|
\ <b>DetailName</b> field's value should be set to <code>ShippingServiceDetails</code>.\
|
|
\ <br><br>The enum values for each shipping service option can be found\
|
|
\ in each <b>ShippingServiceDetails.ShippingService</b> field in the response\
|
|
\ payload. The seller must make sure that the shipping service option\
|
|
\ is still valid, which is indicated by a <code>true</code> value in the\
|
|
\ corresponding <b>ValidForSellingFlow</b> boolean field. International\
|
|
\ shipping service options are typically returned at the top of the response\
|
|
\ payload, and are indicated by an <b>InternationalService</b> boolean\
|
|
\ field that reads <code>true</code>. <br><br>The <b>InternationalService</b>\
|
|
\ boolean field is not returned at all for domestic shipping service options.\
|
|
\ <br><br> 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 <b>regionExcluded</b>\
|
|
\ container is defined for <b>RegionSet</b> type and could technically\
|
|
\ be used here, it is recommened that only the <b>regionIncluded</b> container\
|
|
\ be used at the shipping service level. The excluded shipping regions\
|
|
\ (if any) can instead be set up in the top-level <b>regionExcluded</b>\
|
|
\ container. <br><br>The <b>regionIncluded</b> and <b>regionExcluded</b>\
|
|
\ containers define the geographical regions/countries/states or provinces/domestic\
|
|
\ regions where the seller does and doesn't ship to with this fulfillment\
|
|
\ policy.<br><br>To retrieve the valid geographical shipping region values,\
|
|
\ two-digit country values, or special domestic regions for an eBay marketplace,\
|
|
\ call <a href=\"/devzone/xml/docs/reference/ebay/GeteBayDetails.html\"\
|
|
>GeteBayDetails</a> with <b>DetailName</b> value set to <code>ExcludeShippingLocationDetails</code>,\
|
|
\ then review the <b>ExcludeShippingLocationDetails</b> containers in\
|
|
\ the response for the strings you use in the <b>regionIncluded.regionName</b>\
|
|
\ field. <ul><li>For valid geographical region names, look for the <code>ExcludeShippingLocationDetails</code>\
|
|
\ containers in the <b>GeteBayDetails</b> response where the <b>Region</b>\
|
|
\ value is <code>Worldwide</code>, and the valid values will be shown\
|
|
\ in the corresponding <b>Location</b> fields.</li> <li>For valid two-digit\
|
|
\ country codes, look for <code>ExcludeShippingLocationDetails</code>\
|
|
\ in the <b>GeteBayDetails</b> response where the <b>Region</b> value\
|
|
\ is one of the defined geographical regions, and the valid values will\
|
|
\ be shown in the corresponding <b>Location</b> fields. Alternatively,\
|
|
\ you can find the two-digit country code values in the <a href=\"/api-docs/sell/account/types/ba:CountryCodeEnum\"\
|
|
>CountryCodeEnum</a> type definition.</li> <li>For valid domestic region\
|
|
\ values, look for <code>ExcludeShippingLocationDetails</code> in the\
|
|
\ <b>GeteBayDetails</b> response where the <b>Region</b> value is either\
|
|
\ <code>Domestic Location</code> or <code>Additional Locations</code>,\
|
|
\ and the valid values will be shown in the corresponding <b>Location</b>\
|
|
\ fields.</li></ul> The <code>STATE_OR_PROVINCE</code> region type is\
|
|
\ only applicable to the US and Canada, and valid values for US states\
|
|
\ are the same <a href=\"https://about.usps.com/who-we-are/postal-history/state-abbreviations.htm\
|
|
\ \">two-digit abbreviations</a> used by the United States Postal Service,\
|
|
\ and valid values for Canadian provinces and territories are the same\
|
|
\ <a href=\"https://www.canadapost-postescanada.ca/cpc/en/support/articles/addressing-guidelines/symbols-and-abbreviations.page\
|
|
\ \">two-digit abbreviations</a> 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. <br><br>If the <b>sortOrder</b>\
|
|
\ 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. <br><br><b>Min</b>: 1. <b>Max</b>: 4 (for domestic\
|
|
\ shipping service) or 5 (for international shipping service)."
|
|
format: "int32"
|
|
surcharge:
|
|
description: "<span class=\"tablenote\"> <strong>Note:</strong> 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. <br><br>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 <b>shippingOptions.rateTableId</b> field. </span>Shipping\
|
|
\ surcharges cannot be applied at all to international shipping service\
|
|
\ options."
|
|
$ref: "#/components/schemas/Amount"
|
|
description: "This type is used by the <b>shippingServices</b> array, an array\
|
|
\ that provides details about every domestic and international shipping service\
|
|
\ option that is defined for the policy."
|
|
Subscription:
|
|
type: "object"
|
|
properties:
|
|
marketplaceId:
|
|
type: "string"
|
|
description: "The marketplace with which the subscription is associated.\
|
|
\ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay\
|
|
\ API documentation</a>"
|
|
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:
|
|
type: "string"
|
|
description: "The kind of entity with which the subscription is associated,\
|
|
\ such as an eBay store. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:SubscriptionTypeEnum'>eBay\
|
|
\ API documentation</a>"
|
|
term:
|
|
description: "The term of the subscription plan (typically in months)."
|
|
$ref: "#/components/schemas/TimeDuration"
|
|
description: "This type is used by the <strong>getSubscription</strong> response\
|
|
\ container, which defines the subscription types and levels for the seller\
|
|
\ account."
|
|
SubscriptionResponse:
|
|
type: "object"
|
|
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 <b>getSubscription</b>\
|
|
\ method.<br><br><span class=\"tablenote\"><b>Note</b>: Pagination has not\
|
|
\ yet been enabled for <b>getSubscription</b>, so all of the pagination-related\
|
|
\ fields are for future use.</span>"
|
|
TimeDuration:
|
|
type: "object"
|
|
properties:
|
|
unit:
|
|
type: "string"
|
|
description: "These enum values represent the time measurement unit, such\
|
|
\ as <code>DAY</code>. A span of time is defined when you apply the value\
|
|
\ specified in the <b>value</b> field to the value specified for <b>unit</b>.\
|
|
\ <br><br>See <b>TimeDurationUnitEnum</b> for a complete list of possible\
|
|
\ time-measurement units. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:TimeDurationUnitEnum'>eBay\
|
|
\ API documentation</a>"
|
|
value:
|
|
type: "integer"
|
|
description: "An integer that represents an amount of time, as measured\
|
|
\ by the time-measurement unit specified in the <b>unit</b> 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.<br><br>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."
|
|
UpdatedSalesTaxEntry:
|
|
type: "object"
|
|
properties:
|
|
countryCode:
|
|
type: "string"
|
|
description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
|
|
\ \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> 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.<br><br><span class=\"tablenote\"\
|
|
><b>Note:</b> The system returns one HTTP status code regardless of the\
|
|
\ number of sales-tax table entries provided. Therefore, the same HTTP\
|
|
\ <code>statusCode</code> will be listed for all sales-tax table entries\
|
|
\ returned in the payload.</span>"
|
|
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"
|