Call Index
This API Reference describes the elements and attributes for each call in the Post-Order API.
For details on the Post-Order API call flows, please see the Features Guide section Resolving Order Issues.
Call | Summary | Samples | |
---|---|---|---|
CANCELLATION | |||
Approve CancellationPOST /post-order/v2/cancellation/{cancelId}/approve |
Seller approves a cancellation request | view | |
Check Cancellation EligibilityPOST /post-order/v2/cancellation/check_eligibility |
Verify if an order is eligible to be cancelled | view | |
Confirm Cancellation RefundPOST /post-order/v2/cancellation/{cancelId}/confirm |
Buyer confirms the refund from a cancelled order was received | view | |
Create Cancellation RequestPOST /post-order/v2/cancellation |
Request or perform an order cancellation | view | |
Get CancellationGET /post-order/v2/cancellation/{cancelId} |
Retrieve the details of an order cancellation request | view | |
Reject CancellationPOST /post-order/v2/cancellation/{cancelId}/reject |
Seller rejects a cancellation request | view | |
Search CancellationsGET /post-order/v2/cancellation/search |
Search for cancellations | view | |
CASE MANAGEMENT | |||
Appeal Case DecisionPOST /post-order/v2/casemanagement/{caseId}/appeal |
Buyer or seller appeals a case decision | view | |
Close CasePOST /post-order/v2/casemanagement/{caseId}/close |
Buyer closes a case | view | |
Get CaseGET /post-order/v2/casemanagement/{caseId} |
Retrieve the details related to a specific case | view | |
Issue Case RefundPOST /post-order/v2/casemanagement/{caseId}/issue_refund |
Seller issues a refund for a case | view | |
Provide Case Shipment InfoPOST /post-order/v2/casemanagement/{caseId}/provide_shipment_info |
Provides shipment tracking information for an item that is involved in case.. | view | |
Provides Return AddressPOST /post-order/v2/casemanagement/{caseId}/provide_return_address |
Seller provides a return address to the buyer | view | |
Search CasesGET /post-order/v2/casemanagement/search |
This method is used to search for cases using multiple filter types. | view | |
INQUIRY | |||
Check Inquiry EligibilityPOST /post-order/v2/inquiry/check_eligibility |
Check if a buyer is eligible to open an inquiry on an order line item | view | |
Close InquiryPOST /post-order/v2/inquiry/{inquiryId}/close |
Close an inquiry for the buyer | view | |
Confirm Inquiry RefundPOST /post-order/v2/inquiry/{inquiryId}/confirm_refund |
Buyer confirms the refund was received for an order line item that was part of an INR inquiry | view | |
Create InquiryPOST /post-order/v2/inquiry |
Create an inquiry for the buyer | view | |
Escalate InquiryPOST /post-order/v2/inquiry/{inquiryId}/escalate |
Escalate an inquiry to an INR case | view | |
Get InquiryGET /post-order/v2/inquiry/{inquiryId} |
Retrieve the history and details related to a specific inquiry | view | |
Issue Inquiry RefundPOST /post-order/v2/inquiry/{inquiryId}/issue_refund |
Issue a refund for a line item that is part of an INR inquiry | view | |
Provide Inquiry Refund InfoPOST /post-order/v2/inquiry/{inquiryId}/provide_refund_info |
Provide refund information about an inquiry to the buyer | view | |
Provide Inquiry Shipment InfoPOST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info |
Provide shipment information for an inquiry | view | |
Search InquiriesGET /post-order/v2/inquiry/search |
This method is used to search for inquiries using multiple filter types | view | |
Send Inquiry MessagePOST /post-order/v2/inquiry/{inquiryId}/send_message |
Contact the buyer or seller about an inquiry | view | |
RETURN | |||
Add Shipping Label InfoPOST /post-order/v2/return/{returnId}/add_shipping_label |
Create or update a return shipping label provided by the seller | view | |
Cancel Return RequestPOST /post-order/v2/return/{returnId}/cancel |
Cancel a return request | view | |
Check Return EligibilityPOST /post-order/v2/return/check_eligibility |
Check to see if an item is eligible for a return | view | |
Check Shipping Label Print EligibilityGET /post-order/v2/return/{returnId}/check_label_print_eligibility |
Validate the eligibility of a return shipping label | view | |
Create Return DraftPOST /post-order/v2/return/draft |
Create a return request draft | view | |
Create Return RequestPOST /post-order/v2/return |
Request a return for an item | view | |
Delete Return Request Draft FileDELETE /post-order/v2/return/draft/{draftId}/file/{fileId} |
Delete a file associated with a return request draft | view | |
Escalate ReturnPOST /post-order/v2/return/{returnId}/escalate |
Escalate a return request into a case | view | |
Get ReturnGET /post-order/v2/return/{returnId} |
Retrieve the details of a specific return request | view | |
Get Return DraftGET /post-order/v2/return/draft/{draftId} |
Retrieve a return request draft | view | |
Get Return EstimatePOST /post-order/v2/return/estimate |
This method is used on behalf of a buyer to retrieve the estimated refund amount and return shipping costs associated with returning an item. | view | |
Get Return FilesGET /post-order/v2/return/{returnId}/files |
Retrieve the files associated with a return request | view | |
Get Return PreferencesGET /post-order/v2/return/preference |
Retrieve seller's return preferences | view | |
Get Return Request Draft FilesGET /post-order/v2/return/draft/{draftId}/files |
Retrieve the files associated with a return request draft | view | |
Get Return Shipping LabelGET /post-order/v2/return/{returnId}/get_shipping_label |
Retrieve the data for a return shipping label | view | |
Get Shipment Tracking InfoGET /post-order/v2/return/{returnId}/tracking |
Retrieve shipment tracking activity for a return item | view | |
Initiate Return Shipping LabelPOST /post-order/v2/return/{returnId}/initiate_shipping_label |
Initiate an eBay return shipping label | view | |
Issue Return RefundPOST /post-order/v2/return/{returnId}/issue_refund |
Issue a refund for a returned item | view | |
Mark Return ReceivedPOST /post-order/v2/return/{returnId}/mark_as_received |
Mark a return item or replacemen item as received | view | |
Mark Return Refund ReceivedPOST /post-order/v2/return/{returnId}/mark_refund_received |
Mark a refund as received | view | |
Mark Return Refund SentPOST /post-order/v2/return/{returnId}/mark_refund_sent |
Notify the buyer that a refund has been issued | view | |
Mark Return ShippedPOST /post-order/v2/return/{returnId}/mark_as_shipped |
Mark a return item as shipped | view | |
Process Return RequestPOST /post-order/v2/return/{returnId}/decide |
Seller or buyer perform an action against a return request | view | |
Search ReturnsGET /post-order/v2/return/search |
Search for return requests based on filter criteria | view | |
Send Return MessagePOST /post-order/v2/return/{returnId}/send_message |
Send a message to order partner regarding a return request | view | |
Send Return Shipping LabelPOST /post-order/v2/return/{returnId}/send_shipping_label |
Send a shipping label to an email address | view | |
Set Return PreferencesPOST /post-order/v2/return/preference |
Set seller's return preferences | view | |
Submit Return FilePOST /post-order/v2/return/{returnId}/file/submit |
Activate the files associated with a return request | view | |
Update Return DraftPUT /post-order/v2/return/draft/{draftId} |
Update an existing return request draft | view | |
Update Shipment Tracking InfoPUT /post-order/v2/return/{returnId}/update_tracking |
Update shipment tracking information for a return item | view | |
Upload Return FilePOST /post-order/v2/return/{returnId}/file/upload |
Upload the files relating to a return request | view | |
Upload Return Request Draft FilePOST /post-order/v2/return/draft/{draftId}/file/upload |
Upload the files relating to a return request draft | view | |
Void Shipping LabelPOST /post-order/v2/return/{returnId}/void_shipping_label |
Void a shipping label | view |