Post Order Return API — client.post_order.return_

Version 0.1 · base path /post-order/v2 · async twin: the same methods on AsyncEbayClient, awaited.

Operations

Bases: BaseResource

add_shipping_label_info

add_shipping_label_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

add_shipping_label_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

add_shipping_label_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Create or update a shipping label provided by the seller

cancel_return_request

cancel_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

cancel_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

cancel_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Cancel a return request

check_return_eligibility

check_return_eligibility(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

check_return_eligibility(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

check_return_eligibility(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Check to see if an item is eligible for a return

check_shipping_label_eligibility

check_shipping_label_eligibility(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

check_shipping_label_eligibility(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

check_shipping_label_eligibility(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Validate the eligibility of an existing shipping label

create_return_draft

create_return_draft(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

create_return_draft(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

create_return_draft(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Create a return draft

create_return_request

create_return_request(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

create_return_request(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

create_return_request(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Request a return for an item

create_return_shipping_label

create_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

create_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

create_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Create an eBay shipping label for the buyer

delete_return_draft_file

delete_return_draft_file(draft_id: str, file_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

delete_return_draft_file(draft_id: str, file_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

delete_return_draft_file(draft_id: str, file_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Delete a file associated with a return draft

escalate_return

escalate_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

escalate_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

escalate_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Escalate an existing return to eBay customer support

get_return

get_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> return__models.ReturnDetail

get_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> return__models.ReturnDetail | httpx.Response

Retrieve the details of a specific return

get_return_draft

get_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

get_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Retrieve a return draft

update_return_draft

update_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

update_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

update_return_draft(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Update an existing return draft

get_return_draft_files

get_return_draft_files(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

get_return_draft_files(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_draft_files(draft_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Retrieve the files associated with a return draft

get_return_estimate

get_return_estimate(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

get_return_estimate(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_estimate(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Buyer-facing call to retrieve the estimated refund amount and return shipping costs associated with returning an item.

get_return_files

get_return_files(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

get_return_files(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_files(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Retrieve the files associated with a return

get_return_preferences

get_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> return__models.ReturnPreferences

get_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> return__models.ReturnPreferences | httpx.Response

Retrieve seller's return preferences

set_return_preferences

set_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

set_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

set_return_preferences(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Set seller's return preferences

get_return_shipping_label

get_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

get_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Retrieve the data for an existing shipping label

get_shipment_tracking_info

get_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> Any

get_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

get_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> Any | httpx.Response

Retrieve shipment tracking activity for a return

issue_return_refund

issue_return_refund(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

issue_return_refund(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

issue_return_refund(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Issue a refund

mark_return_received

mark_return_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

mark_return_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

mark_return_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Mark a returned item as received

mark_return_refund_received

mark_return_refund_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

mark_return_refund_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

mark_return_refund_received(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Mark a refund as received

mark_return_refund_sent

mark_return_refund_sent(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

mark_return_refund_sent(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

mark_return_refund_sent(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Notify the buyer that a refund has been issued

mark_return_shipped

mark_return_shipped(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

mark_return_shipped(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

mark_return_shipped(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Mark a return as shipped

process_return_request

process_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

process_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

process_return_request(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Perform an action on a return, such as APPROVE

search

search(*, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: str | None = None, state: str | None = None, status: str | None = None, limit: int | None = None, offset: int | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> return__models.ReturnSearchResponse

search(*, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: str | None = None, state: str | None = None, status: str | None = None, limit: int | None = None, offset: int | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

search(*, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: str | None = None, state: str | None = None, status: str | None = None, limit: int | None = None, offset: int | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> return__models.ReturnSearchResponse | httpx.Response

Retrieve details on items being returned

send_return_message

send_return_message(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

send_return_message(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

send_return_message(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Send a message to the buyer or seller regarding a return

send_return_shipping_label

send_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

send_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

send_return_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Send a shipping label to an email address

submit_return_file

submit_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

submit_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

submit_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Activate the files associated with a return

update_shipment_tracking_info

update_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

update_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

update_shipment_tracking_info(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Update shipment tracking information for an item being returned.

upload_return_draft_file

upload_return_draft_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

upload_return_draft_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

upload_return_draft_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Upload the files relating to a return draft

upload_return_file

upload_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

upload_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

upload_return_file(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Upload the files relating to a return

void_shipping_label

void_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None

void_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response

void_shipping_label(return_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Void a shipping label

Models

PostOrderAmount

Bases: EbayModel

value class-attribute instance-attribute

value = None

currency class-attribute instance-attribute

currency = None

converted_from_currency class-attribute instance-attribute

converted_from_currency = Field(None, alias='convertedFromCurrency')

converted_from_value class-attribute instance-attribute

converted_from_value = Field(None, alias='convertedFromValue')

exchange_rate class-attribute instance-attribute

exchange_rate = Field(None, alias='exchangeRate')

PostOrderDateTime

Bases: EbayModel

value class-attribute instance-attribute

value = None

formatted_value class-attribute instance-attribute

formatted_value = Field(None, alias='formattedValue')

PaginationOutput

Bases: EbayModel

offset class-attribute instance-attribute

offset = None

limit class-attribute instance-attribute

limit = None

total_pages class-attribute instance-attribute

total_pages = Field(None, alias='totalPages')

total_entries class-attribute instance-attribute

total_entries = Field(None, alias='totalEntries')

CountSummary

Bases: EbayModel

count class-attribute instance-attribute

count = None

type class-attribute instance-attribute

type = None

PostOrderHistoryEntry

Bases: EbayModel

date class-attribute instance-attribute

date = None

action class-attribute instance-attribute

action = None

actor class-attribute instance-attribute

actor = None

description class-attribute instance-attribute

description = None

ReturnSummary

Bases: EbayModel

return_id class-attribute instance-attribute

return_id = Field(None, alias='returnId')

order_id class-attribute instance-attribute

order_id = Field(None, alias='orderId')

buyer_login_name class-attribute instance-attribute

buyer_login_name = Field(None, alias='buyerLoginName')

seller_login_name class-attribute instance-attribute

seller_login_name = Field(None, alias='sellerLoginName')

current_type class-attribute instance-attribute

current_type = Field(None, alias='currentType')

state class-attribute instance-attribute

state = None

status class-attribute instance-attribute

status = None

creation_info class-attribute instance-attribute

creation_info = Field(None, alias='creationInfo')

ReturnSearchResponse

Bases: EbayModel

members class-attribute instance-attribute

members = None

total class-attribute instance-attribute

total = None

pagination_output class-attribute instance-attribute

pagination_output = Field(None, alias='paginationOutput')

count_summary class-attribute instance-attribute

count_summary = Field(None, alias='countSummary')

ReturnDetail

Bases: EbayModel

summary class-attribute instance-attribute

summary = None

ReturnPreferences

Bases: EbayModel

rma_required class-attribute instance-attribute

rma_required = Field(None, alias='rmaRequired')

advance_rules_enabled class-attribute instance-attribute

advance_rules_enabled = Field(None, alias='advanceRulesEnabled')