GET/order
Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN
to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days.
The returned Order objects contain information you can use to create and process fulfillments, including:
- Information about the buyer and seller
- Information about the order's line items
- The plans for packaging, addressing and shipping the order
- The status of payment, packaging, addressing, and shipping the order
- A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs
- A summary of applied taxes and fees, and optionally a breakdown of each
Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
URI parameters
Parameter | Type | Description |
---|---|---|
orderIds | array of string | A comma-separated list of the unique identifiers of the orders to retrieve (maximum 50). If one or more order ID values are specified through the orderIds query parameter, all other query parameters will be ignored. Note: getOrders can return orders up to two years old. Do not provide the orderId for an order created more than two years in the past. Occurrence: Optional |
filter | array of FilterField | One or more comma-separated criteria for narrowing down the collection of orders returned by this call. These criteria correspond to specific fields in the response payload. Multiple filter criteria combine to further restrict the results. Note: getOrders can return orders up to two years old. Do not set the creationdate filter to a date beyond two years in the past.Note: If the orderIds parameter is included in the request, the filter parameter will be ignored. The available criteria are as follows:
GET https://api.ebay.com/sell/v1/order? Note: This call requires that certain special characters in the URI query string be percent-encoded: [ = %5B ] = %5D { = %7B | = %7C } = %7D This query filter example uses these codes. Occurrence: Optional |
limit | string | The number of orders to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output. For example, if offset is set to 10 and limit is set to 10 , the call retrieves orders 11 thru 20 from the result set. If a limit is not set, the limit defaults to 50 and returns up to 50 orders. If a requested limit is more than 200, the call fails and returns an error. Note: This feature employs a zero-based list, where the first item in the list has an offset of 0 . If the orderIds parameter is included in the request, this parameter will be ignored. Maximum: 200 Default: 50 Occurrence: Optional |
offset | string | Specifies the number of orders to skip in the result set before returning the first order in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of Default: 0 Occurrence: Optional |
fieldGroups | array of string | This parameter lets you control what is returned in the response. Note: The only presently supported value is TAX_BREAKDOWN . This field group adds addition fields to the response that return a breakdown of taxes and fees. Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.fulfillment
https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
href | string | The URI of the getOrders call request that produced the current page of the result set. Occurrence: Always |
limit | integer | The maximum number of orders returned per page of the result set. The limit value can be passed in as a query parameter, or if omitted, its value defaults to Occurrence: Always |
next | string | The getOrders call URI to use if you wish to view the next page of the result set. For example, the following URI returns records 41 thru 50 from the collection of orders: Occurrence: Conditional |
offset | integer | The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Always |
orders | array of Order | This array contains one or more orders that are part of the current result set, that is controlled by the input criteria. The details of each order include information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status. Occurrence: Always |
orders.buyer | Buyer | This container consists of information about the order's buyer. At this time, only the buyer's eBay user ID is returned, but it's possible that more buyer information can be added to this container in the future. Occurrence: Always |
orders.buyer.buyerRegistrationAddress | ExtendedContact | Buyer's contact information that includes the buyer's name, email, phone number, and address. Occurrence: Always |
orders.buyer.buyerRegistrationAddress.companyName | string | The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.contactAddress | Address | This container shows the shipping address of the buyer or eBay shipping partner. Occurrence: Always |
orders.buyer.buyerRegistrationAddress.contactAddress.addressLine1 | string | The first line of the street address. Occurrence: Always |
orders.buyer.buyerRegistrationAddress.contactAddress.addressLine2 | string | The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.contactAddress.city | string | The city of the shipping destination. Occurrence: Always |
orders.buyer.buyerRegistrationAddress.contactAddress.countryCode | CountryCodeEnum | The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, Occurrence: Always |
orders.buyer.buyerRegistrationAddress.contactAddress.county | string | The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.contactAddress.postalCode | string | The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.contactAddress.stateOrProvince | string | The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.email | string | This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.fullName | string | The full name of the buyer or eBay shipping partner. Occurrence: Always |
orders.buyer.buyerRegistrationAddress.primaryPhone | PhoneNumber | The primary telephone number of the buyer or eBay shipping partner. Occurrence: Conditional |
orders.buyer.buyerRegistrationAddress.primaryPhone.phoneNumber | string | The primary telephone number for the shipping recipient. Occurrence: Always |
orders.buyer.taxAddress | TaxAddress | This container consists of address information that can be used by sellers for tax purpose. Occurrence: Always |
orders.buyer.taxAddress.city | string | The city name that can be used by sellers for tax purpose. Occurrence: Conditional |
orders.buyer.taxAddress.countryCode | CountryCodeEnum | The country code that can be used by sellers for tax purpose, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, US represents the United States, and DE represents Germany. Occurrence: Conditional |
orders.buyer.taxAddress.postalCode | string | The postal code that can be used by sellers for tax purpose. Usually referred to as Zip codes in the US. Occurrence: Conditional |
orders.buyer.taxAddress.stateOrProvince | string | The state name that can be used by sellers for tax purpose. Occurrence: Conditional |
orders.buyer.taxIdentifier | TaxIdentifier | This container consists of taxpayer identification information for buyers from Italy, Spain, or Guatemala. It is currently only returned for orders occurring on the eBay Italy or eBay Spain marketplaces. Occurrence: Conditional |
orders.buyer.taxIdentifier.taxpayerId | string | This value is the unique tax ID associated with the buyer. The type of tax identification is shown in the taxIdentifierType field. Occurrence: Conditional |
orders.buyer.taxIdentifier.taxIdentifierType | TaxIdentifierTypeEnum | This enumeration value indicates the type of tax identification being used for the buyer. The different tax types are defined in the TaxIdentifierTypeEnum type. Occurrence: Conditional |
orders.buyer.taxIdentifier.issuingCountry | CountryCodeEnum | This two-letter code indicates the country that issued the buyer's tax ID. The country that the two-letter code represents can be found in the CountryCodeEnum type, or in the ISO 3166 standard. Occurrence: Conditional |
orders.buyer.username | string | The buyer's eBay user ID. Occurrence: Always |
orders.buyerCheckoutNotes | string | This field contains any comments that the buyer left for the seller about the order during checkout process. This field is only returned if a buyer left comments at checkout time. Occurrence: Conditional |
orders.cancelStatus | CancelStatus | This container consists of order cancellation information if a cancel request has been made. This container is always returned, and if no cancel request has been made, the cancelState field is returned with a value of Occurrence: Always |
orders.cancelStatus.cancelledDate | string | 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. Occurrence: Conditional |
orders.cancelStatus.cancelRequests | array of CancelRequest | This array contains details of one or more buyer requests to cancel the order. Occurrence: Always |
orders.cancelStatus.cancelRequests.cancelCompletedDate | string | 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. This field is not returned until the cancellation request has actually been approved by the seller. Occurrence: Conditional |
orders.cancelStatus.cancelRequests.cancelInitiator | string | This string value indicates the party who made the initial cancellation request. Typically, either the 'Buyer' or 'Seller'. If a cancellation request has been made, this field should be returned. Occurrence: Conditional |
orders.cancelStatus.cancelRequests.cancelReason | string | The reason why the cancelInitiator initiated the cancellation request. Cancellation reasons for a buyer might include 'order placed by mistake' or 'order won't arrive in time'. For a seller, a typical cancellation reason is 'out of stock'. If a cancellation request has been made, this field should be returned. Occurrence: Conditional |
orders.cancelStatus.cancelRequests.cancelRequestedDate | string | 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. This field is returned for each cancellation request. Occurrence: Conditional |
orders.cancelStatus.cancelRequests.cancelRequestId | string | The unique identifier of the order cancellation request. This field is returned for each cancellation request. Occurrence: Conditional |
orders.cancelStatus.cancelRequests.cancelRequestState | CancelRequestStateEnum | The current stage or condition of the cancellation request. This field is returned for each cancellation request. Occurrence: Conditional |
orders.cancelStatus.cancelState | CancelStateEnum | The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of Occurrence: Always |
orders.creationDate | string | 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. Occurrence: Always |
orders.ebayCollectAndRemitTax | boolean | This field is only returned if Occurrence: Conditional |
orders.fulfillmentHrefs | array of string | This array contains a list of one or more getShippingFulfillment call URIs that can be used to retrieve shipping fulfillments that have been set up for the order. Occurrence: Conditional |
orders.fulfillmentStartInstructions | array of FulfillmentStartInstruction | This container consists of a set of specifications for fulfilling the order, including the type of fulfillment, shipping carrier and service, shipping address, 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. Occurrence: Always |
orders.fulfillmentStartInstructions.appointment | AppointmentDetails | This container provides information used by the installation provider concerning appointment details selected by the buyer. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.appointmentEndTime | string | The date and time the appointment ends, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Required for tire installation. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.appointmentStartTime | string | The date and time the appointment begins, formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.appointmentStatus | AppointmentStatusEnum | The status of the appointment. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.appointmentType | AppointmentTypeEnum | The type of appointment. MACRO appointments only have a start time (not bounded with end time). TIME_SLOT appointments have a period (both start time and end time). Required for tire installation. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.appointmentWindow | AppointmentWindowEnum | Appointment window for MACRO appointments. Occurrence: Conditional |
orders.fulfillmentStartInstructions.appointment.serviceProviderAppointmentDate | string | Service provider date of the appointment (no time stamp). Returned only for MACRO appointment types. Occurrence: Conditional |
orders.fulfillmentStartInstructions.destinationTimeZone | string | This field is reserved for internal or future use. Occurrence: Conditional |
orders.fulfillmentStartInstructions.ebaySupportedFulfillment | boolean | This field is only returned if its value is Occurrence: Conditional |
orders.fulfillmentStartInstructions.finalDestinationAddress | Address | This container is only returned if the value of ebaySupportedFulfillment field is Note: For Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer shipping address. Occurrence: Conditional |
orders.fulfillmentStartInstructions.finalDestinationAddress.addressLine1 | string | The first line of the street address. Occurrence: Always |
orders.fulfillmentStartInstructions.finalDestinationAddress.addressLine2 | string | The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address. Occurrence: Conditional |
orders.fulfillmentStartInstructions.finalDestinationAddress.city | string | The city of the shipping destination. Occurrence: Always |
orders.fulfillmentStartInstructions.finalDestinationAddress.countryCode | CountryCodeEnum | The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, Occurrence: Always |
orders.fulfillmentStartInstructions.finalDestinationAddress.county | string | The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available. Occurrence: Conditional |
orders.fulfillmentStartInstructions.finalDestinationAddress.postalCode | string | The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable. Occurrence: Conditional |
orders.fulfillmentStartInstructions.finalDestinationAddress.stateOrProvince | string | The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable. Occurrence: Conditional |
orders.fulfillmentStartInstructions.fulfillmentInstructionsType | FulfillmentInstructionsType | The enumeration value returned in this field indicates the method of fulfillment that will be used to deliver this set of line items (this package) to the buyer. This field will have a value of Occurrence: Always |
orders.fulfillmentStartInstructions.maxEstimatedDeliveryDate | string | 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. This field is not returned ifthe value of the fulfillmentInstructionsType field is Occurrence: Conditional |
orders.fulfillmentStartInstructions.minEstimatedDeliveryDate | string | 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. This field is not returned if the value of the fulfillmentInstructionsType field is Occurrence: Conditional |
orders.fulfillmentStartInstructions.pickupStep | PickupStep | This container is only returned for In-Store Pickup orders, and it indicates the specific merchant's store where the buyer will pick up the order. The In-Store Pickup feature is supported in the US, Canada, UK, Germany, and Australia marketplaces. Occurrence: Conditional |
orders.fulfillmentStartInstructions.pickupStep.merchantLocationKey | string | A merchant-defined unique identifier of the merchant's store where the buyer will pick up their In-Store Pickup order. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep | ShippingStep | This container consists of shipping information for this fulfillment, including the shipping carrier, the shipping service option, and the shipment destination. This container is not returned if the value of the fulfillmentInstructionsType field is Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shippingCarrierCode | string | The unique identifier of the shipping carrier being used to ship the line item. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shippingServiceCode | string | The unique identifier of the shipping service option being used to ship the line item. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo | ExtendedContact | This container consists of shipping and contact information about the individual or organization to whom the fulfillment package will be shipped. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.companyName | string | The company name associated with the buyer or eBay shipping partner. This field is only returned if defined/applicable to the buyer or eBay shipping partner. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress | Address | This container shows the shipping address of the buyer or eBay shipping partner. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine1 | string | The first line of the street address. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.addressLine2 | string | The second line of the street address. This field can be used for additional address information, such as a suite or apartment number. This field will be returned if defined for the shipping address. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.city | string | The city of the shipping destination. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.countryCode | CountryCodeEnum | The country of the shipping destination, represented as a two-letter ISO 3166-1 alpha-2 country code. For example, Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.county | string | The county of the shipping destination. Counties typically, but not always, contain multiple cities or towns. This field is returned if known/available. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.postalCode | string | The postal code of the shipping destination. Usually referred to as Zip codes in the US. Most countries have postal codes, but not all. The postal code will be returned if applicable. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.contactAddress.stateOrProvince | string | The state or province of the shipping destination. Most countries have states or provinces, but not all. The state or province will be returned if applicable. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.email | string | This field contains the email address of the buyer. This address will be returned for up to 14 days from order creation. If an order is more than 14 days old, no address is returned. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.fullName | string | The full name of the buyer or eBay shipping partner. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipTo.primaryPhone | PhoneNumber | The primary telephone number of the buyer or eBay shipping partner. Occurrence: Conditional |
orders.fulfillmentStartInstructions.shippingStep.shipTo.primaryPhone.phoneNumber | string | The primary telephone number for the shipping recipient. Occurrence: Always |
orders.fulfillmentStartInstructions.shippingStep.shipToReferenceId | string | This is the unique identifer of the Global Shipping Program (GSP) shipment. This field is only returned if the line item is being shipped via GSP (the value of the fulfillmentStartInstructions.ebaySupportedFulfillment field will be Occurrence: Conditional |
orders.lastModifiedDate | string | 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. Occurrence: Always |
orders.legacyOrderId | string | The unique identifier of the order in legacy format, as traditionally used by the Trading API (and other legacy APIs). Both the orderId field and this field are always returned. Occurrence: Always |
orders.lineItems | array of LineItem | This array contains the details for all line items that comprise the order. Occurrence: Always |
orders.lineItems.appliedPromotions | array of AppliedPromotion | This array contains information about one or more sales promotions or discounts applied to the line item. It is always returned, but will be returned as an empty array if no special sales promotions or discounts apply to the order line item. Occurrence: Always |
orders.lineItems.appliedPromotions.description | string | A description of the applied sales promotion. Occurrence: Conditional |
orders.lineItems.appliedPromotions.discountAmount | Amount | The monetary amount of the sales promotion. Occurrence: Conditional |
orders.lineItems.appliedPromotions.discountAmount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.appliedPromotions.discountAmount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.appliedPromotions.discountAmount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.appliedPromotions.discountAmount.value | string | 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. Occurrence: Always |
orders.lineItems.appliedPromotions.promotionId | string | An eBay-generated unique identifier of the sales promotion. Occurrence: Conditional |
orders.lineItems.deliveryCost | DeliveryCost | This container consists of a breakdown of all costs associated with the fulfillment of the line item. Occurrence: Always |
orders.lineItems.deliveryCost.discountAmount | Amount | The amount of any shipping discount that has been applied to the line item. This container is returned only if a shipping discount applies to the line item. Occurrence: Conditional |
orders.lineItems.deliveryCost.handlingCost | Amount | The amount of any handing cost that has been applied to the line item. This container is returned only if a handling cost applies to the line item. Occurrence: Conditional |
orders.lineItems.deliveryCost.importCharges | Amount | The amount of any import charges applied to international shipping of the line item. This container is only returned if import charges apply to the line item. Occurrence: Conditional |
orders.lineItems.deliveryCost.importCharges.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.importCharges.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.importCharges.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.deliveryCost.importCharges.value | string | 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. Occurrence: Always |
orders.lineItems.deliveryCost.shippingCost | Amount | The total cost of shipping all units of the line item. This container is always returned even when the shipping cost is free, in which case the value field will show Occurrence: Always |
orders.lineItems.deliveryCost.shippingCost.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.shippingCost.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.shippingCost.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.deliveryCost.shippingCost.value | string | 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. Occurrence: Always |
orders.lineItems.deliveryCost.shippingIntermediationFee | Amount | This field shows the fee due to eBay's international shipping provider for a line item that is being shipped through the Global Shipping Program. Occurrence: Conditional |
orders.lineItems.deliveryCost.shippingIntermediationFee.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.shippingIntermediationFee.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.deliveryCost.shippingIntermediationFee.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.deliveryCost.shippingIntermediationFee.value | string | 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. Occurrence: Always |
orders.lineItems.discountedLineItemCost | Amount | The cost of the line item after applying any discounts. This container is only returned if the order line item was discounted through a promotion. Occurrence: Conditional |
orders.lineItems.discountedLineItemCost.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.discountedLineItemCost.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.discountedLineItemCost.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.discountedLineItemCost.value | string | 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. Occurrence: Always |
orders.lineItems.ebayCollectAndRemitTaxes | array of EbayCollectAndRemitTax | This container will be returned if the order line item is subject to a 'Collect and Remit' tax that eBay will collect and remit to the proper taxing authority on the buyer's behalf.
eBay will display the tax type and amount during checkout in accordance with the buyer's address, and handle collection and remittance of the tax without requiring the seller to take any action. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.amount | Amount | The monetary amount of the 'Collect and Remit' tax. This currently includes:
Note: If the corresponding taxType is STATE_SALES_TAX , PROVINCE_SALES_TAX , GST , VAT , or SST and the lineItems.taxes container also appears for this line item with the same tax amount, the order is subject to 'eBay Collect and Remit' tax. For orders that are subject to 'eBay Collect and Remit' tax, the tax amount in this field will be included in the lineItems.total, paymentSummary.payments.amount, paymentSummary.totalDueSeller, and pricingSummary.total fields. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.amount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.amount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.amount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.ebayCollectAndRemitTaxes.amount.value | string | 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. Occurrence: Always |
orders.lineItems.ebayCollectAndRemitTaxes.ebayReference | EbayTaxReference | This container field describes the line-item level VAT tax details. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.ebayReference.name | string | This field value is returned to indicate the VAT tax type, which will vary by country/region. This string value will be one of the following:
Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.ebayReference.value | string | The value returned in this field is the VAT identifier number (VATIN), which will vary by country/region. This field will be returned if VAT tax is applicable for the order. The name field indicates the VAT tax type, which will vary by country/region:
Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.taxType | TaxTypeEnum | The type of tax and fees that eBay will collect and remit to the taxing or fee authority. See the TaxTypeEnum type definition for more information about each tax or fee type. Occurrence: Conditional |
orders.lineItems.ebayCollectAndRemitTaxes.collectionMethod | CollectionMethodEnum | This field indicates the collection method used to collect the 'Collect and Remit' tax for the order. This field is always returned for orders subject to 'Collect and Remit' tax, and its value is always Occurrence: Conditional |
orders.lineItems.ebayCollectedCharges | EbayCollectedCharges | This container consists of a breakdown of costs that are collected by eBay from the buyer for this order. Occurrence: Conditional |
orders.lineItems.ebayCollectedCharges.ebayShipping | Amount | This container consists of costs related to eBay Shipping collected by eBay from the buyer of this order. Occurrence: Conditional |
orders.lineItems.ebayCollectedCharges.ebayShipping.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.ebayCollectedCharges.ebayShipping.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.ebayCollectedCharges.ebayShipping.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.ebayCollectedCharges.ebayShipping.value | string | 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. Occurrence: Always |
orders.lineItems.giftDetails | GiftDetails | This container consists of information that is needed by the seller to send a digital gift card to the buyer, or recipient of the digital gift card. This container is only returned and applicable for digital gift card line items. Occurrence: Conditional |
orders.lineItems.giftDetails.message | string | This field contains the gift message from the buyer to the gift recipient. This field is only returned if the buyer of the gift included a message for the gift. Occurrence: Conditional |
orders.lineItems.giftDetails.recipientEmail | string | The email address of the gift recipient. The seller will send the digital gift card to this email address. Occurrence: Conditional |
orders.lineItems.giftDetails.senderName | string | The name of the buyer, which will appear on the email that is sent to the gift recipient. Occurrence: Conditional |
orders.lineItems.itemLocation | ItemLocation | This container field describes the physical location of the order line item. Occurrence: Conditional |
orders.lineItems.itemLocation.countryCode | CountryCodeEnum | The two-letter ISO 3166 code representing the country of the address. Occurrence: Conditional |
orders.lineItems.itemLocation.location | string | Indicates the geographical location of the item (along with the value in the countryCode field). This field provides city, province, state, or similar information. Occurrence: Conditional |
orders.lineItems.itemLocation.postalCode | string | The postal code of the address. Occurrence: Conditional |
orders.lineItems.legacyItemId | string | The eBay-generated legacy listing item ID of the listing. Note that the unique identifier of a listing in REST-based APIs is called the listingId instead. Occurrence: Always |
orders.lineItems.legacyVariationId | string | The unique identifier of a single variation within a multiple-variation listing. This field is only returned if the line item purchased was from a multiple-variation listing. Occurrence: Conditional |
orders.lineItems.lineItemCost | Amount | 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 number of units purchased (value of the quantity field). Occurrence: Always |
orders.lineItems.lineItemCost.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.lineItemCost.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.lineItemCost.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.lineItemCost.value | string | 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. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions | LineItemFulfillmentInstructions | This container consists of information related to shipping dates and expectations, including the 'ship-by date' and expected delivery windows that are based on the seller's stated handling time and the shipping service option that will be used. These fields provide guidance on making sure expected delivery dates are made, whether the order is a eBay Guaranteed Delivery order or a non-guaranteed delivery order. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions.destinationTimeZone | string | This field is reserved for internal or future use. Occurrence: Conditional |
orders.lineItems.lineItemFulfillmentInstructions.guaranteedDelivery | boolean | Although this field is still returned, it can be ignored since eBay Guaranteed Delivery is no longer a supported feature on any marketplace. This field may get removed from the schema in the future. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions.maxEstimatedDeliveryDate | string | The estimated latest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. The seller must pay extra attention to this date, as a failure to deliver by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions.minEstimatedDeliveryDate | string | The estimated earliest date and time that the buyer can expect to receive the line item based on the seller's stated handling time and the transit times of the available shipping service options. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions.shipByDate | string | The latest date and time by which the seller should ship line item in order to meet the expected delivery window. This timestamp will be set by eBay based on time of purchase and the seller's stated handling time. The seller must pay extra attention to this date, as a failure to physically ship the line item by this date/time can result in a 'Late shipment' seller defect, and can affect seller level and Top-Rated Seller status. In addition to the seller defect, buyers will be eligible for a shipping cost refund, and will also be eligible to return the item for a full refund (with no return shipping charge) if they choose. Occurrence: Always |
orders.lineItems.lineItemFulfillmentInstructions.sourceTimeZone | string | This field is reserved for internal or future use. Occurrence: Conditional |
orders.lineItems.lineItemFulfillmentStatus | LineItemFulfillmentStatusEnum | This enumeration value indicates the current fulfillment status of the line item. Occurrence: Always |
orders.lineItems.lineItemId | string | This is the unique identifier of an eBay order line item. This field is created as soon as there is a commitment to buy from the seller. Occurrence: Always |
orders.lineItems.linkedOrderLineItems | array of LinkedOrderLineItem | An array of one or more line items related to the corresponding order, but not a part of that order. Details include the order ID, line item ID, and title of the linked line item, the seller of that item, item specifics, estimated delivery times, and shipment tracking (if available). Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.lineItemAspects | array of NameValuePair | This array contains the complete set of items aspects for the linked line item. For example: "lineItemAspects": [Note: All item specifics for the listing are returned. The name/value pairs returned are in the language of the linked line item's listing site, which may vary from the seller's language. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.lineItemAspects.name | string | The text representing the name of the aspect for the name-value pair. For example, Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.lineItemAspects.value | string | The value of the aspect for the name-value pair. For example, Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.lineItemId | string | The unique identifier of the linked order line item. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.maxEstimatedDeliveryDate | string | The end of the date range in which the linked line item is expected to be delivered to the shipping address. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.minEstimatedDeliveryDate | string | The beginning of the date range in which the linked line item is expected to be delivered to the shipping address. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.orderId | string | The unique identifier of the order to which the linked line item belongs. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.sellerId | string | The eBay user ID of the seller who sold the linked line item. For example, the user ID of the tire seller. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.shipments | array of TrackingInfo | An array containing any shipment tracking information available for the linked line item. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.shipments.shipmentTrackingNumber | string | This string value represents the shipment tracking number of the package. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.shipments.shippingCarrierCode | string | This string value represents the shipping carrier used to ship the package. Occurrence: Conditional |
orders.lineItems.linkedOrderLineItems.title | string | The listing title of the linked line item. Occurrence: Conditional |
orders.lineItems.listingMarketplaceId | MarketplaceIdEnum | The unique identifier of the eBay marketplace where the line item was listed. Occurrence: Always |
orders.lineItems.properties | LineItemProperties | Contains information about the eBay programs, if any, under which the line item was listed. Occurrence: Always |
orders.lineItems.properties.buyerProtection | boolean | A value of Occurrence: Always |
orders.lineItems.properties.fromBestOffer | boolean | This field is only returned if Occurrence: Conditional |
orders.lineItems.properties.soldViaAdCampaign | boolean | This field is only returned if Occurrence: Conditional |
orders.lineItems.purchaseMarketplaceId | MarketplaceIdEnum | The unique identifier of the eBay marketplace where the line item was listed. Often, the listingMarketplaceId and the purchaseMarketplaceId identifier are the same, but there are occasions when an item will surface on multiple eBay marketplaces. Occurrence: Always |
orders.lineItems.quantity | integer | The number of units of the line item in the order. These are represented as a group by a single lineItemId. Occurrence: Always |
orders.lineItems.refunds | array of LineItemRefund | This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund. Occurrence: Always |
orders.lineItems.refunds.amount | Amount | This field shows the refund amount for a line item. This field is only returned if the buyer is due a refund for the line item. Occurrence: Conditional |
orders.lineItems.refunds.amount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.refunds.amount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.refunds.amount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.refunds.amount.value | string | 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. Occurrence: Always |
orders.lineItems.refunds.refundDate | string | The date and time that the refund was issued for the line item. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field is not returned until the refund has been issued. Occurrence: Conditional |
orders.lineItems.refunds.refundId | string | Unique identifier of a refund that was initiated for an order's line item through the issueRefund method. If the issueRefund method was used to issue a refund at the order level, this identifier is returned at the order level instead (paymentSummary.refunds.refundId field). Occurrence: Conditional |
orders.lineItems.refunds.refundReferenceId | string | This field is reserved for internal or future use. Occurrence: Conditional |
orders.lineItems.sku | string | Seller-defined Stock-Keeping Unit (SKU). This inventory identifier must be unique within the seller's eBay inventory. SKUs are optional when listing in the legacy/Trading API system, but SKUs are required when listing items through the Inventory API model. Occurrence: Conditional |
orders.lineItems.soldFormat | SoldFormatEnum | The eBay listing type of the line item. The most common listing types are Occurrence: Always |
orders.lineItems.taxes | array of Tax | Contains a list of taxes applied to the line item, if any. This array is always returned, but will be returned as empty if no taxes are applicable to the line item. Occurrence: Always |
orders.lineItems.taxes.amount | Amount | The monetary amount of the tax. The taxes array is always returned for each line item in the order, but this amount will only be returned when the line item is subject to any type of sales tax. Occurrence: Conditional |
orders.lineItems.taxes.amount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.taxes.amount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.taxes.amount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.taxes.amount.value | string | 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. Occurrence: Always |
orders.lineItems.taxes.taxType | TaxTypeEnum | Tax type. This field is only available when fieldGroups is set to Occurrence: Conditional |
orders.lineItems.title | string | The title of the listing. Occurrence: Always |
orders.lineItems.total | Amount | This is the total price that the buyer must pay for the line item after all costs (item cost, delivery cost, taxes,) are added, minus any discounts and/or promotions. Occurrence: Always |
orders.lineItems.total.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.lineItems.total.convertedFromValue | string | 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. Occurrence: Conditional |
orders.lineItems.total.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.lineItems.total.value | string | 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. Occurrence: Always |
orders.lineItems.variationAspects | array of NameValuePair | An array of aspect name-value pairs that identifies the specific variation of a multi-variation listing. This array can contain multiple name-value pairs, such as Occurrence: Conditional |
orders.lineItems.variationAspects.name | string | The text representing the name of the aspect for the name-value pair. For example, Occurrence: Conditional |
orders.lineItems.variationAspects.value | string | The value of the aspect for the name-value pair. For example, Occurrence: Conditional |
orders.orderFulfillmentStatus | OrderFulfillmentStatus | The degree to which fulfillment of the order is complete. See the OrderFulfillmentStatus type definition for more information about each possible fulfillment state. Occurrence: Always |
orders.orderId | string | The unique identifier of the order. Both the legacyOrderId field (traditionally used by Trading and other legacy APIS) and this field are always returned. Occurrence: Always |
orders.orderPaymentStatus | OrderPaymentStatusEnum | The enumeration value returned in this field indicates the current payment status of an order, or in case of a refund request, the current status of the refund. See the OrderPaymentStatusEnum type definition for more information about each possible payment/refund state. Occurrence: Always |
orders.paymentSummary | PaymentSummary | This container consists of detailed payment information for the order, including buyer payment for the order, refund information (if applicable), and seller payment holds (if applicable). Occurrence: Always |
orders.paymentSummary.payments | array of Payment | This array consists of payment information for the order, including payment status, payment method, payment amount, and payment date. This array is always returned, although some of the fields under this container will not be returned until payment has been made. Occurrence: Always |
orders.paymentSummary.payments.amount | Amount | The amount that seller receives for the order via the payment method mentioned in Payment.paymentMethod. Occurrence: Always |
orders.paymentSummary.payments.amount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.paymentSummary.payments.amount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.paymentSummary.payments.amount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.paymentSummary.payments.amount.value | string | 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. Occurrence: Always |
orders.paymentSummary.payments.paymentDate | string | The date and time that the payment was received by the seller. This field will not be returned if buyer has yet to pay for the order. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds | array of PaymentHold | This container is only returned if eBay is temporarily holding the seller's funds for the order. If a payment hold has been placed on the order, this container includes the reason for the payment hold, the expected release date of the funds into the seller's account, the current state of the hold, and as soon as the payment hold has been released, the actual release date. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.expectedReleaseDate | string | 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. This field will be returned if known by eBay. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.holdAmount | Amount | The monetary amount of the payment being held. This field is always returned with the paymentHolds array. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.holdAmount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.holdAmount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.holdAmount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.paymentSummary.payments.paymentHolds.holdAmount.value | string | 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. Occurrence: Always |
orders.paymentSummary.payments.paymentHolds.holdReason | string | The reason that the payment is being held. A seller's payment may be held for a number of reasons, including when the seller is new, the seller's level is below standard, or if a return case or 'Significantly not as described' case is pending against the seller. This field is always returned with the paymentHolds array. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.holdState | string | The current stage or condition of the hold. This field is always returned with the paymentHolds array.
Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.releaseDate | string | 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. This field is not returned until the seller's payment is actually released into the seller's account. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.sellerActionsToRelease | array of SellerActionsToRelease | A list of one or more possible actions that the seller can take to expedite the release of the payment hold. Occurrence: Conditional |
orders.paymentSummary.payments.paymentHolds.sellerActionsToRelease.sellerActionToRelease | string | A possible action that the seller can take to expedite the release of a payment hold. A sellerActionToRelease field is returned for each possible action that a seller may take. Possible actions may include providing shipping/tracking information, issuing a refund, providing refund information, contacting customer support, etc. Occurrence: Conditional |
orders.paymentSummary.payments.paymentMethod | PaymentMethodTypeEnum | The payment method used to pay for the order. See the PaymentMethodTypeEnum type for more information on the payment methods. Occurrence: Always |
orders.paymentSummary.payments.paymentReferenceId | string | This field is only returned if payment has been made by the buyer, and the paymentMethod is Occurrence: Conditional |
orders.paymentSummary.payments.paymentStatus | PaymentStatusEnum | The enumeration value returned in this field indicates the status of the payment for the order. See the PaymentStatusEnum type definition for more information on the possible payment states. Occurrence: Always |
orders.paymentSummary.refunds | array of OrderRefund | This array is always returned, but is returned as an empty array unless the seller has submitted a partial or full refund to the buyer for the order. If a refund has occurred, the refund amount and refund date will be shown for each refund. Occurrence: Always |
orders.paymentSummary.refunds.amount | Amount | This field shows the refund amount for an order. This container is always returned for each refund. Occurrence: Conditional |
orders.paymentSummary.refunds.amount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.paymentSummary.refunds.amount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.paymentSummary.refunds.amount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.paymentSummary.refunds.amount.value | string | 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. Occurrence: Always |
orders.paymentSummary.refunds.refundDate | string | 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. This field is not returned until the refund has been issued. Occurrence: Conditional |
orders.paymentSummary.refunds.refundId | string | Unique identifier of a refund that was initiated for an order through the issueRefund method. If the issueRefund method was used to issue one or more refunds at the line item level, these refund identifiers are returned at the line item level instead (lineItems.refunds.refundId field). Occurrence: Conditional |
orders.paymentSummary.refunds.refundReferenceId | string | The eBay-generated unique identifier for the refund. This field is not returned until the refund has been issued. Occurrence: Conditional |
orders.paymentSummary.refunds.refundStatus | RefundStatusEnum | This enumeration value indicates the current status of the refund to the buyer. This container is always returned for each refund. Occurrence: Conditional |
orders.paymentSummary.totalDueSeller | Amount | This is the total price that the seller receives for the entire order after all costs (item cost, delivery cost, taxes) are added for all line items, minus any discounts and/or promotions for any of the line items. Note that this value is subject to change before payment is actually made by the buyer (if the paymentStatus value was Occurrence: Always |
orders.paymentSummary.totalDueSeller.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.paymentSummary.totalDueSeller.convertedFromValue | string | 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. Occurrence: Conditional |
orders.paymentSummary.totalDueSeller.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.paymentSummary.totalDueSeller.value | string | 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. Occurrence: Always |
orders.pricingSummary | PricingSummary | This container consists of a summary of cumulative costs and charges for all line items of an order, including item price, price adjustments, sales taxes, delivery costs, and order discounts. Occurrence: Always |
orders.pricingSummary.adjustment | Amount | This container shows the total amount of any adjustments that were applied to the cost of the item(s) in the order. This amount does not include shipping, discounts, fixed fees, or taxes. Occurrence: Conditional |
orders.pricingSummary.adjustment.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.adjustment.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.adjustment.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.adjustment.value | string | 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. Occurrence: Always |
orders.pricingSummary.deliveryCost | Amount | This container shows the total cost of delivering the order to the buyer, before any shipping/delivery discount is applied. Occurrence: Always |
orders.pricingSummary.deliveryCost.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.deliveryCost.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.deliveryCost.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.deliveryCost.value | string | 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. Occurrence: Always |
orders.pricingSummary.deliveryDiscount | Amount | This container shows the total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number. Occurrence: Conditional |
orders.pricingSummary.deliveryDiscount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.deliveryDiscount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.deliveryDiscount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.deliveryDiscount.value | string | 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. Occurrence: Always |
orders.pricingSummary.fee | Amount | This container shows the total amount of any special fees applied to the order, such as a tire recycling fee or an electronic waste fee. Occurrence: Conditional |
orders.pricingSummary.fee.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.fee.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.fee.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.fee.value | string | 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. Occurrence: Always |
orders.pricingSummary.priceDiscount | Amount | This container shows 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. Occurrence: Conditional |
orders.pricingSummary.priceDiscount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.priceDiscount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.priceDiscount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.priceDiscount.value | string | 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. Occurrence: Always |
orders.pricingSummary.priceSubtotal | Amount | This container shows the cumulative costs of of all units of all line items in the order, before any discount is applied. Occurrence: Always |
orders.pricingSummary.priceSubtotal.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.priceSubtotal.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.priceSubtotal.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.priceSubtotal.value | string | 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. Occurrence: Always |
orders.pricingSummary.tax | Amount | This container shows the total amount of tax for the order. To calculate the tax percentage rate, divide this value by the value of the total field. Occurrence: Conditional |
orders.pricingSummary.tax.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.tax.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.tax.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.tax.value | string | 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. Occurrence: Always |
orders.pricingSummary.total | Amount | The total cost of the order after adding all line item costs, delivery costs, sales tax, and special fees, and then subtracting all special discounts and price adjustments. Occurrence: Always |
orders.pricingSummary.total.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.pricingSummary.total.convertedFromValue | string | 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. Occurrence: Conditional |
orders.pricingSummary.total.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.pricingSummary.total.value | string | 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. Occurrence: Always |
orders.program | Program | This container is returned for orders that are eligible for eBay's Authenticity Guarantee service. The seller ships Authenticity Guarantee service items to the authentication partner instead of the buyer. The authenticator address is found in the Occurrence: Conditional |
orders.program.authenticityVerification | PostSaleAuthenticationProgram | This field is returned when the third-party authenticator performs the authentication verification inspection on the order line item. Different values will be returned based on whether the item passed or failed the authentication verification inspection. Occurrence: Conditional |
orders.program.authenticityVerification.outcomeReason | AuthenticityVerificationReasonEnum | This field indicates the result of the authenticity verification inspection on an order line item. This field is not returned when the status value of the order line item is Occurrence: Conditional |
orders.program.authenticityVerification.status | AuthenticityVerificationStatusEnum | The value in this field indicates whether the order line item has passed or failed the authenticity verification inspection, or if the inspection and/or results are still pending. The possible values returned here are Occurrence: Conditional |
orders.program.ebayShipping | EbayShipping | This container is returned only if the order is an eBay shipping order. It consists of a field that indicates the provider of a shipping label for this order. Occurrence: Conditional |
orders.program.ebayShipping.shippingLabelProvidedBy | string | This field contains the shipping label provider. If Occurrence: Conditional |
orders.program.ebayVault | EbayVaultProgram | This field provides information about the eBay vault program that has been selected for an order. This is returned only for those items that are eligible for the eBay Vault Program. Occurrence: Conditional |
orders.program.ebayVault.fulfillmentType | EbayVaultFulfillmentTypeEnum | This field specifies how an eBay vault order will be fulfilled. Supported options are:
Occurrence: Conditional |
orders.program.ebayInternationalShipping | EbayInternationalShipping | This container is returned if the order is being fulfilled through eBay International Shipping. Occurrence: Conditional |
orders.program.ebayInternationalShipping.returnsManagedBy | string | The value returned in this field indicates the party that is responsible for managing returns of the order line item. Occurrence: Conditional |
orders.program.fulfillmentProgram | EbayFulfillmentProgram | This field provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner. Occurrence: Conditional |
orders.program.fulfillmentProgram.fulfilledBy | string | The value returned in this field indicates the party that is handling fulfillment of the order line item. Occurrence: Conditional |
orders.salesRecordReference | string | An eBay-generated identifier that is used to identify and manage orders through the Selling Manager and Selling Manager Pro tools. This order identifier can also be found on the Orders grid page and in the Sales Record pages in Seller Hub. A salesRecordReference number is only generated and returned at the order level, and not at the order line item level. Occurrence: Conditional |
orders.sellerId | string | The unique eBay user ID of the seller who sold the order. Occurrence: Always |
orders.totalFeeBasisAmount | Amount | This is the cumulative base amount used to calculate the final value fees for each order. The final value fees are deducted from the seller payout associated with the order. Final value fees are calculated as a percentage of order cost (item cost + shipping cost) and the percentage rate can vary by eBay category. Occurrence: Always |
orders.totalFeeBasisAmount.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.totalFeeBasisAmount.convertedFromValue | string | 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. Occurrence: Conditional |
orders.totalFeeBasisAmount.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.totalFeeBasisAmount.value | string | 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. Occurrence: Always |
orders.totalMarketplaceFee | Amount | This is the cumulative fees accrued for the order and deducted from the seller payout. Occurrence: Conditional |
orders.totalMarketplaceFee.convertedFromCurrency | CurrencyCodeEnum | 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. Occurrence: Conditional |
orders.totalMarketplaceFee.convertedFromValue | string | 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. Occurrence: Conditional |
orders.totalMarketplaceFee.currency | CurrencyCodeEnum | 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. Occurrence: Always |
orders.totalMarketplaceFee.value | string | 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. Occurrence: Always |
prev | string | The getOrders call URI for the previous result set. For example, the following URI returns orders 21 thru 30 from the collection of orders: Occurrence: Conditional |
total | integer | The total number of orders in the results set based on the current input criteria. Occurrence: Always |
warnings | array of ErrorDetailV3 | This array is returned if one or more errors or warnings occur with the call request. Occurrence: Conditional |
warnings.category | string | The context or source of this error or warning. Occurrence: Conditional |
warnings.domain | string | The name of the domain containing the service or application. For example, Occurrence: Conditional |
warnings.errorId | integer | A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms. Occurrence: Conditional |
warnings.inputRefIds | array of string | A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. Occurrence: Conditional |
warnings.longMessage | string | An expanded version of the message field. Occurrence: Conditional |
warnings.message | string | A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale. Occurrence: Conditional |
warnings.outputRefIds | array of string | A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation. Occurrence: Conditional |
warnings.parameters | array of ErrorParameterV3 | Contains a list of name-value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition. Occurrence: Conditional |
warnings.parameters.name | string | This is the name of input field that caused an issue with the call request. Occurrence: Conditional |
warnings.parameters.value | string | This is the actual value that was passed in for the element specified in the name field. Occurrence: Conditional |
warnings.subdomain | string | The name of the domain's subsystem or subdivision. For example, Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
200 | Success |
400 | Bad Request |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
30500 | API_FULFILLMENT | APPLICATION | System error |
30700 | API_FULFILLMENT | REQUEST | Invalid filter name: {fieldname} |
30800 | API_FULFILLMENT | REQUEST | Invalid filter value {fieldvalue} for filter {fieldname} |
30810 | API_FULFILLMENT | REQUEST | Invalid date format |
30820 | API_FULFILLMENT | REQUEST | Start date is missing |
30830 | API_FULFILLMENT | REQUEST | Time range between start date and end date must be within '{allowedTime}' years. |
30840 | API_FULFILLMENT | REQUEST | Start date should be before end date |
30850 | API_FULFILLMENT | REQUEST | Start and end dates can't be in the future |
30900 | API_FULFILLMENT | REQUEST | Exceeded maximum number of order IDs (the current limit is 50 ) |
31000 | API_FULFILLMENT | REQUEST | Invalid offset: {offsetvalue} |
31100 | API_FULFILLMENT | REQUEST | Invalid limit: {limitvalue} |
32800 | API_FULFILLMENT | REQUEST | Invalid field group: {fieldGroup} |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieve orders from last 90 days
This method retrieves all orders from the last 90 days. No path or query parameters are used.
Input
Only the endpoint is used here, with no path or query parameters.
GEThttps://api.ebay.com/sell/fulfillment/v1/order
Output
The output includes the 200 most recent orders. As indicated by the total field, 2190 orders match the criteria, but the limit value defaults to 200, which means only 200 orders are shown per page of data. If the user wants to view orders 201-400, the user could grab the URI shown in the next field to do so.
Note:Not all orders matching criteria are being displayed for sake of space.
Sample 2: Search for Your Orders
This sample retrieves the seller's orders created after the specified date. Each retrieved order includes a summary of taxes and fees.
Input
Use the filter=creationdate parameter to filter by creation date range. You can optionally include limit and offset parameters to paginate the returned collection.
GEThttps://api.ebay.com/sell/fulfillment/v1/order?filter=creationdate:%5B2020-05-01T15:05:43.026Z..%5D&limit=5&offset=5
Output
A successful call returns the OrderSearchPagedCollection container with one or more orders objects.
Sample 3: Search for Your Orders and Return Tax and Fee Breakdown
This sample retrieves all seller's orders created after the specified date. For each order, in addition to a summary of taxes and fees, a breakdown of tax and fee values is included.
Input
Use the filter=creationdate parameter to filter by creation date range. Use the optional fieldGroups=TAX_BREAKDOWN parameter to include breakdowns of tax and fee values for each order. You can optionally include limit and offset parameters to paginate the returned collection.
GEThttps://api.ebay.com/sell/fulfillment/v1/order?filter=creationdate:%5B2020-05-01T15:05:43.026Z..%5D&limit=5&offset=5&fieldGroups=TAX_BREAKDOWN
Output
A successful call returns the OrderSearchPagedCollection container with one or more orders objects. Each returned order includes breakdowns of tax and fee values.