{"note":"OpenAPI conversion -- returning structured metadata","name":"api-ebay-com-sell-account","description":"Account v1 API","version":"v1.9.3","base_url":"https://api.ebay.com/sell/account/v1","endpoints":37,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Account v1 API\n@base https://api.ebay.com/sell/account/v1\n@version v1.9.3\n@auth OAuth2\n@endpoints 37\n@hint download_for_search\n@toc custom_policy(4), fulfillment_policy(6), payment_policy(6), payments_program(2), privilege(1), program(3), rate_table(1), return_policy(6), bulk_create_or_replace_sales_tax(1), sales_tax(4), subscription(1), kyc(1), advertising_eligibility(1)\n\n@group custom_policy\n@endpoint GET /custom_policy/\n@desc This method retrieves the list of custom policies defined for a seller's account. To limit the returned custom policies, specify the policy_types query parameter.\n@optional {policy_types: str # This query parameter specifies the type of custom policies to be returned.Multiple policy types may be requested in a single call by providing a comma-delimited set of all policy types to be returned.Note: Omitting this query parameter from a request will also return policies of all policy types. See the CustomPolicyTypeEnum type for a list of supported values.}\n@returns(200) {customPolicies: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint POST /custom_policy/\n@desc This method creates a new custom policy that specifies the seller's terms for complying with local governmental regulations. Each Custom Policy targets a policyType. Multiple policies may be created as using the following custom policy types:PRODUCT_COMPLIANCE: Product Compliance policies disclose product information as required for regulatory compliance. Note: A maximum of 60 Product Compliance policies per seller may be created.TAKE_BACK: Takeback policies describe the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one. Note: A maximum of 18 Takeback policies per seller may be created.A successful create policy call returns an HTTP status code of 201 Created with the system-generated policy ID included in the Location response header.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {description: str # Contains the seller's policy and policy terms.Max length: 15,000, label: str # Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to the seller's policy information.Max length: 65, name: str # The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.Note: This field is visible only to the seller. Max length: 65, policyType: str # Specifies the type of custom policy being created. Two Custom Policy types are supported: Product Compliance (PRODUCT_COMPLIANCE) Takeback (TAKE_BACK) For implementation help, refer to eBay API documentation}\n@returns(201) Created\n@errors {400: Bad Request, 409: Policy Name already used/ Maximum no of policies per site reached, 500: Internal Server Error}\n\n@endpoint GET /custom_policy/{custom_policy_id}\n@desc This method retrieves the custom policy specified by the custom_policy_id path parameter.\n@required {custom_policy_id: str # This path parameter is the unique identifier of the custom policy to retrieve. This ID can be retrieved for a custom policy by using the getCustomPolicies method.}\n@returns(200) {customPolicyId: str, description: str, label: str, name: str, policyType: str} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /custom_policy/{custom_policy_id}\n@desc This method updates an existing custom policy specified by the custom_policy_id path parameter. Since this method overwrites the policy's name, label, and description fields, always include the complete and current text of all three policy fields in the request payload, even if they are not being updated. For example, the value for the label field is to be updated, but the name and description values will remain unchanged. The existing name and description values, as they are defined in the current policy, must also be passed in. A successful policy update call returns an HTTP status code of 204 No Content.\n@required {custom_policy_id: str # This path parameter is the unique identifier of the custom policy to update.Note: A list of custom policies defined for a seller's account that includes this ID can be retrieved by calling the getCustomPolicies method., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {description: str # Contains the seller specified policy and policy terms.Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.Max length: 15,000, label: str # Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to seller specified policy information.Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.Max length: 65, name: str # The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller and policy type.Note: This field is visible only to the seller. Note: Always supply this field. If this field is not specified, any previous value is removed. Call the getCustomPolicy method to return the present field value for this policy.Max length: 65}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 409: Policy Name already used/ Maximum no of policies per site reached, 500: Internal Server Error}\n\n@endgroup\n\n@group fulfillment_policy\n@endpoint POST /fulfillment_policy/\n@desc This method creates a new fulfillment policy for an eBay marketplace where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers.  A successful request returns the getFulfillmentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.  Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # 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., description: str # A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, freightShipping: bool # This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.Default: false, globalShipping: bool # Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.A seller can use a combination of the Global Shipping Program and other international shipping services. If set to false or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in Setting up worldwide shipping. Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.Default: false, handlingTime: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., localPickup: bool # This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.With local pickup, the buyer and seller make arrangements for pickup time and location.Default: false, marketplaceId: str # The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64, pickupDropOff: bool # This field should be included and set to true if the seller offers the \"Click and Collect\" feature for an item. To enable \"Click and Collect\" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.  In addition to setting this field to true, the merchant must also do the following to enable the \"Click and Collect\" option on a listing: Have inventory for the product at one or more physical stores tied to the merchant's account. Sellers can use the createInventoryLocation method in the Inventory API to associate physical stores to their account and they can then add inventory to specific store locations.Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to 'true'.Have a valid store location with a complete street address.When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the \"Available for Click and Collect\" option on the listing, along with information on the closest store that has the item.Default: false, shippingOptions: [map{costType: str, insuranceFee: map, insuranceOffered: bool, optionType: str, packageHandlingCost: map, rateTableId: str, shippingDiscountProfileId: str, shippingPromotionOffered: bool, shippingServices: [map]}] # This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). The optionType field is used to indicate whether the ShippingOption object applies to domestic or international shipping, and the costType field is used to indicate whether flat-rate shipping or calculated shipping will be used. The rateTableId field can be used to associate a defined shipping rate table to the policy, and the packageHandlingCost container can be used to set a handling charge for the policy. A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option., shipToLocations: map{regionExcluded: [map], regionIncluded: [map]} # This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship.}\n@returns(201) {categoryTypes: [map], description: str, freightShipping: bool, fulfillmentPolicyId: str, globalShipping: bool, handlingTime: map{unit: str, value: int(int32)}, localPickup: bool, marketplaceId: str, name: str, pickupDropOff: bool, shippingOptions: [map], shipToLocations: map{regionExcluded: [map], regionIncluded: [map]}, warnings: [map]} # Created\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /fulfillment_policy/{fulfillmentPolicyId}\n@desc This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.\n@required {fulfillmentPolicyId: str # This path parameter specifies the ID of the fulfillment policy you want to retrieve. This ID can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.}\n@returns(200) {categoryTypes: [map], description: str, freightShipping: bool, fulfillmentPolicyId: str, globalShipping: bool, handlingTime: map{unit: str, value: int(int32)}, localPickup: bool, marketplaceId: str, name: str, pickupDropOff: bool, shippingOptions: [map], shipToLocations: map{regionExcluded: [map], regionIncluded: [map]}} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /fulfillment_policy/{fulfillmentPolicyId}\n@desc This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.\n@required {fulfillmentPolicyId: str # This path parameter specifies the ID of the fulfillment policy you want to update.This ID can be retrieved for a specific fulfillment policy by using the getFulfillmentPolicies method., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # 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., description: str # A seller-defined description of the fulfillment policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, freightShipping: bool # This field is included and set to true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.Default: false, globalShipping: bool # Note: This field is only applicable for the eBay United Kingdom marketplace (EBAY_GB).This field is included and set to true if the seller wants to use the Global Shipping Program for international shipments. See the Global Shipping Program help topic for more details and requirements on the Global Shipping Program.A seller can use a combination of the Global Shipping Program and other international shipping services. If set to false or if the field is omitted, the seller has to manually specifying individual international shipping services (if the seller ships internationally), as described in Setting up worldwide shipping. Sellers opt in or out of the Global Shipping Program through the Shipping preferences in My eBay.eBay International Shipping is an account level setting; no field needs to be set in a Fulfillment business policy to enable eBay International Shipping. If a US seller's account is opted in to eBay International Shipping, this shipping option will be enabled automatically for all listings where international shipping is available. A US seller who is opted in to eBay International Shipping can also specify individual international shipping service options for a Fulfillment business policy.Default: false, handlingTime: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., localPickup: bool # This field should be included and set to true if local pickup is one of the fulfillment options available to the buyer. It is possible for the seller to make local pickup and some shipping service options available to the buyer.With local pickup, the buyer and seller make arrangements for pickup time and location.Default: false, marketplaceId: str # The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Max length: 64, pickupDropOff: bool # This field should be included and set to true if the seller offers the \"Click and Collect\" feature for an item. To enable \"Click and Collect\" on a listing, a seller must be eligible for Click and Collect. Currently, Click and Collect is available to only large retail merchants selling in the eBay AU, UK, DE, FR, and IT marketplaces.  In addition to setting this field to true, the merchant must also do the following to enable the \"Click and Collect\" option on a listing: Have inventory for the product at one or more physical stores tied to the merchant's account. Sellers can use the createInventoryLocation method in the Inventory API to associate physical stores to their account and they can then add inventory to specific store locations.Set an immediate payment requirement on the item. The immediate payment feature requires the seller to: Set the immediatePay flag in the payment policy to 'true'.Have a valid store location with a complete street address.When a merchant successfully lists an item with Click and Collect, prospective buyers within a reasonable distance from one of the merchant's stores (that has stock available) will see the \"Available for Click and Collect\" option on the listing, along with information on the closest store that has the item.Default: false, shippingOptions: [map{costType: str, insuranceFee: map, insuranceOffered: bool, optionType: str, packageHandlingCost: map, rateTableId: str, shippingDiscountProfileId: str, shippingPromotionOffered: bool, shippingServices: [map]}] # This array is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object is required for domestic shipping service options and for international shipping service options (if the seller ships to international locations). The optionType field is used to indicate whether the ShippingOption object applies to domestic or international shipping, and the costType field is used to indicate whether flat-rate shipping or calculated shipping will be used. The rateTableId field can be used to associate a defined shipping rate table to the policy, and the packageHandlingCost container can be used to set a handling charge for the policy. A separate ShippingServices object will be used to specify cost and other details for every available domestic and international shipping service option., shipToLocations: map{regionExcluded: [map], regionIncluded: [map]} # This type consists of the regionIncluded and regionExcluded arrays, which indicate the areas to where the seller does and doesn't ship.}\n@returns(200) {categoryTypes: [map], description: str, freightShipping: bool, fulfillmentPolicyId: str, globalShipping: bool, handlingTime: map{unit: str, value: int(int32)}, localPickup: bool, marketplaceId: str, name: str, pickupDropOff: bool, shippingOptions: [map], shipToLocations: map{regionExcluded: [map], regionIncluded: [map]}, warnings: [map]} # OK\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /fulfillment_policy/{fulfillmentPolicyId}\n@desc This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.\n@required {fulfillmentPolicyId: str # This path parameter specifies the ID of the fulfillment policy to delete. This ID can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /fulfillment_policy\n@desc This method retrieves all the fulfillment policies configured for the marketplace you specify using the marketplace_id query parameter.\n@required {marketplace_id: str # 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}\n@optional {Content-Language: str # Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {fulfillmentPolicies: [map], href: str, limit: int(int32), next: str, offset: int(int32), prev: str, total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /fulfillment_policy/get_by_policy_name\n@desc This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters.\n@required {marketplace_id: str # 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, name: str # This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.This value can be retrieved for a fulfillment policy by using the getFulfillmentPolicies method.}\n@optional {Content-Language: str # Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {categoryTypes: [map], description: str, freightShipping: bool, fulfillmentPolicyId: str, globalShipping: bool, handlingTime: map{unit: str, value: int(int32)}, localPickup: bool, marketplaceId: str, name: str, pickupDropOff: bool, shippingOptions: [map], shipToLocations: map{regionExcluded: [map], regionIncluded: [map]}} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group payment_policy\n@endpoint GET /payment_policy\n@desc This method retrieves all the payment business policies configured for the marketplace you specify using the marketplace_id query parameter.\n@required {marketplace_id: str # 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}\n@optional {Content-Language: str # Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), paymentPolicies: [map], prev: str, total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint POST /payment_policy\n@desc This method creates a new payment policy where the policy encapsulates seller's terms for order payments. A successful request returns the getPaymentPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.  Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # 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., deposit: map{amount: map, dueIn: map, paymentMethods: [map]} # This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing., description: str # A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, fullPaymentDueIn: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., immediatePay: bool # This field should be included and set to true if the seller wants to require immediate payment from the buyer for: A fixed-price itemAn auction item where the buyer is using the 'Buy it Now' optionA deposit for a motor vehicle listingDefault: False, marketplaceId: str # The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.Max length: 64, paymentInstructions: str # Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.A free-form string field that allows sellers to add detailed payment instructions to their listings., paymentMethods: [map{brands: [str], paymentMethodType: str, recipientAccountReference: map}] # Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.}\n@returns(201) {categoryTypes: [map], deposit: map{amount: map{currency: str, value: str}, dueIn: map{unit: str, value: int(int32)}, paymentMethods: [map]}, description: str, fullPaymentDueIn: map{unit: str, value: int(int32)}, immediatePay: bool, marketplaceId: str, name: str, paymentInstructions: str, paymentMethods: [map], paymentPolicyId: str, warnings: [map]} # Created\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /payment_policy/{payment_policy_id}\n@desc This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.\n@required {payment_policy_id: str # This path parameter specifies the ID of the payment policy you want to retrieve.  This ID can be retrieved for a payment policy by using the getPaymentPolices method.}\n@returns(200) {categoryTypes: [map], deposit: map{amount: map{currency: str, value: str}, dueIn: map{unit: str, value: int(int32)}, paymentMethods: [map]}, description: str, fullPaymentDueIn: map{unit: str, value: int(int32)}, immediatePay: bool, marketplaceId: str, name: str, paymentInstructions: str, paymentMethods: [map], paymentPolicyId: str} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /payment_policy/{payment_policy_id}\n@desc This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.\n@required {payment_policy_id: str # This path parameter specifies the ID of the payment policy you want to update.  This ID can be retrieved for a payment policy by using the getPaymentPolices method., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # 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., deposit: map{amount: map, dueIn: map, paymentMethods: [map]} # This type is used to specify/indicate that an initial deposit is required for a motor vehicle listing., description: str # A seller-defined description of the payment business policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, fullPaymentDueIn: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., immediatePay: bool # This field should be included and set to true if the seller wants to require immediate payment from the buyer for: A fixed-price itemAn auction item where the buyer is using the 'Buy it Now' optionA deposit for a motor vehicle listingDefault: False, marketplaceId: str # The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.Max length: 64, paymentInstructions: str # Note: DO NOT USE THIS FIELD. Payment instructions are no longer supported by payment business policies.A free-form string field that allows sellers to add detailed payment instructions to their listings., paymentMethods: [map{brands: [str], paymentMethodType: str, recipientAccountReference: map}] # Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.}\n@returns(200) {categoryTypes: [map], deposit: map{amount: map{currency: str, value: str}, dueIn: map{unit: str, value: int(int32)}, paymentMethods: [map]}, description: str, fullPaymentDueIn: map{unit: str, value: int(int32)}, immediatePay: bool, marketplaceId: str, name: str, paymentInstructions: str, paymentMethods: [map], paymentPolicyId: str, warnings: [map]} # OK\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /payment_policy/{payment_policy_id}\n@desc This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter.\n@required {payment_policy_id: str # This path parameter specifies the unique identifier of the payment policy you want to delete. This ID can be retrieved for a payment policy by using the getPaymentPolices method.}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /payment_policy/get_by_policy_name\n@desc This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters.\n@required {marketplace_id: str # 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, name: str # This query parameter specifies the seller-defined name of the payment policy you want to retrieve. This value can be retrieved for a payment policy by using the getPaymentPolicies method.}\n@optional {Content-Language: str # Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {categoryTypes: [map], deposit: map{amount: map{currency: str, value: str}, dueIn: map{unit: str, value: int(int32)}, paymentMethods: [map]}, description: str, fullPaymentDueIn: map{unit: str, value: int(int32)}, immediatePay: bool, marketplaceId: str, name: str, paymentInstructions: str, paymentMethods: [map], paymentPolicyId: str} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group payments_program\n@endpoint GET /payments_program/{marketplace_id}/{payments_program_type}\n@desc Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.\n@required {marketplace_id: str # This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status., payments_program_type: str # This path parameter specifies the payments program whose status is returned by the call.}\n@returns(200) {marketplaceId: str, paymentsProgramType: str, status: str, wasPreviouslyOptedIn: bool} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding\n@desc Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.This method retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.\n@required {marketplace_id: str # The eBay marketplace ID associated with the onboarding status to retrieve., payments_program_type: str # The type of payments program whose status is returned by the method.}\n@returns(200) {onboardingStatus: str, steps: [map]} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endgroup\n\n@group privilege\n@endpoint GET /privilege\n@desc This method retrieves the seller's current set of privileges, including whether or not the seller's eBay registration has been completed, as well as the details of their site-wide sellingLimit (the amount and quantity they can sell on a given day).\n@returns(200) {sellerRegistrationCompleted: bool, sellingLimit: map{amount: map{currency: str, value: str}, quantity: int(int32)}} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group program\n@endpoint GET /program/get_opted_in_programs\n@desc This method gets a list of the seller programs that the seller has opted-in to.\n@returns(200) {programs: [map]} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint POST /program/opt_in\n@desc This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs.Note: It can take up to 24-hours for eBay to process your request to opt-in to a Seller Program. Use the getOptedInPrograms call to check the status of your request after the processing period has passed.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {programType: str # The seller program to opt in to when part of an optInToProgram request, or out of when part of an  optOutOfProgram request. When returned in an getOptedInPrograms response, a separate programType field is returned for each seller program that the seller is opted in to. For implementation help, refer to eBay API documentation}\n@returns(200) Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint POST /program/opt_out\n@desc This method opts the seller out of a seller program in which they are currently opted in to. A seller can retrieve a list of the seller programs they are opted-in to using the getOptedInPrograms method.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {programType: str # The seller program to opt in to when part of an optInToProgram request, or out of when part of an  optOutOfProgram request. When returned in an getOptedInPrograms response, a separate programType field is returned for each seller program that the seller is opted in to. For implementation help, refer to eBay API documentation}\n@returns(200) Success\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endgroup\n\n@group rate_table\n@endpoint GET /rate_table\n@desc This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables.  The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options. This call currently supports getting rate tables related to the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain.  Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables.  Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to Shipping rate tables in  My eBay to create and update rate tables.\n@optional {country_code: str # This query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum}\n@returns(200) {rateTables: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group return_policy\n@endpoint GET /return_policy\n@desc This method retrieves all the return policies configured for the marketplace you specify using the marketplace_id query parameter.\n@required {marketplace_id: str # 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}\n@optional {Content-Language: str # Get the correct policies for a marketplace that supports multiple locales using the Content-Language request header. For example, get the policies for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {href: str, limit: int(int32), next: str, offset: int(int32), prev: str, returnPolicies: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint POST /return_policy\n@desc This method creates a new return policy where the policy encapsulates seller's terms for returning items.  Each policy targets a specific marketplace, and you can create multiple policies for each marketplace. Return policies are not applicable to motor-vehicle listings.A successful request returns the getReturnPolicy URI to the new policy in the Location response header and the ID for the new policy is returned in the response payload.  Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.\n@required {Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # This container indicates which category group that the return policy applies to.Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies., description: str # A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, extendedHolidayReturnsOffered: bool # Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned., internationalOverride: map{returnMethod: str, returnPeriod: map, returnsAccepted: bool, returnShippingCostPayer: str} # 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., marketplaceId: str # The ID of the eBay marketplace to which this return business policy applies.  For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64, refundMethod: str # This field sets the refund method to use for returned items. Its value defaults to MONEY_BACK if omitted, so this field is only needed for Buy online, Pickup in Store or Click and Collect items where the seller is willing to offer merchandise credit as an additional refund method to buyers. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.Important! If this field is not included in a return business policy, it will default to MONEY_BACK. For implementation help, refer to eBay API documentation, restockingFeePercentage: str # Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored., returnInstructions: str # This text-based field provides more details on seller-specified return instructions. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.Max length: 5000 (8000 for DE), returnMethod: str # 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 eBay API documentation, returnPeriod: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., returnsAccepted: bool # If set to true, the seller accepts returns. If set to false, the seller does not accept returns.Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits., returnShippingCostPayer: str # This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.  This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation}\n@returns(201) {categoryTypes: [map], description: str, extendedHolidayReturnsOffered: bool, internationalOverride: map{returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnsAccepted: bool, returnShippingCostPayer: str}, marketplaceId: str, name: str, refundMethod: str, restockingFeePercentage: str, returnInstructions: str, returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnPolicyId: str, returnsAccepted: bool, returnShippingCostPayer: str, warnings: [map]} # Created\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /return_policy/{return_policy_id}\n@desc This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.\n@required {return_policy_id: str # This path parameter specifies the unique identifier of the return policy you want to retrieve.  This ID can be retrieved for a return policy by using the getReturnPolicies method.}\n@returns(200) {categoryTypes: [map], description: str, extendedHolidayReturnsOffered: bool, internationalOverride: map{returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnsAccepted: bool, returnShippingCostPayer: str}, marketplaceId: str, name: str, refundMethod: str, restockingFeePercentage: str, returnInstructions: str, returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnPolicyId: str, returnsAccepted: bool, returnShippingCostPayer: str} # Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /return_policy/{return_policy_id}\n@desc This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.\n@required {return_policy_id: str # This path parameter specifies the ID of the return policy you want to update.  This ID can be retrieved for a return policy by using the getReturnPolicies method., Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.  For more information, refer to HTTP request headers.}\n@optional {categoryTypes: [map{default: bool, name: str}] # This container indicates which category group that the return policy applies to.Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value must be set to ALL_EXCLUDING_MOTORS_VEHICLES for return business policies., description: str # A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.  Max length: 250, extendedHolidayReturnsOffered: bool # Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned., internationalOverride: map{returnMethod: str, returnPeriod: map, returnsAccepted: bool, returnShippingCostPayer: str} # 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., marketplaceId: str # The ID of the eBay marketplace to which this return business policy applies.  For implementation help, refer to eBay API documentation, name: str # A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace. Max length: 64, refundMethod: str # This field sets the refund method to use for returned items. Its value defaults to MONEY_BACK if omitted, so this field is only needed for Buy online, Pickup in Store or Click and Collect items where the seller is willing to offer merchandise credit as an additional refund method to buyers. Getting their money back for returned items is always an option for buyers, regardless of what the seller sets in this field.Important! If this field is not included in a return business policy, it will default to MONEY_BACK. For implementation help, refer to eBay API documentation, restockingFeePercentage: str # Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored., returnInstructions: str # This text-based field provides more details on seller-specified return instructions. Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.Max length: 5000 (8000 for DE), returnMethod: str # 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 eBay API documentation, returnPeriod: map{unit: str, value: int(int32)} # A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned., returnsAccepted: bool # If set to true, the seller accepts returns. If set to false, the seller does not accept returns.Note:Top-Rated sellers must accept item returns and the handlingTime should be set to zero days or one day for a listing to receive a Top-Rated Plus badge on the View Item or search result pages. For more information on eBay's Top-Rated seller program, see Becoming a Top Rated Seller and qualifying for Top Rated Plus benefits., returnShippingCostPayer: str # This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. Note: Eligible Parts & Accessories (P&A) listings require sellers to offer buyers free returns with a minimum return period of 30 days. See Support for easy returns in Parts and Accessories for details. Depending on the return policy and specifics of the return, either the buyer or the seller can be responsible for the return shipping costs. Note that the seller is always responsible for return shipping costs for SNAD-related issues.  This field is conditionally required if returnsAccepted is set to true. For implementation help, refer to eBay API documentation}\n@returns(200) {categoryTypes: [map], description: str, extendedHolidayReturnsOffered: bool, internationalOverride: map{returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnsAccepted: bool, returnShippingCostPayer: str}, marketplaceId: str, name: str, refundMethod: str, restockingFeePercentage: str, returnInstructions: str, returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnPolicyId: str, returnsAccepted: bool, returnShippingCostPayer: str, warnings: [map]} # OK\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /return_policy/{return_policy_id}\n@desc This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.\n@required {return_policy_id: str # This path parameter specifies the unique identifier of the return policy you want to delete. This ID can be retrieved for a return policy by using the getReturnPolicies method.}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 409: Conflict, 500: Internal Server Error}\n\n@endpoint GET /return_policy/get_by_policy_name\n@desc This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters.\n@required {marketplace_id: str # 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, name: str # This query parameter specifies the seller-defined name of the return policy you want to retrieve. This value can be retrieved for a return policy by using the getReturnPolicies method.}\n@optional {Content-Language: str # Get the correct policy for a marketplace that supports multiple locales using the Content-Language request header. For example, get a policy for the French locale of the Canadian marketplace by specifying fr-CA for the Content-Language header. Likewise, target the Dutch locale of the Belgium marketplace by setting Content-Language: nl-BE. For details on header values, see HTTP request headers.}\n@returns(200) {categoryTypes: [map], description: str, extendedHolidayReturnsOffered: bool, internationalOverride: map{returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnsAccepted: bool, returnShippingCostPayer: str}, marketplaceId: str, name: str, refundMethod: str, restockingFeePercentage: str, returnInstructions: str, returnMethod: str, returnPeriod: map{unit: str, value: int(int32)}, returnPolicyId: str, returnsAccepted: bool, returnShippingCostPayer: str} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group bulk_create_or_replace_sales_tax\n@endpoint POST /bulk_create_or_replace_sales_tax\n@desc This method creates or updates multiple sales-tax table entries.Sales-tax tables can be set up for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Each sales-tax table entry comprises the following parameters:countryCodejurisdictionIdsalesTaxPercentageshippingAndHandlingTaxedValid jurisdiction IDs are retrieved using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! \">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges.\n@optional {salesTaxInputList: [map{countryCode: str, salesTaxJurisdictionId: str, salesTaxPercentage: str, shippingAndHandlingTaxed: bool}] # The array of sales-tax table entries to be created or updated.}\n@returns(200) {updatedSalesTaxEntries: [map]} # Success\n@returns(207) partial success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group sales_tax\n@endpoint GET /sales_tax/{countryCode}/{jurisdictionId}\n@desc This call retrieves the current sales-tax table entry for a specific tax jurisdiction. Specify the jurisdiction to retrieve using the countryCode and jurisdictionId path parameters. All four response fields will be returned if a sales-tax entry exists for the tax jurisdiction. Otherwise, the response will be returned as empty.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Important! \">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges.\n@required {countryCode: str # This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table you want to retrieve.Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:USCA, jurisdictionId: str # This path parameter specifies the ID of the sales tax jurisdiction for the tax table entry to be retrieved.Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.Note: When countryCode is set to US, the only supported values for jurisdictionId are:AS (American Samoa)GU (GuamMP Northern Mariana IslandsPW (Palau)VI (US Virgin Islands)}\n@returns(200) {countryCode: str, salesTaxJurisdictionId: str, salesTaxPercentage: str, shippingAndHandlingTaxed: bool} # Success\n@returns(204) No content\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint PUT /sales_tax/{countryCode}/{jurisdictionId}\n@desc This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId.  A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.You can set up sales-tax tables for countries that support different tax jurisdictions.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.For details about using this call, refer to Establishing sales-tax tables.Important! \">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges.\n@required {countryCode: str # This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create a sales tax table entry.Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:USCA, jurisdictionId: str # This path parameter specifies the ID of the tax jurisdiction for the table entry to be created.Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.Note: When countryCode is set to US, the only supported values for jurisdictionId are:AS (American Samoa)GU (Guam)MP (Northern Mariana Islands)PW (Palau)VI (US Virgin Islands), Content-Type: str # This header indicates the format of the request body provided by the client. Its value should be set to application/json.For more information, refer to HTTP request headers.}\n@optional {salesTaxPercentage: str # This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling chargesAlthough it is a string, a percentage value is set here, such as 7.75., shippingAndHandlingTaxed: bool # This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false.}\n@returns(204) No Content\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint DELETE /sales_tax/{countryCode}/{jurisdictionId}\n@desc This call deletes a sales-tax table entry for a jurisdiction. Specify the jurisdiction to delete using the countryCode and jurisdictionId path parameters.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.\n@required {countryCode: str # This path parameter specifies the two-letter ISO 3166 code for the country whose sales tax table entry you want to delete.Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:USCA, jurisdictionId: str # This path parameter specifies the ID of the sales tax jurisdiction whose table entry you want to delete.Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API.Note: When countryCode is set to US, the only supported values for jurisdictionId are:AS (American Samoa)GU (Guam)MP (Northern Mariana Islands)PW (Palau)VI (US Virgin Islands)}\n@returns(204) Success\n@errors {400: Bad Request, 404: Not Found, 500: Internal Server Error}\n\n@endpoint GET /sales_tax\n@desc Use this call to retrieve all sales tax table entries that the seller has defined for a specific country. All four response fields will be returned for each tax jurisdiction that matches the search criteria. If no sales tax rates are defined for the specified, a 204 No Content status code is returned with no response payload.Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.Important! \">Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.However, sellers may continue to use a sales-tax table to set rates for the following US territories:American Samoa (AS)Guam (GU)Northern Mariana Islands (MP)Palau (PW)US Virgin Islands (VI)For additional information, refer to Taxes and import charges.\n@required {country_code: str # This path parameter specifies the two-letter ISO 3166 code for the country whose tax table you want to retrieve.Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:USCA For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum}\n@returns(200) {salesTaxes: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group subscription\n@endpoint GET /subscription\n@desc This method retrieves a list of subscriptions associated with the seller account.\n@optional {limit: str # This field is for future use., continuation_token: str # This field is for future use.}\n@returns(200) {href: str, limit: int(int32), next: str, subscriptions: [map], total: int(int32)} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group kyc\n@endpoint GET /kyc\n@desc Note: This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just return an empty payload with a 204 No Content HTTP status code.\n@returns(200) {kycChecks: [map]} # OK\n@returns(204) No Content\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@group advertising_eligibility\n@endpoint GET /advertising_eligibility\n@desc This method allows developers to check the seller eligibility status for eBay advertising programs.\n@required {X-EBAY-C-MARKETPLACE-ID: str # The unique identifier of the eBay marketplace for which the seller eligibility status shall be checked. This header is required or the call will fail.See the MarketplaceIdEnum type for the supported marketplace ID values.}\n@optional {program_types: str # A comma-separated list of eBay advertising programs for which eligibility status will be returned. See the  AdvertisingProgramEnum type for a list of supported values.If no programs are specified, the results will be returned for all programs.}\n@returns(200) {advertisingEligibility: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}