This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.

eBay Fulfillment APIVersion 1.2.0

Get an Order

GET /order/{orderId}

Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status.

The returned Order object contains information you can use to create and process fulfillments, including:

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/sell/fulfillment/v1/order/{orderId}

URI parameters

Parameter Type Required? Meaning
orderId string Required The unique identifier of the order. This value was returned by the getOrders call in the orders.orderId field; for example, 170009092860-9849164007!140000000544476.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

This request requires a user access token with the following scope:

https://api.ebay.com/oauth/api_scope/sell.fulfillment

https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly

See Getting Access Tokens for more information.



Payload model

This call has no request payload.


Output

See also Samples.

HTTP status codes

This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Status Meaning
200 Success
400 Bad Request
404 Not Found
500 Internal Server Error

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

{ /* Order */
"buyer":
    { /* Buyer */
    "username": string
    },
"buyerCheckoutNotes": string,
"cancelStatus":
    { /* CancelStatus */
    "cancelledDate": string,
    "cancelRequests": [
        { /* CancelRequest */
        "cancelCompletedDate": string,
        "cancelInitiator": string,
        "cancelReason": string,
        "cancelRequestedDate": string,
        "cancelRequestId": string,
        "cancelRequestState": string
        }
        /* More CancelRequest nodes here */
      ],
    "cancelState": string
    },
"creationDate": string,
"fulfillmentHrefs": [
    string
    /* More string nodes here */
  ],
"fulfillmentStartInstructions": [
    { /* FulfillmentStartInstruction */
    "ebaySupportedFulfillment": boolean,
    "finalDestinationAddress":
        { /* Address */
        "addressLine1": string,
        "addressLine2": string,
        "city": string,
        "countryCode": string,
        "county": string,
        "postalCode": string,
        "stateOrProvince": string
        },
    "fulfillmentInstructionsType": string,
    "maxEstimatedDeliveryDate": string,
    "minEstimatedDeliveryDate": string,
    "shippingStep":
        { /* ShippingStep */
        "shippingCarrierCode": string,
        "shippingServiceCode": string,
        "shipTo":
            { /* Contact */
            "companyName": string,
            "contactAddress":
                { /* Address */
                "addressLine1": string,
                "addressLine2": string,
                "city": string,
                "countryCode": string,
                "county": string,
                "postalCode": string,
                "stateOrProvince": string
                },
            "fullName": string,
            "primaryPhone":
                { /* PhoneNumber */
                "phoneNumber": string
                }
            }
        }
    }
    /* More FulfillmentStartInstruction nodes here */
  ],
"lastModifiedDate": string,
"lineItems": [
    { /* LineItem */
    "appliedPromotions": [
        { /* AppliedPromotion */
        "description": string,
        "discountAmount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            },
        "promotionId": string
        }
        /* More AppliedPromotion nodes here */
      ],
    "deliveryCost":
        { /* DeliveryCost */
        "importCharges":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            },
        "shippingCost":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            },
        "shippingIntermediationFee":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            }
        },
    "discountedLineItemCost":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "giftDetails":
        { /* GiftDetails */
        "message": string,
        "recipientEmail": string,
        "senderName": string
        },
    "legacyItemId": string,
    "legacyVariationId": string,
    "lineItemCost":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "lineItemFulfillmentInstructions":
        { /* LineItemFulfillmentInstructions */
        "guaranteedDelivery": boolean,
        "maxEstimatedDeliveryDate": string,
        "minEstimatedDeliveryDate": string,
        "shipByDate": string
        },
    "lineItemFulfillmentStatus": string,
    "lineItemId": string,
    "listingMarketplaceId": string,
    "properties":
        { /* LineItemProperties */
        "buyerProtection": boolean,
        "fromBestOffer": boolean
        },
    "purchaseMarketplaceId": string,
    "quantity": integer,
    "sku": string,
    "soldFormat": string,
    "taxes": [
        { /* Tax */
        "amount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            }
        }
        /* More Tax nodes here */
      ],
    "title": string,
    "total":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        }
    }
    /* More LineItem nodes here */
  ],
