/order/{orderId} - Fulfillment API

Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees. The returned Order object contains 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

{ "buyer": { "taxAddress": { "city": "string", "countryCode": "string", "postalCode": "string", "stateOrProvince": "string" }, "taxIdentifier": { "issuingCountry": "string", "taxIdentifierType": "string", "taxpayerId": "string" }, "username": "string" }, "buyerCheckoutNotes": "string", "cancelStatus": { "cancelRequests": [ { "cancelCompletedDate": "string", "cancelInitiator": "string", "cancelReason": "string", "cancelRequestId": "string", "cancelRequestState": "string", "cancelRequestedDate": "string" } ], "cancelState": "string", "cancelledDate": "string" }, "creationDate": "string", "ebayCollectAndRemitTax": true, "fulfillmentHrefs": [ "string" ], "fulfillmentStartInstructions": [ { "ebaySupportedFulfillment": true, "finalDestinationAddress": { "addressLine1": "string", "addressLine2": "string", "city": "string", "country": "string", "county": "string", "postalCode": "string", "stateOrProvince": "string" }, "fulfillmentInstructionsType": "string", "maxEstimatedDeliveryDate": "string", "minEstimatedDeliveryDate": "string", "pickupStep": { "merchantLocationKey": "string" }, "shippingStep": { "shipTo": { "companyName": "string", "contactAddress": { "addressLine1": "string", "addressLine2": "string", "city": "string", "country": "string", "county": "string", "postalCode": "string", "stateOrProvince": "string" }, "email": "string", "fullName": "string", "primaryPhone": { "phoneNumber": "string" } }, "shipToReferenceId": "string", "shippingCarrierCode": "string", "shippingServiceCode": "string" } } ], "lastModifiedDate": "string", "legacyOrderId": "string", "lineItems": [ { "appliedPromotions": [ { "description": "string", "discountAmount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "promotionId": "string" } ], "deliveryCost": { "importCharges": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "shippingCost": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "shippingIntermediationFee": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" } }, "discountedLineItemCost": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "ebayCollectAndRemitTaxes": [ { "amount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "collectionMethod": "string", "ebayReference": { "name": "string", "value": "string" }, "taxType": "string" } ], "giftDetails": { "message": "string", "recipientEmail": "string", "senderName": "string" }, "itemLocation": { "countryCode": "string", "location": "string", "postalCode": "string" }, "legacyItemId": "string", "legacyVariationId": "string", "lineItemCost": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "lineItemFulfillmentInstructions": { "guaranteedDelivery": true, "maxEstimatedDeliveryDate": "string", "minEstimatedDeliveryDate": "string", "shipByDate": "string" }, "lineItemFulfillmentStatus": "string", "lineItemId": "string", "listingMarketplaceId": "string", "properties": { "buyerProtection": true, "fromBestOffer": true, "soldViaAdCampaign": true }, "purchaseMarketplaceId": "string", "quantity": 0, "refunds": [ { "amount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "refundDate": "string", "refundId": "string", "refundReferenceId": "string" } ], "sku": "string", "soldFormat": "string", "taxes": [ { "amount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "taxType": "string" } ], "title": "string", "total": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" } } ], "orderFulfillmentStatus": "string", "orderId": "string", "orderPaymentStatus": "string", "paymentSummary": { "payments": [ { "amount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "paymentDate": "string", "paymentHolds": [ { "expectedReleaseDate": "string", "holdAmount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "holdReason": "string", "holdState": "string", "releaseDate": "string", "sellerActionsToRelease": [ { "sellerActionToRelease": "string" } ] } ], "paymentMethod": "string", "paymentReferenceId": "string", "paymentStatus": "string" } ], "refunds": [ { "amount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "refundDate": "string", "refundId": "string", "refundReferenceId": "string", "refundStatus": "string" } ], "totalDueSeller": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" } }, "pricingSummary": { "adjustment": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "deliveryCost": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "deliveryDiscount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "fee": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "priceDiscountSubtotal": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "priceSubtotal": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "tax": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "total": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" } }, "program": { "authenticityVerification": { "outcomeReason": "string", "status": "string" }, "fulfillmentProgram": { "fulfilledBy": "string" } }, "salesRecordReference": "string", "sellerId": "string", "totalFeeBasisAmount": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" }, "totalMarketplaceFee": { "convertedFromCurrency": "string", "convertedFromValue": "string", "currency": "string", "value": "string" } }

Request

Path Params

orderId

string

required

The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field. Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getOrder method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

Query Params

fieldGroups

string

optional

The response type associated with the order. The only presently supported value is TAX_BREAKDOWN. This type returns a breakdown of tax and fee values associated with the order.

Responses

🟢200Success

application/json

Body

This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

buyer

object (Buyer)

optional

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.

taxAddress

object (TaxAddress)

optional

This container consists of address information that can be used by sellers for tax purpose.

taxIdentifier

object (TaxIdentifier)

optional

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. Note: Currently, the taxIdentifier container is only returned in getOrder and not in getOrders. So, if a seller wanted to view a buyer's tax information for a particular order returned in getOrders, that seller would need to use the orderId value for that particular order, and then run a getOrder call against that order ID.

