eBay Business Policies Management APIVersion 1.0.0
 

GetSellerProfilesRequest ( BaseRequest )

This call is used to retrieve one or more business policies for a seller. Specific business policies can be retrieved by passing in profileId or profileName values, or all policies of a certain type (payment, return, or shipping) can be retrieved.

Call that uses GetSellerProfilesRequest:

Fields

includeDetails ( boolean ) [0..1]
This optional flag determines whether or not detailed information is retrieved for each business policy in the response. If included and set to 'true' or not included (since 'true' is the default), all applicable containers and fields for each business policy are returned in the response. If included and set to 'false', the following containers are not returned in the response:
  • paymentInfo (for all retrieved payment policies)
  • returnPolicyInfo (for all retrieved return policies)
  • shippingPolicyInfo (for all retrieved shipping policies)
  • lt;/ul>
See the Field Index to learn which calls use includeDetails.

profileId ( long ) [0..*]
Unique identifier for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response.
See the Field Index to learn which calls use profileId.

profileName ( string ) [0..*]
Unique name for a seller's business policy. Pass a valid value into this field to retrieve a specific business policy. This field can be repeated multiple times to retrieve multiple policies.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all business policies that match any of the supplied filters are retrieved in the response.
See the Field Index to learn which calls use profileName.

profileType ( ProfileType ) [0..*]
The seller passes in one or more profileType enumeration values to retrieve all business policies of that type. Valid values for this field are PAYMENT, RETURN_POLICY, and SHIPPING.

Boolean OR logic is applied when using any combination of the profileType, profileID, and profileName filters in a getSellerProfiles request, so all policies that match any of the supplied filters are retrieved in the response.
See the Field Index to learn which calls use profileType.