"orderFulfillmentStatus": string,
"orderId": string,
"orderPaymentStatus": string,
"paymentSummary":
    { /* PaymentSummary */
    "payments": [
        { /* Payment */
        "amount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            },
        "paymentDate": string,
        "paymentHolds": [
            { /* PaymentHold */
            "expectedReleaseDate": string,
            "holdAmount":
                { /* Amount */
                "convertedFromCurrency": string,
                "convertedFromValue": string,
                "currency": string,
                "value": string
                },
            "holdReason": string,
            "holdState": string,
            "releaseDate": string,
            "sellerActionsToRelease": [
                { /* SellerActionsToRelease */
                "sellerActionToRelease": string
                }
                /* More SellerActionsToRelease nodes here */
              ]
            }
            /* More PaymentHold nodes here */
          ],
        "paymentMethod": string,
        "paymentReferenceId": string,
        "paymentStatus": string
        }
        /* More Payment nodes here */
      ],
    "refunds": [
        { /* OrderRefund */
        "amount":
            { /* Amount */
            "convertedFromCurrency": string,
            "convertedFromValue": string,
            "currency": string,
            "value": string
            },
        "refundDate": string,
        "refundReferenceId": string,
        "refundStatus": string
        }
        /* More OrderRefund nodes here */
      ],
    "totalDueSeller":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        }
    },
"pricingSummary":
    { /* PricingSummary */
    "adjustment":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "deliveryCost":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "deliveryDiscount":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "fee":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "priceDiscountSubtotal":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "priceSubtotal":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "tax":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        },
    "total":
        { /* Amount */
        "convertedFromCurrency": string,
        "convertedFromValue": string,
        "currency": string,
        "value": string
        }
    },
"sellerId": string
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
buyer Buyer Always Contains information about the buyer who paid the order.
buyer.username string Always The buyer's eBay user name.
buyerCheckoutNotes string Conditionally Comments about the order (if any) provided by the buyer at checkout.
cancelStatus CancelStatus Always Contains information about a request (if any) that has been made to cancel the order.
cancelStatus.cancelledDate string Conditionally The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
cancelStatus.cancelRequests array of CancelRequest Always Contains the details of one or more buyer requests to cancel the order.

For the getOrders call: This array is returned but is always empty.
For the getOrder call: This array is returned fully populated with information about any cancellation requests.
cancelStatus.cancelRequests
  .cancelCompletedDate
string Conditionally The date and time that the order cancellation was completed, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
cancelStatus.cancelRequests
  .cancelInitiator
string Always The party who made the initial cancellation request.
cancelStatus.cancelRequests
  .cancelReason
string Always The reason why the cancelInitiator initiated the cancellation request.
cancelStatus.cancelRequests
  .cancelRequestedDate
string Always The date and time that the order cancellation was requested. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
cancelStatus.cancelRequests
  .cancelRequestId
string Always The unique identifier of the order cancellation request.
cancelStatus.cancelRequests
  .cancelRequestState
string Always The current stage or condition of the cancellation request.

Applicable values are from CancelRequestStateEnum:

COMPLETED
The buyer's cancellation request has been accepted and the order has been cancelled.
REJECTED
The buyer's request to cancel the order has been rejected.
REQUESTED
The buyer has requested that a particular order be cancelled.

Code so that your app gracefully handles any future changes to this list.
cancelStatus.cancelState string Always The state of the order with regard to cancellation.

Applicable values are from CancelStateEnum:

CANCELED
The order has been cancelled.
IN_PROGRESS
One or more cancellation requests have been made against the order.
NONE_REQUESTED
No cancellation requests have been made against the order.

Code so that your app gracefully handles any future changes to this list.
creationDate string Always The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
fulfillmentHrefs array of string Conditionally Contains a list of one or more hypertext references in the form of URLs. Each URL can be used to invoke the Get Shipping Fulfillment call to retrieve the details of each fulfillment, if any, that is associated with this order.
fulfillmentStartInstructions array of FulfillmentStartInstruction Always Contains a list of one or more sets of specifications for fulfilling the order. Each set specifies the type of fulfillment, shipping carrier and service, addressing details, and estimated delivery window. These instructions are derived from the buyer's and seller's eBay account preferences, the listing parameters, and the buyer's checkout selections. The seller can use them as a starting point for packaging, addressing, and shipping the order.
fulfillmentStartInstructions
  .ebaySupportedFulfillment
boolean Always A value of true indicates that the value of the fulfillmentInstructionsType field is SHIP_TO, and that the fulfillment will be shipped via eBay's Global Shipping Program.