username

string

optional

The buyer's eBay user ID.

buyerCheckoutNotes

string

optional

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.

cancelStatus

object (CancelStatus)

optional

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 NONE_REQUESTED, and an empty cancelRequests array is also returned.

cancelRequests

array[object (CancelRequest) {6}]

optional

This array contains details of one or more buyer requests to cancel the order. For the getOrders call: This array is returned but is always empty. For the getOrder call: This array is returned fully populated with information about any cancellation requests.

cancelState

string

optional

The state of the order with regard to cancellation. This field is always returned, and if there are no cancellation requests, a value of NONE_REQUESTED is returned. For implementation help, refer to eBay API documentation

cancelledDate

string

optional

The date and time the order was cancelled, if applicable. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

creationDate

string

optional

The date and time that the order was created. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

ebayCollectAndRemitTax

boolean

optional

This field is only returned if true, and indicates that eBay will collect tax (US state-mandated sales tax, 'Goods and Services' tax in Australia or New Zealand, and VAT collected for UK and EU countries) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence. If this field is returned, the seller should search for one or more ebayCollectAndRemitTaxes containers at the line item level to get more information about the type of tax and the amount.

fulfillmentHrefs

array[string]

optional

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.

fulfillmentStartInstructions

array[object (FulfillmentStartInstruction) {7}]

optional

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. Note: Although this container is presented as an array, it currently returns only one set of fulfillment specifications. Additional array members will be supported in future functionality.

ebaySupportedFulfillment

boolean

optional

This field is only returned if its value is true and indicates that the fulfillment will be shipped via eBay's Global Shipping Program. For more information, see the Global Shipping Program help topic.

finalDestinationAddress

object (Address)

optional

This container is only returned if the value of ebaySupportedFulfillment field is true. This is the final destination address for a Global Shipping Program shipment, which is usually the buyer's home. Sellers should not ship directly to this address; instead they should ship this package to their international shipping provider's domestic warehouse. The international shipping provider is responsible for delivery to the final destination address. For more information, see Addressing a Global Shipping Program Shipment. 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.

fulfillmentInstructionsType

string

optional

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 SHIP_TO if the ebaySupportedFulfillment field is returned with a value of true. See the FulfillmentInstructionsType definition for more information about different fulfillment types. For implementation help, refer to eBay API documentation

maxEstimatedDeliveryDate

string

optional

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 DIGITAL or PREPARE_FOR_PICKUP. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

minEstimatedDeliveryDate

string

optional

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 DIGITAL or PREPARE_FOR_PICKUP. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

pickupStep

object (PickupStep)

optional

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.

shippingStep

object (ShippingStep)

optional

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 DIGITAL, or for In-Store Pickup orders. For Click and Collect orders, the shipping destination will be a brick-and-mortar store where the buyer will pick up the order.

lastModifiedDate

string

optional

The date and time that the order was last modified. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z Example: 2015-08-04T19:09:02.768Z

legacyOrderId

string

optional

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. Note: In June 2019, Order IDs in REST APIs transitioned to a new format. For the Trading and other legacy APIs, by using version control/compatibility level, users have the option of using the older legacy order ID format, or they can migrate to the new order ID format, which is the same order ID format being used by REST APIs. Although users of the Trading API (and other legacy APIs) can now transition to the new order ID format, this legacyOrderId field will still return order IDs in the old format to distinguish between the old and new order IDs.

lineItems

array[object (LineItem) {22}]

optional

This array contains the details for all line items that comprise the order.

appliedPromotions

array[object (AppliedPromotion) {3}]

optional

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.

deliveryCost

object (DeliveryCost)

optional

This container consists of a breakdown of all costs associated with the fulfillment of the line item.

discountedLineItemCost

object (Amount)

optional

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.

ebayCollectAndRemitTaxes

array[object (EbayCollectAndRemitTax) {4}]

optional

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. 'Collect and Remit' tax includes US state-mandated sales tax, 'Goods and Services' tax in Australia or New Zealand, and VAT collected for UK and EU countries. The amount of this tax is shown in the amount field, and the type of tax is shown in the taxType field. 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.

giftDetails

object (GiftDetails)

optional

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.

itemLocation

object (ItemLocation)

optional

This container field describes the physical location of the order line item.

legacyItemId

string

optional

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.

legacyVariationId

string

optional

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.

lineItemCost

object (Amount)

optional

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).

lineItemFulfillmentInstructions

object (LineItemFulfillmentInstructions)

optional

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.

lineItemFulfillmentStatus

string

optional

This enumeration value indicates the current fulfillment status of the line item. For implementation help, refer to eBay API documentation

lineItemId

string

optional

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.

listingMarketplaceId

string

optional

The unique identifier of the eBay marketplace where the line item was listed. For implementation help, refer to eBay API documentation

properties

object (LineItemProperties)

optional

Contains information about the eBay programs, if any, under which the line item was listed.

purchaseMarketplaceId

string

optional

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. For implementation help, refer to eBay API documentation

quantity

integer <int32>

optional

