You are here: Buy APIs > Order API > Release Notes

Order API release notes

Just getting started with the Order API? See the following documents for details on using this API:

API releases

The following table lists the Order API releases:

Release Version

Release Date

Description of Release

v1_beta.6.0

2017-04-20

  • Response field changes.
  • Buying Integration changes.

v1_beta.6.0

2017-04-17

Documentation changes.

v1_beta.5.0 (03-13-17)

2017-03-13

Added an error.

v1_beta.4.0

2017-01-25

Changed the URL for all production Checkout calls

v1_beta.3.0

2017-01-11

Added error message 15026 to the Initiate Checkout Session calls

v1_beta.3.0

2016-11-17

Change in address validation process on EBAY_US site

v1_beta.1.0

2016-11-08

New Image Type, new response field and changes to responses fields

v1_beta.0.0

2016-10-19

Initial API beta release

 

v1_beta.6.0

Changes to response fields

The shippingCarrierName and shippingServiceName fields were renamed in the Order API. This affects all the calls in this API calls except, Place Order and Place Guest Order.

Important! These changes are backward incompatible.

The new release of the Buy API will be available in production on 4/20/2017. To give you more time to integrated with this change, the shippingCarrierName and shippingServiceName fields will be supported until 5/19/2017. After that date, they will removed from the interface.

The following tables compares the Order API call responses from the prior release (Previous) with this release (New). The bolded text in the table shows the fields that have been renamed.

Checkout calls response changes

The changes shown in the table below apply to all the Checkout calls except, Place Order and Place Guest Order.

Previous

New

Change

lineItems.shippingDetail.shippingCarrierName lineItems.shippingDetail.shippingCarrierCode Renamed
lineItems.shippingDetail.shippingServiceName lineItems.shippingDetail.shippingServiceCode Renamed

 

Get Guest Purchase Order call response changes

 

Previous

New

Change

lineItems.shippingDetail.shippingCarrierName lineItems.shippingDetail.shippingCarrierCode Renamed
lineItems.shippingDetail.shippingServiceName lineItems.shippingDetail.shippingServiceCode Renamed


Get Purchase Order call response changes

 

Previous

New

Change

lineItems.shippingDetail.shippingCarrierName lineItems.shippingDetail.shippingCarrierCode Renamed
lineItems.shippingDetail.shippingServiceName lineItems.shippingDetail.shippingServiceCode Renamed
shippingFulfillments.shippingCarrierName shippingFulfillments.shippingCarrierCode Renamed
shippingFulfillments.shippingServiceName shippingFulfillments.shippingServiceCode Renamed

 

Buying Integration Guide update

The following changes were made to the Buying Integration Guide:

  • The integration has been split into three chapters; Overview, Requirements, and Application Example
  • Added a Legacy API compatibility section to the Overview chapter.

v1_beta.5.0 (04-07-07)

Documentation update

In the Buying Integration Guide, the Buyer experience requirements section has been replaced with the Buying Integration Guide section.

v1_beta.5.0 (03-13-17)

Currently, the only marketplace supported is the US and items purchased can only be shipped to the US. This release adds the following error to catch when the X-EBAY-C-MARKETPLACE-ID header is not EBAY-US and/or when the shipping address is not US.

15027 API_ORDER BUSINESS ERROR - The value {fieldValue} is not supported for the {fieldName}. The supported values are: {supportedValues}.

Also the documentation has been updated to show these restrictions.

v1_beta.4.0

The URL for all Checkout calls in Production was changed. This change was made in order to meet security requirements for payments. It was changed:

From
     https://api.ebay.com/buy/order/v1

To
     https://apix.ebay.com/buy/order/v1

There was no change to the Sandbox URL, which is https://api.sandbox.ebay.com/buy/order/v1.

v1_beta.3.0

The following change has been made in this release.

Added an error message to checkout calls

The LINEITEM_NOT_SHIPPABLE_TO_SHIPPING_ADDRESS (15026) error message was added to the Initiate Checkout Session calls. This error occurs when an item being purchased is not shippable to the shipping address provided. For example, when the item can be shipped only within the US but the shipping address is in Germany.

v1_beta.2.0

The following change has been made in this release.

Changed the address validation process

There was a change made to the validation of an addresses on EBAY_US.

When eBay cannot validate the address, instead of getting an 15002 error, you will get a 15007 warning. If you receive this warning, now you can choose to either correct the address or proceed.

Note: Address fields are validated only on EBAY_US.