For more information, see Managing Shipping.
fulfillmentStartInstructions
  .finalDestinationAddress
Address Conditionally Contains the final destination address of the shipment.

This address is returned only for Global Shipping Program shipments. Sellers should not ship directly to this address; instead they should ship this package to their international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address.

For more information, see Addressing a Global Shipping Program Shipment.
fulfillmentStartInstructions
  .finalDestinationAddress
  .addressLine1
string Always The first line of the street address.
fulfillmentStartInstructions
  .finalDestinationAddress
  .addressLine2
string Conditionally The second line of the street address. This field can be used for additional address information, such as a suite or apartment number.
fulfillmentStartInstructions
  .finalDestinationAddress.city
string Conditionally The city of the address.
fulfillmentStartInstructions
  .finalDestinationAddress
  .countryCode
string Always The country of the address, represented as two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany.

Applicable values are from CountryCodeEnum:See countryCode.
Code so that your app gracefully handles any future changes to this list.
fulfillmentStartInstructions
  .finalDestinationAddress
  .county
string Conditionally The county (not the country) in which the address is located. Counties typically, but not always, contain multiple cities or towns.
fulfillmentStartInstructions
  .finalDestinationAddress
  .postalCode
string Conditionally The postal code (if any) of the address.
fulfillmentStartInstructions
  .finalDestinationAddress
  .stateOrProvince
string Conditionally The state or province within the country in which the address resides.
fulfillmentStartInstructions
  .fulfillmentInstructionsType
string Always The method of fulfillment that will be used to deliver this set of line items to the buyer.

Applicable values are from FulfillmentInstructionsType:

DIGITAL
The seller will make these line items available to the buyer as digital content via email, download, or another means.
PREPARE_FOR_PICKUP
This value is reserved for internal or future use.
SELLER_DEFINED
The seller will determine how to deliver these line items to the buyer.
SHIP_TO
The seller will package and ship these line items to the buyer.

Code so that your app gracefully handles any future changes to this list.
fulfillmentStartInstructions
  .maxEstimatedDeliveryDate
string Conditionally NOT returned if the value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP, or if the order has promotional free shipping. This is the estimated latest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
fulfillmentStartInstructions
  .minEstimatedDeliveryDate
string Conditionally NOT returned if the value of the fulfillmentInstructionsType field is DIGITAL or PREPARE_FOR_PICKUP, or if the order has promotional free shipping. This is the estimated earliest date that the fulfillment will be completed. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
fulfillmentStartInstructions
  .shippingStep
ShippingStep Conditionally Returned only if the value of fulfillmentInstructionsType is SHIP_TO. Contains shipping information for this fulfillment, including the carrier, the service, and the shipment destination.
fulfillmentStartInstructions
  .shippingStep
  .shippingCarrierCode
string Always The code identifying the shipping carrier for this fulfillment.

Note: The Trading API's ShippingCarrierCodeType enumeration contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See ShippingCarrierCodeType.
fulfillmentStartInstructions
  .shippingStep
  .shippingServiceCode
string Always The eBay code identifying the shipping service used for this fulfillment.

Note: To get a complete list of available shipping services, applications should call the Trading API's GeteBayDetails call with a DetailName value of ShippingServiceDetails. To check for the shipping services available for a specific site, specify the site ID in the header. See also ShippingServiceCodeType.
fulfillmentStartInstructions
  .shippingStep.shipTo
Contact Always Contains information about the individual or organization to whom the fulfillment package will be shipped.

Note: For a Global Shipping Program shipment, this is the address of the international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address. For more information, see Addressing a Global Shipping Program Shipment.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .companyName
string Conditionally The contact's company name.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress
Address Always Contains the details of the contact's geographical address.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.addressLine1
string Always The first line of the street address.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.addressLine2
string Conditionally The second line of the street address. This field can be used for additional address information, such as a suite or apartment number.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.city
string Conditionally The city of the address.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.countryCode
string Always The country of the address, represented as two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany.

Applicable values are from CountryCodeEnum:See countryCode.
Code so that your app gracefully handles any future changes to this list.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.county
string Conditionally The county (not the country) in which the address is located. Counties typically, but not always, contain multiple cities or towns.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress.postalCode
string Conditionally The postal code (if any) of the address.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .contactAddress
  .stateOrProvince
