Post-Order API Version 2

• Home
• All Docs
• Support
• Knowledge Base
• Forums
• Resources

• Features Guide
• Usage Guide
• Making a Call
• API Reference
• Tutorials
• Release Notes

Post-Order API – Version 2 Release Notes

Just getting started with the Post-Order API? The navigation bar contains links to the API Reference, the Usage Guide, and more.

See the following for a general introduction to the Post-Order API, and other resources offered by the eBay Developers Program:

• Post-Order API - Usage Guide – An introduction to the Post-Order API
• Developers Program – Join page
• Developer Support – Request support or file a bug
• Knowledge Base – Answers to API questions
• API Site Status – Current server status

API Releases

The following table lists the official releases for the Post-Order API, Version 2:

 

Note: The maintains releases for this RESTful API are tracked only by date and all the notes in this document pertain to the major version of the API.

Feature Update – October 24, 2015

This is a feature update for the Post-Order API, Version 2.

Index of Changed Calls

No changes to existing calls.

New Calls

• Search Cases (GET /post-order/v2/casemanagement/search/)
• Search Inquiries (GET /post-order/v2/inquiry/search)
• Create Custom List (POST /post-order/v2/rules/custom_list)
• Create Return Rules (POST /post-order/v2/rules)
• Get Custom List (GET /post-order/v2/rules/custom_list_detail)
• Get Custom Lists (GET /post-order/v2/rules/custom_list)
• Get Return Rule Templates (GET /post-order/v2/rules/get_templates)
• Get Store Categories (GET /post-order/v2/rules/get_store_category)
• Get Return Rule (GET /post-order/v2/rules/{ruleId})
• Get Return Rule History (GET /post-order/v2/rules/{ruleId}/get_trigger_history)
• Get Return Rules (GET /post-order/v2/rules/disposition_rules_list)
• Update Custom List (PUT /post-order/v2/rules/custom_list)
• Update Return Rules (PUT /post-order/v2/rules)

New Features

This release contains new search calls for order inquiries and cases, plus numerous new calls to set up and manage automated return rules.
See the New Calls section for a complete list of the new operations.

Documentation Changes and Errata

The documentation has been updated to support the new calls.

 

Feature Update – September 28, 2015

This is a feature update for the Post-Order API, Version 2.

Index of Changed Calls

This release adds new upload seller shipping label functionality to the Post-Order API.

New Calls

None

Changed Calls

• POST /post-order/v2/return/{returnId}/add_shipping_label
• POST /post-order/v2/return/{returnId}/file/upload
• POST /post-order/v2/return
• GET /post-order/v2/return/{returnId}

Schema Changes

New Features

Sellers Can Provide Own Shipping Labels to Buyers

The POST /post-order/v2/return/{returnId}/add_shipping_label call was enhanced to enable the seller to provide their own shipping labels to buyers for return shipping. To do this, the seller first uses the POST /post-order/v2/return/{returnId}/file/upload call to upload a scanned image of the seller's shipping label to the return request. Then, the seller uses the POST /post-order/v2/return/{returnId}/add_shipping_label call to make this shipping label available to the buyer. See the POST /post-order/v2/return/{returnId}/add_shipping_label sample to find out more about how this is done.

Other Enhancements to "add_shipping_label" Call

In addition to being able to provide a seller-generated shipping label to the buyer, the new labelAction field in the POST /post-order/v2/return/{returnId}/add_shipping_label call allows the seller to perform the following actions:

