eBay Post-Order APIVersion 2

Create Custom List

POST /post-order/v2/rules/custom_list

This call allows the seller to create a custom list of the seller's active listings or a list of eBay categories. A custom list can be applied to a return rule.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/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.

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

Request field descriptions



Input Container/Field Type Occurrence Meaning
customListDetail CustomListDetailType Required This container is used to provide details about 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
This value indicates the custom list type is an item list.
UNKNOWN
This value indicates the custom list type 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 CreateCustomListResponse 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

{ /* CreateCustomListResponse */
"listId": integer
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
listId integer Always The unique identifier of the custom list. This identifier is created by eBay upon the successful creation of a custom list.
null



Samples

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



Change History

Change Date Description