string Conditionally The state or province within the country in which the address resides.
fulfillmentStartInstructions
  .shippingStep.shipTo.fullName
string Always The contact's full name.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .primaryPhone
PhoneNumber Conditionally Contains the contact's primary telephone number.
fulfillmentStartInstructions
  .shippingStep.shipTo
  .primaryPhone.phoneNumber
string Always The telephone number.
lastModifiedDate string Always The date and time that the order was last modified.This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
lineItems array of LineItem Always Contains the details of one or more line items that comprise the order. A line item consists of one or more units of a specific variation and version of a listed item that has been purchased.
lineItems.appliedPromotions array of AppliedPromotion Conditionally Contains information about one or more sales promotions or discounts applied to the line item.
lineItems.appliedPromotions
  .description
string Always A description of the applied promotion.
lineItems.appliedPromotions
  .discountAmount
Amount Always The monetary amount of the discount for the promotion.
lineItems.appliedPromotions
  .discountAmount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.appliedPromotions
  .discountAmount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.appliedPromotions
  .discountAmount.currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.appliedPromotions
  .discountAmount.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems.appliedPromotions
  .promotionId
string Always An eBay-generated identifier for the promotion. This is the value generated by the Marketing API's Create Item Promotion call and returned as the resource identifier of the location code that accompanies the HTTP 201 status code. It is also returned by the Trading API's SetPromotionalSale call and in the PromotionalSaleID field.
lineItems.deliveryCost DeliveryCost Always Contains a breakdown of all costs associated with the fulfillment of the line item.
lineItems.deliveryCost
  .importCharges
Amount Conditionally The amount of any import charges applied to international shipping of the line item.
lineItems.deliveryCost
  .importCharges
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .importCharges
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.deliveryCost
  .importCharges.currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .importCharges.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems.deliveryCost
  .shippingCost
Amount Conditionally The total cost of shipping all units of the line item.
lineItems.deliveryCost
  .shippingCost
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .shippingCost
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.deliveryCost
  .shippingCost.currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .shippingCost.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems.deliveryCost
  .shippingIntermediationFee
Amount Conditionally The amount of any fee charged by a provider of shipping intermediation for the line item.
lineItems.deliveryCost
  .shippingIntermediationFee
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .shippingIntermediationFee
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.deliveryCost
  .shippingIntermediationFee
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.deliveryCost
  .shippingIntermediationFee
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems
  .discountedLineItemCost
Amount Conditionally The cost of the line item after applying any discounts.
lineItems
  .discountedLineItemCost
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems
  .discountedLineItemCost
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems
  .discountedLineItemCost
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems
  .discountedLineItemCost.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems.giftDetails GiftDetails Conditionally Contains gift information about the line item. This container is returned only if the line item was purchased as a gift.
lineItems.giftDetails.message string Always A gift message from the buyer to the gift recipient.
lineItems.giftDetails
  .recipientEmail
string Always The email address of the gift recipient.
lineItems.giftDetails
  .senderName
string Always The name of the buyer to provide to the gift recipient.
lineItems.legacyItemId string Always The eBay-generated legacy listing item ID of the line item. This partially identifies the line item, but does not include the variation, version, or unit quantity.
lineItems.legacyVariationId string Conditionally An eBay-generated string that uniquely identifies the combination of item variations that apply to this line item.
lineItems.lineItemCost Amount Always The selling price of the line item before applying any discounts. The value of this field is calculated by multiplying the single unit price by the value of the quantity field.
lineItems.lineItemCost
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.lineItemCost
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.lineItemCost
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.lineItemCost.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems
  .lineItemFulfillmentInstructions
LineItemFulfillmentInstructions Always Contains the specifications for processing the fulfillment of the line item, including the handling and delivery timing in support of eBay Guaranteed Delivery. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery.
lineItems
  .lineItemFulfillmentInstructions
  .guaranteedDelivery
boolean Always A value of true indicates that the seller offered this line item with eBay Guaranteed Delivery, and the buyer purchased the line item with the Guaranteed Delivery option. Guaranteed Delivery is presented to the buyer for a given item listing based on the following criteria:
  • The item is of a type, size, weight, and location defined by the seller as eligible for eBay Guaranteed Delivery in a shipping rate table.
  • The seller is offering the item with eBay Guaranteed Delivery.
  • The buyer is located in a destination region that can be shipped to within the delivery window of at least one shipping service category (e.g. One-day, Expedited, Standard, or Economy) for which eBay Guaranteed Delivery is offered by the seller for the item.
