Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
custom_policy_id, which can be used to reference the policy.","type":"string"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20411":{"category":"REQUEST","description":"Invalid/Missing policyType","domain":"API_ACCOUNT"},"20412":{"category":"REQUEST","description":"Invalid/Missing label","domain":"API_ACCOUNT"},"20413":{"category":"REQUEST","description":"Invalid/Missing name","domain":"API_ACCOUNT"},"20414":{"category":"REQUEST","description":"Invalid/Missing description","domain":"API_ACCOUNT"},"20415":{"category":"REQUEST","description":"Invalid/Missing marketplaceId","domain":"API_ACCOUNT"},"20417":{"category":"REQUEST","description":"Maximum custom policy per site is reached","domain":"API_ACCOUNT"},"20418":{"category":"REQUEST","description":"This policy name is already used","domain":"API_ACCOUNT"}}}},"409":{"description":"Policy Name already used/ Maximum no of policies per site reached"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["custom_policy"]}},"/custom_policy/{custom_policy_id}":{"get":{"description":"This method retrieves the custom policy specified by the custom_policy_id path parameter for the selected eBay marketplace.Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) on April 3, 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell.
Due to this change, the X-EBAY-C-MARKETPLACE-ID request header is no longer relevant. If this header is passed in after April 3, it will just be ignored in all four methods.
marketplace_id query parameter. 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.","operationId":"getFulfillmentPolicies","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/":{"post":{"description":"This method creates a new fulfillment policy where the policy encapsulates seller's terms for fulfilling item purchases. Fulfillment policies include the shipment options that the seller offers to buyers. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.
Using the eBay standard envelope service (eSE)
The eBay standard envelope service (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific Trading Cards categories (not all categories are supported), and to Coins & Paper Money, Postcards, and Stamps. See Using the eBay standard envelope (eSE) service.
","operationId":"createFulfillmentPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyRequest","description":"Request to create a seller account fulfillment policy."}}},"description":"Request to create a seller account fulfillment policy.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetFulfillmentPolicyResponse"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created fulfillment policy. The URL includes the eBay-assignedfulfillmentPolicyId, which you can use to reference the policy.","type":"string"}}},"x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"},"20201":{"category":"BUSINESS","description":"{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace.","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/get_by_policy_name":{"get":{"description":"This method retrieves the details for a specific fulfillment policy. In the request, supply both the policy name and its associated marketplace_id as query parameters. 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.","operationId":"getFulfillmentPolicyByName","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This query parameter specifies the seller-defined name of the fulfillment policy you want to retrieve.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]}},"/fulfillment_policy/{fulfillmentPolicyId}":{"delete":{"description":"This method deletes a fulfillment policy. Supply the ID of the policy you want to delete in the fulfillmentPolicyId path parameter.","operationId":"deleteFulfillmentPolicy","parameters":[{"description":"This path parameter specifies the ID of the fulfillment policy to delete.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"20409":{"category":"BUSINESS","description":"Invalid default policy type. {additionalInfo}","domain":"API_ACCOUNT"},"21409":{"category":"BUSINESS","description":"Invalid default for category type. {additionalInfo}","domain":"API_ACCOUNT"},"22409":{"category":"BUSINESS","description":"Invalid target default policy. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]},"get":{"description":"This method retrieves the complete details of a fulfillment policy. Supply the ID of the policy you want to retrieve using the fulfillmentPolicyId path parameter.","operationId":"getFulfillmentPolicy","parameters":[{"description":"This path parameter specifies the ID of the fulfillment policy you want to retrieve.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["fulfillment_policy"]},"put":{"description":"This method updates an existing fulfillment policy. Specify the policy you want to update using the fulfillment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.","operationId":"updateFulfillmentPolicy","parameters":[{"description":"This path parameter specifies the ID of the fulfillment policy you want to update.","in":"path","name":"fulfillmentPolicyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentPolicyRequest","description":"Fulfillment policy request"}}},"description":"Fulfillment policy request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetFulfillmentPolicyResponse"}}},"description":"OK","x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"},"20201":{"category":"BUSINESS","description":"{fieldName} (Click and Collect Program) can not be enabled for this seller or marketplace.","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["fulfillment_policy"]}},"/kyc":{"get":{"description":"Note:This method was originally created to see which onboarding requirements were still pending for sellers being onboarded for eBay managed payments, but now that all seller accounts are onboarded globally, this method should now just returne an empty payload with a 204 No Content HTTP status code. ","operationId":"getKYC","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KycResponse"}}},"description":"OK"},"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"21400":{"category":"REQUEST","description":"This marketplace is not supported. Please refer to documentation.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["kyc"]}},"/payment_policy":{"get":{"description":"This method retrieves all the payment policies configured for the marketplace you specify using the marketplace_id query parameter. 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.","operationId":"getPaymentPolicies","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]},"post":{"description":"This method creates a new payment policy where the policy encapsulates seller's terms for order payments. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.
","operationId":"createPaymentPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyRequest","description":"Payment policy request"}}},"description":"Payment policy request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentPolicyResponse"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created payment policy. The URL includes the eBay-assignedpaymentPolicyId, which you can use to reference the policy.","type":"string"}}},"x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"},"20405":{"category":"REQUEST","description":"Invalid payment method. {fieldName}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]}},"/payment_policy/get_by_policy_name":{"get":{"description":"This method retrieves the details of a specific payment policy. Supply both the policy name and its associated marketplace_id in the request query parameters. 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.","operationId":"getPaymentPolicyByName","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This query parameter specifies the seller-defined name of the payment policy you want to retrieve.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]}},"/payment_policy/{payment_policy_id}":{"delete":{"description":"This method deletes a payment policy. Supply the ID of the policy you want to delete in the paymentPolicyId path parameter. ","operationId":"deletePaymentPolicy","parameters":[{"description":"This path parameter specifies the ID of the payment policy you want to delete.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"20409":{"category":"BUSINESS","description":"Invalid default policy type. {additionalInfo}","domain":"API_ACCOUNT"},"21409":{"category":"BUSINESS","description":"Invalid default for category type. {additionalInfo}","domain":"API_ACCOUNT"},"22409":{"category":"BUSINESS","description":"Invalid target default policy. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]},"get":{"description":"This method retrieves the complete details of a payment policy. Supply the ID of the policy you want to retrieve using the paymentPolicyId path parameter.","operationId":"getPaymentPolicy","parameters":[{"description":"This path parameter specifies the ID of the payment policy you want to retrieve.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["payment_policy"]},"put":{"description":"This method updates an existing payment policy. Specify the policy you want to update using the payment_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.","operationId":"updatePaymentPolicy","parameters":[{"description":"This path parameter specifies the ID of the payment policy you want to update.","in":"path","name":"payment_policy_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentPolicyRequest","description":"Payment policy request"}}},"description":"Payment policy request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentPolicyResponse"}}},"description":"OK","x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"},"20405":{"category":"REQUEST","description":"Invalid payment method. {fieldName}","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["payment_policy"]}},"/payments_program/{marketplace_id}/{payments_program_type}":{"get":{"description":"Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.EBAY_AUEBAY_CAEBAY_DEEBAY_ESEBAY_FREBAY_GBEBAY_ITEBAY_USmarketplace_id query parameter. 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.","operationId":"getReturnPolicies","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPolicyResponse"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["return_policy"]},"post":{"description":"This method creates a new return policy where the policy encapsulates seller's terms for returning items. Tip: For details on creating and using the business policies supported by the Account API, see eBay business policies.
","operationId":"createReturnPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPolicyRequest","description":"Return policy request"}}},"description":"Return policy request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetReturnPolicyResponse"}}},"description":"Created","headers":{"Location":{"schema":{"description":"The location response header contains the URL to the newly created return policy. The URL includes the eBay-assignedreturnPolicyId, which you can use to reference the policy.","type":"string"}}},"x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field .","domain":"API_ACCOUNT"},"20406":{"category":"REQUEST","description":"Invalid return option","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["return_policy"]}},"/return_policy/get_by_policy_name":{"get":{"description":"This method retrieves the details of a specific return policy. Supply both the policy name and its associated marketplace_id in the request query parameters. 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.","operationId":"getReturnPolicyByName","parameters":[{"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","in":"query","name":"marketplace_id","required":true,"schema":{"type":"string"}},{"description":"This query parameter specifies the seller-defined name of the return policy you want to retrieve.","in":"query","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["return_policy"]}},"/return_policy/{return_policy_id}":{"delete":{"description":"This method deletes a return policy. Supply the ID of the policy you want to delete in the returnPolicyId path parameter.","operationId":"deleteReturnPolicy","parameters":[{"description":"This path parameter specifies the ID of the return policy you want to delete.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20401":{"category":"REQUEST","description":"Missing field {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict","x-response-codes":{"errors":{"20409":{"category":"BUSINESS","description":"Invalid default policy type. {additionalInfo}","domain":"API_ACCOUNT"},"21409":{"category":"BUSINESS","description":"Invalid default for category type. {additionalInfo}","domain":"API_ACCOUNT"},"22409":{"category":"BUSINESS","description":"Invalid target default policy. {additionalInfo}","domain":"API_ACCOUNT"}}}},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["return_policy"]},"get":{"description":"This method retrieves the complete details of the return policy specified by the returnPolicyId path parameter.","operationId":"getReturnPolicy","parameters":[{"description":"This path parameter specifies the of the return policy you want to retrieve.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPolicy"}}},"description":"Success"},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20403":{"category":"REQUEST","description":"Invalid {fieldName}. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account","https://api.ebay.com/oauth/api_scope/sell.account.readonly"]}],"tags":["return_policy"]},"put":{"description":"This method updates an existing return policy. Specify the policy you want to update using the return_policy_id path parameter. Supply a complete policy payload with the updates you want to make; this call overwrites the existing policy with the new details specified in the payload.","operationId":"updateReturnPolicy","parameters":[{"description":"This path parameter specifies the ID of the return policy you want to update.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnPolicyRequest","description":"Container for a return policy request."}}},"description":"Container for a return policy request.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetReturnPolicyResponse"}}},"description":"OK","x-response-codes":{"errors":{"20200":{"category":"BUSINESS","description":"Warning. {additionalInfo}","domain":"API_ACCOUNT"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"20400":{"category":"REQUEST","description":"Invalid request. {additionalInfo}","domain":"API_ACCOUNT"},"20401":{"category":"REQUEST","description":"Missing field {fieldName}.","domain":"API_ACCOUNT"},"20402":{"category":"REQUEST","description":"Invalid input. {additionalInfo}","domain":"API_ACCOUNT"},"20404":{"category":"REQUEST","description":"{fieldName} not found.","domain":"API_ACCOUNT"},"20406":{"category":"REQUEST","description":"Invalid return option. {fieldName}","domain":"API_ACCOUNT"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"20500":{"category":"APPLICATION","description":"System error.","domain":"API_ACCOUNT"},"20501":{"category":"APPLICATION","description":"Service unavailable. Please try again in next 24 hours.","domain":"API_ACCOUNT"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.account"]}],"tags":["return_policy"]}},"/sales_tax":{"get":{"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. CAD.MOTORS_VEHICLES category type is not valid for return policies. eBay flows do not support the return of motor vehicles. For implementation help, refer to eBay API documentation","type":"string"}},"type":"object"},"CompactCustomPolicyResponse":{"description":"The response payload for requests that return a list of custom policies.","properties":{"customPolicyId":{"description":"The unique custom policy identifier for the policy being returned.2000.0"},"dueIn":{"$ref":"#/components/schemas/TimeDuration","description":"This value indicates the number of hours that the buyer has (after they commit to buy) to pay the initial deposit on a motor vehicle. Valid dueIn times are 24, 48, and 72 hours. HOUR is set as the unit value, and 24, 48 or 72 are set in the value field.Application: 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.Business: 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.Request: 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.message error field.","type":"string"},"message":{"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.","type":"string"},"outputRefIds":{"description":"Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId.","items":{"type":"string"},"type":"array"},"parameters":{"description":"This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.","items":{"$ref":"#/components/schemas/ErrorParameter"},"type":"array"},"subdomain":{"description":"If present, indicates the subsystem in which the error occurred.","type":"string"}},"type":"object"},"ErrorParameter":{"description":"A complex type that indicates a parameter that caused an error and the value of the parameter which caused the error.","properties":{"name":{"description":"Name of the parameter that caused the error.","type":"string"},"value":{"description":"The value of the parameter that caused the error.","type":"string"}},"type":"object"},"FulfillmentPolicy":{"description":"This type is used by the fulfillmentPolicy response container, a container which defines a seller's fulfillment policy for a specific marketplace.","properties":{"categoryTypes":{"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"},"type":"array"},"description":{"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. true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.","type":"boolean"},"fulfillmentPolicyId":{"description":"A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.","type":"string"},"globalShipping":{"description":"If returned as true, eBay's Global Shipping Program will be used by the seller to ship items to international locations.If only local pickup or freight shipping is available for the item, this container may not get returned.
"},"localPickup":{"description":"If returned astrue, local pickup is available for this policy.","type":"boolean"},"marketplaceId":{"description":"The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. true, the seller offers the \"Click and Collect\" option. A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option.
","items":{"$ref":"#/components/schemas/ShippingOption"},"type":"array"}},"type":"object"},"FulfillmentPolicyRequest":{"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.","properties":{"categoryTypes":{"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"},"type":"array"},"description":{"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.true if freight shipping is available for the item. Freight shipping can be used for large items over 150 lbs.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.false or if the field is omitted, the seller is responsible for manually specifying individual international shipping services (if the seller ships internationally)., as described in Setting up worldwide shipping. Default: false
","type":"boolean"},"handlingTime":{"$ref":"#/components/schemas/TimeDuration","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.DispatchTimeMaxDetails, then inspect the DispatchTimeMaxDetails container in the response for the time values supported by the site (typical handling times are 0, 1, 2, 3, 4, 5, 10, 15, and 20, but these can vary by site and may change over time.) This field is conditionally required when the seller is offering one or more domestic or international shipping options, but it is not applicable when the item is only available through local pickup (\"localPickup\": \"true\"), or if it will be shipped through a freight shipping service (\"freightShipping\": \"true\").
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.false","type":"boolean"},"marketplaceId":{"description":"The ID of the eBay marketplace to which this fulfillment policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. 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 and UK 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:
Sellers can use the createInventoryLocaion method in the Inventory API to associate physical stores to their account and they can then can add inventory to specific store locations.
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","type":"boolean"},"shipToLocations":{"$ref":"#/components/schemas/RegionSet","description":"This container consists of the regionIncluded and regionExcluded arrays, which are used to define the geographical regions/countries/states or provinces/domestic regions that a seller does and does not ship to for the associated fulfillment policy. Note that this container can be considered the master list of where the seller ships and does not ship, but there is also a shipToLocations container that can be set at the shipping service option level.ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in both the regionIncluded.regionName and in the regionExcluded.regionName fields. ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields. ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition. For valid domestic region values, look for ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields. STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post."},"shippingOptions":{"description":"This array is used to provide detailed information on the domestic and international shipping options available 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.
","items":{"$ref":"#/components/schemas/ShippingOption"},"type":"array"}},"type":"object"},"FulfillmentPolicyResponse":{"description":"The response payload for the getFulfillmentPolicies method.0.","format":"int32","type":"integer"}},"type":"object"},"InternationalReturnOverrideType":{"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. ","properties":{"returnMethod":{"description":"This field sets/indicates if the seller offers replacement items to the buyer in the case of an international return. The buyer must be willing to accept a replacement item; otherwise, the seller will need to issue a refund for a return. For implementation help, refer to eBay API documentation","type":"string"},"returnPeriod":{"$ref":"#/components/schemas/TimeDuration","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. DAY and the value field to either 30 or 60 (or other value, as appropriate). true."},"returnShippingCostPayer":{"description":"This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. true. For implementation help, refer to eBay API documentation","type":"string"},"returnsAccepted":{"description":"If set to true, the seller accepts international returns. If set to false, the seller does not accept international returns. Upload bank document now.'. The detailMessage field will often provide more details on what is required of the seller.","type":"string"},"dataRequired":{"description":"The enumeration value returned in this field categorizes the type of details needed for the KYC check. More information about the check is shown in the detailMessage and other applicable, corresponding fields. For implementation help, refer to eBay API documentation","type":"string"},"detailMessage":{"description":"This field gives a detailed message about what is required from the seller. An example might be, 'Please upload a bank document by 2020-08-01 to get your account back in good standing.'.","type":"string"},"dueDate":{"description":"The timestamp in this field indicates the date by which the seller should resolve the KYC requirement.06-05-2020 10:34:18","type":"string"},"remedyUrl":{"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.","type":"string"}},"type":"object"},"KycResponse":{"description":"This is the base response type of the getKYC method.","properties":{"kycChecks":{"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.204 No Content HTTP status code.","items":{"$ref":"#/components/schemas/KycCheck"},"type":"array"}},"type":"object"},"PaymentMethod":{"description":"This type is used by the paymentMethods container, which is used by the seller to specify one or more offline payment methods. MOTORS_VEHICLES, and is only returned if the seller requires an initial deposit on motor vehicles.Note: The due date that is specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchasing the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing.
"},"description":{"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.MOTORS_VEHICLES. MOTORS_VEHICLES) payment business policy must specify at least one of the following paymentMethods values for the final payment: true, immediate payment is required from the buyer for: true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller.","type":"boolean"},"marketplaceId":{"description":"The ID of the eBay marketplace to which the payment business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. Note: The 'due date' specified in the deposit container will be overridden if the payment business policy requires immediate payment (in this case, for the deposit), and the buyer commits to purchase the motor vehicle through a fixed-price listing or through the 'Buy it Now' option of an auction listing.
"},"description":{"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.3 DAYS7 DAYS (the default)10 DAYS14 DAYSCASH_ON_PICKUPCASHIER_CHECKMONEY_ORDERPERSONAL_CHECK7 DAYS"},"immediatePay":{"description":"This field should be included and set to true if the seller wants to require immediate payment from the buyer for: 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.","type":"string"},"paymentMethods":{"description":"Note: This field applies only when the seller needs to specify one or more offline payment methods. eBay now manages the electronic payment options available to buyers to pay for the item.
This array is used to specify one or more offline payment methods that will be accepted for payment that occurs off of eBay's platform.","items":{"$ref":"#/components/schemas/PaymentMethod"},"type":"array"}},"type":"object"},"PaymentPolicyResponse":{"description":"The response payload for the getPaymentPolicies method.0.","format":"int32","type":"integer"}},"type":"object"},"PaymentsProgramOnboardingResponse":{"description":"Type used by the payments program onboarding response","properties":{"onboardingStatus":{"description":"This enumeration value indicates the eligibility of payment onboarding for the registered site. For implementation help, refer to eBay API documentation","type":"string"},"steps":{"description":"An array of the active process steps for payment onboarding and the status of each step. This array includes the step name, step status, and a webUrl to the IN_PROGRESS step. The step names are returned in sequential order. ","items":{"$ref":"#/components/schemas/PaymentsProgramOnboardingSteps"},"type":"array"}},"type":"object"},"PaymentsProgramOnboardingSteps":{"description":"The payments program onboarding steps, status, and link.","properties":{"name":{"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. ","type":"string"},"status":{"description":"This enumeration value indicates the status of the associated step. Note: Only one step can be IN_PROGRESS at a time.
IN_PROGRESS step.","type":"string"}},"type":"object"},"PaymentsProgramResponse":{"description":"The response object containing the sellers status with regards to the specified payment program.","properties":{"marketplaceId":{"description":"The ID of the eBay marketplace to which the payment program applies. For implementation help, refer to eBay API documentation","type":"string"},"paymentsProgramType":{"description":"This parameter specifies the payment program whose status is returned by the call. EBAY_PAYMENTS. For implementation help, refer to eBay API documentation","type":"string"},"status":{"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 eBay API documentation","type":"string"},"wasPreviouslyOptedIn":{"description":"If returned as true, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of false indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it. true while the status field returns OPTED_IN.","type":"boolean"}},"type":"object"},"Program":{"description":"A seller program in to which a seller can opt-in.","properties":{"programType":{"description":"A seller program in to which a seller can opt-in. For implementation help, refer to eBay API documentation","type":"string"}},"type":"object"},"Programs":{"description":"The base response type of the getOptedInPrograms method.","properties":{"programs":{"description":"An array of seller programs that the seller's account is opted in to.","items":{"$ref":"#/components/schemas/Program"},"type":"array"}},"type":"object"},"RateTable":{"description":"This type is used to provide details about each shipping rate table that is returned in the getRateTables response.","properties":{"countryCode":{"description":"A two-letter ISO 3166 country code representing the eBay marketplace where the shipping rate table is defined. For implementation help, refer to eBay API documentation","type":"string"},"locality":{"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 eBay API documentation","type":"string"},"name":{"description":"The seller-defined name for the shipping rate table.","type":"string"},"rateTableId":{"description":"A unique eBay-assigned ID for a seller's shipping rate table. These rateTableId values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API.","type":"string"}},"type":"object"},"RateTableResponse":{"description":"This type is the base response of the getRateTables method.","properties":{"rateTables":{"description":"An array of all shipping rate tables defined for a marketplace (or all marketplaces if no country_code query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.","items":{"$ref":"#/components/schemas/RateTable"},"type":"array"}},"type":"object"},"RecipientAccountReference":{"description":"Note: This type is no longer applicable. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.","properties":{"referenceId":{"description":"Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods.","type":"string"},"referenceType":{"description":"Note: DO NOT USE THIS FIELD. eBay now controls all electronic payment methods available for a marketplace, and a seller never has to specify any electronic payment methods. For implementation help, refer to eBay API documentation","type":"string"}},"type":"object"},"Region":{"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').","properties":{"regionName":{"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. Many sellers are willing to ship to many international locations, but they may want to exclude some world regions or some countries as places they are willing to ship to.
This array will be returned as empty if no shipping regions are excluded with the fulfillment business policy.
Note: The regionExcluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.","items":{"$ref":"#/components/schemas/Region"},"type":"array"},"regionIncluded":{"description":"An array of one or more regionName fields that specify the areas to where a seller ships.
Each eBay marketplace supports its own set of allowable shipping locations.
Note: The regionIncluded array is not applicable for motor vehicle business policies on the US, CA, or UK marketplaces. If this array is used in a createFulfillmentPolicy or updateFulfillmentPolicy request, it will be ignored.","items":{"$ref":"#/components/schemas/Region"},"type":"array"}},"type":"object"},"ReturnPolicy":{"description":"This type is used by the returnPolicy response container, a container which defines a seller's return business policy for a specific marketplace.","properties":{"categoryTypes":{"description":"This container indicates which category group that the return policy applies to.
Note: Return business policies are not applicable to motor vehicle listings, so the categoryTypes.name value will always be ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.","items":{"$ref":"#/components/schemas/CategoryType"},"type":"array"},"description":{"description":"A seller-defined description of the return business policy. This description is only for the seller's use, and is not exposed on any eBay pages.
Max length: 250","type":"string"},"extendedHolidayReturnsOffered":{"description":"
Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.
","type":"boolean"},"internationalOverride":{"$ref":"#/components/schemas/InternationalReturnOverrideType","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 policies. 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."},"marketplaceId":{"description":"The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.MONEY_BACK. For implementation help, refer to eBay API documentation","type":"string"},"restockingFeePercentage":{"description":"Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored and it is no longer returned.
","type":"string"},"returnInstructions":{"description":"This text-based field provides more details on seller-specified return instructions. This field is only returned if set for the return business policy.Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.
BUYER or SELLER. true, the seller accepts returns. ALL_EXCLUDING_MOTORS_VEHICLES for return business policies.","items":{"$ref":"#/components/schemas/CategoryType"},"type":"array"},"description":{"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. Important! This field is deprecated, since eBay no longer supports extended holiday returns. Any value supplied in this field is neither read nor returned.
","type":"boolean"},"internationalOverride":{"$ref":"#/components/schemas/InternationalReturnOverrideType","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."},"marketplaceId":{"description":"The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.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","type":"string"},"restockingFeePercentage":{"description":"Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns. If this field is included, it is ignored.
","type":"string"},"returnInstructions":{"description":"This text-based field provides more details on seller-specified return instructions.Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.
DAY and value to either 30 or 60 (or other value, as appropriate). true."},"returnShippingCostPayer":{"description":"This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. true. For implementation help, refer to eBay API documentation","type":"string"},"returnsAccepted":{"description":"If set to true, the seller accepts 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.
","type":"boolean"}},"type":"object"},"ReturnPolicyResponse":{"description":"The response payload for the getReturnPolicies method.0.","format":"int32","type":"integer"}},"type":"object"},"SalesTax":{"description":"This type is used to provide sales tax settings for a specific tax jurisdiction.","properties":{"countryCode":{"description":"The country code enumeration value identifies the country to which this sales tax rate applies. For implementation help, refer to eBay API documentation","type":"string"},"salesTaxJurisdictionId":{"description":"A unique ID that identifies the sales tax jurisdiction to which the sales tax rate applies (for example, a state within the United States).","type":"string"},"salesTaxPercentage":{"description":"The sales tax rate that will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges7.75","type":"string"},"shippingAndHandlingTaxed":{"description":"If returned as true, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order.","type":"boolean"}},"type":"object"},"SalesTaxBase":{"description":"This type is used by the base request of the createOrReplaceSalesTax. ","properties":{"salesTaxPercentage":{"description":"This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges7.75.","type":"string"},"shippingAndHandlingTaxed":{"description":"This field is set to true if the seller wishes to apply sales tax to shipping and handling charges, and not just the total sales price of the order. Otherwise, this field's value should be set to false.","type":"boolean"}},"type":"object"},"SalesTaxes":{"description":"This type is used by the root response of the getSalesTaxes method.","properties":{"salesTaxes":{"description":"An array of one or more sales tax rate entries for a specific marketplace (or all applicable marketplaces if the country_code query parameter is not used.204 No Content.","items":{"$ref":"#/components/schemas/SalesTax"},"type":"array"}},"type":"object"},"SellerEligibilityMultiProgramResponse":{"description":"The base response of the getAdvertisingEligibility method that contains the seller eligibility information for one or more advertising programs.","properties":{"advertisingEligibility":{"description":"An array of response fields that define the seller eligibility for eBay adverstising programs.","items":{"$ref":"#/components/schemas/SellerEligibilityResponse"},"type":"array"}},"type":"object"},"SellerEligibilityResponse":{"description":"A type that is used to provide the seller's eligibility status for an eBay advertising program.","properties":{"programType":{"description":"The eBay advertising program for which a seller may be eligible. For implementation help, refer to eBay API documentation","type":"string"},"reason":{"description":"The reason why a seller is ineligible for the specified eBay advertising program.true, the seller's registration is completed. If this field is returned as false, the registration process is not complete.","type":"boolean"},"sellingLimit":{"$ref":"#/components/schemas/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."}},"type":"object"},"SetFulfillmentPolicyResponse":{"description":"Complex type that that gets populated with a response containing a fulfillment policy.","properties":{"categoryTypes":{"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"},"type":"array"},"description":{"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. true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.","type":"boolean"},"fulfillmentPolicyId":{"description":"A unique eBay-assigned ID for a fulfillment business policy. This ID is generated when the policy is created.","type":"string"},"globalShipping":{"description":"If returned as true, the eBay Global Shipping Program will be used by the seller to ship items to international locations.If only local pickup or freight shipping is available for the item, this container may not get returned.
"},"localPickup":{"description":"If returned astrue, local pickup is available for this policy.","type":"boolean"},"marketplaceId":{"description":"The ID of the eBay marketplace to which this fulfillment business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this fulfillment business policy. Names must be unique for policies assigned to the same marketplace. true, the seller offers the \"Click and Collect\" option. A separate ShippingServices object is used to specify cost and other details for every available domestic and international shipping service option.
","items":{"$ref":"#/components/schemas/ShippingOption"},"type":"array"},"warnings":{"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"},"type":"array"}},"type":"object"},"SetPaymentPolicyResponse":{"description":"Complex type that that gets populated with a response containing a payment policy.","properties":{"categoryTypes":{"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"},"type":"array"},"deposit":{"$ref":"#/components/schemas/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."},"description":{"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.Note: This value is always returned if categoryTypes is set to MOTORS_VEHICLES.
true indicates that immediate payment is required from the buyer for: true in the payment business policy, but it will not apply in some scenarios. For example, immediate payment is not applicable for auction listings that have a winning bidder, for buyer purchases that involve the Best Offer feature, or for transactions that happen offline between the buyer and seller.","type":"boolean"},"marketplaceId":{"description":"The ID of the eBay marketplace to which this payment business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this payment business policy. Names must be unique for policies assigned to the same marketplace.Note: NO LONGER SUPPORTED. Although this field may be returned for some older payment business policies, payment instructions are no longer supported by payment business policies. If this field is returned, it can be ignored and these payment instructions will not appear in any listings that use the corresponding business policy.
A free-form string field that allows sellers to add detailed payment instructions to their listings.","type":"string"},"paymentMethods":{"description":"This array shows the available payment methods that the seller has set for the payment business policy.ALL_EXCLUDING_MOTORS_VEHICLES for return business policies, since return business policies are not applicable to motor vehicle listings.","items":{"$ref":"#/components/schemas/CategoryType"},"type":"array"},"description":{"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. Important! This field is deprecated, since eBay no longer supports extended holiday returns. This field should no longer be returned.
","type":"boolean"},"internationalOverride":{"$ref":"#/components/schemas/InternationalReturnOverrideType","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."},"marketplaceId":{"description":"The ID of the eBay marketplace to which this return business policy applies. For implementation help, refer to eBay API documentation","type":"string"},"name":{"description":"A seller-defined name for this return business policy. Names must be unique for policies assigned to the same marketplace.MONEY_BACK. For implementation help, refer to eBay API documentation","type":"string"},"restockingFeePercentage":{"description":"Important! This field is deprecated, since eBay no longer allows sellers to charge a restocking fee for buyer remorse returns.
","type":"string"},"returnInstructions":{"description":"This text-based field provides more details on seller-specified return instructions.Important! This field is no longer supported on many eBay marketplaces. To see if a marketplace and eBay category does support this field, call getReturnPolicies method of the Metadata API. Then you will look for the policyDescriptionEnabled field with a value of true for the eBay category.
BUYER or SELLER. true, the seller accepts returns. If set to false, this field indicates that the seller does not accept returns.","type":"boolean"},"warnings":{"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"},"type":"array"}},"type":"object"},"ShippingOption":{"description":"This type is used by the shippingOptions array, which is used to provide detailed information on the domestic and international shipping options available for the policy. A separate ShippingOption object covers domestic shipping service options and international shipping service options (if the seller ships to international locations).","properties":{"costType":{"description":"This field defines whether the shipping cost model is FLAT_RATE (the same rate for all buyers, or buyers within a region if shipping rate tables are used) or CALCULATED (the shipping rate varies by the ship-to location and size and weight of the package). true for a motor vehicle listing if it will be the buyer's responsibility to pick up the purchased motor vehicle after full payment is made. true for a motor vehicle listing if it will be the buyer's responsibility to arrange for shipment of a purchased motor vehicle after full payment is made. true if the seller offers a free shipping option to the buyer. true for the first domestic shipping service option specified in the shippingServices container (it is ignored if set for subsequent shipping services or for any international shipping service option). 1 or if the sortOrderId field is not used, it is the shipping service option that's specified first in the shippingServices container.ExcludeShippingLocationDetails, then review the ExcludeShippingLocationDetails containers in the response for the strings you use in the regionIncluded.regionName field. ExcludeShippingLocationDetails containers in the GeteBayDetails response where the Region value is Worldwide, and the valid values will be shown in the corresponding Location fields.ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is one of the defined geographical regions, and the valid values will be shown in the corresponding Location fields. Alternatively, you can find the two-digit country code values in the CountryCodeEnum type definition.ExcludeShippingLocationDetails in the GeteBayDetails response where the Region value is either Domestic Location or Additional Locations, and the valid values will be shown in the corresponding Location fields.STATE_OR_PROVINCE region type is only applicable to the US and Canada, and valid values for US states are the same two-digit abbreviations used by the United States Postal Service, and valid values for Canadian provinces and territories are the same two-digit abbreviations used by the Canada Post."},"shippingCarrierCode":{"description":"This field sets/indicates the shipping carrier, such as USPS, FedEx, or UPS. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here. ShippingCarrierDetails. The enum values for each shipping carriers can be found in each ShippingCarrierDetails.ShippingCarrier field in the response payload.0.0 for the first specified domestic shipping service option and if the corresponding freeShipping field is set to true. USPSPriority, FedEx2Day, or UPS3rdDay. Although this field uses the string type, the seller must pass in a pre-defined enumeration value here. ShippingServiceDetails. true value in the corresponding ValidForSellingFlow boolean field. International shipping service options are typically returned at the top of the response payload, and are indicated by an InternationalService boolean field that reads true. 1 appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of 1 appears at the bottom of the list. DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.