eBay Post-Order APIVersion 2

Get Return Preferences

GET /post-order/v2/return/preference

Retrieves the return preferences currently active on the seller's account. This call does not have any path or query parameters, nor does it have a request payload.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/return/preference

This call has no path or query parameters.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

This call has no request payload.


Output

See also Samples.

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

Supported response formats: application/json, application/xml

For more information:
- See GetSellerReturnPreferenceResponse for a description of the response structure
- See the following table for descriptions of each of the data elements returned
- See the Samples for an example of the response format

{ /* GetSellerReturnPreferenceResponse */
"advanceRulesEnabled": boolean,
"basicRules": [
    { /* RuleDetailType */
    "actionDetail":
        { /* RuleActionDetailType */
        "actionData": [
            { /* RuleActionDataDetailType */
            "id": string
            }
            /* More RuleActionDataDetailType nodes here */
          ],
        "dataType": string,
        "isInvalid": boolean
        },
    "condition": [
        { /* RuleConditionDetailType */
        "dataList":
            { /* ConditionListDetailType */
            "all": [
                { /* ListDataType */
                "id": string,
                "name": string
                }
                /* More ListDataType nodes here */
              ],
            "isMultiple": boolean,
            "selected": [
                { /* ListDataType */
                "id": string,
                "name": string
                }
                /* More ListDataType nodes here */
              ]
            },
        "isChecked": boolean,
        "isEbayPlus": boolean,
        "isInvalid": boolean,
        "storeCategory": boolean,
        "storeId": integer
        }
        /* More RuleConditionDetailType nodes here */
      ],
    "ruleSummary":
        { /* RuleSummaryType */
        "count": integer,
        "countInTestMode": integer,
        "invalidAction":
            { /* RuleActionDetailType */
            "actionData": [
                { /* RuleActionDataDetailType */
                "id": string
                }
                /* More RuleActionDataDetailType nodes here */
              ],
            "dataType": string,
            "isInvalid": boolean
            },
        "invalidConditions": [
            { /* RuleConditionDetailType */
            "dataList":
                { /* ConditionListDetailType */
                "all": [
                    { /* ListDataType */
                    "id": string,
                    "name": string
                    }
                    /* More ListDataType nodes here */
                  ],
                "isMultiple": boolean,
                "selected": [
                    { /* ListDataType */
                    "id": string,
                    "name": string
                    }
                    /* More ListDataType nodes here */
                  ]
                },
            "isChecked": boolean,
            "isEbayPlus": boolean,
            "isInvalid": boolean,
            "storeCategory": boolean,
            "storeId": integer
            }
            /* More RuleConditionDetailType nodes here */
          ],
        "lastModifiedDate": datetime,
        "priority": integer
        }
    }
    /* More RuleDetailType nodes here */
  ],
"RMARequired": boolean,
"versionId": integer
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
advanceRulesEnabled boolean Always This Boolean field is returned as true if the seller is enabled to set up advanced return rules for the account.
basicRules array of RuleDetailType Conditionally This container holds an array of the return rules set up on the seller's account. This container is returned if at least one return rule is defined and active for the seller's account.
basicRules.actionDetail RuleActionDetailType Always This container consists of details on a rule action.
basicRules.actionDetail
  .actionData
array of RuleActionDataDetailType Conditionally This field provides more information about the type of action taken against the return rule.
basicRules.actionDetail
  .actionData.id
string Conditionally A container consisting of details about the rule action data.
basicRules.actionDetail
  .dataType
string Conditionally This enumeration value indicates the type of action taken against the return rule.

Applicable values are from RuleActionDataType:

RETURN_ADDRESS
Indicates the action taken on the return rule concerns a return address.
UNKNOWN
Indicates the action taken on the return rule is unknown.

Code so that your app gracefully handles any future changes to this list.
basicRules.actionDetail
  .isInvalid
boolean Conditionally This Boolean field is returned as true if the return rule is invalid. This field is not returned if the return rule is valid.
basicRules.condition array of RuleConditionDetailType Always This is an array of one or more conditions for a return rule. Each container provides details about each rule condition.
basicRules.condition.dataList ConditionListDetailType Conditionally An array of one or more rule conditions.
basicRules.condition.dataList
  .all
array of ListDataType Always The id/name pairs in this field identify all the seller's items that the rule condition will apply towards.
basicRules.condition.dataList
  .all.id
string Conditionally For an item list, this field identifies the item ID. For a category list, this field identifies the eBay category ID. For return reasons, this field identifies the return reason enumeration value.
basicRules.condition.dataList
  .all.name
string Conditionally For an item list, this field identifies the item title for the item identified in the id field. For a category list, this field identifies the category name for the eBay category identified in the id field. For return reasons, this field identifies the displayable text for the return reason identified in the id field.
basicRules.condition.dataList
  .isMultiple
boolean Always This Boolean field indicates if multiple items are affected by the rule condition.
basicRules.condition.dataList
  .selected
array of ListDataType Always The id/name pair in this field identifies the current item that the rule condition applies towards.
basicRules.condition.dataList
  .selected.id
string Conditionally For an item list, this field identifies the item ID. For a category list, this field identifies the eBay category ID. For return reasons, this field identifies the return reason enumeration value.
basicRules.condition.dataList
  .selected.name
string Conditionally For an item list, this field identifies the item title for the item identified in the id field. For a category list, this field identifies the category name for the eBay category identified in the id field. For return reasons, this field identifies the displayable text for the return reason identified in the id field.
basicRules.condition.isChecked boolean Conditionally This Boolean field is returned as true if the rule condition has been checked.
basicRules.condition
  .isEbayPlus
boolean Conditionally This Boolean field is returned as true if the listing is enabled with the eBay Plus feature. eBay Plus is only available on the Germany site. This field is only returned if true.
basicRules.condition.isInvalid boolean Conditionally This Boolean field is returned as true if the rule condition is invalid. This field is not returned if the rule condition is valid.
basicRules.condition
  .storeCategory
boolean Conditionally This Boolean field is returned as true if the rule condition applies to an eBay Store category. This field is only returned if true.
basicRules.condition.storeId integer Conditionally The unique identifier of the eBay store.
basicRules.ruleSummary RuleSummaryType Always This container provides a summary of information on the seller's return rules, including.
basicRules.ruleSummary.count integer Always This integer value indicates the total number of return rules defined on the seller's account.
basicRules.ruleSummary
  .countInTestMode
integer Always This integer value indicates the number of return rules in the disabled/inactive state.
basicRules.ruleSummary
  .invalidAction
RuleActionDetailType Conditionally An array of invalid return rule actions. This container is only returned if there are invalid return rule actions.
basicRules.ruleSummary
  .invalidAction.actionData
array of RuleActionDataDetailType Conditionally This field provides more information about the type of action taken against the return rule.
basicRules.ruleSummary
  .invalidAction.actionData.id
string Conditionally A container consisting of details about the rule action data.
basicRules.ruleSummary
  .invalidAction.dataType
string Conditionally This enumeration value indicates the type of action taken against the return rule.

Applicable values are from RuleActionDataType:

RETURN_ADDRESS
Indicates the action taken on the return rule concerns a return address.
UNKNOWN
Indicates the action taken on the return rule is unknown.

Code so that your app gracefully handles any future changes to this list.
basicRules.ruleSummary
  .invalidAction.isInvalid
boolean Conditionally This Boolean field is returned as true if the return rule is invalid. This field is not returned if the return rule is valid.
basicRules.ruleSummary
  .invalidConditions
array of RuleConditionDetailType Conditionally An array of invalid conditions for the return rule. This container is only returned if there are invalid conditions for the return rule.
basicRules.ruleSummary
  .invalidConditions.dataList
ConditionListDetailType Conditionally An array of one or more rule conditions.
basicRules.ruleSummary
  .invalidConditions.dataList
  .all
array of ListDataType Always The id/name pairs in this field identify all the seller's items that the rule condition will apply towards.
basicRules.ruleSummary
  .invalidConditions.dataList
  .all.id
string Conditionally For an item list, this field identifies the item ID. For a category list, this field identifies the eBay category ID. For return reasons, this field identifies the return reason enumeration value.
basicRules.ruleSummary
  .invalidConditions.dataList
  .all.name
string Conditionally For an item list, this field identifies the item title for the item identified in the id field. For a category list, this field identifies the category name for the eBay category identified in the id field. For return reasons, this field identifies the displayable text for the return reason identified in the id field.
basicRules.ruleSummary
  .invalidConditions.dataList
  .isMultiple
boolean Always This Boolean field indicates if multiple items are affected by the rule condition.
basicRules.ruleSummary
  .invalidConditions.dataList
  .selected
array of ListDataType Always The id/name pair in this field identifies the current item that the rule condition applies towards.
basicRules.ruleSummary
  .invalidConditions.dataList
  .selected.id
string Conditionally For an item list, this field identifies the item ID. For a category list, this field identifies the eBay category ID. For return reasons, this field identifies the return reason enumeration value.
basicRules.ruleSummary
  .invalidConditions.dataList
  .selected.name
string Conditionally For an item list, this field identifies the item title for the item identified in the id field. For a category list, this field identifies the category name for the eBay category identified in the id field. For return reasons, this field identifies the displayable text for the return reason identified in the id field.
basicRules.ruleSummary
  .invalidConditions.isChecked
boolean Conditionally This Boolean field is returned as true if the rule condition has been checked.
basicRules.ruleSummary
  .invalidConditions.isEbayPlus
boolean Conditionally This Boolean field is returned as true if the listing is enabled with the eBay Plus feature. eBay Plus is only available on the Germany site. This field is only returned if true.
basicRules.ruleSummary
  .invalidConditions.isInvalid
boolean Conditionally This Boolean field is returned as true if the rule condition is invalid. This field is not returned if the rule condition is valid.
basicRules.ruleSummary
  .invalidConditions
  .storeCategory
boolean Conditionally This Boolean field is returned as true if the rule condition applies to an eBay Store category. This field is only returned if true.
basicRules.ruleSummary
  .invalidConditions.storeId
integer Conditionally The unique identifier of the eBay store.
basicRules.ruleSummary
  .lastModifiedDate
datetime Always The timestamp indicated the last action performed on the return rule. The action may be the creation date of the return rule, or the date of the last recorded modification to the return rule.
basicRules.ruleSummary
  .priority
integer Always This integer value indicates the priority of the return rule.
RMARequired boolean Always This Boolean field is returned as true if the seller is requiring that an Return Merchandise Authorization (RMA) number be provided by the buyer when returning an item. This Boolean field is returned as false if the seller is not requiring that an RMA number be provided.
versionId integer Always The unique identifier of the seller's current set of return rules. This unique identifier will be updated each time the seller makes any type of update to return rules. This unique identifier will be needed when the seller updates return rules through the updateReturnRules call.



Samples

Code samples not yet added for this call's documentation.



Change History

Change Date Description