Sellers who opt into handling time Guaranteed Delivery must complete handling for the line item before the time indicated by the shipByDate field. Sellers who opt into door-to-door Guaranteed Delivery must also ensure that the line item is delivered before the time specified by the maxEstimatedDeliveryDate field.
lineItems
  .lineItemFulfillmentInstructions
  .maxEstimatedDeliveryDate
string Always The estimated latest date and time that the buyer can expect to receive the line item. If the value of guaranteedDelivery is true, failure to deliver by this time will be counted in eBay Top Rated Seller calculations for sellers who opted into door-to-door Guaranteed Delivery.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
lineItems
  .lineItemFulfillmentInstructions
  .minEstimatedDeliveryDate
string Always The estimated earliest date and time that the buyer can expect to receive the line item.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
lineItems
  .lineItemFulfillmentInstructions
  .shipByDate
string Always The latest date and time by which this line item must be shipped. If the value of guaranteedDelivery is true, failure to ship by this time will be counted in eBay Top Rated Seller calculations for sellers who opted into handling time Guaranteed Delivery.

Note: This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
lineItems
  .lineItemFulfillmentStatus
string Always The degree to which fulfillment of the line item is complete.

Applicable values are from LineItemFulfillmentStatusEnum:

FULFILLED
The line item has been processed, packaged, and shipped.

Note: A line item is considered fulfilled as soon as any one unit or component of the line item is assigned to a fulfillment.
NOT_STARTED
The seller has not yet begun packaging the line item.

Code so that your app gracefully handles any future changes to this list.
lineItems.lineItemId string Always The globally unique eBay-generated identifier of the line item.

Note: A single line item can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller cannot distribute them among multiple shipping packages. Thus, each line item ID will appear in exactly one fulfillment.
lineItems.listingMarketplaceId string Always The eBay marketplace where the line item was listed.

Applicable values are from MarketplaceIdEnum:See listingMarketplaceId.
Code so that your app gracefully handles any future changes to this list.
lineItems.properties LineItemProperties Always Contains information about the eBay programs, if any, under which the line item was listed.
lineItems.properties
  .buyerProtection
boolean Always A value of true indicates that the line item is covered by eBay's Buyer Protection program.
lineItems.properties
  .fromBestOffer
boolean Always Note: This field is always returned, but its value is not currently reliable (always false). It will become significant in a future release.
lineItems
  .purchaseMarketplaceId
string Always The eBay marketplace where the line item was purchased.

Applicable values are from MarketplaceIdEnum:See purchaseMarketplaceId.
Code so that your app gracefully handles any future changes to this list.
lineItems.quantity integer Always The number of units of the line item in the order. These are represented as a group by a single lineItemId.
lineItems.sku string Conditionally Stock Keeping Unit. This is the seller's inventory reference identifier, which typically applies to a specific variation and version of the item.
lineItems.soldFormat string Always The eBay listing type of the line item.

Applicable values are from SoldFormatEnum:

AUCTION
Chinese auction listing, a single-quantity online auction format. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
FIXED_PRICE
A basic fixed-price listing format. Bids do not occur. The quantity of items is one or more. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores' fixed price items are treated as basic fixed-price items.
OTHER
Some other (unidentified) listing format.
SECOND_CHANCE_OFFER
Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. A seller can create a Second Chance Offer immediately after a listing ends and up to 60 days after the end of the listing.

Code so that your app gracefully handles any future changes to this list.
lineItems.taxes array of Tax Conditionally Contains a list of taxes applied to the line item, if any.
lineItems.taxes.amount Amount Always The monetary amount of the tax.
lineItems.taxes.amount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.taxes.amount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.taxes.amount
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.taxes.amount.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
lineItems.title string Always The seller's listing title for the line item.
lineItems.total Amount Always The net monetary amount of promotions, delivery costs, fees, combined unit prices, refunds, and taxes that apply to the line item.
lineItems.total
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
lineItems.total
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
lineItems.total.currency string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
lineItems.total.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
orderFulfillmentStatus string Always The degree to which fulfillment of the order is complete.