This change affects the Initiate Checkout Session, Update Payment Info, Update Shipping Address, Initiate Guest Checkout Session, Update Guest Payment Info, and Update Guest Line Item Shipping Address calls.

For example:

Initiate Checkout Session call response

Previous

New

{

  "errors": [
    {
      "errorId": 15002,
      "domain": "API_ORDER",
      "category": "REQUEST",
      "message": "Invalid field : shippingAddress. 
     The indicated field contains an invalid value. 
     Correct the value and resubmit the call.",
      "inputRefIds": [
        "$.shippingAddress"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "shippingAddress"
        }
      ]
    }
  ],
 }
{
  "checkoutSessionId": "v1|100008000669035|U3IuED_0Td6",
  "warnings": [
    {
      "errorId": 15007,
      "domain": "API_ORDER",
      "category": "REQUEST",
        "message": "The shippingAddress provided may be incorrect. 
		    You may proceed with this address
                   or provide a correct address.",
      "inputRefIds": [
        "$.shippingAddress"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "shippingAddress"
        }
      ]
    }
  ],
...
}

 

Update Payment Info call response

Previous

New

{
  
  "errors": [
    {
      "errorId": 15002,
      "domain": "API_ORDER",
      "category": "REQUEST",
       "message": "Invalid field : billingAddress. 
	  The indicated field contains an invalid value. 
	  Correct the value and resubmit the call.",
      "inputRefIds": [
        "$.billingAddress"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "billingAddress"
        }
      ]
    }
  ]
}   
{
  "checkoutSessionId": "v1|100008000669035|U3IuED_0Td6",
  "warnings": [
    {
      "errorId": 15007,
      "domain": "API_ORDER",
      "category": "REQUEST", 
        "message": "The billingAddress provided may be incorrect. 
		     You may proceed with this address
                    or provide a correct address.",     

      "inputRefIds": [
        "$.billingAddress"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "billingAddress"
        }
      ]
    }
  ]
...
}   

 

Update Shipping Address call response

Previous

New

{
  
  "errors": [
    {
      "errorId": 15002,
      "domain": "API_ORDER",
      "category": "REQUEST",
      "message": "Invalid field : shippingAddress. 
         The indicated field contains an invalid value. 
         Correct the value and resubmit the call.",
      "inputRefIds": [
        "$"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "shippingAddress"
        }
      ]
    }
  ]
}     
{
  "checkoutSessionId": "v1|100008000669035|U3IuED_0Td6",
  "warnings": [
    {
      "errorId": 15007,
      "domain": "API_ORDER",
      "category": "REQUEST",
      "message": "The shippingAddress provided may be incorrect. 
		    You may proceed with this address
                   or provide a correct address.",
      "inputRefIds": [
        "$"
      ],
      "parameters": [
        {
          "name": "fieldName",
          "value": "shippingAddress"
        }
      ]
    }
  ]
...
}     

 

v1_beta.1.0

The following changes have been made in this release:

Added type

The new type called Image was added. It replaces string as the data type for fields that return image URLs. Image has the following fields.

  • width – An integer representing the width of the image.
  • height – An integer representing the height of the image.
  • imageUrl – A string that is the URL of the image.

Note: Currently only the imageUrl field is getting populated. The height and width fields were added for future use.

Added fields

The following new response fields were added.

New Field Description Data Type
seller.sellerAccountTypes

Indicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries.

 

This field is returned only on the following sites.

EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, and EBAY_PL

 

Valid values:

  • BUSINESS
  • INDIVIDUAL
string
item.subtitle An additional shorten title for the item that is created by the seller. string

Removed or renamed response fields

Several response fields were deleted, renamed, or had their data type changed. These response fields are discussed in the table below:

Field Name Change Data type Change
lineItem.imageUrl Renamed to image Changed from string to image type
paymentMethodBrand.logoImageUrl Renamed to paymentMethodBrand.logoImage Changed from string to image type
seller.logoImageUrl Deleted  

v1_beta.0.0

This is the initial release of this API.

New calls

  • Checkout Session
    • Initiate Checkout Session
    • Get Checkout Session
    • Update Payment Info
    • Update Shipping Address
    • Update Shipping Option
    • Update Quantity for Line Item
    • Place Order
  • Purchase Order
    • Get Purchase Order
  • Guest Checkout Session
    • Initiate Guest Checkout Session
    • Get Guest Checkout Session
    • Update Guest Payment Info
    • Update Guest Shipping Address
    • Update Guest Shipping Option
    • Update Guest Quantity for Line Item
    • Place Guest Order
  • Guest Purchase Order
    • Get Guest Purchase Order