• Inform the buyer to use the eBay return shipping label
• Inform the buyer that the seller-generated shipping label has already been sent
• Inform the buyer that no shipping label is available (and state the reason through the noLabelReason field
• Instruct the buyer to purchase their own shipping label, but the seller will reimburse them for the return shipping cost

New holdTransactionId Field

New holdTransactionId field is conditionally returned in the POST /post-order/v2/return and GET /post-order/v2/return/{returnId} calls if a return request has been placed in hold status.

Documentation Changes and Errata

Shipping Returns Section of Features Guide Updated

The Shipping returns section of the Features Guide was updated to account for the new upload seller shipping label functionality.

Return Call Samples Updated

The POST /post-order/v2/return/{returnId}/file/upload and POST /post-order/v2/return/{returnId}/add_shipping_label call samples have been updated to account for the new upload seller shipping label functionality.

Various Documentation Updates

The API Reference, the Usage Guide, and the Post-Order content of the eBay Features Guide have been revised and extended for clarity and accuracy as of December 3, 2015. Existing code should still behave the same.

Feature Update – August 24, 2015

This is a feature update for the Post-Order API, Version 2.

Index of Changed Calls

This release adds new operations for order inquiries (/inquiry)and order escalations (/casemanagement) to the Post-Order API.

New Calls

• POST /post-order/v2/inquiry/
• GET /post-order/v2/inquiry/{inquiryId}
• POST /post-order/v2/inquiry/{inquiryId}/check_eligibility
• POST /post-order/v2/inquiry/{inquiryId}/close
• POST /post-order/v2/inquiry/{inquiryId}/confirm_refund
• POST /post-order/v2/inquiry/{inquiryId}/escalate
• POST /post-order/v2/inquiry/{inquiryId}/issue_refund
• POST /post-order/v2/inquiry/{inquiryId}/provide_refund_info
• POST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info
• POST /post-order/v2/inquiry/{inquiryId}/send_message
• POST /post-order/v2/casemanagement/appeal
• POST /post-order/v2/casemanagement/close
• POST /post-order/v2/casemanagement/issue_refund
• POST /post-order/v2/casemanagement/provide_return_address
• POST /post-order/v2/casemanagement/provide_shipment_info
• GET /post-order/v2/casemanagement/{caseId}

New Features

This release contains several new operations that offer flows for order inquiries and escalations.
See the New Calls section for a complete list of the new operations, and the Usage Guide for details on the newly supported use cases.

Documentation Changes and Errata

The documentation has been updated to support the new inquiry and escalation operations and use cases.

 

Initial Version 2 Release – June 29, 2015

This is the initial release of the Post-Order API, Version 2.

Index of Changed Calls

The following /return and /cancellation operations are included in this initial release of the Post-Order API, Version 2.

New Calls

• POST /post-order/v2/cancellation/cancel
• POST /post-order/v2/cancellation/check_eligibility
• GET /post-order/v2/cancellation/search
• GET /post-order/v2/cancellation/{cancelId}
• POST /post-order/v2/cancellation/{cancelId}/approve
• POST /post-order/v2/cancellation/{cancelId}/confirm
• POST /post-order/v2/cancellation/{cancelId}/reject
• POST /post-order/v2/return
• POST /post-order/v2/return/check_eligibility
• POST /post-order/v2/return/draft
• GET /post-order/v2/return/draft/{draftId}
• PUT /post-order/v2/return/draft/{draftId}
• POST /post-order/v2/return/draft/{draftId}/file/upload
• DELETE /post-order/v2/return/draft/{draftId}/file/{fileId}
• GET /post-order/v2/return/draft/{draftId}/files
• POST /post-order/v2/return/estimate
• GET /post-order/v2/return/metadata/{metadataKey}
• GET /post-order/v2/return/search
• GET /post-order/v2/return/{returnId}
• POST /post-order/v2/return/{returnId}/add_shipping_label
• POST /post-order/v2/return/{returnId}/cancel
• GET /post-order/v2/return/{returnId}/check_label_print_eligibility
• POST /post-order/v2/return/{returnId}/decide
• POST /post-order/v2/return/{returnId}/escalate
• POST /post-order/v2/return/{returnId}/file/submit
• POST /post-order/v2/return/{returnId}/file/upload
• DELETE /post-order/v2/return/{returnId}/file/{fileId}
• GET /post-order/v2/return/{returnId}/files
• GET /post-order/v2/return/{returnId}/get_shipping_label
• POST /post-order/v2/return/{returnId}/initiate_shipping_label
• POST /post-order/v2/return/{returnId}/issue_refund
• POST /post-order/v2/return/{returnId}/mark_as_received
• POST /post-order/v2/return/{returnId}/mark_as_shipped
• POST /post-order/v2/return/{returnId}/mark_refund_received
• POST /post-order/v2/return/{returnId}/mark_refund_sent
• POST /post-order/v2/return/{returnId}/send_message
• POST /post-order/v2/return/{returnId}/send_shipping_label
• GET /post-order/v2/return/{returnId}/tracking
• POST /post-order/v2/return/{returnId}/void_shipping_label

 

Copyright © 2015–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.