Applicable values are from OrderFulfillmentStatus:

FULFILLED
The entire order has been shipped.

Note: When any quantity of a line item is assigned to a fulfillment, that line item is marked as FULFILLED, even if the total quantity of the line item has not yet shipped.
IN_PROGRESS
Applies only to orders with more than one line item. Indicates the seller has begun packaging and shipping line items from the order, but not all line items have been shipped.
NOT_STARTED
The seller has not yet begun packaging any line items from the order.

Code so that your app gracefully handles any future changes to this list.
orderId string Always The unique identifier of the order. This value was originally generated by eBay as a result of the buyer's checkout process; for example, 170009092860-9849164007!140000000544476.

Note: The value of this field is not formatted the same way as the value of the Trading API's OrderId field. Do not attempt to use this field's value in the Trading API.
orderPaymentStatus string Always The current status of all monetary exchanges (payment by buyer and refund to buyer) for the order.

Applicable values are from OrderPaymentStatusEnum:See orderPaymentStatus.
Code so that your app gracefully handles any future changes to this list.
paymentSummary PaymentSummary Always Contains information about the various monetary exchanges for the order.
paymentSummary.payments array of Payment Conditionally Contains a list of payments made for the order, if any.
paymentSummary.payments.amount Amount Always The monetary amount of the order.
paymentSummary.payments.amount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.payments.amount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
paymentSummary.payments.amount
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.payments.amount
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
paymentSummary.payments
  .paymentDate
string Always The date and time that the payment was received by the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
paymentSummary.payments
  .paymentHolds
array of PaymentHold Conditionally Contains information about a hold (if any) placed on some or all of the payment, including the reason why the payment for the order is being held, the expected release date of the funds into the seller's account, the current state of the hold, and if the payment has been released, the actual release date. This container is returned only if a hold exists.
paymentSummary.payments
  .paymentHolds
  .expectedReleaseDate
string Always The date and time that the payment being held is expected to be released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
paymentSummary.payments
  .paymentHolds.holdAmount
Amount Always The monetary amount of the payment being held.
paymentSummary.payments
  .paymentHolds.holdAmount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.payments
  .paymentHolds.holdAmount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
paymentSummary.payments
  .paymentHolds.holdAmount
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.payments
  .paymentHolds.holdAmount.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
paymentSummary.payments
  .paymentHolds.holdReason
string Always The reason that the payment is being held.
paymentSummary.payments
  .paymentHolds.holdState
string Always The current stage or condition of the hold.

Applicable values:
  • HELD
  • HELD_PENDING
  • NOT_HELD
  • RELEASE_CONFIRMED
  • RELEASE_FAILED
  • RELEASE_PENDING
  • RELEASED
paymentSummary.payments
  .paymentHolds.releaseDate
string Conditionally The date and time that the payment being held was actually released to the seller. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
paymentSummary.payments
  .paymentHolds
  .sellerActionsToRelease
array of SellerActionsToRelease Always A list of actions the seller can take to release the hold on the payment.
paymentSummary.payments
  .paymentHolds
  .sellerActionsToRelease
  .sellerActionToRelease
string Always An action the seller can take to release the hold.
paymentSummary.payments
  .paymentMethod
string Always The method by which the payment was made.

Applicable values are from PaymentMethodTypeEnum:See paymentMethod.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.payments
  .paymentReferenceId
string Conditionally Returned only if the value of paymentMethod is PAYPAL. This field contains the PayPal-generated transaction identifier.
paymentSummary.payments
  .paymentStatus
string Always The degree of completion of the payment.

Applicable values are from PaymentStatusEnum:

FAILED
The payment has failed.
NOT_APPLICABLE
This value is reserved for internal or future use.
PAID
The payment is complete.
PENDING
The payment is in progress.

Code so that your app gracefully handles any future changes to this list.
paymentSummary.refunds array of OrderRefund Conditionally Contains a list of refunds issued for the order, if any. This does not include line item level refunds.
paymentSummary.refunds.amount Amount Always The monetary amount of the refund.
paymentSummary.refunds.amount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.refunds.amount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
paymentSummary.refunds.amount
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.refunds.amount
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
paymentSummary.refunds
  .refundDate
