GetOrderTransactions
Use this call to retrieve information about one or more orders based on OrderIDs, ItemIDs, or SKU values. The order types that can be retrieved with this call are discussed below:
| Note: This call will be decommissioned on January 31, 2024. No further updates are planned for this API during the deprecation period. Developers have the option of migrating to the GetOrders call in the Trading API, or the getOrders method of the Fulfillment API. Please note that the Fulfillment API only returns paid orders, so if your use case calls for retrieving both paid and unpaid orders, we recommend migrating to the GetOrders call in the Trading API. |
- Single line item orders: With the introduction of the OrderLineItemID field and other enhancements, GetOrderTransactions can now return single line item orders (traditionally known as transactions in eBay listings). In the API, a Transaction object, including a TransactionID and an OrderLineItemID, is generated by eBay as soon as the buyer commits to a purchase in an eBay listing. The OrderLineItemID value is actually a concatenation of ItemID and TransactionID with a hyphen separating the two values. The OrderLineItemID value is very versatile as it can substitute for any ItemID/TransactionID pair when these values are used as input filters, and its value can be passed into the OrderID field when OrderID is used as an input filter.
- Multiple line item orders: A multiple line item order known as a Combined Invoice order (formerly called combined payment order). If multiple unpaid orders exist between the same buyer and seller, either the buyer or seller can combine these multiple order line items into a Combined Invoice order. Combined Invoice orders can be created on the Web site by the buyer or seller, and by the seller using the AddOrder call. In the AddOrder request, the caller passes in two or more order line items in the TransactionArray container and an eBay-generated OrderID value is returned in the response, and then can be used in the OrderID field of the GetOrderTransactions request.
Usage Details
Unlike GetOrders, there are no time filters available in the GetOrderTransactions request. With GetOrderTransactions, you are either want to retrieve specific orders (using the OrderIDArray), or you want to find all orders associated with a particular item (and the item can be identified with an ItemID or SKU value. To find orders tied to a SKU value, the Item.InventoryTrackingMethod property (set at listing time) should be set to SKU.
Although it is possible to retrieve specific single line item orders through the ItemTransactionIDArray container using an ItemID/TransactionID pair or an OrderLineItemID value, the better solution might be to pass in one or more OrderLineItemID values into the OrderID field of the OrderIDArray container.
Testing GetOrderTransactions
You can test GetOrderTransactions in the Sandbox environment. To test the call, experiment with passing in one or more single and multiple line item OrderIDs into the OrderIDArray node and see if results are as expected. Similarly, pass in one or more ItemIDs or SKU values to see if the return results match the expected sales for those items.
Related Information
See also the reference documentation for this call:
- GetOrders - Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller.
| Output Detail Controls Samples Change History |
Input
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <GetOrderTransactionsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <IncludeFinalValueFees> boolean </IncludeFinalValueFees> <ItemTransactionIDArray> ItemTransactionIDArrayType <ItemTransactionID> ItemTransactionIDType <ItemID> ItemIDType (string) </ItemID> <OrderLineItemID> string </OrderLineItemID> <SKU> SKUType (string) </SKU> <TransactionID> string </TransactionID> </ItemTransactionID> <!-- ... more ItemTransactionID nodes allowed here ... --> </ItemTransactionIDArray> <OrderIDArray> OrderIDArrayType <OrderID> OrderIDType (string) </OrderID> <!-- ... more OrderID values allowed here ... --> </OrderIDArray> <!-- Standard Input Fields --> <DetailLevel> DetailLevelCodeType </DetailLevel> <!-- ... more DetailLevel values allowed here ... --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <OutputSelector> string </OutputSelector> <!-- ... more OutputSelector values allowed here ... --> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetOrderTransactionsRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| IncludeFinalValueFees | boolean | Optional |
This field is included and set to true if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the Transaction.FinalValueFee field. The Final Value Fee is assessed right after the creation of an order line item. See the Selling fees help page for more information about how Final Value Fees are calculated. Default: false. |
| ItemTransactionIDArray | ItemTransactionIDArrayType | Conditional | This container is used if the seller wants to retrieve for one or more order line items. An ItemTransactionID container is required for each order line item that is to be retrieved. An order line item can be identified with an ItemID/TransactionID pair, with an OrderLineItemID value, or with a SKU value (if a SKU is defined for the order line item). |
|
ItemTransactionIDArray .ItemTransactionID |
ItemTransactionIDType | Conditional,
repeatable: [0..*] |
An ItemTransactionID container is required to specify a specific order line item to retrieve. The seller has the option of using an OrderLineItemID, a SKU value (if it exists for the order line item and the InventoryTrackingMethod is set to SKU), or an ItemID/TransactionID pair to identify an order line item.
|
|
ItemTransactionIDArray .ItemTransactionID.ItemID |
ItemIDType (string) | Conditional |
Unique identifier for an eBay listing. A multiple-quantity listing can have multiple order line items, but only one ItemID. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request. |
|
ItemTransactionIDArray .ItemTransactionID .OrderLineItemID |
string | Conditional |
OrderLineItemID is a unique identifier for an eBay order line item. If an OrderLineItemID is included in an ItemTransactionID node in the request, the ItemID, TransactionID, and SKU fields are not required and are ignored if they are included in the request. |
|
ItemTransactionIDArray .ItemTransactionID.SKU |
SKUType (string) | Conditional |
A SKU (stock keeping unit) is a unique identifier defined and used by the seller to identify a product or variation of an item. Unless an OrderLineItemID value or ItemID/TransactionID pair is specified in the same node, this field is required for each ItemTransactionID node included in the request. To retrieve order line items associated with a SKU, the InventoryTrackingMethod field must be set to SKU. The InventoryTrackingMethod field is set through AddFixedPriceItem or RelistFixedPriceItem. Max length: 50. |
|
ItemTransactionIDArray .ItemTransactionID .TransactionID |
string | Conditional |
Unique identifier for an eBay order line item. The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID or SKU value can substitute for the ItemID/TransactionID pair. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. |
| OrderIDArray | OrderIDArrayType | Conditional |
This container is used if the seller wants to search for one or more orders. An OrderID field is required for each order that is to be retrieved. Up to 20 OrderID fields can be used. Note: As of June 2019, eBay has changed the format of order identifier values. 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. 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. For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely. During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level. Note: For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment. When using a GetOrders or GetOrderTransactions call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order. |
| OrderIDArray.OrderID | OrderIDType (string) | Conditional,
repeatable: [0..*] |
A unique identifier for an eBay order. If one or more OrderID values are used in a GetOrders or GetOrderTransactions call, any order status or date range filters are ignored. Note: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level. Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the GetOrders and GetOrderTransactions calls, will support the identifiers for both unpaid and paid orders. The new order ID format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. 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. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call. Sellers should not fulfill orders until buyer has made payment. Max length: 40. |
| Standard Input Fields |
| DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it and processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (Not all values in DetailLevelCodeType apply to this field.) |
||||||||||||||||||||||||||||||||||||||||
| ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
| OutputSelector | string | Optional,
repeatable: [0..*] |
You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload. For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example: If the following output selectors are used: |
||||||||||||||||||||||||||||||||||||||||
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
| WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
| Input Detail Controls Samples Change History |
Output
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <GetOrderTransactionsResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <OrderArray> OrderArrayType <Order> OrderType <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount> <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid> <AmountSaved currencyID="CurrencyCodeType"> AmountType (double) </AmountSaved> <BuyerCheckoutMessage> string </BuyerCheckoutMessage> <BuyerPackageEnclosures> BuyerPackageEnclosuresType <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure> <!-- ... more BuyerPackageEnclosure values allowed here ... --> </BuyerPackageEnclosures> <BuyerTaxIdentifier> TaxIdentifierType <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute> <!-- ... more Attribute values allowed here ... --> <ID> string </ID> <Type> ValueTypeCodeType </Type> </BuyerTaxIdentifier> <!-- ... more BuyerTaxIdentifier nodes allowed here ... --> <BuyerUserID> UserIDType (string) </BuyerUserID> <CancelReason> token </CancelReason> <CancelStatus> CancelStatusCodeType </CancelStatus> <CheckoutStatus> CheckoutStatusType <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <LastModifiedTime> dateTime </LastModifiedTime> <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument> <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod> <Status> CompleteStatusCodeType </Status> </CheckoutStatus> <ContainseBayPlusTransaction> boolean </ContainseBayPlusTransaction> <CreatedTime> dateTime </CreatedTime> <CreatingUserRole> TradingRoleCodeType </CreatingUserRole> <eBayCollectAndRemitTax> boolean </eBayCollectAndRemitTax> <ExtendedOrderID> string </ExtendedOrderID> <ExternalTransaction> ExternalTransactionType <ExternalTransactionID> string </ExternalTransactionID> <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus> <ExternalTransactionTime> dateTime </ExternalTransactionTime> <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount> </ExternalTransaction> <!-- ... more ExternalTransaction nodes allowed here ... --> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <IsMultiLegShipping> boolean </IsMultiLegShipping> <LogisticsPlanType> token </LogisticsPlanType> <MonetaryDetails> PaymentsInformationType <Payments> PaymentInformationType <Payment> PaymentTransactionType <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee> <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer> <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount> <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID> <!-- ... more PaymentReferenceID values allowed here ... --> <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus> <PaymentTime> dateTime </PaymentTime> <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID> </Payment> <!-- ... more Payment nodes allowed here ... --> </Payments> <Refunds> RefundInformationType <Refund> RefundTransactionInfoType <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID> <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount> <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus> <RefundTime> dateTime </RefundTime> <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo> <RefundType> RefundSourceTypeCodeType </RefundType> </Refund> <!-- ... more Refund nodes allowed here ... --> </Refunds> </MonetaryDetails> <MultiLegShippingDetails> MultiLegShippingDetailsType <SellerShipmentToLogisticsProvider> MultiLegShipmentType <ShippingServiceDetails> MultiLegShippingServiceType <ShippingService> token </ShippingService> <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost> </ShippingServiceDetails> <ShippingTimeMax> int </ShippingTimeMax> <ShippingTimeMin> int </ShippingTimeMin> <ShipToAddress> AddressType <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute> <!-- ... more AddressAttribute values allowed here ... --> <AddressID> string </AddressID> <AddressOwner> AddressOwnerCodeType </AddressOwner> <AddressUsage> AddressUsageCodeType </AddressUsage> <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <ExternalAddressID> string </ExternalAddressID> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <ReferenceID> string </ReferenceID> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> </ShipToAddress> </SellerShipmentToLogisticsProvider> </MultiLegShippingDetails> <OrderID> OrderIDType (string) </OrderID> <OrderStatus> OrderStatusCodeType </OrderStatus> <PaidTime> dateTime </PaidTime> <PaymentHoldDetails> PaymentHoldDetailType <ExpectedReleaseDate> dateTime </ExpectedReleaseDate> <NumOfReqSellerActions> int </NumOfReqSellerActions> <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason> <RequiredSellerActionArray> RequiredSellerActionArrayType <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction> <!-- ... more RequiredSellerAction values allowed here ... --> </RequiredSellerActionArray> </PaymentHoldDetails> <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus> <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods> <!-- ... more PaymentMethods values allowed here ... --> <PickupDetails> PickupDetailsType <PickupOptions> PickupOptionsType <PickupMethod> token </PickupMethod> <PickupPriority> int </PickupPriority> </PickupOptions> <!-- ... more PickupOptions nodes allowed here ... --> </PickupDetails> <PickupMethodSelected> PickupMethodSelectedType <MerchantPickupCode> string </MerchantPickupCode> <PickupFulfillmentTime> dateTime </PickupFulfillmentTime> <PickupLocationUUID> string </PickupLocationUUID> <PickupMethod> token </PickupMethod> <PickupStatus> PickupStatusCodeType </PickupStatus> <PickupStoreID> string </PickupStoreID> </PickupMethodSelected> <SellerEmail> string </SellerEmail> <SellerUserID> UserIDType (string) </SellerUserID> <ShippedTime> dateTime </ShippedTime> <ShippingAddress> AddressType <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute> <!-- ... more AddressAttribute values allowed here ... --> <AddressID> string </AddressID> <AddressOwner> AddressOwnerCodeType </AddressOwner> <AddressUsage> AddressUsageCodeType </AddressUsage> <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <ExternalAddressID> string </ExternalAddressID> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> </ShippingAddress> <ShippingDetails> ShippingDetailsType <ChangePaymentInstructions> boolean </ChangePaymentInstructions> <eBayEstimatedLabelCost currencyID="CurrencyCodeType"> AmountType (double) </eBayEstimatedLabelCost> <ExcludeShipToLocation> string </ExcludeShipToLocation> <!-- ... more ExcludeShipToLocation values allowed here ... --> <GetItFast> boolean </GetItFast> <InternationalShippingServiceOption> InternationalShippingServiceOptionsType <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> <ShipToLocation> string </ShipToLocation> <!-- ... more ShipToLocation values allowed here ... --> </InternationalShippingServiceOption> <!-- ... more InternationalShippingServiceOption nodes allowed here ... --> <SalesTax> SalesTaxType <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount> <SalesTaxPercent> float </SalesTaxPercent> <SalesTaxState> string </SalesTaxState> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </SalesTax> <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber> <ShipmentTrackingDetails> ShipmentTrackingDetailsType <ShipmentTrackingNumber> string </ShipmentTrackingNumber> <ShippingCarrierUsed> string </ShippingCarrierUsed> </ShipmentTrackingDetails> <!-- ... more ShipmentTrackingDetails nodes allowed here ... --> <ShippingServiceOptions> ShippingServiceOptionsType <ExpeditedService> boolean </ExpeditedService> <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingPackageInfo> ShippingPackageInfoType <ActualDeliveryTime> dateTime </ActualDeliveryTime> <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax> <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin> <ShippingTrackingEvent> token </ShippingTrackingEvent> <StoreID> string </StoreID> </ShippingPackageInfo> <!-- ... more ShippingPackageInfo nodes allowed here ... --> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <TaxTable> TaxTableType <TaxJurisdiction> TaxJurisdictionType <JurisdictionID> string </JurisdictionID> <SalesTaxPercent> float </SalesTaxPercent> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </TaxJurisdiction> <!-- ... more TaxJurisdiction nodes allowed here ... --> </TaxTable> </ShippingDetails> <ShippingServiceSelected> ShippingServiceOptionsType <ExpeditedService> boolean </ExpeditedService> <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingPackageInfo> ShippingPackageInfoType <ActualDeliveryTime> dateTime </ActualDeliveryTime> <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax> <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin> <HandleByTime> dateTime </HandleByTime> <MaxNativeEstimatedDeliveryTime> dateTime </MaxNativeEstimatedDeliveryTime> <MinNativeEstimatedDeliveryTime> dateTime </MinNativeEstimatedDeliveryTime> <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax> <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin> <ShippingTrackingEvent> token </ShippingTrackingEvent> <StoreID> string </StoreID> </ShippingPackageInfo> <!-- ... more ShippingPackageInfo nodes allowed here ... --> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> </ShippingServiceSelected> <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal> <Total currencyID="CurrencyCodeType"> AmountType (double) </Total> <TransactionArray> TransactionArrayType <Transaction> TransactionType <ActualHandlingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualHandlingCost> <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost> <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount> <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid> <BestOfferSale> boolean </BestOfferSale> <Buyer> UserType <AboutMePage> boolean </AboutMePage> <eBayGoodStanding> boolean </eBayGoodStanding> <EIASToken> string </EIASToken> <Email> string </Email> <FeedbackPrivate> boolean </FeedbackPrivate> <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar> <FeedbackScore> int </FeedbackScore> <IDVerified> boolean </IDVerified> <NewUser> boolean </NewUser> <RegistrationDate> dateTime </RegistrationDate> <Site> SiteCodeType </Site> <StaticAlias> string </StaticAlias> <Status> UserStatusCodeType </Status> <UserAnonymized> boolean </UserAnonymized> <UserFirstName> string </UserFirstName> <UserID> UserIDType (string) </UserID> <UserIDChanged> boolean </UserIDChanged> <UserIDLastChanged> dateTime </UserIDLastChanged> <UserLastName> string </UserLastName> <VATStatus> VATStatusCodeType </VATStatus> </Buyer> <BuyerGuaranteePrice currencyID="CurrencyCodeType"> AmountType (double) </BuyerGuaranteePrice> <BuyerPackageEnclosures> BuyerPackageEnclosuresType <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure> <!-- ... more BuyerPackageEnclosure values allowed here ... --> </BuyerPackageEnclosures> <ConvertedAdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAdjustmentAmount> <ConvertedAmountPaid currencyID="CurrencyCodeType"> AmountType (double) </ConvertedAmountPaid> <ConvertedTransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedTransactionPrice> <CreatedDate> dateTime </CreatedDate> <DepositType> DepositTypeCodeType </DepositType> <DigitalDeliverySelected> DigitalDeliverySelectedType <DeliveryDetails> DeliveryDetailsType <Recipient> DigitalDeliveryUserType <Email> string </Email> <Name> string </Name> </Recipient> <Sender> DigitalDeliveryUserType <Email> string </Email> <Name> string </Name> </Sender> </DeliveryDetails> <DeliveryMethod> token </DeliveryMethod> <DeliveryStatus> DeliveryStatusType <Email> token </Email> </DeliveryStatus> </DigitalDeliverySelected> <eBayCollectAndRemitTax> boolean </eBayCollectAndRemitTax> <eBayCollectAndRemitTaxes> TaxesType <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference> <TaxDetails> TaxDetailsType <CollectionMethod> CollectionMethodCodeType </CollectionMethod> <Imposition> TaxTypeCodeType </Imposition> <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount> <TaxCode> string </TaxCode> <TaxDescription> TaxDescriptionCodeType </TaxDescription> <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount> <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount> <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount> </TaxDetails> <!-- ... more TaxDetails nodes allowed here ... --> <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount> </eBayCollectAndRemitTaxes> <eBayPaymentID> string </eBayPaymentID> <eBayPlusTransaction> boolean </eBayPlusTransaction> <ExtendedOrderID> string </ExtendedOrderID> <ExternalTransaction> ExternalTransactionType <ExternalTransactionID> string </ExternalTransactionID> <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus> <ExternalTransactionTime> dateTime </ExternalTransactionTime> <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount> </ExternalTransaction> <!-- ... more ExternalTransaction nodes allowed here ... --> <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee> <Gift> boolean </Gift> <GiftSummary> GiftSummaryType <Message> string </Message> </GiftSummary> <GuaranteedDelivery> boolean </GuaranteedDelivery> <GuaranteedShipping> boolean </GuaranteedShipping> <IntangibleItem> boolean </IntangibleItem> <InventoryReservationID> string </InventoryReservationID> <InvoiceSentTime> dateTime </InvoiceSentTime> <IsMultiLegShipping> boolean </IsMultiLegShipping> <Item> ItemType <ApplicationData> string </ApplicationData> <AutoPay> boolean </AutoPay> <BuyerProtection> BuyerProtectionCodeType </BuyerProtection> <BuyItNowPrice currencyID="CurrencyCodeType"> AmountType (double) </BuyItNowPrice> <Charity> CharityType <CharityID> string </CharityID> <CharityListing> boolean </CharityListing> <CharityName> string </CharityName> <DonationPercent> float </DonationPercent> </Charity> <ConditionDisplayName> string </ConditionDisplayName> <ConditionID> int </ConditionID> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <ItemID> ItemIDType (string) </ItemID> <ListingType> ListingTypeCodeType </ListingType> <PrivateListing> boolean </PrivateListing> <SellingStatus> SellingStatusType <ConvertedCurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </ConvertedCurrentPrice> <CurrentPrice currencyID="CurrencyCodeType"> AmountType (double) </CurrentPrice> <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee> <ListingStatus> ListingStatusCodeType </ListingStatus> </SellingStatus> </Item> <LogisticsPlanType> token </LogisticsPlanType> <MonetaryDetails> PaymentsInformationType <Payments> PaymentInformationType <Payment> PaymentTransactionType <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee> <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer> <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount> <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID> <!-- ... more PaymentReferenceID values allowed here ... --> <PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus> <PaymentTime> dateTime </PaymentTime> <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID> </Payment> <!-- ... more Payment nodes allowed here ... --> </Payments> <Refunds> RefundInformationType <Refund> RefundTransactionInfoType <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount> <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID> <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount> <RefundStatus> PaymentTransactionStatusCodeType </RefundStatus> <RefundTime> dateTime </RefundTime> <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo> <RefundType> RefundSourceTypeCodeType </RefundType> </Refund> <!-- ... more Refund nodes allowed here ... --> </Refunds> </MonetaryDetails> <MultiLegShippingDetails> MultiLegShippingDetailsType <SellerShipmentToLogisticsProvider> MultiLegShipmentType <ShippingServiceDetails> MultiLegShippingServiceType <ShippingService> token </ShippingService> <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost> </ShippingServiceDetails> <ShippingTimeMax> int </ShippingTimeMax> <ShippingTimeMin> int </ShippingTimeMin> <ShipToAddress> AddressType <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute> <!-- ... more AddressAttribute values allowed here ... --> <AddressID> string </AddressID> <AddressOwner> AddressOwnerCodeType </AddressOwner> <AddressUsage> AddressUsageCodeType </AddressUsage> <CityName> string </CityName> <Country> CountryCodeType </Country> <CountryName> string </CountryName> <ExternalAddressID> string </ExternalAddressID> <Name> string </Name> <Phone> string </Phone> <PostalCode> string </PostalCode> <ReferenceID> string </ReferenceID> <StateOrProvince> string </StateOrProvince> <Street1> string </Street1> <Street2> string </Street2> </ShipToAddress> </SellerShipmentToLogisticsProvider> </MultiLegShippingDetails> <OrderLineItemID> string </OrderLineItemID> <PaidTime> dateTime </PaidTime> <PaymentHoldDetails> PaymentHoldDetailType <ExpectedReleaseDate> dateTime </ExpectedReleaseDate> <NumOfReqSellerActions> int </NumOfReqSellerActions> <PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason> <RequiredSellerActionArray> RequiredSellerActionArrayType <RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction> <!-- ... more RequiredSellerAction values allowed here ... --> </RequiredSellerActionArray> </PaymentHoldDetails> <PayPalEmailAddress> string </PayPalEmailAddress> <PickupMethodSelected> PickupMethodSelectedType <MerchantPickupCode> string </MerchantPickupCode> <PickupFulfillmentTime> dateTime </PickupFulfillmentTime> <PickupLocationUUID> string </PickupLocationUUID> <PickupMethod> token </PickupMethod> <PickupStatus> PickupStatusCodeType </PickupStatus> <PickupStoreID> string </PickupStoreID> </PickupMethodSelected> <Platform> TransactionPlatformCodeType </Platform> <Program> TransactionProgramType <AuthenticityVerification> AuthenticityVerificationType <OutcomeReason> string </OutcomeReason> <ServiceCost> ServiceCostType <Amount currencyID="CurrencyCodeType"> AmountType (double) </Amount> <ConvertedFromAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedFromAmount> </ServiceCost> <Status> string </Status> </AuthenticityVerification> <Fulfillment> FulfillmentType <FulfillmentBy> string </FulfillmentBy> <FulfillmentRefId> string </FulfillmentRefId> </Fulfillment> </Program> <QuantityPurchased> int </QuantityPurchased> <SellerDiscounts> SellerDiscountsType <OriginalItemPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemPrice> <OriginalItemShippingCost currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemShippingCost> <OriginalShippingService> token </OriginalShippingService> <SellerDiscount> SellerDiscountType <CampaignDisplayName> string </CampaignDisplayName> <CampaignID> long </CampaignID> <ItemDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ItemDiscountAmount> <ShippingDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ShippingDiscountAmount> </SellerDiscount> <!-- ... more SellerDiscount nodes allowed here ... --> </SellerDiscounts> <ShippingDetails> ShippingDetailsType <ChangePaymentInstructions> boolean </ChangePaymentInstructions> <eBayEstimatedLabelCost currencyID="CurrencyCodeType"> AmountType (double) </eBayEstimatedLabelCost> <ExcludeShipToLocation> string </ExcludeShipToLocation> <!-- ... more ExcludeShipToLocation values allowed here ... --> <GetItFast> boolean </GetItFast> <InternationalShippingServiceOption> InternationalShippingServiceOptionsType <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> <ShipToLocation> string </ShipToLocation> <!-- ... more ShipToLocation values allowed here ... --> </InternationalShippingServiceOption> <!-- ... more InternationalShippingServiceOption nodes allowed here ... --> <SalesTax> SalesTaxType <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount> <SalesTaxPercent> float </SalesTaxPercent> <SalesTaxState> string </SalesTaxState> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </SalesTax> <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber> <ShipmentTrackingDetails> ShipmentTrackingDetailsType <ShipmentTrackingNumber> string </ShipmentTrackingNumber> <ShippingCarrierUsed> string </ShippingCarrierUsed> </ShipmentTrackingDetails> <!-- ... more ShipmentTrackingDetails nodes allowed here ... --> <ShippingServiceOptions> ShippingServiceOptionsType <ExpeditedService> boolean </ExpeditedService> <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingPackageInfo> ShippingPackageInfoType <ActualDeliveryTime> dateTime </ActualDeliveryTime> <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax> <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin> <ShippingTrackingEvent> token </ShippingTrackingEvent> <StoreID> string </StoreID> </ShippingPackageInfo> <!-- ... more ShippingPackageInfo nodes allowed here ... --> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> </ShippingServiceOptions> <!-- ... more ShippingServiceOptions nodes allowed here ... --> <TaxTable> TaxTableType <TaxJurisdiction> TaxJurisdictionType <JurisdictionID> string </JurisdictionID> <SalesTaxPercent> float </SalesTaxPercent> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> </TaxJurisdiction> <!-- ... more TaxJurisdiction nodes allowed here ... --> </TaxTable> </ShippingDetails> <ShippingServiceSelected> ShippingServiceOptionsType <ExpeditedService> boolean </ExpeditedService> <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge> <ShippingPackageInfo> ShippingPackageInfoType <ActualDeliveryTime> dateTime </ActualDeliveryTime> <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax> <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin> <HandleByTime> dateTime </HandleByTime> <MaxNativeEstimatedDeliveryTime> dateTime </MaxNativeEstimatedDeliveryTime> <MinNativeEstimatedDeliveryTime> dateTime </MinNativeEstimatedDeliveryTime> <ScheduledDeliveryTimeMax> dateTime </ScheduledDeliveryTimeMax> <ScheduledDeliveryTimeMin> dateTime </ScheduledDeliveryTimeMin> <ShippingTrackingEvent> token </ShippingTrackingEvent> <StoreID> string </StoreID> </ShippingPackageInfo> <!-- ... more ShippingPackageInfo nodes allowed here ... --> <ShippingService> token </ShippingService> <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost> <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost> <ShippingServicePriority> int </ShippingServicePriority> </ShippingServiceSelected> <Status> TransactionStatusType <BuyerSelectedShipping> boolean </BuyerSelectedShipping> <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus> <CompleteStatus> CompleteStatusCodeType </CompleteStatus> <DigitalStatus> DigitalStatusCodeType </DigitalStatus> <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus> <InquiryStatus> InquiryStatusCodeType </InquiryStatus> <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled> <LastTimeModified> dateTime </LastTimeModified> <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus> <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument> <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed> <ReturnStatus> ReturnStatusCodeType </ReturnStatus> </Status> <Taxes> TaxesType <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference> <TaxDetails> TaxDetailsType <Imposition> TaxTypeCodeType </Imposition> <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount> <TaxCode> string </TaxCode> <TaxDescription> TaxDescriptionCodeType </TaxDescription> <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount> <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount> <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount> </TaxDetails> <!-- ... more TaxDetails nodes allowed here ... --> <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount> </Taxes> <TransactionID> string </TransactionID> <TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice> <TransactionSiteID> SiteCodeType </TransactionSiteID> <UnpaidItem> UnpaidItemType <Status> UnpaidItemCaseStatusTypeCodeType </Status> <Type> UnpaidItemCaseOpenTypeCodeType </Type> </UnpaidItem> <Variation> VariationType <SKU> SKUType (string) </SKU> <VariationSpecifics> NameValueListArrayType <NameValueList> NameValueListType <Name> string </Name> <Value> string </Value> <!-- ... more Value values allowed here ... --> </NameValueList> <!-- ... more NameValueList nodes allowed here ... --> </VariationSpecifics> <!-- ... more VariationSpecifics nodes allowed here ... --> <VariationTitle> string </VariationTitle> <VariationViewItemURL> anyURI </VariationViewItemURL> </Variation> </Transaction> <!-- ... more Transaction nodes allowed here ... --> </TransactionArray> </Order> <!-- ... more Order nodes allowed here ... --> </OrderArray> <!-- Standard Output Fields --> <Ack> AckCodeType </Ack> <Build> string </Build> <CorrelationID> string </CorrelationID> <Errors> ErrorType <ErrorClassification> ErrorClassificationCodeType </ErrorClassification> <ErrorCode> token </ErrorCode> <ErrorParameters ParamID="string"> ErrorParameterType <Value> string </Value> </ErrorParameters> <!-- ... more ErrorParameters nodes allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </GetOrderTransactionsResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| OrderArray | OrderArrayType | Always |
This container consists of an array of eBay orders that match the input criteria that was passed into the call request.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order | OrderType | Always,
repeatable: [1..*] |
Details of an eBay order. One eBay order can have one or more order line items (Transaction objects).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Combined Invoice. |
|
OrderArray.Order .AdjustmentAmount |
AmountType (double) | Always |
This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .AdjustmentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.AmountPaid | AmountType (double) | Conditionally |
This value indicates the total amount paid by the buyer for the order. This amount includes the sale price of each line item, shipping and handling charges, additional services, and any sales tax applied towards the order. This value is only returned after the buyer has paid for the order. Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.AmountPaid [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the total amount paid by the buyer for the order. This amount includes the sale price of each line item, shipping and handling charges, additional services, and any sales tax applied towards the order. This value is only returned after the buyer has paid for the order. Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.AmountSaved | AmountType (double) | Always |
This value indicates the amount that the buyer saved on the order due to any discounts (item, shipping, promotional) applied to the purchase, or if the seller 'manually' reduced the order total. This field is always returned even when it is '0.0'.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.AmountSaved [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the amount that the buyer saved on the order due to any discounts (item, shipping, promotional) applied to the purchase, or if the seller 'manually' reduced the order total. This field is always returned even when it is '0.0'. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .BuyerCheckoutMessage |
string | Conditionally |
This field is returned if the buyer left a message for the seller during checkout.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .BuyerPackageEnclosures |
BuyerPackageEnclosuresType | Conditionally |
This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site. Note: The ContainingOrder.BuyerPackageEnclosures container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .BuyerPackageEnclosures .BuyerPackageEnclosure |
BuyerPackageEnclosureType (string) | Conditionally,
repeatable: [0..*] |
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .BuyerPackageEnclosures .BuyerPackageEnclosure [ attribute type ] |
PaymentInstructionCodeType | Conditionally |
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site. For a list of possible enumeration values, see PaymentInstructionCodeType. |
|
OrderArray.Order .BuyerTaxIdentifier |
TaxIdentifierType | Conditionally,
repeatable: [0..*] |
This container will either consist of VAT or Codice Fiscale taxpayer identification information for the buyer. It is required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site. On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout. This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier container will be returned for each tax ID that is associated with the buyer's account. Note: The ContainingOrder.BuyerTaxIdentifier container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .BuyerTaxIdentifier.Attribute |
TaxIdentifierAttributeType (string) | Conditionally,
repeatable: [0..*] |
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .BuyerTaxIdentifier.Attribute [ attribute name ] |
TaxIdentifierAttributeCodeType | Conditionally |
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country. For a list of possible enumeration values, see TaxIdentifierAttributeCodeType. |
|
OrderArray.Order .BuyerTaxIdentifier.ID |
string | Conditionally |
This value is the actual tax ID for the buyer. The type of tax ID is shown in the Type field. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .BuyerTaxIdentifier.Type |
ValueTypeCodeType | Conditionally |
This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process. Applicable values: See Type. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.BuyerUserID | UserIDType (string) | Always |
The eBay user ID of the order's buyer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.CancelReason | token | Conditionally |
This value indicates the reason why the order cancellation was initiated. This field is only returned if an order cancellation has been initiated by the buyer or seller. Typical buyer-initiated cancellation reasons include 'OrderPlacedByMistake', 'WontArriveInTime', or 'FoundCheaperPrice'. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as 'BuyerCancelOrder'. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as 'OutOfStock'. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field. Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See CancelReasonCodeType |
| OrderArray.Order.CancelStatus | CancelStatusCodeType | Conditionally |
The current status for the order cancellation request (if it exists for the order). This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled. Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request. Applicable values: See CancelStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus |
CheckoutStatusType | Always |
This container indicates the current status of the order, including a timestamp that indicates the last time that the status of the order changed. For orders that have been paid for, the Status value will show as Complete.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentStatus |
PaymentStatusCodeType | Always |
Indicates the status of the buyer's payment for an order. If the payment was successfuly processed, a value of NoPaymentFailure will be returned.
Applicable values: Note: This value may also get returned for a sales transaction that occurred off of eBay's platform, and the payment status may stay in this state unless the seller marks the order as paid. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .IntegratedMerchantCreditCardEnabled |
boolean | Always |
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .LastModifiedTime |
dateTime | Always |
This timestamp indicates when the order was last modified.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .PaymentInstrument |
BuyerPaymentInstrumentCodeType | Conditionally |
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethod field.
Applicable values: See PaymentInstrument. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus.PaymentMethod |
BuyerPaymentMethodCodeType | Always |
The payment method that the buyer selected to pay for the order. Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus.Status |
CompleteStatusCodeType | Always |
Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status field reads Incomplete when payment has yet to be initiated, Pending when payment has been initiated but is in process, and Complete when the payment process has completed. Note: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The Status value will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
Applicable values: Note: If the PaymentMethodUsed is CashOnPickup, the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Note: If the payment method is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ContainseBayPlusTransaction |
boolean | Conditionally |
If true, the order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: Currently, eBay Plus is available only to buyers in Germany and Australia. See Offering eBay Plus for more details. |
| OrderArray.Order.CreatedTime | dateTime | Always |
Timestamp that indicates the date and time that the order was created. Note: For single line item orders, this timestamp value is often the same as the CreatedDate field in the corresponding Transaction container. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CreatingUserRole |
TradingRoleCodeType | Conditionally |
This value indicates whether a 'Combined Invoice' order was initiated/created by the buyer or by the seller. This field is only returned for Combined Invoice orders. An AddOrder call can be used by a seller or buyer to combine two or more unpaid order line items into a 'Combined Invoice' order. Once two or more line items are successfully combined into one order, the buyer only needs to make one payment (instead of multiple payments - one for each order line item). The CreatingUserRole field is required in the AddOrder call request. Note: Except for listings that required immediate payment, buyers also may have the opportunity to combine multiple line items (from the same seller) into a 'Combined Invoice' order through the buy/checkout flow. This may include accepted Best Offers or auctions that the buyer wins. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Combined Invoice. |
|
OrderArray.Order .eBayCollectAndRemitTax |
boolean | Always |
This boolean field is returned as true if one or more line items in the order are subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false (not subject to eBay Collect and Remit). A Transaction.eBayCollectAndRemitTaxes container is returned for any order line items subject to such a tax, and the type and amount of this tax is displayed in the Transaction.eBayCollectAndRemitTaxes.TaxDetails container. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic. As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic. Note: The ContainingOrder.eBayCollectAndRemitTax field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. |
|
OrderArray.Order .ExtendedOrderID |
string | Conditionally |
A unique identifier for an eBay order in the eBay REST API model. ExtendedOrderID values will be used to identify orders in REST-based APIs, including the Post-Order API and the Fulfillment API. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties. Note: As of June 2019, eBay has changed the format of order identifier values, and this new format is relevant to both legacy and REST API-based order ID fields. 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. 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. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ExternalTransaction |
ExternalTransactionType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1309. No longer recommended. Use MonetaryDetails instead. Container consisting of payment details for an eBay order, including an identifier for the monetary transaction and a field to express any fees or credits applied to the monetary transaction. This field is only returned after payment for the order has occurred. Note: This container will stop being returned on January 31, 2024. The MonetaryDetails container should be used instead. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionID |
string | Conditionally |
Deprecated as of version 1309. Unique identifier for a payment of an eBay order that occurred outside of eBay's system. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionStatus |
PaymentTransactionStatusCodeType | Conditionally |
Deprecated as of version 1309. The current processing status of an external payment for an eBay order. Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionTime |
dateTime | Conditionally |
Deprecated as of version 1309. Timestamp for the payment transaction. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ExternalTransaction .FeeOrCreditAmount |
AmountType (double) | Conditionally |
Deprecated as of version 1309. Fee amount is a positive value and credit amount is a negative value. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
| OrderArray.Order .ExternalTransaction .FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Deprecated as of version 1309.
Fee amount is a positive value and credit amount is a negative value. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ExternalTransaction .PaymentOrRefundAmount |
AmountType (double) | Conditionally |
Deprecated as of version 1309. If this dollar value is a positive amount, this is the amount that the buyer paid the seller through for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer. Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
| OrderArray.Order .ExternalTransaction .PaymentOrRefundAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Deprecated as of version 1309.
If this dollar value is a positive amount, this is the amount that the buyer paid the seller through for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer. Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .IntegratedMerchantCreditCardEnabled |
boolean | Always |
Deprecated as of version 1309. No longer functional. This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments. Note: This field will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .IsMultiLegShipping |
boolean | Conditionally |
If IsMultilegShipping is true, at least one order line item in the order will not be shipped directly to the buyer. Orders requiring multiple shipping legs include international orders being shipped through the Global Shipping Program or through eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container. If an order line item is subject to the Authenticity Guarantee service, the <b>Transaction.Program</b> container will be returned. Note: The ContainingOrder.IsMultiLegShipping field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .LogisticsPlanType |
token | Conditionally |
This field will be returned at the order level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature. Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order is a digital gift card that will be delivered to the buyer or recipient of the gift card by email. Note: The ContainingOrder.LogisticsPlanType field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See LogisticsPlanCodeType |
|
OrderArray.Order .MonetaryDetails |
PaymentsInformationType | Conditionally |
Contains information about each monetary transaction that occurs for the order, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container. Note: The ContainingOrder.MonetaryDetails container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. |
|
OrderArray.Order .MonetaryDetails.Payments |
PaymentInformationType | Conditionally |
Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a Payment container.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment |
PaymentTransactionType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government. Note: Australia import tax is only applicable to the Australia site. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.FeeOrCreditAmount |
AmountType (double) | Conditionally |
Fee Amount is a positive value and Credit Amount is a negative value. This field is not returned if the Payee field's type attribute is eBayPartner.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Fee Amount is a positive value and Credit Amount is a negative value. This field is not returned if the Payee field's type attribute is eBayPartner.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.Payee |
UserIdentityType (string) | Conditionally |
The person or organization who is to receive the payment allocation.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.Payee [ attribute type ] |
UserIdentityCodeType | Conditionally |
The person or organization who is to receive the payment allocation. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.Payer |
UserIdentityType (string) | Conditionally |
This field indicates the eBay user or eBay partner who submitted the payment. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.Payer [ attribute type ] |
UserIdentityCodeType | Conditionally |
This field indicates the eBay user or eBay partner who submitted the payment. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentAmount |
AmountType (double) | Conditionally |
The amount of the payment that is allocated to the payee.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount of the payment that is allocated to the payee. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentReferenceID |
TransactionReferenceType (string) | Conditionally,
repeatable: [0..*] |
The payment transaction ID. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
The payment transaction ID. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentStatus |
PaymentTransactionStatusCodeType | Conditionally |
The current status of a buyer payment that is allocated to a specified payee.
Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentTime |
dateTime | Conditionally |
The date and time when the payment is received by the payee.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.ReferenceID |
TransactionReferenceType (string) | Conditionally |
A unique transaction ID for the payment. This field is not returned if the Payee field's type attribute is eBayPartner. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
A unique transaction ID for the payment. This field is not returned if the Payee field's type attribute is eBayPartner. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .MonetaryDetails.Refunds |
RefundInformationType | Conditionally |
This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item. This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API. Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund |
RefundTransactionInfoType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.FeeOrCreditAmount |
AmountType (double) | Conditionally |
This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Refunds .Refund.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.ReferenceID |
TransactionReferenceType (string) | Conditionally |
This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Refunds .Refund.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundAmount |
AmountType (double) | Conditionally |
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: For GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The logic will remain the same for GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: For GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The logic will remain the same for GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundStatus |
PaymentTransactionStatusCodeType | Conditionally |
This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the Refund container. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundTime |
dateTime | Conditionally |
This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundTo |
UserIdentityType (string) | Conditionally |
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundTo [ attribute type ] |
UserIdentityCodeType | Conditionally |
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .MonetaryDetails.Refunds .Refund.RefundType |
RefundSourceTypeCodeType | Conditionally |
This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails |
MultiLegShippingDetailsType | Conditionally |
This container consists of details related to the first leg of an order requiring multiple shipping legs. Types of orders that require multiple shipping legs include international orders going through Global Shipping Program or eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program. If the item is subject to the Authenticity Guarantee service program, the seller ships the item to the authentication partner, and if the item passes an authentication inspection, the authentication partner ships it directly to the buyer. This container is only returned if the order has one or more order line items requiring multiple shipping legs. Note: The ContainingOrder.MultiLegShippingDetails container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider |
MultiLegShipmentType | Conditionally |
Contains information about the domestic leg of a international order being shipped through the Global Shipping Program or eBay International Shipping, including the selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails |
MultiLegShippingServiceType | Conditionally |
Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .ShippingService |
token | Conditionally |
The shipping service specified for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .TotalShippingCost |
AmountType (double) | Conditionally |
The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .TotalShippingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMax |
int | Conditionally |
The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner. This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMin |
int | Conditionally |
The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner. This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress |
AddressType | Conditionally |
Contains shipping address information for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a Global Shipping Program shipment, this container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order. For an eBay International Shipping shipment, the eBay Virtual Tracking Number is returned in the field.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .AddressAttribute |
AddressAttributeType (string) | Conditionally,
repeatable: [0..*] |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .AddressAttribute [ attribute type ] |
AddressAttributeCodeType | Conditionally |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. For a list of possible enumeration values, see AddressAttributeCodeType. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressID |
string | Conditionally |
Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address. Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressOwner |
AddressOwnerCodeType | Conditionally |
This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressUsage |
AddressUsageCodeType | Conditionally |
Deprecated as of version 1309. No longer functional. This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CityName |
string | Conditionally |
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CountryName |
string | Conditionally |
The full name of the country associated with an address on file with eBay. Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .ExternalAddressID |
string | Conditionally |
Deprecated as of version 1309. No longer functional. This field is no longer applicable, and should no longer be returned. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Max length: 20. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. Max length: 128. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of Invalid Request if you are not authorized to see the user's phone number. In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.ReferenceID |
string | Conditionally |
Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. Example: "Reference #1234567890123456" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.StateOrProvince |
string | Conditionally |
The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.OrderID | OrderIDType (string) | Always |
A unique identifier for a single or multiple line item eBay order. In the ContainingOrder container of a GetItemTransactions or GetSellerTransactions response, this identifier identifies the parent order of the order line item. A single buyer payment is made for each order. For order management calls only: This field is returned with the correct order ID only to the buyer and the seller. For third parties:
Note: The unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the GetOrders and GetOrderTransactions calls, will support the identifiers for both unpaid and paid orders. The revised order ID format (introduced in June 2019) is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. 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. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment. Max length: 40. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.OrderStatus | OrderStatusCodeType | Always |
This enumeration value indicates the current status of the order.
Applicable values: See OrderStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.PaidTime | dateTime | Conditionally |
Timestamp indicating the date and time of order payment. This field is not returned until payment has been made by the buyer. This time is specified in GMT (not Pacific time). See eBay Features Guide for information about converting between GMT and other time zones. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PaymentHoldDetails |
PaymentHoldDetailType | Conditionally |
Deprecated as of version 1309. No longer recommended. Use Transaction.PaymentHoldDetails instead. This container consists of information related to the payment hold on the order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if a payment hold has placed on the order. See PaymentHoldReasonCodeType for some details on why/when a seller's funds may be held, or visit the Pending payments help topic for more information on eBay's payment hold policies. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldDetails .ExpectedReleaseDate |
dateTime | Conditionally |
Deprecated as of version 1309. Timestamp that indicates the expected date in which eBay will distribute the funds to the seller's account. This is not a firm date and is subject to change. This field is only returned after checkout is complete and if the PaymentHoldStatus indicates a hold has been placed on payment. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldDetails .NumOfReqSellerActions |
int | Always |
Deprecated as of version 1309. Integer value that indicates the number of possible actions that a seller can take to possibly expedite the release of funds into their account. This value should equal the number of RequiredSellerAction fields contained in the RequiredSellerActionArray container. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldDetails .PaymentHoldReason |
PaymentHoldReasonCodeType | Conditionally |
Deprecated as of version 1309. Enumerated value that indicates why the buyer's payment for the order is being held by eBay instead of being distributed to the seller's account. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. Applicable values: See PaymentHoldReason. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldDetails .RequiredSellerActionArray |
RequiredSellerActionArrayType | Always |
Deprecated as of version 1309. Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldDetails .RequiredSellerActionArray .RequiredSellerAction |
RequiredSellerActionCodeType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1309. This field contains a possible action that a seller can take to expedite the release of a payment hold. There can be one or more RequiredSellerAction fields in the RequiredSellerActionArray container. Applicable values: See RequiredSellerAction. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .PaymentHoldStatus |
PaymentHoldStatusCodeType | Always |
This field indicates the type and/or status of a payment hold on the item. It is always returned for GetOrders and GetOrderTransactions, even if there are no payment holds (in which case, an enumeration value of None is shown). Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Note: This field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PaymentMethods |
BuyerPaymentMethodCodeType | Always,
repeatable: [1..*] |
In GetOrders, GetOrderTransactions, and OrderReport, a PaymentMethods field will appear for each payment method available to the buyer for the order's purchase. However, once the buyer pays for the order, any and all of these PaymentMethods fields will stop being returned, and instead, the actual payment method used will be returned in the PaymentMethod field of the CheckoutStatus container. In an AddOrder call, the seller can use one or more PaymentMethods fields to override whatever available payment methods were already defined for each individual line item. Note: For AddOrder, the seller can only specify offline payment methods (if offline payment is supported for the listing), as eBay now controls all electronic payment methods avaialable to buyers, and sellers have no control over these payment methods. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.PickupDetails | PickupDetailsType | Conditionally |
Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container. Note: A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.PickupDetails .PickupOptions |
PickupOptionsType | Conditionally,
repeatable: [0..*] |
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container. Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.PickupDetails .PickupOptions.PickupMethod |
token | Conditionally |
This value indicates an available pickup method. This field is always returned with the PickupOptions container. Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases. Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See PickupMethodCodeType |
|
OrderArray.Order.PickupDetails .PickupOptions.PickupPriority |
int | Conditionally |
This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container. Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected |
PickupMethodSelectedType | Conditionally |
Container consisting of details related to the selected pickup method, including the pickup method type, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant). This container is only returned when the buyer has selected the In-Store Pickup or Click and Collect option and has paid for the order. All fields in the PickupMethodSelected container are static, except for the PickupStatus field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API. Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for these features. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected .MerchantPickupCode |
string | Conditionally |
The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected .PickupFulfillmentTime |
dateTime | Conditionally |
Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected .PickupLocationUUID |
string | Conditionally |
The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected .PickupMethod |
token | Conditionally |
This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container. Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See PickupMethodCodeType |
|
OrderArray.Order .PickupMethodSelected .PickupStatus |
PickupStatusCodeType | Conditionally |
This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container. Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: See PickupStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PickupMethodSelected .PickupStoreID |
string | Conditionally |
The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.SellerEmail | string | Conditionally |
The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call. Note: For the GetOrders and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned to the buyer or to a third party. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.SellerUserID | UserIDType (string) | Conditionally |
This is the eBay user ID of the order's seller.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.ShippedTime | dateTime | Conditionally |
Timestamp indicating the date and time of order shipment. This field is not returned until shipment tracking is provided for all line items in the order, or if the order has been marked as 'shipped' by the seller. This time is specified in GMT (not Pacific time). See eBay Features Guide for information about converting between GMT and other time zones. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress |
AddressType | Always |
This container shows the shipping address for the order. Note: For an Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address. Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order. Note: For GetOrderTransactions, the buyer's shipping address may also be returned at the order line item level in the Transaction.Buyer.BuyerInfo.ShippingAddress container. Note: For eBay Vault scenarios: GetOrders, GetOrderTransactions, and GetItemTransactions calls, mock address details are returned for: DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress .AddressAttribute |
AddressAttributeType (string) | Conditionally,
repeatable: [0..*] |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingAddress .AddressAttribute [ attribute type ] |
AddressAttributeCodeType | Conditionally |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. For a list of possible enumeration values, see AddressAttributeCodeType. |
|
OrderArray.Order .ShippingAddress.AddressID |
string | Conditionally |
Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address. Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.AddressOwner |
AddressOwnerCodeType | Conditionally |
This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.AddressUsage |
AddressUsageCodeType | Conditionally |
Deprecated as of version 1309. No longer functional. This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ShippingAddress.CityName |
string | Conditionally |
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.CountryName |
string | Conditionally |
The full name of the country associated with an address on file with eBay. Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress .ExternalAddressID |
string | Conditionally |
Deprecated as of version 1309. No longer functional. This field is no longer applicable, and should no longer be returned. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Max length: 20. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ShippingAddress.Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. Max length: 128. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of Invalid Request if you are not authorized to see the user's phone number. In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress .StateOrProvince |
string | Conditionally |
The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails |
ShippingDetailsType | Always |
Container consisting of order-level shipping details. More shipping-related details can be found at the line item level for each line item in the order. In an AddOrder call, the seller can use the ShippingDetails container to make adjustments to shipping details, including the available shipping service options and shipping cost. Sometimes, sellers will reduce the cost of shipping if one or more order line items can be shipped together in the same package. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ChangePaymentInstructions |
boolean | Conditionally |
Deprecated as of version 1309. No longer recommended. Indicates whether the seller specified payment and shipping instructions during checkout. Note: This field is deprecated and will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ShippingDetails .eBayEstimatedLabelCost |
AmountType (double) | Conditionally |
This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .eBayEstimatedLabelCost [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ExcludeShipToLocation |
string | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1309. No longer recommended. Use GetItem instead. Use this field in an Add/Revise/Relist call to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item. The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list. This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations. Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned. You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.) Specify none in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions responses on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See CountryCodeType, ShippingRegionCodeType Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .ShippingDetails.GetItFast |
boolean | Always |
Note: This field is deprecated and will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption |
InternationalShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International Shipping is offered for the listing). If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (Unbounded) Fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ImportCharge |
AmountType (double) | Conditionally |
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. Min: 0. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditionally |
An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. For flat and calculated shipping. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditionally |
This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified. If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditionally,
repeatable: [0..*] |
An international location or region to where the item seller will ship the item. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Ship-To Locations. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
OrderArray.Order .ShippingDetails.SalesTax |
SalesTaxType | Conditionally |
This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites. This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions. This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead. Note: As of November 2021, buyers in all US states except for Missouri (and several US territories), will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxAmount |
AmountType (double) | Conditionally |
The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order. GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order. GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call. Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level. Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxState |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same. The SalesTaxState field is conditionallly required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with the SalesTax container (whether true or false). Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. With 'eBay Collect and Remit' sales tax, the sales tax is applied against the full cost of the order, including any shipping and handling charges. So, if this field is included for a state that is subject to 'eBay Collect and Remit', this setting is ignored by eBay during checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .SellingManagerSalesRecordNumber |
int | Conditionally |
The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of 0 will be returned to all third parties. The sale record ID can be for a single or a multiple line item order. Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShipmentTrackingDetails |
ShipmentTrackingDetailsType | Conditionally,
repeatable: [0..*] |
Container for the shipping carrier and tracking information associated with the shipment of an order. As each package has a unique tracking number, this container should be repeated for each package in the order. Note: Top-rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 90 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more information on eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. Note: Shipment tracking information does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShipmentTrackingDetails .ShipmentTrackingNumber |
string | Conditionally |
The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. The seller is responsible for the accuracy of the shipment tracking number, as eBay only verifies that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but cannot verify the accuracy of the tracking number. For order management calls, For GetOrders, GetOrderTransactions, GetSellerTransactions, and GetItemTransactions only: This field is only returned if a valid tracking number is set. With the exception of the GetSellerTransactions (where it is only returned to the seller and not buyer), the tracking number will only be returned to the seller or buyer. If a user is using a Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, this field is returned to third parties, but the string value returned in the field will be Unavailable. Note: The Trading API only supports alphanumeric characters for shipment tracking numbers, and any other characters are not supported, including spaces, hyphens, and all other special characters. Users should not enter spaces even if spaces are shown for the tracking number on the shipping label. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShipmentTrackingDetails .ShippingCarrierUsed |
string | Conditionally |
The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When the site ID is Austria, Poland, or UK, ShippingCarrierUsed can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters ( a-z, A-Z), numbers (0-9), space, and dash (-). The site ID is specified in the CompleteSale request header. Note: Commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierDetails.ShippingCarrier field. ShippingCarrierCodeType also has a list of valid shipping carriers, but eBay cannot guarantee that this enumerated type contains a full, updated list of shipping carriers. For the CompleteSale call:
PBI.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingCarrierCodeType |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (Unbounded) Fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ExpeditedService |
boolean | Conditionally |
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ImportCharge |
AmountType (double) | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo |
ShippingPackageInfoType | Conditionally,
repeatable: [0..*] |
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ActualDeliveryTime |
dateTime | Conditionally |
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ScheduledDeliveryTimeMax |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ScheduledDeliveryTimeMin |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ShippingTrackingEvent |
token | Conditionally |
This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingTrackingEventCodeType |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo.StoreID |
string | Conditionally |
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards categories, and to Coins & Paper Money, Postcards, and Stamps. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope. See eBay standard envelope for details and restrictions. For the REST equivalent, see Using the eBay standard envelope (eSE) service.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditionally |
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.TaxTable |
TaxTableType | Conditionally |
Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned. For GetItem, a tax table is returned if it exists when:
DetailLevel: ReturnAll. |
|
OrderArray.Order .ShippingDetails.TaxTable .TaxJurisdiction |
TaxJurisdictionType | Conditionally,
repeatable: [0..*] |
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table. If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions. This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .ShippingDetails.TaxTable .TaxJurisdiction .JurisdictionID |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction. DetailLevel: ReturnAll. |
|
OrderArray.Order .ShippingDetails.TaxTable .TaxJurisdiction .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .ShippingDetails.TaxTable .TaxJurisdiction .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with each TaxJurisdiction container (whether true or false). Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .ShippingServiceSelected |
ShippingServiceOptionsType | Always |
Container consisting of details about the domestic or international shipping service selected by the buyer for delivery of the order. Note that more shipping service information may be returned at the order line item level in the Transaction.ShippingServiceSelected container.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ExpeditedService |
boolean | Conditionally |
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ImportCharge |
AmountType (double) | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo |
ShippingPackageInfoType | Conditionally,
repeatable: [0..*] |
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .ActualDeliveryTime |
dateTime | Conditionally |
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .EstimatedDeliveryTimeMax |
dateTime | Conditionally |
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order. The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .EstimatedDeliveryTimeMin |
dateTime | Conditionally |
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order. The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .HandleByTime |
dateTime | Conditionally |
This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .MaxNativeEstimatedDeliveryTime |
dateTime | Conditionally |
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .MinNativeEstimatedDeliveryTime |
dateTime | Conditionally |
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .ScheduledDeliveryTimeMax |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .ScheduledDeliveryTimeMin |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo .ShippingTrackingEvent |
token | Conditionally |
This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingTrackingEventCodeType |
|
OrderArray.Order .ShippingServiceSelected .ShippingPackageInfo.StoreID |
string | Conditionally |
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ShippingService |
token | Conditionally |
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards categories, and to Coins & Paper Money, Postcards, and Stamps. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope. See eBay standard envelope for details and restrictions. For the REST equivalent, see Using the eBay standard envelope (eSE) service.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .ShippingServiceSelected .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingServicePriority |
int | Conditionally |
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Subtotal | AmountType (double) | Always |
The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Subtotal [ attribute currencyID ] |
CurrencyCodeType | Always |
The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.Total | AmountType (double) | Always |
The Total amount shows the total cost for the order, including total item cost (shown in Subtotal field), shipping charges (shown in ShippingServiceSelected.ShippingServiceCost field), and sales tax (shown in SalesTax.SalesTaxAmount field). Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. In an AddOrder call, the seller can pass in the Total amount for the 'Combined Invoice' order, and this is what the buyer will be expected to pay for the order. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Total [ attribute currencyID ] |
CurrencyCodeType | Always |
The Total amount shows the total cost for the order, including total item cost (shown in Subtotal field), shipping charges (shown in ShippingServiceSelected.ShippingServiceCost field), and sales tax (shown in SalesTax.SalesTaxAmount field). Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher. In an AddOrder call, the seller can pass in the Total amount for the 'Combined Invoice' order, and this is what the buyer will be expected to pay for the order. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray |
TransactionArrayType | Always |
Container consisting of one or more line items that comprise an order. The data for each order line item in the order is stored in a separate Transaction container. Under the TransactionArray container in an AddOrder call, a seller or buyer specifies two or more (up to 40) order line items into a 'Combined Invoice' order. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Combined Invoice. |
|
OrderArray.Order .TransactionArray.Transaction |
TransactionType | Always,
repeatable: [1..*] |
A Transaction container is returned for each line item in the order. This container consists of detailed information on one order line item. For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ActualHandlingCost |
AmountType (double) | Conditionally |
The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ActualHandlingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ActualShippingCost |
AmountType (double) | Conditionally |
The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ActualShippingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .AdjustmentAmount |
AmountType (double) | Always |
This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction. Adjustments to sales transaction costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .AdjustmentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the dollar amount by which the buyer has adjusted the the total cost of the sales transaction. Adjustments to sales transaction costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .AmountPaid |
AmountType (double) | Conditionally |
The total amount the buyer paid for the order line item. This amount includes all costs such as item cost, shipping/handling charges, and sales tax that is applied to the order by the seller. If the seller allowed the buyer to change the total for an order, the buyer is able to change the total up until the time when Checkout status is Complete. Determine whether the buyer changed the amount by retrieving the order line item data and comparing the AmountPaid value to what the seller expected. If multiple order line items between the same buyer and seller have been combined into a 'Combined Invoice' order, the AmountPaid value returned for each line item in the order reflects the total amount paid for the entire order, and not for the individual order line item. In a GetItemTransactions or GetSellerTransactions call, you can determine which order line items belong to the same 'Combined Invoice' order by checking to see if the ContainingOrder.OrderID value is the same.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .AmountPaid [ attribute currencyID ] |
CurrencyCodeType | Always |
The total amount the buyer paid for the order line item. This amount includes all costs such as item cost, shipping/handling charges, and sales tax that is applied to the order by the seller. If the seller allowed the buyer to change the total for an order, the buyer is able to change the total up until the time when Checkout status is Complete. Determine whether the buyer changed the amount by retrieving the order line item data and comparing the AmountPaid value to what the seller expected. If multiple order line items between the same buyer and seller have been combined into a 'Combined Invoice' order, the AmountPaid value returned for each line item in the order reflects the total amount paid for the entire order, and not for the individual order line item. In a GetItemTransactions or GetSellerTransactions call, you can determine which order line items belong to the same 'Combined Invoice' order by checking to see if the ContainingOrder.OrderID value is the same. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .BestOfferSale |
boolean | Always |
Indicates whether or not the sales transaction resulted from the seller accepting a Best Offer (or Counter Offer) from a buyer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
Container consisting of user and shipping details for the order's buyer. To be returned by GetItemsAwaitingFeedback the seller must be the one making the request. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.AboutMePage |
boolean | Conditionally |
A value of true indicates that the user has set up an About Me page. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.eBayGoodStanding |
boolean | Conditionally |
This boolean field is returned as true if the eBay user is in good standing with eBay. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.EIASToken |
string | Conditionally |
Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.
DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.Email |
string | Conditionally |
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ReturnAll. See:
|
|
OrderArray.Order .TransactionArray.Transaction .Buyer.FeedbackPrivate |
boolean | Conditionally |
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.FeedbackRatingStar |
FeedbackRatingStarCodeType | Conditionally |
A visual indicator of an eBay user's Feedback score. A different colored star is used for each range of Feedback scores. See FeedbackRatingStarCodeType for specific values. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See FeedbackRatingStar. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.FeedbackScore |
int | Conditionally |
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in either side of an order. Each order line item can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.IDVerified |
boolean | Conditionally |
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.NewUser |
boolean | Conditionally |
This boolean is returned as true if the eBay user has been registered on eBay for 30 days or less. Note: The Buyer.NewUser field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.RegistrationDate |
dateTime | Conditionally |
Indicates the date the specified user originally registered with eBay. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.Site |
SiteCodeType | Conditionally |
eBay site the user is registered with. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Applicable values: See Site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.StaticAlias |
string | Conditionally |
Deprecated as of version 1309. No longer recommended. Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.) Note: This field will stop being returned on January 31, 2024. DetailLevel: ReturnAll. See Static Email Addresses in Trading API Calls. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.Status |
UserStatusCodeType | Conditionally |
Indicates the user's registration/user status.
Applicable values: See Status. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserAnonymized |
boolean | Conditionally |
Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserFirstName |
string | Conditionally |
The first name of the buyer or seller involved in the order. Note: The Seller.UserFirstName field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserID |
UserIDType (string) | Conditionally |
Unique eBay user ID for the user. Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules: When bidding on items, UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. When bidding on items listed on the Philippines site: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that in this Philippines site format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". For PlaceOffer, see also SellingStatus.HighBidder. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserIDChanged |
boolean | Conditionally |
If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserIDLastChanged |
dateTime | Conditionally |
Date and time when the user last changed their eBay user ID (in GMT). Note: The Buyer.UserIDLastChanged field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.UserLastName |
string | Conditionally |
The last name of the buyer or seller involved in the order. Note: The Seller.UserLastName field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.VATStatus |
VATStatusCodeType | Conditionally |
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. See VATStatus. |
|
OrderArray.Order .TransactionArray.Transaction .BuyerGuaranteePrice |
AmountType (double) | Conditionally |
Deprecated as of version 1309. No longer recommended. The Buyer Guarantee price. This field is only applicable to the Australian site. Note: This field will stop being returned on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
| OrderArray.Order .TransactionArray.Transaction .BuyerGuaranteePrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Deprecated as of version 1309. No longer recommended.
The Buyer Guarantee price. This field is only applicable to the Australian site. Note: This field will stop being returned on January 31, 2024. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .BuyerPackageEnclosures |
BuyerPackageEnclosuresType | Conditionally |
This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .BuyerPackageEnclosures .BuyerPackageEnclosure |
BuyerPackageEnclosureType (string) | Conditionally,
repeatable: [0..*] |
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .BuyerPackageEnclosures .BuyerPackageEnclosure [ attribute type ] |
PaymentInstructionCodeType | Conditionally |
A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site. For a list of possible enumeration values, see PaymentInstructionCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ConvertedAdjustmentAmount |
AmountType (double) | Conditionally |
This field shows the converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. This value should be the same as the value in AdjustmentAmount if the eBay listing site and the site that returned the response are the same, or use the same currency. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ConvertedAdjustmentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This field shows the converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned, even if there was no cost adjustment to the sales transaction. Its value will just be '0.0' if there was no cost adjustment. This value should be the same as the value in AdjustmentAmount if the eBay listing site and the site that returned the response are the same, or use the same currency. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ConvertedAmountPaid |
AmountType (double) | Conditionally |
This field shows the converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for paid orders. This value should be the same as the value in AmountPaid if the eBay listing site and the site that returned the response are the same, or use the same currency. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ConvertedAmountPaid [ attribute currencyID ] |
CurrencyCodeType | Always |
This field shows the converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for paid orders. This value should be the same as the value in AmountPaid if the eBay listing site and the site that returned the response are the same, or use the same currency. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ConvertedTransactionPrice |
AmountType (double) | Conditionally |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ConvertedTransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
This field shows the converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. This field is always returned for sales transactions. This value should be the same as the value in TransactionPrice if the eBay listing site and the site that returned the response are the same, or use the same currency. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Always |
This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a 'Buy It Now' auction listing, a sales transaction is created once the buyer clicks the Buy button.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DepositType |
DepositTypeCodeType | Conditionally |
This value indicates whether or not the seller requires a deposit for the purchase of a motor vehicle. This field is only applicable to motor vehicle listings that require an initial deposit. A value of 'OtherMethod' will be returned if the motor vehicle listing requires an initial deposit, or a value of 'None' if an initial deposit is not required.
Applicable values: This value should be used in an Add/Revise call if the seller is requiring a deposit for a motor vehicle listing. (Not all values in DepositTypeCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected |
DigitalDeliverySelectedType | Conditionally |
This container is only returned by GetOrders and other order management calls if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift (in this case, the Gift boolean field will be returned with a value of true). The DigitalDeliverySelected container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails |
DeliveryDetailsType | Conditionally |
This container is returned by GetOrders and other order management calls to provide details on the recipient of a digital gift card that was purchased. The DeliveryDetails container is only returned if the buyer is buying a digital gift card and giving that gift card to another person.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Recipient |
DigitalDeliveryUserType | Conditionally |
This container consists of the name and email of the person who is receiving the digital gift card. If the buyer has purchased the gift card for themselves, the buyer's name and email will appear in this container. If the buyer is giving the gift card to another individual, that individual's name and email will appear in this container. This container is always returned for a digital gift card line item. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Recipient |
string | Conditionally |
This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Recipient .Name |
string | Conditionally |
This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Sender |
DigitalDeliveryUserType | Conditionally |
This container consists of the name and email of the person who purchased the digital gift card. This container is only returned if the purchaser of the digital gift card is giving the gift card to someone else, and that individual's name and email will appear in the Recipient container. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Sender.Email |
string | Conditionally |
This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryDetails.Sender.Name |
string | Conditionally |
This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryMethod |
token | Conditionally |
This value indicates the method in which the digital gift card will be delivered to the buyer or to the person whom the purchaser is giving the digital gift card to. Currently, the only supported delivery method is by email.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See DeliveryMethodCodeType |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryStatus |
DeliveryStatusType | Conditionally |
This container consists of the current status of whatever delivery method is being used (indicated in the DigitalDeliverySelected.DeliveryMethod field). Currently, the only supported delivery method is by email.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .DigitalDeliverySelected .DeliveryStatus.Email |
token | Conditionally |
This value indicates the current delivery status for the digital gift card that is being delivered by email. Currently, the only supported delivery status value is 'Notified', which indicates that the link to download the digital gift card has been sent to the recipient by email.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See DeliveryStatusEmailCodeType |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTax |
boolean | Conditionally |
This boolean field is returned as true if the line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false (not subject to eBay Collect and Remit). An eBayCollectAndRemitTaxes container is returned if the order line item is subject to such a tax, and the type and amount of this tax is displayed in the eBayCollectAndRemitTaxes.TaxDetails container. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic. As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes |
TaxesType | Conditionally |
This container is returned if the order line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. The type of tax will be shown in the TaxDetails.Imposition and TaxDetails.TaxDescription fields, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic. As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .eBayReference |
eBayTaxReferenceValue (string) | Conditionally |
The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute. Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .eBayReference [ attribute name ] |
string | Conditionally |
The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute. Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails |
TaxDetailsType | Conditionally,
repeatable: [0..*] |
Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.CollectionMethod |
CollectionMethodCodeType | Conditionally |
This field indicates the collection method used to collect the 'eBay Collect and Remit' or 'Good and Services' tax for the order. This field is always returned for orders subject to 'Collect and Remit' or 'Good and Services' tax, and its value is always NET. Note: Although the CollectionMethod field is returned for all orders subject to 'Collect and Remit' sales tax or 'Good and Services' tax, the CollectionMethod field and CollectionMethodCodeType are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes. Applicable values: (Not all values in CollectionMethodCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.Imposition |
TaxTypeCodeType | Conditionally |
This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).
Applicable values: See Imposition. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.TaxAmount |
AmountType (double) | Conditionally |
This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value). TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.TaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value). TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.TaxCode |
string | Conditionally |
This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails.TaxDescription |
TaxDescriptionCodeType | Conditionally |
This enumeration value indicates the type of tax charged against the item.
Applicable values: Note: At this time, this tax type is only applicable to the Australia site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnHandlingAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnHandlingAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnShippingAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnShippingAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnSubtotalAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TaxDetails .TaxOnSubtotalAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TotalTaxAmount |
AmountType (double) | Conditionally |
This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .eBayCollectAndRemitTaxes .TotalTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .eBayPaymentID |
string | Conditionally | The generated eBay payment ID used by the buyer when he/she chooses electronic transfer as payment method for paying the seller. This field is only applicable to the eBay Germany site (Site ID 77). |
|
OrderArray.Order .TransactionArray.Transaction .eBayPlusTransaction |
boolean | Conditionally |
If true, the buyer of the order line item has a eBay Plus program subscription, and is eligible to receive the benefits of this program, such as fast, free shipping and free returns. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: Currently, eBay Plus is available only to buyers in Germany and Australia. See Offering eBay Plus for more details. |
|
OrderArray.Order .TransactionArray.Transaction .ExtendedOrderID |
string | Conditionally |
A unique identifier for an eBay order. This field is only returned for paid orders, and not unpaid orders. Note: ExtendedOrderID was first created when eBay changed the format of Order IDs back in June 2019. For a short period, the OrderID field showed the old Order ID format and the ExtendedOrderID field showed the new Order ID format. For paid orders, both OrderID and ExtendedOrderID now show the same Order ID value. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties. Max length: 40. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction |
ExternalTransactionType | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1309. No longer recommended. Use Transaction.MonetaryDetails instead. Container consisting of payment details for an eBay sales transaction, including an identifier for the monetary transaction and a field to express any fees or credits applied to the monetary transaction. This field is only returned after payment for the order has occurred. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real transaction identifier is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties. Note: This container will stop being returned on January 31, 2024. The MonetaryDetails container should be used instead. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .ExternalTransactionID |
string | Conditionally |
Deprecated as of version 1309. Unique identifier for a payment of an eBay order that occurred outside of eBay's system. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .ExternalTransactionStatus |
PaymentTransactionStatusCodeType | Conditionally |
Deprecated as of version 1309. The current processing status of an external payment for an eBay order. Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .ExternalTransactionTime |
dateTime | Conditionally |
Deprecated as of version 1309. Timestamp for the payment transaction. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .FeeOrCreditAmount |
AmountType (double) | Conditionally |
Deprecated as of version 1309. Fee amount is a positive value and credit amount is a negative value. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
| OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Deprecated as of version 1309.
Fee amount is a positive value and credit amount is a negative value. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .PaymentOrRefundAmount |
AmountType (double) | Conditionally |
Deprecated as of version 1309. If this dollar value is a positive amount, this is the amount that the buyer paid the seller through for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer. Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
| OrderArray.Order .TransactionArray.Transaction .ExternalTransaction .PaymentOrRefundAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Deprecated as of version 1309.
If this dollar value is a positive amount, this is the amount that the buyer paid the seller through for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer. Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .FinalValueFee |
AmountType (double) | Conditionally |
A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, regardless of the checkout status. If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .FinalValueFee [ attribute currencyID ] |
CurrencyCodeType | Always |
A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, regardless of the checkout status. If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Gift |
boolean | Conditionally |
This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
|
|
OrderArray.Order .TransactionArray.Transaction .GiftSummary |
GiftSummaryType | Conditionally |
This container is returned in GetOrders and other order management calls if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient. The GiftSummary container consists of the message that the buyer wrote for the recipient of the digital gift card. A digital gift card line item is indicated if the DigitalDeliverySelected container is returned in the response, and if the digital gift card is sent to another individual as a gift, the Gift boolean field will be returned with a value of true.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .GiftSummary.Message |
string | Conditionally |
This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card. For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .GuaranteedDelivery |
boolean | Always |
This field is deprecated, and can be ignored if returned. The Guaranteed Delivery program is no longer supported on any eBay marketplace.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .GuaranteedShipping |
boolean | Conditionally |
Note: This field is for future use, as the eBay Guaranteed Shipping feature has been put on hold. eBay Guaranteed Shipping should not be confused with eBay Guaranteed Delivery, which is a completely different feature. This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time. With eBay's Guaranteed Shipping, the seller will never pay more for shipping than what is charged to the buyer. eBay recommends the shipping service option for the seller to use based on the dimensions and weight of the shipping package.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .IntangibleItem |
boolean | Always |
This flag indicates whether or not the order line item is an intangible good, such as an MP3 track or a mobile phone ringtone.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .InventoryReservationID |
string | Conditionally |
The unique identifier of the inventory reservation.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .InvoiceSentTime |
dateTime | Conditionally |
This field indicates the date/time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer.
DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .IsMultiLegShipping |
boolean | Conditionally |
Order line items requiring multiple shipping legs include items being shipped through the Global Shipping Program or through eBay International Shipping, as well as order line items subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container. If an order line item is subject to the Authenticity Guarantee service, the Transaction.Program container will be returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item |
ItemType | Always |
This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call. In an AddOrder call, only the unique identifier of the listing (ItemID) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ApplicationData |
string | Conditionally |
Return custom, application-specific data associated with the item. The data you specify is stored by eBay with the item for your own reference, but it is not used by eBay in any way. Use ApplicationData to store special information for yourself, such as a part number. For a SKU in an eBay.com listing, use the SKU element instead. To remove this value when revising or relisting an item, use DeletedField. Max length: 32. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.AutoPay |
boolean | Always |
This field is included and set to if true in an Add/Revise/Relist call if the seller wants to require immediate payment from the buyer. If this field is set to false or not included, the seller is not requesting immediate payment. Note that this field may be set to true, but that does not necessarily mean that the buyer will be required to pay right away. For example, immediate payment is not currently applicable to auctions items won in a competitive bidding process or to items where the buyer and seller negotiated the price through the Best Offer feature. Immediate payment is also not applicable to listings where the payment happens offline between the buyer and seller.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.BuyerProtection |
BuyerProtectionCodeType | Conditionally |
The enumeration value returned in this field indicates whether an item is eligible for the buyer protection. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. Applicable values: See BuyerProtection. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.BuyItNowPrice |
AmountType (double) | Conditionally |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Item.BuyItNowPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
This field is only applicable for auction listings. By specifying a 'Buy It Now' price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. When a buyer uses the 'Buy It Now' option to purchase the item, the auction listing will end immediately. By including this field and specifying a 'Buy It Now' price, the seller is enabling the 'Buy It Now' feature on the auction listing. If the seller includes this field for any other listing type other than an auction, this field and its price will just be ignored. The price in this field must be at least 30 percent higher than the starting bid price (which is specified in an Add call through the Item.StartPrice field). Once a bid is made on an auction listing, and the bid meets or exceeds the Item.ReservePrice value (if set), the 'Buy It Now' option becomes unavailable, and this field will no longer be applicable. If there is no Reserve Price, the first bid will nullify the 'Buy It Now' option. Keep in mind that GetItem (and other 'Get' calls that retrieve the Item details) may still return the BuyItNowPrice field for an auction item even if the 'Buy It Now' option is no longer available. Instead, a user should look for the ListingDetails.BuyItNowAvailable boolean field in the GetItem response to determine if the 'Buy It Now' option is still available for the auction item. Note: For the US site, new eBay sellers are subject to Seller Limits, which limit the quantity of items that may be listed and/or the total cumulative value of these listings. While subject to these selling limits, an eBay seller can use the GetMyeBaySelling call to retrieve both the remaining number of listings they can create and the remaining cumulative value of these listings. These values are shown in the Summary.QuantityLimitRemaining and Summary.AmountLimitRemaining fields in the GetMyeBaySelling response. If a call to add an item or revise an item would result in the exceeding of these limits, the add item or revise item call will fail. These fields will only be returned if the seller is subject to seller limits. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Charity |
CharityType | Conditionally |
This container identifies the nonprofit organization that will benefit with a percentage of the proceeds from each sale of an item through an auction or fixed-price listing. Charity names and IDs can be found by going to eBay for Charity page and doing a search. The donation percentage can be set in 5 percent increments from 10 percent to 100 percent. When it comes to revising an auction or fixed-price listing, you can add a benefitting charity (as long as there is at least 12 hours left before end of listing/close of auction), but you cannot remove or change a nonprofit company once one is already established in the original listing. For Revise calls: The non-profit organization and donation percentage can now be modified in a Revise call as long as there are no active bids on an auction listing, or no pending Best Offers/Counter Offers on a listing. This container will only be returned in Get calls for charitable listings. Charitable listings are only supported in the US and UK marketplaces. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .Item.Charity.CharityID |
string | Conditionally |
The unique identifier that eBay creates and assigns to each nonprofit organization. The field is conditionally required in an Add/Revise/Relist call if the seller will be donating a percentage of the sale proceeds to this organization for each sale generated by the listing. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Charity.CharityListing |
boolean | Conditionally |
If this field is returned as true, a percentage of order line item's purchase price will be donated to a nonprofit organization.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Charity.CharityName |
string | Conditionally |
The full name of the nonprofit organization. Max length: 150. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Charity.DonationPercent |
float | Conditionally |
The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the eBay for Charity listing. Possible values: 10.0 to 100.0.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ConditionDisplayName |
string | Always |
The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed). Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another. Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished. Only returned when the seller specified ConditionID in their listing. Note: This field will stop being returned in order management calls on January 31, 2024. Max length: 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ConditionID |
int | Always |
This is a numeric identifier for an item's condition. All numeric Condition ID values map to an item condition string value. For example, numeric identifier 1000 maps to New condition. Important: For trading card listings in Non-Sport Trading Card Singles ( 183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, Condition ID 2750 can be used to specify the card as a Graded card and Condition ID 4000 can be used to specify the card as an Ungraded card. If either of these condition IDs are used, the seller is required to use the ConditionDescriptors container to provide one or more applicable Condition Descriptor name-value pairs. See the ConditionDescriptors field description for more information. Beginning on October 23rd, 2023, trading card listings in the affected categories must either use Condition ID 2750 or Condition ID 4000, and no other item conditions will be accepted. These Condition IDs and the ConditionDescriptors container will be required for all new listings. If not provided after this date, the following calls will fail: AddItem, AddFixedPriceItem, AddItems, VerifyAddItem, and VerifyAddFixedPriceItem. By January 22, 2024, all existing listings must be modified with either Condition ID 2750 or Condition ID 4000 and applicable ConditionDescriptors name-value pairs. This adds ReviseItem, ReviseFixedPriceItem, RelistItem, RelistFixedPriceItem, and VerifyRelistItem calls to the requirement. Most eBay listing categories require an item condition, but a few eBay categories do not (such as Digital Gift Cards or Antiques categories). To verify if the listing category requires an item condition, and if so, what are the supported item condition and ConditionID values, you can call GetCategoryFeatures. In this GetCategoryFeatures call, you'd pass in the listing CategoryID value and two FeatureID fields - one of these fields set to ConditionEnabled, and the other field set to ConditionValues. In the GetCategoryFeatures response, look at the Category.ConditionEnabled to see if item condition is required for the category. Then look at the Category.ConditionValues container in the response for the full list of Condition IDs that you can pass in through the ConditionID field of an Add/Revise/Relist/Verify call. Note that the Condition.DisplayName value in the response is the actual condition value that will appear in the actual eBay listing. If you pass in a ConditionID value that is not valid for the category, or if you don't pass in a ConditionID value at all for a category that requires it, the listing request fails. If you are listing in two categories (using a secondary category), it is the primary listing category that determines which ConditionID values are supported. For Revise/Relist calls: In most cases, you can change the ConditionID value (if applicable/warranted), with the exception being an auction listing that has one or more bids, or any listing that is scheduled to end in 12 hours or less. For GetItem: The ConditionID value is always returned if set for the listing. GetItem also returns the item condition string value in the ConditionDisplayName field. Note: On the US, Canada, UK, Germany, France, Italy, and Australia marketplaces, condition ID 2500 ('Seller Refurbished') can no longer be used in numerous categories. See Category and marketplace support for the eBay Refurbished Program for the full list. In these categories, the 'Seller Refurbished' item condition has been replaced by one of three new refurbished values, which include condition ID 2010 ('Excellent - Refurbished'), condition ID 2020 ('Very Good - Refurbished'), and condition ID 2030 ('Good - Refurbished'). To use any of these new refurbished item conditions, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in these three categories will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Sellers who are not eligible to list with the new refurbished item conditions, will need to use another item condition supported in these categories, such as condition ID 3000 ('Used'). Any seller that is interested in eligibility requirements to list with any refurbished item condition, including condition ID 2000 ('Certified - Refurbished'), should see the eBay Refurbished Program page in Seller Center. Note: This field will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .Item .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments. Note: This field will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ItemID |
ItemIDType (string) | Always |
The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ListingType |
ListingTypeCodeType | Always |
The selling format of the eBay listing, such as auction (indicated with Chinese value), fixed-price (indicated with FixedPriceItem value), or classified ad (indicated with AdType value). If this field is not included in an AddItem, AddItems, or VerifyAddItem call, the listing type defaults to auction For AddFixedPriceItem, RelistFixedPriceItem, or VerifyAddFixedPriceItem call, this field must be included and set to FixedPriceItem, since these calls only work with fixed-price listings. This field is not applicable to Revise calls because the selling format of active listings cannot be changed. Applicable values: See ListingType. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.PrivateListing |
boolean | Always |
A true value in this field indicates that the listing is private. Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. For ReviseItem/ReviseFixedPriceItem: The seller will not be able change this setting if the listing has any pending bids, any pending best offers, previous sales (for multiple-quantity, fixed-price listing), or if the listing will end within 12 hours. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus |
SellingStatusType | Always |
Various details about the current status of the listing, such as the current number of bids, the current high bidder, quantity sold, current price, and listing status.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice |
AmountType (double) | Conditionally |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .ConvertedCurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites). In multi-variation listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice |
AmountType (double) | Conditionally |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .CurrentPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
The current price of the item in the original listing currency. For auction listings, this price is the starting minimum price (if the listing has no bids) or the current highest bid (if bids have been placed) for the item. This does not reflect the BuyItNow price. For fixed-price and ad format listings, this is the current listing price. In multi-variation, fixed-price listings, this value matches the lowest-priced variation that is still available for sale. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .FinalValueFee |
AmountType (double) | Conditionally |
A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment. The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page. The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status. If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data. See the Selling fees help page for more information about how Final Value Fees are calculated. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .FinalValueFee [ attribute currencyID ] |
CurrencyCodeType | Always |
A seller is changed a Final Value Fee (FVF) when the item is sold, ends with a winning bid, or is purchased. This fee applies whether or not the sale is completed with the buyer and is generated before the buyer makes a payment. The FVF is calculated using a percentage. This percentage is based on whether the seller has a Store subscription or not. If a seller does have a Store subscription, the FVF is calculated based on the level of that plan. For complete information about selling fees and eBay Store subscription plans, see the Fee Center Home Page. The Final Value Fee for each order line item is returned by GetSellerTransactions, GetItemTransactions, GetOrders, and GetOrderTransactions, regardless of the checkout status. If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data. See the Selling fees help page for more information about how Final Value Fees are calculated. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellingStatus .ListingStatus |
ListingStatusCodeType | Conditionally |
Specifies an active or ended listing's status in eBay's processing workflow.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .LogisticsPlanType |
token | Conditionally |
This field will be returned at the order line item level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature. Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order line item is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See LogisticsPlanCodeType |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails |
PaymentsInformationType | Conditionally |
Contains information about each monetary transaction that occurs for the order line item, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container. Note: MonetaryDetails can already be used instead of the older ExternalTransaction container, and the ExternalTransaction container may eventually get deprecated. Due to this possibility, you are encouraged to start using MonetaryDetails as soon as it is convenient. DetailLevel: ItemReturnDescription, ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments |
PaymentInformationType | Conditionally |
Contains information about how different portions of the funds exchanged for a specified order are allocated among payees. Each allocated portion is represented by a Payment container.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment |
PaymentTransactionType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government. Note: Australia import tax is only applicable to the Australia site. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.FeeOrCreditAmount |
AmountType (double) | Conditionally |
Fee Amount is a positive value and Credit Amount is a negative value. This field is not returned if the Payee field's type attribute is eBayPartner.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Fee Amount is a positive value and Credit Amount is a negative value. This field is not returned if the Payee field's type attribute is eBayPartner.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payee |
UserIdentityType (string) | Conditionally |
The person or organization who is to receive the payment allocation.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payee [ attribute type ] |
UserIdentityCodeType | Conditionally |
The person or organization who is to receive the payment allocation. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payer |
UserIdentityType (string) | Conditionally |
This field indicates the eBay user or eBay partner who submitted the payment. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payer [ attribute type ] |
UserIdentityCodeType | Conditionally |
This field indicates the eBay user or eBay partner who submitted the payment. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentAmount |
AmountType (double) | Conditionally |
The amount of the payment that is allocated to the payee.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount of the payment that is allocated to the payee. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentReferenceID |
TransactionReferenceType (string) | Conditionally,
repeatable: [0..*] |
The payment transaction ID. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
The payment transaction ID. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentStatus |
PaymentTransactionStatusCodeType | Conditionally |
The current status of a buyer payment that is allocated to a specified payee.
Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentTime |
dateTime | Conditionally |
The date and time when the payment is received by the payee.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.ReferenceID |
TransactionReferenceType (string) | Conditionally |
A unique transaction ID for the payment. This field is not returned if the Payee field's type attribute is eBayPartner. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
A unique transaction ID for the payment. This field is not returned if the Payee field's type attribute is eBayPartner. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds |
RefundInformationType | Conditionally |
This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item. This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API. Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund |
RefundTransactionInfoType | Conditionally,
repeatable: [0..*] |
This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.FeeOrCreditAmount |
AmountType (double) | Conditionally |
This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.ReferenceID |
TransactionReferenceType (string) | Conditionally |
This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundAmount |
AmountType (double) | Conditionally |
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: For GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The logic will remain the same for GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT). Note: For GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount. The logic will remain the same for GetItemTransactions, GetSellerTransactions, and GetOrderTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundStatus |
PaymentTransactionStatusCodeType | Conditionally |
This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. This field is always returned with the Refund container. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Succeeded value is returned in an order management call, it is safe for the seller to ship the order to the buyer. Note: Previously, the Succeeded value would automatically get returned for order payment transactions that were occurring off of eBay's platform. As of March 2020, the Pending value will get returned instead for order payment transactions occurring off of eBay's platform, and the seller can use the CompleteSale call to mark the order as paid. Once the seller does this, the payment status will change from Pending to Succeeded. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundTime |
dateTime | Conditionally |
This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED). Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundTo |
UserIdentityType (string) | Conditionally |
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundTo [ attribute type ] |
UserIdentityCodeType | Conditionally |
This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Refunds .Refund.RefundType |
RefundSourceTypeCodeType | Conditionally |
This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails |
MultiLegShippingDetailsType | Conditionally |
This container consists of details related to the first leg of an order requiring multiple shipping legs. Types of orders that require multiple shipping legs include international orders going through the Global Shipping Program or through eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program.If the item is subject to the Authenticity Guarantee service program, the seller ships the item to the authentication partner, and if the item passes an authentication inspection, the authentication partner ships it directly to the buyer. This container is only returned if the order has one or more order line items requiring multiple shipping legs. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider |
MultiLegShipmentType | Conditionally |
Contains information about the domestic leg of a international order being shipped through the Global Shipping Program or eBay International Shipping, including the selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails |
MultiLegShippingServiceType | Conditionally |
Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .ShippingService |
token | Conditionally |
The shipping service specified for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .TotalShippingCost |
AmountType (double) | Conditionally |
The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .TotalShippingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMax |
int | Conditionally |
The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner. This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMin |
int | Conditionally |
The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner. This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress |
AddressType | Conditionally |
Contains shipping address information for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a Global Shipping Program shipment, this container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order. For an eBay International Shipping shipment, the eBay Virtual Tracking Number is returned in the field.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .AddressAttribute |
AddressAttributeType (string) | Conditionally,
repeatable: [0..*] |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .AddressAttribute [ attribute type ] |
AddressAttributeCodeType | Conditionally |
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. For a list of possible enumeration values, see AddressAttributeCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressID |
string | Conditionally |
Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address. Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressOwner |
AddressOwnerCodeType | Conditionally |
This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressUsage |
AddressUsageCodeType | Conditionally |
Deprecated as of version 1309. No longer functional. This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CityName |
string | Conditionally |
The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made. Applicable values: See Country. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CountryName |
string | Conditionally |
The full name of the country associated with an address on file with eBay. Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .ExternalAddressID |
string | Conditionally |
Deprecated as of version 1309. No longer functional. This field is no longer applicable, and should no longer be returned. Note: This field will stop being returned and removed from the WSDL on January 31, 2024. Max length: 20. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Name |
string | Conditionally |
The eBay user's name associated with an address on file with eBay. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024. Max length: 128. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of Invalid Request if you are not authorized to see the user's phone number. In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.PostalCode |
string | Conditionally |
User's postal code. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.ReferenceID |
string | Conditionally |
Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. Example: "Reference #1234567890123456" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.StateOrProvince |
string | Conditionally |
The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street1 |
string | Conditionally |
The first line of the user's street address. Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street2 |
string | Conditionally |
The second line of the user's street address (such as an apartment number or suite number). Returned if the user specified a second street value for their address. Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456" Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This identifier is created as soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties. |
|
OrderArray.Order .TransactionArray.Transaction .PaidTime |
dateTime | Conditionally |
Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer. This value will only be visible to the user on either side of the order. An order can be marked as 'Paid' in the following ways:
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails |
PaymentHoldDetailType | Conditionally |
This container consists of information related to the payment hold on the order line item, including the reason why the buyer's payment for the order line item is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if a payment hold has been placed on the order line item. See PaymentHoldReasonCodeType for some details on why/when a seller's funds may be held, or visit the Pending payments help topic for more information on eBay's payment hold policies. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .ExpectedReleaseDate |
dateTime | Conditionally |
Timestamp that indicates the expected date in which eBay will distribute the funds to the seller's account. This is not a firm date and is subject to change. This field is only returned after checkout is complete and if the PaymentHoldStatus indicates a hold has been placed on payment. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .NumOfReqSellerActions |
int | Always |
Integer value that indicates the number of possible actions that a seller can take to possibly expedite the release of funds into their account. This value should equal the number of RequiredSellerAction fields contained in the RequiredSellerActionArray container. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .PaymentHoldReason |
PaymentHoldReasonCodeType | Conditionally |
Enumerated value that indicates why the buyer's payment for the order is being held by eBay instead of being distributed to the seller's account. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. Applicable values: See PaymentHoldReason. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .RequiredSellerActionArray |
RequiredSellerActionArrayType | Always |
Container consisting of one or more RequiredSellerAction fields. RequiredSellerAction fields provide possible actions that a seller can take to expedite the release of funds into their account. Note: The Order.PaymentHoldDetails and ContainingOrder.PaymentHoldDetails containers and child fields will stop being returned on January 31, 2024 and will be removed from the Trading WSDL. Payment hold details can be viewed at the transaction level instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .RequiredSellerActionArray .RequiredSellerAction |
RequiredSellerActionCodeType | Conditionally,
repeatable: [0..*] |
This field contains a possible action that a seller can take to expedite the release of a payment hold. There can be one or more RequiredSellerAction fields in the RequiredSellerActionArray container.
Applicable values: See RequiredSellerAction. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PayPalEmailAddress |
string | Conditionally |
Deprecated as of version 1309. No longer functional. This field is deprecated. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected |
PickupMethodSelectedType | Conditionally |
This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .MerchantPickupCode |
string | Conditionally |
The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .PickupFulfillmentTime |
dateTime | Conditionally |
Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .PickupLocationUUID |
string | Conditionally |
The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .PickupMethod |
token | Conditionally |
This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container. Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See PickupMethodCodeType |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .PickupStatus |
PickupStatusCodeType | Conditionally |
This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container. Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. Applicable values: See PickupStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PickupMethodSelected .PickupStoreID |
string | Conditionally |
The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container. Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Platform |
TransactionPlatformCodeType | Always |
This value indicates the site on which the sales transaction originated. Note: Currently, the only value that should be returned in this field is eBay, as the Half.com marketplace no longer exists.
Applicable values: (Not all values in TransactionPlatformCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program |
TransactionProgramType | Conditionally |
This container gives the status of an order line item going through the Authenticity Guarantee service process. In the Authenticity Guarantee service program, a third-party authenticator must verify the authenticity of the item before it can be sent to the buyer. This container is only returned for order line items subject to the Authenticity Guarantee service process, and if it is returned, the seller must make sure to send the item to the third-party authenticator's address (shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress field), and not to the buyer's shipping address. If the item is successfully authenticated, the authenticator will ship the item to the buyer. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification |
AuthenticityVerificationType | Conditionally |
This container gives status on whether the order line item has passed or failed the authenticity inspection.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .OutcomeReason |
string | Conditionally |
This field is returned after the third-party authenticator has performed the authentication inspection on the order line item. Different values will be returned based on whether the item passed or failed the authentication inspection. This field is not returned when the status value of the order line item is PENDING or PASSED. The possible values returned here are CUSTOMIZED, MISCATEGORIZED, NOT_AUTHENTIC, NOT_AS_DESCRIBED, or NOT_AUTHENTIC_NO_RETURN.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .ServiceCost |
ServiceCostType | Conditionally |
This container shows service cost to the buyer for an item that will go through the Authenticity Guarantee process.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .ServiceCost.Amount |
AmountType (double) | Conditionally |
The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .ServiceCost.Amount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .ServiceCost .ConvertedFromAmount |
AmountType (double) | Conditionally |
The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .ServiceCost .ConvertedFromAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Program .AuthenticityVerification .Status |
string | Conditionally |
The value in this field indicates whether the order line item has passed or failed the authenticity inspection, or if the test and/or results are still pending. The possible values returned here are PENDING, PASSED, PASSED_WITH_EXCEPTION, PASSED_WITH_PARTIAL_FAILURE, or FAILED.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program.Fulfillment |
FulfillmentType | Conditionally |
This container 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.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program.Fulfillment .FulfillmentBy |
string | Conditionally |
The value returned in this field indicates the party that is handling fulfillment of the order line item. For eBay Vault scenarios, for the GetOrders, GetOrderTransactions, GetItemTransactions, and GetSellerTransactions calls, this value is returned as EBAY for either of the following fulfillment options:
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Program.Fulfillment .FulfillmentRefId |
string | Conditionally |
The value in this field identifies the warehouse where the order line item is located. For eBay Vault scenarios: GetOrders, GetOrderTransactions, GetItemTransactions, and GetSellerTransactions calls, if FulfillmentBy is returned as EBAY, FulfillmentRefId is not returned.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .QuantityPurchased |
int | Conditionally |
This value indicates the quantity of the line item purchased at the same time by the same buyer from one listing. For auction listings, this value is always '1'. For fixed-price, non-variation listings, this value can be greater than 1.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts |
SellerDiscountsType | Conditionally |
A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item. This container is only returned if the order line item is eligible for seller discounts.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalItemPrice |
AmountType (double) | Conditionally |
The original purchase price of the order line item (before any seller discounts are applied).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalItemPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
The original purchase price of the order line item (before any seller discounts are applied). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalItemShippingCost |
AmountType (double) | Conditionally |
The original shipping cost for the order line item (before any seller discounts are applied).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalItemShippingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
The original shipping cost for the order line item (before any seller discounts are applied). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalShippingService |
token | Conditionally |
The original shipping service offered by the seller to ship an item to a buyer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount |
SellerDiscountType | Conditionally,
repeatable: [0..*] |
A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .CampaignDisplayName |
string | Conditionally |
The name of the seller discount campaign. This field will only be returned with the SellerDiscount container if defined for the seller discount campaign.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount.CampaignID |
long | Conditionally |
Unique identifier for a seller discount campaign. This ID is automatically created when the seller creates the discount campaign. This field is always returned with the SellerDiscount container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ItemDiscountAmount |
AmountType (double) | Conditionally |
The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign. Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ItemDiscountAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign. Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ShippingDiscountAmount |
AmountType (double) | Conditionally |
The dollar amount of the shipping discount applied to the order line item.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ShippingDiscountAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The dollar amount of the shipping discount applied to the order line item. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails |
ShippingDetailsType | Conditionally |
Container consisting of shipping-related details for a sales transaction. Shipping details may include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, sales tax information (if applicable), and shipment tracking details (if shipped). Note: For GetOrders and GetOrderTransactions, a ShippingDetails container is returned at the order at line item level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ChangePaymentInstructions |
boolean | Conditionally |
Deprecated as of version 1309. No longer recommended. Indicates whether the seller specified payment and shipping instructions during checkout. Note: This field is deprecated and will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .eBayEstimatedLabelCost |
AmountType (double) | Conditionally |
This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.
|
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .eBayEstimatedLabelCost [ attribute currencyID ] |
CurrencyCodeType | Always |
This dollar value indicates the cost to buy the shipping label from eBay. Presently, this field is only returned for orders that will go through eBay shipping and its value will be 0.0. With eBay shipping, a free shipping label by eBay is downloadable by the seller via the eBay website.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ExcludeShipToLocation |
string | Conditionally,
repeatable: [0..*] |
Deprecated as of version 1309. No longer recommended. Use GetItem instead. Use this field in an Add/Revise/Relist call to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item. The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list. This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations. Note: The ShipToLocations and ShippingDetails.ExcludeShipToLocation containers are not applicable for motor vehicle listings on the US, CA, or UK marketplaces. If these containers are sent in the request, they are ignored and a warning is returned. You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.) Specify none in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing. Note: This field will stop being returned in GetItemTransactions and GetSellerTransactions responses on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See CountryCodeType, ShippingRegionCodeType Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.GetItFast |
boolean | Always |
Note: This field is deprecated and will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption |
InternationalShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International Shipping is offered for the listing). If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (Unbounded) Fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ImportCharge |
AmountType (double) | Conditionally |
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. Min: 0. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditionally |
An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. For flat and calculated shipping. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditionally |
This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified. If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditionally,
repeatable: [0..*] |
An international location or region to where the item seller will ship the item. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Ship-To Locations. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax |
SalesTaxType | Conditionally |
This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites. This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions. This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead. Note: As of November 2021, buyers in all US states except for Missouri (and several US territories), will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxAmount |
AmountType (double) | Conditionally |
The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order. GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order. GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the OrderLineItemID to call GetOrderTransactions. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call. Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level. Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxState |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same. The SalesTaxState field is conditionallly required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with the SalesTax container (whether true or false). Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. With 'eBay Collect and Remit' sales tax, the sales tax is applied against the full cost of the order, including any shipping and handling charges. So, if this field is included for a state that is subject to 'eBay Collect and Remit', this setting is ignored by eBay during checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .SellingManagerSalesRecordNumber |
int | Conditionally |
The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of 0 will be returned to all third parties. The sale record ID can be for a single or a multiple line item order. Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShipmentTrackingDetails |
ShipmentTrackingDetailsType | Conditionally,
repeatable: [0..*] |
Container for the shipping carrier and tracking information associated with the shipment of an order. As each package has a unique tracking number, this container should be repeated for each package in the order. Note: Top-rated sellers must have a record of uploading shipment tracking information (through site or through API) for at least 90 percent of their order line items (purchased by U.S. buyers) to keep their status as Top-rated sellers. For more information on eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. Note: Shipment tracking information does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShipmentTrackingDetails .ShipmentTrackingNumber |
string | Conditionally |
The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. The seller is responsible for the accuracy of the shipment tracking number, as eBay only verifies that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but cannot verify the accuracy of the tracking number. For order management calls, For GetOrders, GetOrderTransactions, GetSellerTransactions, and GetItemTransactions only: This field is only returned if a valid tracking number is set. With the exception of the GetSellerTransactions (where it is only returned to the seller and not buyer), the tracking number will only be returned to the seller or buyer. If a user is using a Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, this field is returned to third parties, but the string value returned in the field will be Unavailable. Note: The Trading API only supports alphanumeric characters for shipment tracking numbers, and any other characters are not supported, including spaces, hyphens, and all other special characters. Users should not enter spaces even if spaces are shown for the tracking number on the shipping label. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShipmentTrackingDetails .ShippingCarrierUsed |
string | Conditionally |
The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When the site ID is Austria, Poland, or UK, ShippingCarrierUsed can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters ( a-z, A-Z), numbers (0-9), space, and dash (-). The site ID is specified in the CompleteSale request header. Note: Commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierDetails.ShippingCarrier field. ShippingCarrierCodeType also has a list of valid shipping carriers, but eBay cannot guarantee that this enumerated type contains a full, updated list of shipping carriers. For the CompleteSale call:
PBI.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingCarrierCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See Repeating (Unbounded) Fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1). |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ExpeditedService |
boolean | Conditionally |
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ImportCharge |
AmountType (double) | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo |
ShippingPackageInfoType | Conditionally,
repeatable: [0..*] |
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ActualDeliveryTime |
dateTime | Conditionally |
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ScheduledDeliveryTimeMax |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ScheduledDeliveryTimeMin |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo .ShippingTrackingEvent |
token | Conditionally |
This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingTrackingEventCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingPackageInfo.StoreID |
string | Conditionally |
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards categories, and to Coins & Paper Money, Postcards, and Stamps. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope. See eBay standard envelope for details and restrictions. For the REST equivalent, see Using the eBay standard envelope (eSE) service.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditionally |
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.TaxTable |
TaxTableType | Conditionally |
Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned. For GetItem, a tax table is returned if it exists when:
DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.TaxTable .TaxJurisdiction |
TaxJurisdictionType | Conditionally,
repeatable: [0..*] |
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table. If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions. This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.TaxTable .TaxJurisdiction .JurisdictionID |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.TaxTable .TaxJurisdiction .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.TaxTable .TaxJurisdiction .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with each TaxJurisdiction container (whether true or false). Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected |
ShippingServiceOptionsType | Conditionally |
The shipping service actually selected by the buyer from the shipping services offered by the seller. The buyer typically selects the shipping service at checkout/payment time.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ExpeditedService |
boolean | Conditionally |
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ImportCharge |
AmountType (double) | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
For orders using eBay International Shipping, when using the GetOrders and GetOrderTransactions calls, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges. For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo |
ShippingPackageInfoType | Conditionally,
repeatable: [0..*] |
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .ActualDeliveryTime |
dateTime | Conditionally |
This timestamp indicates when the order was actually delivered to the buyer. This field is only returned after the order has been delivered to the buyer. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer (or marked as shipped), the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .EstimatedDeliveryTimeMax |
dateTime | Conditionally |
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order. The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .EstimatedDeliveryTimeMin |
dateTime | Conditionally |
The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order. The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .HandleByTime |
dateTime | Conditionally |
This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .MaxNativeEstimatedDeliveryTime |
dateTime | Conditionally |
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .MinNativeEstimatedDeliveryTime |
dateTime | Conditionally |
The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order. This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .ScheduledDeliveryTimeMax |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMax value indicates the latest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .ScheduledDeliveryTimeMin |
dateTime | Conditionally |
The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. The ScheduledDeliveryTimeMin value indicates the earliest time that the buyer can expect to receive the order. The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields will start being returned once the seller marks the order as shipped/provides tracking information. Until then, the EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are returned instead. Note: This field does not appear in Merchant Data API's OrderReport responses, because once shipment tracking information is provided to the buyer, the order/order line item is considered acknowledged, and acknowledged orders do not show up in OrderReport responses. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo .ShippingTrackingEvent |
token | Conditionally |
This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingTrackingEventCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingPackageInfo.StoreID |
string | Conditionally |
The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingService |
token | Conditionally |
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards categories, and to Coins & Paper Money, Postcards, and Stamps. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope. See eBay standard envelope for details and restrictions. For the REST equivalent, see Using the eBay standard envelope (eSE) service.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingServiceAdditionalCost |
AmountType (double) | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost. The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingServiceCost |
AmountType (double) | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingServiceSelected .ShippingServicePriority |
int | Conditionally |
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow. For GetOrders, only a limited number of applicable fields are returned at the order line item level. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.BuyerSelectedShipping |
boolean | Conditionally |
Indicates whether the buyer has selected shipping details during checkout. False indicates that the shipping service was selected by eBay for the buyer. For example, if the buyer has not yet completed the Review Your Purchase page, he has not picked a shipping service. If it is false, the application should ignore ShippingServiceCost and ShippingServiceSelected (items whose values are defaulted by eBay).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.CheckoutStatus |
CheckoutStatusCodeType | Conditionally |
Indicates the current status of the checkout flow for the order. If the payment was successfuly processed, a value of CheckoutComplete will be returned.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.CompleteStatus |
CompleteStatusCodeType | Conditionally |
Indicates whether checkout is complete, incomplete, or pending for an order.
Applicable values: Note: If the PaymentMethodUsed is CashOnPickup, the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Note: If the payment method is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.DigitalStatus |
DigitalStatusCodeType | Conditionally |
This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.eBayPaymentStatus |
PaymentStatusCodeType | Conditionally |
Indicates the status of the buyer's payment for an order. If the payment was successfuly processed, a value of NoPaymentFailure will be returned.
Applicable values: Note: This value may also get returned for a sales transaction that occurred off of eBay's platform, and the payment status may stay in this state unless the seller marks the order as paid. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.InquiryStatus |
InquiryStatusCodeType | Conditionally |
This field gives the status of a buyer's Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.
Applicable values: See InquiryStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments. Note: This field is deprecated and will stop being returned in order management calls on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.LastTimeModified |
dateTime | Conditionally |
Indicates date and time an order's status was last updated (in GMT). Note: Please note that for a multiple line item order, if any part of the order was modified, all line items of that order may be returned in the response, and each line item of that order should have the same timestamp value in this field. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.PaymentHoldStatus |
PaymentHoldStatusCodeType | Conditionally |
This field indicates the type and/or status of a payment hold on the item. Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.PaymentInstrument |
BuyerPaymentInstrumentCodeType | Conditionally |
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethodUsed field by the GetItemTransactions call.
Applicable values: See PaymentInstrument. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.PaymentMethodUsed |
BuyerPaymentMethodCodeType | Conditionally |
The payment method that the buyer selected to pay for the order. Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.
Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.ReturnStatus |
ReturnStatusCodeType | Conditionally |
This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return request, or has escalated an existing return request into a return case.
Applicable values: See ReturnStatus. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes |
TaxesType | Conditionally |
A container consisting of detailed tax information (sales tax, Goods and Services tax, or VAT) for a sales transaction. The Taxes container is returned if the order line item is subject to any taxes on the buyer's purchase. The information in this container supercedes/overrides any sales tax information in the ShippingDetails.SalesTax container.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.eBayReference |
eBayTaxReferenceValue (string) | Conditionally |
The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute. Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.eBayReference [ attribute name ] |
string | Conditionally |
The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute. Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher. On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails |
TaxDetailsType | Conditionally,
repeatable: [0..*] |
Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails.Imposition |
TaxTypeCodeType | Conditionally |
This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).
Applicable values: See Imposition. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails.TaxAmount |
AmountType (double) | Conditionally |
This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value). TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails.TaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value). TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails.TaxCode |
string | Conditionally |
This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxDescription |
TaxDescriptionCodeType | Conditionally |
This enumeration value indicates the type of tax charged against the item.
Applicable values: Note: At this time, this tax type is only applicable to the Australia site. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnHandlingAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnHandlingAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnShippingAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnShippingAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnSubtotalAmount |
AmountType (double) | Conditionally |
This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxOnSubtotalAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type). For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TotalTaxAmount |
AmountType (double) | Conditionally |
This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TotalTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .TransactionID |
string | Always |
Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An ItemID/TransactionID pair can be used and referenced during an order checkout flow to identify a line item. The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing. For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer and seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer and seller, and a dummy value of 10000000000000 will be returned to all third parties.
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .TransactionPrice |
AmountType (double) | Always |
The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value. For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount. For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .TransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value. For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount. For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .TransactionSiteID |
SiteCodeType | Conditionally |
The site upon which the line item was purchased.
Applicable values: See TransactionSiteID. Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem |
UnpaidItemType | Conditionally |
Deprecated as of version 1309. No longer functional. Note: This container is deprecated (Unpaid Item cases are no longer supported). This container will stop being returned on January 31, 2024. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem.Status |
UnpaidItemCaseStatusTypeCodeType | Conditionally |
Deprecated as of version 1309. Note: This field is deprecated (Unpaid Item cases are no longer supported). Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem.Type |
UnpaidItemCaseOpenTypeCodeType | Conditionally |
Deprecated as of version 1309. Note: This field is deprecated (Unpaid Item cases are no longer supported). Applicable values: Code so that your app gracefully handles any future changes to this list. DetailLevel: ReturnAll. See Resolving unpaid items with buyers for more information about managing the Unpaid Item preferences feature. Deprecation version: 1309. See also Deprecated Objects. |
|
OrderArray.Order .TransactionArray.Transaction .Variation |
VariationType | Conditionally |
In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design, and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple quanity of the same variation are purchased. The Variation node contains information about which variation was purchased. Therefore, applications that process orders should always check to see if this node is present. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values. If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU. If you include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 80. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics |
NameValueListArrayType | Conditionally,
repeatable: [2..5] |
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values. When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0. For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics .NameValueList |
NameValueListType | Conditionally,
repeatable: [0..*] |
For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. Note: The maximum number of item specifics that may be defined for a listing has increased from 30 to 45. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has variations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations:
For PlaceOffer: Required if the item being purchased includes Item Variations. For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required. Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics .NameValueList.Name |
string | Conditionally |
Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name. For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing. Max length: 65. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used. For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings. For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing. Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description. Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning'). DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationTitle |
string | Conditionally |
The title of the variation. This is a concatenation of the listing title plus the values (no names) from Variationpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M]. Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024. Max length: 120. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation .VariationViewItemURL |
anyURI | Conditionally |
URL for the variation on eBay. This links to eBay's View Item page, with the page configured to show details of the specified variation. The syntax of this URL is similar to Item.ViewItemURL (not optimized for natural search).
DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
| Standard Output Fields |
| Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
| Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
| CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
| Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
| Errors.ErrorCode | token | Conditionally |
A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
See Errors By Number. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
| Errors.ErrorParameters.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
| Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
| Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
| Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
| HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
| Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
| Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
| Input Output Samples Change History |
Detail Controls
DetailLevel
The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)
The none column indicates the fields that are returned when you do not specify a DetailLevel.
| Detail Level value | Summary of Effects |
|---|---|
| ReturnAll | Returns all fields |
| ItemReturnDescription |
Returns all fields except the following:
|
| none | Same as for ItemReturnDescription |
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
| - | The field is not returned. |