eBay Post-Order API Version 2

Post-Order API – Making a Call

Post Order is a RESTful API and you can follow the normal procedure for making a REST call when employing the operations in this API.

This document gives an overview of how to put together a Post Order call. It describes the operation HTTP methods, endpoints, HTTP headers, and payload formats. The document also covers general information you might find useful when making Post Order calls. The guide contains the following sections:

Call Structure

Create a call to the Post-Order API by combining the following elements:

Note: The Developers Program Knowledge Base is a good source of code samples. To find code samples and other useful information for the Post-Order API, select Post-Order API from the Search By Product drop-down menu and click Search.

Base Endpoints

While each API call has a unique endpoint, all calls share a common base endpoint to which the unique URI endpoint for the call is appended.

The API supports two environments, one for testing and one for production use. The base endpoints for these environments are as follows:

Sandbox base endpoint:
  https://api.sandbox.ebay.com

Production base endpoint:
  https://api.ebay.com

Note: When making calls, be sure you're using an authorization token that is generated for the environment you are addressing.

HTTP Headers

You must include a set of HTTP headers in each Post Order call you make. The following table lists both the required header values, along with the optional headers:

Header Description Applicable Values
Authorization The Authentication Token that is used to validate the caller has permission to access the eBay servers. Often, the token contains the permission needed for the caller to make a call on behalf of the user for whom the call is being made. Prefix a valid eBay token with the word "Bearer".
For more detailed information on getting and renewing authentication tokens, see Getting Tokens.
Required
Bearer <authorization-token-value>
Content-Type The MIME type of the body of the request. Must be JSON.
Required
application/json
X-EBAY-C-MARKETPLACE-ID The global ID of the eBay site on which the transaction took place.
Required
Currently, the marketplaces are limited to:
EBAY_US, EBAY_UK, EBAY_DE, EBAY_AU, and EBAY_CA.
Accept The media type for the response. Defaults to JSON (the only supported media type). application/json

 

Important! The Authorization header requires you to supply a current and valid authorization token. For details on generating a valid token, see Getting Tokens.

Request and Response Payload Formats

Post Order supports JSON as the input and output format. See HTTP Headers for details on specifying the payload format.

In most cases, the standard JSON grammar rules are followed, as described in RFC 4627. However, you should be aware of the following special case.

For the most part, formatting JSON payloads is straight forward. However, when a field has both an attribute and a value, the value requires a special JSON representation. For example, you might encounter a call that requires the use of an attribute to help specify the details of a field (as in a product ID, where it is given both a type attribute, as well as a value: <productId type=ISBN>1234567890</productId>). In JSON requests and responses, attributes like this are preceded by an at-sign ("@"), and the product ID values are represented with a "__value__" name.

Here's an example of how to specify the product ID in JSON:

  "productId": {
    "@type":"ISBN" ,
    "__value__":"1234567890"
  } ,

Back to top

A Call Example

To put it all together, here is an example cancellation/search call that returns all the open cancellations associated with an account.

The Request

As covered above, combine an HTTP method, an endpoint, the HTTP headers, and a payload to create a call.

The Operation

The operation is the HTTP method plus a URI endpoint. The following example operation makes use of the Sandbox environment:

  GET https://api.sandbox.ebay.com/post-order/v2/cancellation/search

The Headers

The following headers (1) set JSON as the request and response payload formats (even though search has no request payload), (2) supply the authentication token needed to make the call, and (3) set EBAY_US as the marketplace:

Header Value
Authorization TOKEN <authorization-token-value>
X-EBAY-C-MARKETPLACE-ID EBAY_US
Content-Type application/json
Accept application/json

The Request Payload

The cancellation/search operation does not use a request payload.

The Response

The response payload from a successful cancellation/search request displays all the current cancellations associated with the account. A JSON response resembles the following:

{
    "cancellations": [
        {
            "cancelId": "5000018282",
            "marketplaceId": "EBAY_US",
            "legacyOrderId": "170007292461-9190794007",
            "requestorType": "SELLER",
            "cancelReason": "OUT_OF_STOCK_OR_CANNOT_FULFILL",
            "cancelState": "CLOSED",
            "cancelStatus": "CANCEL_CLOSED_WITH_REFUND",
            "cancelCloseReason": "FULL_REFUNDED",
            "paymentStatus": "UNKNOWN",
            "requestRefundAmount": {
                "value": 0,
                "currency": "USD"
            },
            "cancelRequestDate": {
                "value": "2015-05-18T22:42:11.000Z",
            },
            "cancelCloseDate": {
                "value": "2015-05-18T22:42:11.000Z",
            }
        },
        {
            "cancelId": "5000020253",
            "marketplaceId": "EBAY_US",
            "legacyOrderId": "170007591793-9351013007",
            "requestorType": "SELLER",
            "cancelReason": "OUT_OF_STOCK_OR_CANNOT_FULFILL",
            "cancelState": "CLOSED",
            "cancelStatus": "CANCEL_CLOSED_WITH_REFUND",
            "cancelCloseReason": "FULL_REFUNDED",
            "paymentStatus": "PAYPAL_PAID",
            "requestRefundAmount": {
                "value": 2.46,
                "currency": "USD"
            },
            "cancelRequestDate": {
                "value": "2015-06-13T00:32:09.000Z",
            },
            "cancelCloseDate": {
                "value": "2015-06-13T00:37:06.000Z",
            }
        }
    ],
    "total": 2,
    "paginationOutput": {
        "offset": 1,
        "limit": 6,
        "totalPages": 1,
        "totalEntries": 2
    }
}

 


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.