string Always The date and time that the refund was issued. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock.

Format: YYYY-MM-DDTHH:MM:SS.SSSZ
Example: 2015-08-04T19:09:02.768Z
paymentSummary.refunds
  .refundReferenceId
string Always The eBay-generated identifier for the refund
paymentSummary.refunds
  .refundStatus
string Always The degree of completion of a refund being made to the buyer.

Applicable values are from RefundStatusEnum:

FAILED
The refund process has been completed but was not successful.
PENDING
The refund has been initiated but not yet completed.
REFUNDED
The refund has been successfully completed.

Code so that your app gracefully handles any future changes to this list.
paymentSummary.totalDueSeller Amount Always The net monetary amount currently due to the seller for the order. This value changes as charges, payments, and refunds are applied.
paymentSummary.totalDueSeller
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.totalDueSeller
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
paymentSummary.totalDueSeller
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
paymentSummary.totalDueSeller
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary PricingSummary Always Contains a summary of costs and charges for the order, including price, adjustment, taxes, and shipping.
pricingSummary.adjustment Amount Conditionally The total amount of any adjustments that were applied to the order. This amount does not include shipping, discounts, fixed fees, or taxes.
pricingSummary.adjustment
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.adjustment
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.adjustment
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.adjustment
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary.deliveryCost Amount Always The total cost of delivering the order to the buyer, before any discount.
pricingSummary.deliveryCost
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.deliveryCost
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.deliveryCost
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.deliveryCost
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary
  .deliveryDiscount
Amount Conditionally The total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number. This value excludes buyer incentives.
pricingSummary
  .deliveryDiscount
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary
  .deliveryDiscount
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary
  .deliveryDiscount.currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary
  .deliveryDiscount.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary.fee Amount Conditionally The total amount of any fixed fees applied to the order, such as a recycling fee or a restocking fee.
pricingSummary.fee
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.fee
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.fee.currency string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.fee.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary
  .priceDiscountSubtotal
Amount Conditionally The total amount of all item price discounts (including promotions) that apply to the order and reduce its cost to the buyer. This should be a negative real number. This value excludes buyer incentives.
pricingSummary
  .priceDiscountSubtotal
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary
  .priceDiscountSubtotal
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary
  .priceDiscountSubtotal
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary
  .priceDiscountSubtotal.value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary.priceSubtotal Amount Always The total of the listed prices of all units of all line items in the order, before any discount.
pricingSummary.priceSubtotal
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.priceSubtotal
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.priceSubtotal
  .currency
string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.priceSubtotal
  .value
string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary.tax Amount Always The net amount of tax charged as a percentage of the order subtotal. Divide this value by the value of the subtotal field to confirm the approximate tax percentage applied.
pricingSummary.tax
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.tax
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.tax.currency string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.tax.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
pricingSummary.total Amount Always The total cost of the order, including all discounts, adjustments, fees, taxes, and delivery costs.
pricingSummary.total
  .convertedFromCurrency
string Conditionally A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Applicable values are from CurrencyCodeEnum:See convertedFromCurrency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.total
  .convertedFromValue
string Conditionally The monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.
pricingSummary.total.currency string Always A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Applicable values are from CurrencyCodeEnum:See currency.
Code so that your app gracefully handles any future changes to this list.
pricingSummary.total.value string Always The monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.
sellerId string Always The eBay ID of the seller who sold the order.



Error Codes

Code Domain Category Nature Meaning
30500 API_FULFILLMENT APPLICATION ERROR System error
32100 API_FULFILLMENT REQUEST ERROR Invalid order ID: {orderId}



Samples

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Get an Order

Retrieve the order specified by order ID.

Description

This sample retrieves a seller's order corresponding to the provided order ID.

Input

Use the orderid parameter to retrieve a specific order.

URL format. See also the non-wrapped version of this URL.

GET https://api.ebay.com/sell/fulfillment/v1/order/6498414015!260000000562911

Output

A successful call returns one Order container.

