eBay Post-Order APIVersion 2

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 Cancellation Request
POST /post-order/v2/cancellation/{cancelId}/approve
Seller approves a cancellation request view
  Check Cancellation Eligibility
POST /post-order/v2/cancellation/check_eligibility
Check the eligibility of an order cancellation view
  Confirm Cancellation Refund
POST /post-order/v2/cancellation/{cancelId}/confirm
Buyer confirms the refund from a cancellation was received view
  Get Cancellation
GET /post-order/v2/cancellation/{cancelId}
Retrieve the details of an order cancellation view
  Reject Cancellation Request
POST /post-order/v2/cancellation/{cancelId}/reject
Seller rejects a cancellation request view
  Search Cancellations
GET /post-order/v2/cancellation/search
Search for cancellations view
  Submit Cancellation Request
POST /post-order/v2/cancellation
Request or perform an order cancellation view
CASE MANAGEMENT
  Appeal Case Decision
POST /post-order/v2/casemanagement/{caseId}/appeal
Buyer or seller appeals a case decision view
  Close case
POST /post-order/v2/casemanagement/{caseId}/close
Buyer closes a case view
  Get Case
GET /post-order/v2/casemanagement/{caseId}
Retrieve the details related to a specific case view
  Issue Case Refund
POST /post-order/v2/casemanagement/{caseId}/issue_refund
Seller issues a refund for a case view
  Provide Return Shipment Info
POST /post-order/v2/casemanagement/{caseId}/provide_shipment_info
Buyer provides return shipment information view
  Provides Return Address
POST /post-order/v2/casemanagement/{caseId}/provide_return_address
Seller provides a return address to the buyer view
  Search Cases
GET /post-order/v2/casemanagement/search
This call is used to search for cases using multiple filter types. n/a
INQUIRY
  Check Inquiry Eligibility
POST /post-order/v2/inquiry/check_eligibility
Check if a buyer is eligible to open an inquiry on an order view
  Close Inquiry
POST /post-order/v2/inquiry/{inquiryId}/close
Close an inquiry for the buyer view
  Confirm Inquiry Refund
POST /post-order/v2/inquiry/{inquiryId}/confirm_refund
Buyer confirms the refund from an inquiry was received view
  Create Inquiry
POST /post-order/v2/inquiry
Create an inquiry for the buyer view
  Escalate Inquiry
POST /post-order/v2/inquiry/{inquiryId}/escalate
Escalate an inquiry to an INR case view
  Get Inquiry
GET /post-order/v2/inquiry/{inquiryId}
Retrieve the history and details related to a specific inquiry view
  Issue Inquiry Refund
POST /post-order/v2/inquiry/{inquiryId}/issue_refund
Issue a refund for an inquiry view
  Provide Inquiry Refund Info
POST /post-order/v2/inquiry/{inquiryId}/provide_refund_info
Provide refund information about an inquiry to the buyer view
  Provide Inquiry Shipment Info
POST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info
Provide shipment information for an inquiry view
  Search Inquiries
GET /post-order/v2/inquiry/search
This call is used to search for inquiries using multiple filter types. n/a
  Send Inquiry Message
POST /post-order/v2/inquiry/{inquiryId}/send_message
Contact the buyer or seller about an inquiry view
RETURN
  Add Shipping Label Info
POST /post-order/v2/return/{returnId}/add_shipping_label
Create or update a shipping label provided by the seller view
  Cancel Return Request
POST /post-order/v2/return/{returnId}/cancel
Cancel a return request view
  Check Return Eligibility
POST /post-order/v2/return/check_eligibility
Check to see if an item is eligible for a return view
  Check Shipping Label Eligibility
GET /post-order/v2/return/{returnId}/check_label_print_eligibility
Validate the eligibility of an existing shipping label view
  Create Return Draft
POST /post-order/v2/return/draft
Create a return draft view
  Create Return Request
POST /post-order/v2/return
Request a return for an item view
  Create Return Shipping Label
POST /post-order/v2/return/{returnId}/initiate_shipping_label
Create an eBay shipping label for the buyer view
  Delete Return Draft File
DELETE /post-order/v2/return/draft/{draftId}/file/{fileId}
Delete a file associated with a return draft view
  Delete Return File
DELETE /post-order/v2/return/{returnId}/file/{fileId}
Delete a file associated with a return view
  Escalate Return
