eBay Post-Order APIVersion 2

Update Custom List

PUT /post-order/v2/rules/custom_list

This call allows the seller to update a custom list of the seller's active listings or a list of eBay categories.

Input

See also Samples.

Resource URI (production)

PUT https://api.ebay.com/post-order/v2/post-order/v2/rules/custom_list

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

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

{ /* ModifyCustomListRequest */
"customListDetail":
    { /* CustomListDetailType */
    "listData": [
        { /* CustomListDataType */
        "id": integer,
        "identify": string,
        "name": string
        }
        /* More CustomListDataType nodes here */
      ],
    "listId": integer,
    "listName": string,
    "listType": string
    },
"forceDelete": boolean,
"operation": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
customListDetail CustomListDetailType Required This container consists of the details of the custom list.
customListDetail.listData array of CustomListDataType Required This container consist of one or more id and name pairs. For an item list, these pairs identify the item ID and the item title. For a category list, these pairs identify the category ID and the category name.
customListDetail.listData.id integer Conditional The unique identifier of the custom list.
customListDetail.listData
  .identify
string Conditional This field identifies the custom list.
customListDetail.listData.name string Conditional The name of the custom list.
customListDetail.listId integer Conditional The unique identifier of the custom list. This unique identifier is created by eBay upon successful creation of a custom list. This field is not applicable to the request payload of the createCustomList call.
customListDetail.listName string Required This is the name given to the list by the seller. A list name is required.
customListDetail.listType string Required This enumeration value indicates the type of list.

Applicable values are from CustomListType:

ITEM_LIST
Indicates the custom list type is an item list.
UNKNOWN
Indicates the custom list type is unknown.
forceDelete boolean Conditional This boolean field is included in the request and set to true if the user wishes to delete the custom list. If this action is being taken against a custom list, the operation value should be set to DELETEALL.
operation string Required This enumeration value indicates whether or not one or more items or eBay categories are being added to or removed from the custom list.

Applicable values are from CustomListModificationType:

ADD
Indicates an entity was added to the custom list.
DELETE
Indicates an entity was deleted from the custom list.
DELETEALL
Indicates all entities in the custom list were deleted.
UNKNOWN
Indicates the modification made to the custom list is unknown.

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

{ /* ModifyCustomListResponse */
"listId": integer,
"ruleAffected": [
    { /* 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 RuleSummaryType nodes here */
  ]
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
listId integer Always This is the unique identifier of the custom list of items or eBay categories that was modified. This field is always returned as long as the updateCustomList call is successful.
ruleAffected array of RuleSummaryType Conditionally This is an array of one or more return rules that are affected by the modification made on the custom list identified in the listId field. A summary of information is provided for each return rule that was affected. This container will not be returned if the modification to the custom list did not affect any return rules.
ruleAffected.count integer Always This integer value indicates the total number of return rules defined on the seller's account.
ruleAffected.countInTestMode integer Always This integer value indicates the number of return rules in the disabled/inactive state.
ruleAffected.invalidAction RuleActionDetailType Conditionally An array of invalid return rule actions. This container is only returned if there are invalid return rule actions.
ruleAffected.invalidAction
  .actionData
array of RuleActionDataDetailType Conditionally This field provides more information about the type of action taken against the return rule.
ruleAffected.invalidAction
  .actionData.id
string Conditionally A container consisting of details about the rule action data.
ruleAffected.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.
ruleAffected.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.
ruleAffected.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.
ruleAffected.invalidConditions
  .dataList
ConditionListDetailType Conditionally An array of one or more rule conditions.
ruleAffected.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.
ruleAffected.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.
ruleAffected.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.
ruleAffected.invalidConditions
  .dataList.isMultiple
boolean Always This boolean field indicates if multiple items are affected by the rule condition.
ruleAffected.invalidConditions
  .dataList.selected
array of ListDataType Always The id/name pair in this field identifies the current item that the rule condition applies towards.
ruleAffected.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.
ruleAffected.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.
ruleAffected.invalidConditions
  .isChecked
boolean Conditionally This boolean field is returned as true if the rule condition has been checked.
ruleAffected.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.
ruleAffected.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.
ruleAffected.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.
ruleAffected.invalidConditions
  .storeId
integer Conditionally The unique identifier of the eBay store.
ruleAffected.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.
ruleAffected.priority integer Always This integer value indicates the priority of the return rule.
null



Samples

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



Change History

Change Date Description