Skip to content

Post Order Case Management API — client.post_order.case

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

Operations

Bases: BaseResource

appeal_case_decision

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

Buyer or seller appeals a case decision

close_case

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

Buyer closes a case

get_case

get_case(case_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> case_models.CaseDetail
get_case(case_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_case(case_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> case_models.CaseDetail | httpx.Response

Retrieve the details related to a specific case

issue_case_refund

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

Seller issues a refund for a case

provide_return_shipment_info

provide_return_shipment_info(case_id: str, *, shipping_carrier_name: str, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> None
provide_return_shipment_info(case_id: str, *, shipping_carrier_name: str, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
provide_return_shipment_info(case_id: str, *, shipping_carrier_name: str, tracking_number: str, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> None | httpx.Response

Buyer provides return shipment information

provides_return_address

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

Seller provides a return address to the buyer

search

search(*, case_type_filter: str | None = None, case_status_filter: str | None = None, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: str | None = None, limit: int | None = None, offset: int | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> case_models.CaseSearchResponse
search(*, case_type_filter: str | None = None, case_status_filter: str | None = None, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: 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(*, case_type_filter: str | None = None, case_status_filter: str | None = None, order_id: str | None = None, item_id: str | None = None, transaction_id: str | None = None, buyer_login_name: str | None = None, limit: int | None = None, offset: int | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> case_models.CaseSearchResponse | httpx.Response

This call is used to search for cases using multiple filter types.

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

CaseSummary

Bases: EbayModel

item_id class-attribute instance-attribute

item_id = Field(None, alias='itemId')

transaction_id class-attribute instance-attribute

transaction_id = Field(None, alias='transactionId')

case_id class-attribute instance-attribute

case_id = Field(None, alias='caseId')

buyer class-attribute instance-attribute

buyer = None

seller class-attribute instance-attribute

seller = None

case_status_enum class-attribute instance-attribute

case_status_enum = Field(None, alias='caseStatusEnum')

claim_amount class-attribute instance-attribute

claim_amount = Field(None, alias='claimAmount')

respond_by_date class-attribute instance-attribute

respond_by_date = Field(None, alias='respondByDate')

creation_date class-attribute instance-attribute

creation_date = Field(None, alias='creationDate')

last_modified_date class-attribute instance-attribute

last_modified_date = Field(None, alias='lastModifiedDate')

CaseSearchResponse

Bases: EbayModel

members class-attribute instance-attribute

members = None

total_number_of_cases class-attribute instance-attribute

total_number_of_cases = Field(None, alias='totalNumberOfCases')

pagination_output class-attribute instance-attribute

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

CaseHistoryDetails

Bases: EbayModel

history class-attribute instance-attribute

history = None

buyerrequested class-attribute instance-attribute

buyerrequested = None

shipment_tracking_details class-attribute instance-attribute

shipment_tracking_details = Field(None, alias='shipmentTrackingDetails')

CaseDetail

Bases: EbayModel

case_id class-attribute instance-attribute

case_id = Field(None, alias='caseId')

case_type class-attribute instance-attribute

case_type = Field(None, alias='caseType')

item_id class-attribute instance-attribute

item_id = Field(None, alias='itemId')

transaction_id class-attribute instance-attribute

transaction_id = Field(None, alias='transactionId')

return_id class-attribute instance-attribute

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

claim_amount class-attribute instance-attribute

claim_amount = Field(None, alias='claimAmount')

shipping_fee class-attribute instance-attribute

shipping_fee = Field(None, alias='shippingFee')

case_quantity class-attribute instance-attribute

case_quantity = Field(None, alias='caseQuantity')

initiator class-attribute instance-attribute

initiator = None

creation_date class-attribute instance-attribute

creation_date = Field(None, alias='creationDate')

last_modified_date class-attribute instance-attribute

last_modified_date = Field(None, alias='lastModifiedDate')

seller_closure_reason class-attribute instance-attribute

seller_closure_reason = Field(None, alias='sellerClosureReason')

buyer_closure_reason class-attribute instance-attribute

buyer_closure_reason = Field(None, alias='buyerClosureReason')

case_details class-attribute instance-attribute

case_details = Field(None, alias='caseDetails')

action_deadlines class-attribute instance-attribute

action_deadlines = Field(None, alias='actionDeadlines')

appeal_details class-attribute instance-attribute

appeal_details = Field(None, alias='appealDetails')

buyer class-attribute instance-attribute

buyer = None

seller class-attribute instance-attribute

seller = None

buyer_outcome class-attribute instance-attribute

buyer_outcome = Field(None, alias='buyerOutcome')

seller_outcome class-attribute instance-attribute

seller_outcome = Field(None, alias='sellerOutcome')

next_steps class-attribute instance-attribute

next_steps = Field(None, alias='nextSteps')

case_content_on_hold class-attribute instance-attribute

case_content_on_hold = Field(None, alias='caseContentOnHold')

status class-attribute instance-attribute

status = None

fsnadno_seller_fault class-attribute instance-attribute

fsnadno_seller_fault = Field(None, alias='fsnadnoSellerFault')

case_history_details class-attribute instance-attribute

case_history_details = Field(None, alias='caseHistoryDetails')