POST /post-order/v2/return/{returnId}/escalate
Escalate an existing return to eBay customer support view
  Get Return
GET /post-order/v2/return/{returnId}
Retrieve the details of a specific return view
  Get Return Draft
GET /post-order/v2/return/draft/{draftId}
Retrieve a return draft view
  Get Return Draft Files
GET /post-order/v2/return/draft/{draftId}/files
Retrieve the files associated with a return draft view
  Get Return Estimate
POST /post-order/v2/return/estimate
Retrieve the cost estimate of a refund with its shipping cost view
  Get Return Files
GET /post-order/v2/return/{returnId}/files
Retrieve the files associated with a return view
  Get Return Metadata
GET /post-order/v2/return/metadata/{metadataKey}
Retrieve metadata related to a return view
  Get Return Preferences
GET /post-order/v2/return/preference
Retrieve seller's return preferences n/a
  Get Return Shipping Label
GET /post-order/v2/return/{returnId}/get_shipping_label
Retrieve the data for an existing shipping label view
  Get Shipment Tracking
GET /post-order/v2/return/{returnId}/tracking
Retrieve shipment tracking activity for a return view
  Issue Return Refund
POST /post-order/v2/return/{returnId}/issue_refund
Issue a refund view
  Mark Return Received
POST /post-order/v2/return/{returnId}/mark_as_received
Mark a returned item as received view
  Mark Return Refund Received
POST /post-order/v2/return/{returnId}/mark_refund_received
Mark a refund as received view
  Mark Return Refund Sent
POST /post-order/v2/return/{returnId}/mark_refund_sent
Notify the buyer that a refund has been issued view
  Mark Return Shipped
POST /post-order/v2/return/{returnId}/mark_as_shipped
Mark a return as shipped view
  Process Return Request
POST /post-order/v2/return/{returnId}/decide
Perform an action on a return, such as APPROVE view
  Search Returns
GET /post-order/v2/return/search
Retrieve details on items being returned view
  Send Return Message
POST /post-order/v2/return/{returnId}/send_message
Send a message to the buyer or seller regarding a return view
  Send Return Shipping Label
POST /post-order/v2/return/{returnId}/send_shipping_label
Send a shipping label to an email address view
  Set Return Preferences
POST /post-order/v2/return/preference
Set seller's return preferences n/a
  Submit Return File
POST /post-order/v2/return/{returnId}/file/submit
Activate the files associated with a return view
  Update Return Draft
PUT /post-order/v2/return/draft/{draftId}
Update an existing return draft view
  Update Shipment Tracking
PUT /post-order/v2/return/{returnId}/update_tracking
Update shipment tracking information n/a
  Upload Return Draft File
POST /post-order/v2/return/draft/{draftId}/file/upload
Upload the files relating to a return draft view
  Upload Return File
POST /post-order/v2/return/{returnId}/file/upload
Upload the files relating to a return view
  Void Shipping Label
POST /post-order/v2/return/{returnId}/void_shipping_label
Void a shipping label view
RULES
  Create Custom List
POST /post-order/v2/rules/custom_list
Create a custom list of items or eBay categories n/a
  Create Return Rules
POST /post-order/v2/rules
Create a return rule set n/a
  Get Custom List
GET /post-order/v2/rules/custom_list_detail
Retrieve a specific item or category custom list n/a
  Get Custom Lists
GET /post-order/v2/rules/custom_list
Retrieve all item or category custom lists n/a
  Get Return Rule Templates
GET /post-order/v2/rules/get_templates
Retrieves a list of return rule templates n/a
  Get Store Categories
GET /post-order/v2/rules/get_store_category
Retrieve eBay Store categories n/a
  Get Return Rule
GET /post-order/v2/rules/{ruleId}
Retrieve a specific return rule n/a
  Get Return Rule History
GET /post-order/v2/rules/{ruleId}/get_trigger_history
Retrieve a history of return requests processed by a specific return rule n/a
  Get Return Rules
GET /post-order/v2/rules/disposition_rules_list
Retrieve all seller return rules n/a
  Update Custom List
PUT /post-order/v2/rules/custom_list
Update a custom list of items or eBay categories n/a
  Update Return Rules
PUT /post-order/v2/rules
Update one or more return rules n/a