JSON format.
{
  "orderId": "6498414015!260000000562911",
  "creationDate": "2016-09-29T21:50:57.000Z",
  "lastModifiedDate": "2016-09-29T21:53:00.000Z",
  "orderFulfillmentStatus": "NOT_STARTED",
  "orderPaymentStatus": "PENDING",
  "sellerId": "ru_publicapi",
  "buyer": {
    "username": "rus_buyer"
  },
  "buyerCheckoutNotes": "Please show up!",
  "pricingSummary": {
    "priceSubtotal": {
      "value": "99.96",
      "currency": "USD"
    },
    "deliveryCost": {
      "value": "0.0",
      "currency": "USD"
    },
    "tax": {
      "value": "4.5",
      "currency": "USD"
    },
    "total": {
      "value": "94.46",
      "currency": "USD"
    }
  },
  "paymentSummary": {
    "totalDueSeller": {
      "value": "94.46",
      "currency": "USD"
    },
    "refunds": [],
    "payments": [
      {
        "paymentMethod": "PAYPAL",
        "amount": {
          "value": "94.46",
          "currency": "USD"
        },
        "paymentStatus": "PENDING",
        "paymentHolds": [
          {
            "holdReason": "NEW_SELLER",
            "holdAmount": {
              "value": "94.46",
              "currency": "USD"
            },
            "holdState": "HELD"
          }
        ]
      }
    ]
  },
  "fulfillmentStartInstructions": [
    {
      "fulfillmentInstructionsType": "SHIP_TO",
      "shippingStep": {
        "shipTo": {
          "fullName": "Dear friend",
          "contactAddress": {
            "addressLine1": "1395 Saratoga Ave Apt 101",
            "city": "San Jose",
            "stateOrProvince": "CA",
            "postalCode": "95129-4453",
            "countryCode": "US"
          },
          "primaryPhone": {
            "phoneNumber": "408 464 2712"
          }
        },
        "shippingServiceCode": "Promotional Shipping (varies)"
      }
    }
  ],
  "fulfillmentHrefs": [],
  "lineItems": [
    {
      "lineItemId": "5575863026",
      "legacyItemId": "350007451113",
      "title": "Hanes T-ShirtMaker Plus Deluxe S00703",
      "lineItemCost": {
        "value": "79.98",
        "currency": "USD"
      },
      "quantity": 2,
      "soldFormat": "FIXED_PRICE",
      "listingMarketplaceId": "EBAY_US",
      "purchaseMarketplaceId": "EBAY_US",
      "lineItemFulfillmentStatus": "NOT_STARTED",
      "total": {
        "value": "83.98",
        "currency": "USD"
      },
      "deliveryCost": {},
      "appliedPromotions": [
        {
          "discountAmount": {
            "value": "0.0",
            "currency": "USD"
          },
          "promotionCode": "5001614705",
          "description": "Free shipping on orders over $50"
        }
      ],
      "taxes": [
        {
          "amount": {
            "value": "4.0",
            "currency": "USD"
          }
        }
      ]
    },
    {
      "lineItemId": "5575864026",
      "legacyItemId": "350007396635",
      "legacyVariationId": "510002164224",
      "title": "Good Quality Shirt",
      "lineItemCost": {
        "value": "19.98",
        "currency": "USD"
      },
      "discountedLineItemCost": {
        "value": "9.98",
        "currency": "USD"
      },
      "quantity": 2,
      "soldFormat": "FIXED_PRICE",
      "listingMarketplaceId": "EBAY_US",
      "purchaseMarketplaceId": "EBAY_US",
      "lineItemFulfillmentStatus": "NOT_STARTED",
      "total": {
        "value": "10.48",
        "currency": "USD"
      },
      "deliveryCost": {},
      "appliedPromotions": [
        {
          "discountAmount": {
            "value": "10.0",
            "currency": "USD"
          },
          "promotionCode": "5001692805",
          "description": "Buy 1, get 1 free"
        },
        {
          "discountAmount": {
            "value": "0.0",
            "currency": "USD"
          },
          "promotionCode": "5001614705",
          "description": "Free shipping on orders over $50"
        }
      ],
      "taxes": [
        {
          "amount": {
            "value": "0.5",
            "currency": "USD"
          }
        }
      ]
    }
  ]
}



Change History

Change Date Description
1.2.0
2017-06-12
  • lineItemFulfillmentInstructions (added): Contains the specifications for processing the fulfillment of a line item, including the handling window and the delivery window. These fields provide guidance for eBay Guaranteed Delivery as well as for non-guaranteed delivery.
1.0.0
2016-10-19
  • Call (added): New call.