eBay Post-Order APIVersion 2

Get Return Rules

GET /post-order/v2/rules/disposition_rules_list

This call is used to retrieve all return rules set in the seller's return preferences. By using the fieldgroups query parameter, the seller can control how much detail on each return rule is returned in the response.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/post-order/v2/rules/disposition_rules_list?
  fieldgroups=RuleListFieldGroupEnum

URI parameters

Parameter Type Required? Meaning
fieldgroups RuleListFieldGroupEnum Optional The fieldgroups query parameter can be used in the call URI to control the detail level that is returned in the response. Only one RuleListFieldGroupEnum value may be used. See the RuleListFieldGroupEnum type for more information on the values that may be used.


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 GetDispositionRulesResponse 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

{ /* GetDispositionRulesResponse */
"creationDisabled": boolean,
"rule": [
    { /* 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 */
  ],
"totalNumRules": integer,
"versionId": integer
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
creationDisabled boolean Conditionally This boolean field is only returned if true, and it indicates if automated return rules are turned off.
rule array of RuleDetailType Always An array of one or more return rules, with detailed information on each rule.
rule.actionDetail RuleActionDetailType Always This container consists of details on a rule action.
rule.actionDetail.actionData array of RuleActionDataDetailType Conditionally This field provides more information about the type of action taken against the return rule.
rule.actionDetail.actionData
  .id
string Conditionally A container consisting of details about the rule action data.
rule.actionDetail.dataType string Conditionally This enumeration value indicates the type of action taken against the return rule.

Applicable values are from RuleActionDataType:

RETURN_ADDRESS
This enumeration value indicates that the action taken on the return rule concerns a return address.
UNKNOWN
This enumeration value indicates that the action taken on the return rule is unknown.

Code so that your app gracefully handles any future changes to this list.
rule.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.
rule.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.
rule.condition.dataList ConditionListDetailType Conditionally An array of one or more rule conditions.
rule.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.
rule.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.
rule.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.
rule.condition.dataList
  .isMultiple
boolean Always This boolean field indicates if multiple items are affected by the rule condition.
rule.condition.dataList
  .selected
array of ListDataType Always The id/name pair in this field identifies the current item that the rule condition applies towards.
rule.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.
rule.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.
rule.condition.isChecked boolean Conditionally This boolean field is returned as true if the rule condition has been checked.
rule.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.
rule.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.
rule.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.
rule.condition.storeId integer Conditionally The unique identifier of the eBay store.
rule.ruleSummary RuleSummaryType Always This container provides a summary of information on the seller's return rules, including.
rule.ruleSummary.count integer Always This integer value indicates the total number of return rules defined on the seller's account.
rule.ruleSummary
  .countInTestMode
integer Always This integer value indicates the number of return rules in the disabled/inactive state.
rule.ruleSummary.invalidAction RuleActionDetailType Conditionally An array of invalid return rule actions. This container is only returned if there are invalid return rule actions.
rule.ruleSummary.invalidAction
  .actionData
array of RuleActionDataDetailType Conditionally This field provides more information about the type of action taken against the return rule.
rule.ruleSummary.invalidAction
  .actionData.id
string Conditionally A container consisting of details about the rule action data.
rule.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
This enumeration value indicates that the action taken on the return rule concerns a return address.
UNKNOWN
This enumeration value indicates that the action taken on the return rule is unknown.

Code so that your app gracefully handles any future changes to this list.
rule.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.
rule.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.
rule.ruleSummary
  .invalidConditions.dataList
ConditionListDetailType Conditionally An array of one or more rule conditions.
rule.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.
rule.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.
rule.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.
rule.ruleSummary
  .invalidConditions.dataList
  .isMultiple
boolean Always This boolean field indicates if multiple items are affected by the rule condition.
rule.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.
rule.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.
rule.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.
rule.ruleSummary
  .invalidConditions.isChecked
boolean Conditionally This boolean field is returned as true if the rule condition has been checked.
rule.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.
rule.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.
rule.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.
rule.ruleSummary
  .invalidConditions.storeId
integer Conditionally The unique identifier of the eBay store.
rule.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.
rule.ruleSummary.priority integer Always This integer value indicates the priority of the return rule.
totalNumRules integer Always This integer value indicates the total number of return rules enabled on the seller's account.
versionId integer Always The unique identifier of rule version.
null



Samples

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



Change History

Change Date Description