The number of units of the line item in the order. These are represented as a group by a single lineItemId.

refunds

array[object (LineItemRefund) {4}]

optional

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.

sku

string

optional

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.

soldFormat

string

optional

The eBay listing type of the line item. The most common listing types are AUCTION and FIXED_PRICE. For implementation help, refer to eBay API documentation

taxes

array[object (Tax) {2}]

optional

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.

title

string

optional

The title of the listing.

total

object (Amount)

optional

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. Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, 'Collect and Remit' will not be added into this total value. To determine if 'Collect and Remit' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is in this amount: STATE_SALES_TAX: US state-mandated sales tax GST: 'Good and Services' tax in Australia or New Zealand VAT: VAT collected for UK or EU countriesPayPal sellers, be aware the 'Collect and Remit' tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but PayPal will pull out the 'Collect and Remit' tax amount shortly after the payment clears and distribute the tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

orderFulfillmentStatus

string

optional

The degree to which fulfillment of the order is complete. See the OrderFulfillmentStatus type definition for more information about each possible fulfillment state. For implementation help, refer to eBay API documentation

orderId

string

optional

The unique identifier of the order. Both the legacyOrderId field (traditionally used by Trading and other legacy APIS) and this field are always returned. Note: In June 2019, Order IDs in REST APIs transitioned to a new format. For the Trading and other legacy APIs, by using version control/compatibility level, users have the option of using the older legacy order ID format, or they can migrate to the new order ID format, which is the same order ID format being used by REST APIs. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers are automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

orderPaymentStatus

string

optional

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. For implementation help, refer to eBay API documentation

paymentSummary

object (PaymentSummary)

optional

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).

payments

array[object (Payment) {6}]

optional

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.

refunds

array[object (OrderRefund) {5}]

optional

totalDueSeller

object (Amount)

optional

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 PENDING or FAILED), or if a partial or full refund occurs with the order. Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this totalDueSeller value. To determine if 'Collect and Remit' taxes were added into this totalDueSeller value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is in this amount: STATE_SALES_TAX: US GST: Australia or New Zealand VAT: UK or EU countriesPayPal sellers, be aware the 'Collect and Remit' tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but PayPal will pull out the 'Collect and Remit' tax amount shortly after the payment clears and distribute the tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

pricingSummary

object (PricingSummary)

optional

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.

adjustment

object (Amount)

optional

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. This container is only returned if price adjustments were made to the order after the initial transaction/commitment to buy occurred.

deliveryCost

object (Amount)

optional

This container shows the total cost of delivering the order to the buyer, before any shipping/delivery discount is applied.

deliveryDiscount

object (Amount)

optional

This container shows the total amount of delivery discounts (including shipping discounts) that apply to the order. This should be a negative real number. This container is only returned if delivery discounts are being applied to the order.

fee

object (Amount)

optional

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. This container is returned if special fees are being applied to the order and if the fieldGroups is set to TAX_BREAKDOWN.

priceDiscountSubtotal

object (Amount)

optional

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. This container is only returned if special discounts are being applied to the order.

priceSubtotal

object (Amount)

optional

This container shows the cumulative costs of of all units of all line items in the order, before any discount is applied.

tax

object (Amount)

optional

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. This container is only returned if any type of tax (sales tax, tax on shipping, tax on handling, import tax, etc.) is applied to the order.

total

object (Amount)

optional

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. Note: For orders that are subject to 'eBay Collect and Remit' tax, the 'Collect and Remit' tax amount for the order will be included in this total value only when the fieldGroups query parameter is set to TAX_BREAKDOWN. If the fieldGroups query parameter is not set to TAX_BREAKDOWN, 'Collect and Remit' will not be added into this total value. To determine if 'Collect and Remit' taxes were added into this total value, the user can check for the corresponding lineItems.ebayCollectAndRemitTaxes and the lineItems.taxes containers in the response. If both of these containers appear for one or more line items in the response with the following taxType values, the 'Collect and Remit' tax amount that the buyer paid is in this amount: STATE_SALES_TAX: US state-mandated sales tax GST: 'Good and Services' tax in Australia or New Zealand VAT: VAT collected for UK or EU countriesPayPal sellers, be aware the 'Collect and Remit' tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but PayPal will pull out the 'Collect and Remit' tax amount shortly after the payment clears and distribute the tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

program

object (Program)

optional

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 fulfillmentStartInstructions.shippingStep.shipTo container. If the item is successfully authenticated, the authenticator will ship the item to the buyer.

authenticityVerification

object (PostSaleAuthenticationProgram)

optional

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.

fulfillmentProgram

object (EbayFulfillmentProgram)

optional

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.

salesRecordReference

string

optional

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. In cases where the seller does not have a Selling Manager or Selling Manager Pro subscription nor access to Seller Hub, this field may not be returned.

sellerId

string

optional

The unique eBay user ID of the seller who sold the order.

totalFeeBasisAmount

object (Amount)

optional

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.

totalMarketplaceFee

object (Amount)

optional

This is the cumulative fees accrued for the order and deducted from the seller payout.

🟠400Bad Request

🟠404Not Found

🔴500Internal Server Error