GetOrders is the recommended call to use for order (sales) management. Use this call to retrieve all orders in which the authenticated caller is either the buyer or seller. The order types that can be retrieved with this call are discussed below:
See also Integrating PayPal With Your eBay Applications.
With the Global Shipping Program, a seller can easily ship items to buyers in other countries with minimal concern for the complexities of international shipping such as customs duty and taxes, shipping regulations and restrictions. It's currently available only to sellers listing items on the eBay US site.
Sellers are presented with the option to join the Global Shipping Program on various pages of the eBay US site. Sellers will see this offer in promotional emails, at sign-in, on their My eBay page, and in other locations. Opting in to the program is done only from the web UI; there's no way to opt in using an API. Once opted in, sellers need not opt out again. They can simply choose not to offer the Global Shipping Program in their listings.
The features of the Global Shipping Program are implemented using some dedicated fields and some existing fields in GetOrders and other Trading API calls. For more information, see the Shipping chapter in the Trading API User's Guide.
Executing a GetOrders call with no input filters returns all active (pending) and completed (paid) single and multiple line item orders. To limit the amount of orders that are returned, or to returned specific orders, the caller can use filters in the following ways:
If OrderIDs are used in the request, all other filter criteria are ignored.
GetOrders returns only those orders that match the criteria specified in the input fields. (Thus it is possible for no order to be returned.)
Recommendation: capture and store OrderIDs and OrderLineItemIDs (that can be passed into the OrderID field) at the time of creation so that the IDs are easily accessible when you want to use GetOrders.
You can test GetOrders in the Sandbox environment.
Testing GetOrders:
The results should include two Order nodes. The Combined Payment Order node should include two Transaction nodes under the TransactionArray container, and the single line item Order node should include one Transaction node under the TransactionArray container.
You can also experiment using some of the input filters.
See Listing an Item.
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetOrders User Notes |
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 Samples.
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"?>
<GetOrdersRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Input Fields -->
<CreateTimeFrom> dateTime </CreateTimeFrom>
<CreateTimeTo> dateTime </CreateTimeTo>
<IncludeFinalValueFee> boolean </IncludeFinalValueFee>
<ListingType> ListingTypeCodeType </ListingType>
<ModTimeFrom> dateTime </ModTimeFrom>
<ModTimeTo> dateTime </ModTimeTo>
<NumberOfDays> int </NumberOfDays>
<OrderIDArray> OrderIDArrayType
<OrderID> OrderIDType (string) </OrderID>
<!-- ... more OrderID values allowed here ... -->
</OrderIDArray>
<OrderRole> TradingRoleCodeType </OrderRole>
<OrderStatus> OrderStatusCodeType </OrderStatus>
<Pagination> PaginationType
<EntriesPerPage> int </EntriesPerPage>
<PageNumber> int </PageNumber>
</Pagination>
<SortingOrder> SortOrderCodeType </SortingOrder>
<!-- 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>
</GetOrdersRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| CreateTimeFrom | dateTime | Conditional |
The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. The CreateTimeFrom field is the starting date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the CreateTimeFrom and CreateTimeTo fields is 90 days. CreateTimeFrom/CreateTimeTo date filters are ignored if the NumberOfDays date filter is used in the request, or if one or more order IDs are passed in the request. Applicable to Half.com. |
| CreateTimeTo | dateTime | Conditional |
The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. The CreateTimeTo field is the ending date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the CreateTimeFrom and CreateTimeTo fields is 90 days. If the CreateTimeFrom field is used and the CreateTimeTo field is omitted, the "TimeTo" value defaults to the present time or to 90 days past the CreateTimeFrom value (if CreateTimeFrom value is more than 90 days in the past). CreateTimeFrom/CreateTimeTo date filters are ignored if the NumberOfDays date filter is used in the request, or if one or more order IDs are passed in the request. Note: If a GetOrders call is made within a few seconds after the creation of a multiple line item order, the caller runs the risk of retrieving orders that are in an inconsistent state, since the order consolidation involved in a multi-line item order may not have been completed. For this reason, it is recommended that sellers include the CreateTimeTo field in the call, and set its value to: Current Time - 2 minutes. Applicable to Half.com. |
| IncludeFinalValueFee | boolean | Conditional |
Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is assessed right after the creation of an eBay order line item. |
| ListingType | ListingTypeCodeType | Conditional |
Specify Half to retrieve Half.com orders. Note: Do not use this field if you are retrieving eBay orders. This field cannot be used as a listing type filter on eBay.com. If not provided, or if you specify any value other than Half, this field has no useful effect and the call retrieves eBay orders of all types. Also, you can't retrieve both eBay and Half.com orders in the same response. Applicable values: • Half (in/out) Half.com listing (item is listed on Half.com, not on eBay). You must be a registered Half.com seller to use this format. (Not all values in ListingTypeCodeType apply to this field.) |
| ModTimeFrom | dateTime | Conditional |
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving existing orders that have been modified within this time window (for example, 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' status). The ModTimeFrom field is the starting date range. All eBay orders that were last modified within this date range are returned in the output. The maximum date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 days. ModTimeFrom/ModTimeTo date filters are ignored if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request, or if one or more order IDs are passed in the request. Applicable to Half.com. |
| ModTimeTo | dateTime | Conditional |
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving existing orders that have been modified within this time window (for example, 'Incomplete' status to 'Pending' status or 'Pending' status to 'Complete' status). The ModTimeTo field is the ending date range. All eBay orders that were last modified within this date range are returned in the output. The maximum date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the "TimeTo" value defaults to the present time (if ModTimeFrom value is less than 30 days in the past) or to 30 days past the ModTimeFrom value. ModTimeFrom/ModTimeTo date filters are ignored if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request, or if one or more order IDs are passed in the request. Applicable to Half.com. |
| NumberOfDays | int | Conditional |
This filter specifies the number of days (24-hour periods) in the past to search for orders. All eBay orders that were either created or modified within this period are returned in the output. This field cannot be used in conjunction with the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters. This date filter is ignored if one or more order IDs are passed in the request. Applicable to Half.com. Min: 1. Max: 30. |
| OrderIDArray | OrderIDArrayType | Conditional |
A container for eBay order IDs. If one or more order IDs are specified in this container, no other call-specific input fields are applicable. Not applicable to Half.com. |
| OrderIDArray.OrderID | OrderIDType (string) | Conditional,
repeatable: [0..*] |
A unique identifier that identifies a single line item or multiple line item (Combined Payment) order. For the GetOrders and GetOrderTransactions calls, the OrderID field can handle a hyphenated OrderLineItemID value. OrderLineItemID is a unique identifier for an eBay transaction and is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. |
| OrderRole | TradingRoleCodeType | Conditional |
Filters the returned orders based on the role of the user. The user's role is either buyer or seller. If this field is used with a date filter, returned orders must satisfy both the date range and the OrderRole value. Applicable to eBay.com and Half.com. Applicable values: • Buyer (in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order. • CustomCode (in/out) This value is reserved for future or internal use. • Seller (in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order. |
| OrderStatus | OrderStatusCodeType | Conditional |
Filters the returned orders by order status. For eBay orders, only the Active and Completed values are applicable. The Shipping value can be used for Half.com orders. If this field is used with a date filter, returned orders must satisfy both the date range and the OrderStatus value. To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify order IDs, no other filters may be used. For Half.com, you can get some, but not all orders. Orders on Half.com have different order status values from eBay orders. When you set ListingType to Half, set OrderStatus to Shipped. Otherwise, GetOrders may return incomplete information or have indeterminate results. Applicable values: • Active (in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active. • Cancelled (in/out) The cart was cancelled. • Completed (in/out) The order is completed. • Inactive (in/out) The cart is invalid; it does not exist. An example is a cart that has expired. • Shipped (in/out) The order was shipped. Half.com users can specify this in the GetOrders input. (Not all values in OrderStatusCodeType apply to this field.) |
| Pagination | PaginationType | Optional | If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of entries. Use the Pagination filters to control the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. |
| Pagination.EntriesPerPage | int | Optional |
This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. For GetOrders, the maximum value is 100 and the default value is 25 orders per page. For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. For GetProducts, the maximum value is 20, and any higher values are ignored. |
| Pagination.PageNumber | int | Optional |
Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. Min: 1. Default: 1. |
| SortingOrder | SortOrderCodeType | Conditional |
Specifies how orders returned by this call should be sorted (using LastModifiedTime as the sort key). A value of Ascending returns the earliest modified orders first, and a value of Descending returns the latest modified orders first. Default: Ascending
Applicable values: • Ascending (in/out) The results will be sorted by the specified key in ascending (low to high) order. • CustomCode (in/out) Reserved for internal or future use. • Descending (in/out) The results will be sorted by the specified key in descending (high to low) order. |
| 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 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. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) 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 a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (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. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| 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 this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. |
| Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. 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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level. |
| Input Detail Controls Samples Change History Top Errors for GetOrders User Notes |
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 Samples.
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"?>
<GetOrdersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Output Fields -->
<HasMoreOrders> boolean </HasMoreOrders>
<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>
<BuyerUserID> UserIDType (string) </BuyerUserID>
<CheckoutStatus> CheckoutStatusType
<eBayPaymentMismatchDetails> eBayPaymentMismatchDetailsType
<ActionRequiredBy> dateTime </ActionRequiredBy>
<MismatchAmount currencyID="CurrencyCodeType"> AmountType (double) </MismatchAmount>
<MismatchType> MismatchTypeCodeType </MismatchType>
</eBayPaymentMismatchDetails>
<eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
<IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
<LastModifiedTime> dateTime </LastModifiedTime>
<PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
<Status> CompleteStatusCodeType </Status>
</CheckoutStatus>
<CreatedTime> dateTime </CreatedTime>
<CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
<EIASToken> string </EIASToken>
<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>
<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>
<PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
<PaymentTime> dateTime </PaymentTime>
<ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
</Payment>
<!-- ... more Payment nodes allowed here ... -->
</Payments>
</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
<AddressID> string </AddressID>
<AddressOwner> AddressOwnerCodeType </AddressOwner>
<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 ... -->
<RefundArray> RefundArrayType
<Refund> RefundType
<EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
<ExternalReferenceID> string </ExternalReferenceID>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundCompletionTime> dateTime </RefundCompletionTime>
<RefundFailureReason> RefundFailureReasonType
<RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
</RefundFailureReason>
<RefundFromSeller currencyID="CurrencyCodeType"> AmountType (double) </RefundFromSeller>
<RefundFundingSourceArray> RefundFundingSourceArrayType
<RefundFundingSource> RefundFundingSourceType
<AccountNumber> string </AccountNumber>
<BuyerExternalTransactionID> string </BuyerExternalTransactionID>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
<SellerExternalTransactionID> string </SellerExternalTransactionID>
</RefundFundingSource>
<!-- ... more RefundFundingSource nodes allowed here ... -->
</RefundFundingSourceArray>
<RefundID> string </RefundID>
<RefundRequestedTime> dateTime </RefundRequestedTime>
<RefundStatus> RefundStatusCodeType </RefundStatus>
<RefundTime> dateTime </RefundTime>
<RefundTransactionArray> RefundTransactionArrayType
<RefundTransaction> RefundTransactionType
<ItemID> string </ItemID>
<OrderID> string </OrderID>
<RefundLineArray> RefundLineArrayType
<RefundLine type="RefundLineTypeCodeType" currencyID="CurrencyCodeType"> RefundLineType (AmountType) </RefundLine>
<!-- ... more RefundLine values allowed here ... -->
</RefundLineArray>
<TransactionID> string </TransactionID>
</RefundTransaction>
<!-- ... more RefundTransaction nodes allowed here ... -->
</RefundTransactionArray>
<SellerNoteToBuyer> string </SellerNoteToBuyer>
<TotalRefundToBuyer currencyID="CurrencyCodeType"> AmountType (double) </TotalRefundToBuyer>
</Refund>
<!-- ... more Refund nodes allowed here ... -->
</RefundArray>
<ShippedTime> dateTime </ShippedTime>
<ShippingAddress> AddressType
<AddressID> string </AddressID>
<AddressOwner> AddressOwnerCodeType </AddressOwner>
<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
<CalculatedShippingRate> CalculatedShippingRateType
<InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
<OriginatingPostalCode> string </OriginatingPostalCode>
<PackageDepth> MeasureType (decimal) </PackageDepth>
<PackageLength> MeasureType (decimal) </PackageLength>
<PackageWidth> MeasureType (decimal) </PackageWidth>
<PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
<ShippingIrregular> boolean </ShippingIrregular>
<ShippingPackage> ShippingPackageCodeType </ShippingPackage>
<WeightMajor> MeasureType (decimal) </WeightMajor>
<WeightMinor> MeasureType (decimal) </WeightMinor>
</CalculatedShippingRate>
<CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
<GetItFast> boolean </GetItFast>
<InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
<InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
<InsuranceWanted> boolean </InsuranceWanted>
<InternationalShippingServiceOption> InternationalShippingServiceOptionsType
<ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
<ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
<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>
<ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
<ShippingService> token </ShippingService>
<ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
<ShippingServicePriority> int </ShippingServicePriority>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes allowed here ... -->
</ShippingDetails>
<ShippingServiceSelected> ShippingServiceOptionsType
<ExpeditedService> boolean </ExpeditedService>
<ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
<ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
<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>
<Buyer> UserType
<BuyerInfo> BuyerType
</BuyerInfo>
<Email> string </Email>
</Buyer>
<CreatedDate> dateTime </CreatedDate>
<FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
<InvoiceSentTime> dateTime </InvoiceSentTime>
<Item> ItemType
<AttributeArray> AttributeArrayType
<Attribute attributeLabel="string"> AttributeType
<Value> ValType
<ValueLiteral> string </ValueLiteral>
</Value>
<!-- ... more Value nodes allowed here ... -->
</Attribute>
<!-- ... more Attribute nodes allowed here ... -->
</AttributeArray>
<IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
<ItemID> ItemIDType (string) </ItemID>
<SellerInventoryID> string </SellerInventoryID>
<Site> SiteCodeType </Site>
<SKU> SKUType (string) </SKU>
<Title> string </Title>
</Item>
<ListingCheckoutRedirectPreference> ListingCheckoutRedirectPreferenceType
<SellerThirdPartyUsername> string </SellerThirdPartyUsername>
</ListingCheckoutRedirectPreference>
<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>
<PaymentStatus> PaymentTransactionStatusCodeType </PaymentStatus>
<PaymentTime> dateTime </PaymentTime>
<ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
</Payment>
<!-- ... more Payment nodes allowed here ... -->
</Payments>
</MonetaryDetails>
<OrderLineItemID> string </OrderLineItemID>
<PaymentHoldDetails> PaymentHoldDetailType
<ExpectedReleaseDate> dateTime </ExpectedReleaseDate>
<NumOfReqSellerActions> int </NumOfReqSellerActions>
<PaymentHoldReason> PaymentHoldReasonCodeType </PaymentHoldReason>
<RequiredSellerActionArray> RequiredSellerActionArrayType
<RequiredSellerAction> RequiredSellerActionCodeType </RequiredSellerAction>
<!-- ... more RequiredSellerAction values allowed here ... -->
</RequiredSellerActionArray>
</PaymentHoldDetails>
<QuantityPurchased> int </QuantityPurchased>
<RefundArray> RefundArrayType
<Refund> RefundType
<EstimatedRefundCompletionTime> dateTime </EstimatedRefundCompletionTime>
<ExternalReferenceID> string </ExternalReferenceID>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundCompletionTime> dateTime </RefundCompletionTime>
<RefundFailureReason> RefundFailureReasonType
<RefundFailureCode> RefundFailureCodeType </RefundFailureCode>
</RefundFailureReason>
<RefundFromSeller currencyID="CurrencyCodeType"> AmountType (double) </RefundFromSeller>
<RefundFundingSourceArray> RefundFundingSourceArrayType
<RefundFundingSource> RefundFundingSourceType
<AccountNumber> string </AccountNumber>
<BuyerExternalTransactionID> string </BuyerExternalTransactionID>
<RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
<RefundingSourceType> RefundingSourceTypeCodeType </RefundingSourceType>
<SellerExternalTransactionID> string </SellerExternalTransactionID>
</RefundFundingSource>
<!-- ... more RefundFundingSource nodes allowed here ... -->
</RefundFundingSourceArray>
<RefundID> string </RefundID>
<RefundRequestedTime> dateTime </RefundRequestedTime>
<RefundStatus> RefundStatusCodeType </RefundStatus>
<RefundTime> dateTime </RefundTime>
<RefundTransactionArray> RefundTransactionArrayType
<RefundTransaction> RefundTransactionType
<ItemID> string </ItemID>
<OrderID> string </OrderID>
<RefundLineArray> RefundLineArrayType
<RefundLine type="RefundLineTypeCodeType" currencyID="CurrencyCodeType"> RefundLineType (AmountType) </RefundLine>
<!-- ... more RefundLine values allowed here ... -->
</RefundLineArray>
<TransactionID> string </TransactionID>
</RefundTransaction>
<!-- ... more RefundTransaction nodes allowed here ... -->
</RefundTransactionArray>
<SellerNoteToBuyer> string </SellerNoteToBuyer>
<TotalRefundToBuyer currencyID="CurrencyCodeType"> AmountType (double) </TotalRefundToBuyer>
</Refund>
<!-- ... more Refund nodes allowed here ... -->
</RefundArray>
<SellerDiscounts> SellerDiscountsType
<OriginalItemPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemPrice>
<OriginalItemShippingCost currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemShippingCost>
<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>
<ShippedTime> dateTime </ShippedTime>
<ShippingDetails> ShippingDetailsType
<CalculatedShippingRate> CalculatedShippingRateType
<InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
<OriginatingPostalCode> string </OriginatingPostalCode>
<PackageDepth> MeasureType (decimal) </PackageDepth>
<PackageLength> MeasureType (decimal) </PackageLength>
<PackageWidth> MeasureType (decimal) </PackageWidth>
<PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
<ShippingIrregular> boolean </ShippingIrregular>
<ShippingPackage> ShippingPackageCodeType </ShippingPackage>
<WeightMajor> MeasureType (decimal) </WeightMajor>
<WeightMinor> MeasureType (decimal) </WeightMinor>
</CalculatedShippingRate>
<CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
<GetItFast> boolean </GetItFast>
<InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
<InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
<InsuranceWanted> boolean </InsuranceWanted>
<InternationalShippingServiceOption> InternationalShippingServiceOptionsType
<ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
<ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
<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>
<ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
<ShippingService> token </ShippingService>
<ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
<ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
<ShippingServicePriority> int </ShippingServicePriority>
</ShippingServiceOptions>
<!-- ... more ShippingServiceOptions nodes allowed here ... -->
</ShippingDetails>
<Status> TransactionStatusType
<eBayPaymentMismatchDetails> eBayPaymentMismatchDetailsType
<ActionRequiredBy> dateTime </ActionRequiredBy>
<MismatchAmount currencyID="CurrencyCodeType"> AmountType (double) </MismatchAmount>
<MismatchType> MismatchTypeCodeType </MismatchType>
</eBayPaymentMismatchDetails>
<IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
<PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
<PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
</Status>
<Taxes> TaxesType
<TaxDetails> TaxDetailsType
<Imposition> TaxTypeCodeType </Imposition>
<TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
<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>
<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>
<OrdersPerPage> int </OrdersPerPage>
<PageNumber> int </PageNumber>
<PaginationResult> PaginationResultType
<TotalNumberOfEntries> int </TotalNumberOfEntries>
<TotalNumberOfPages> int </TotalNumberOfPages>
</PaginationResult>
<ReturnedOrderCountActual> int </ReturnedOrderCountActual>
<!-- 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>
</GetOrdersResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| HasMoreOrders | boolean | Always |
A true value indicates that there are more orders to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray | OrderArrayType | Always |
The set of orders that match the order IDs or filter criteria specified. Also applicable to Half.com (only returns orders that have not been marked as shipped).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order | OrderType | Always,
repeatable: [1..*] |
Also applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing an Item. |
|
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, shipping insurance, 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. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .AdjustmentAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.AmountPaid | AmountType (double) | Conditionally |
This value indicates the total amount of the order. This amount includes the sale price of each line item, shipping and handling charges, shipping insurance (if offered and selected by the buyer), additional services, and any applied sales tax. This value is returned after the buyer has completed checkout (the CheckoutStatus.Status output field reads 'Complete'). Note: For auction listings on North American sites and on eBay Motors Parts and Accessories, the AmountPaid value minus any applied sales tax is the amount subject to the final value fee calculation. The sales tax amount is returned in the ShippingDetails.SalesTax.SalesTaxAmount field. For more information on how final value fees are calculated, see the final value fees help page. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.AmountPaid [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.AmountSaved | AmountType (double) | Always |
This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Payment order. This value is returned as 0.00 for single line item orders.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.AmountSaved [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.BuyerUserID | UserIDType (string) | Always |
eBay user ID of the order's buyer. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus |
CheckoutStatusType | Always |
Container consisting of details related to the current checkout status of the order. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentMismatchDetails |
eBayPaymentMismatchDetailsType | Conditionally |
This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and if the buyer has selected EFT as the payment method. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentMismatchDetails .ActionRequiredBy |
dateTime | Conditionally |
This dateTime value indicates the date by which the seller needs to accept or reject the overpayment/underpayment. If the seller doesn't take action by this date, eBay returns the payment to the buyer and essentially voids the sale. This field is always returned with the eBayPaymentMismatchDetails container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentMismatchDetails .MismatchAmount |
AmountType (double) | Conditionally |
This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .CheckoutStatus .eBayPaymentMismatchDetails .MismatchAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentMismatchDetails .MismatchType |
MismatchTypeCodeType | Conditionally |
This enumeration value indicates if the buyer has overpaid or underpaid for an order going through the new eBay payment process. This field is always returned with the eBayPaymentMismatchDetails container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. Applicable values: • CustomCode (out) Reserved for internal or future use • OverPayment (out) This value indicates that the buyer paid more than the required amount. • UnderPayment (out) This value indicates that the buyer paid less than the required amount. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .eBayPaymentStatus |
PaymentStatusCodeType | Always |
This value indicates the payment status of an order. Also applicable to Half.com orders (GetOrders only). Applicable values: • BuyerCreditCardFailed (out) This value indicates that the buyer's payment via a credit card failed. This value is only applicable if the seller accepts credit cards as a form of payment. • BuyerECheckBounced (out) This value indicates that the buyer's eCheck bounced. This value is only applicable if the seller accepts eChecks as a form of payment. • BuyerFailedPaymentReportedBySeller (out) This value indicates that the seller reported the buyer's payment as failed. • CustomCode (out) Reserved for internal or future use. • NoPaymentFailure (out) This value indicates that the buyer's payment for the order has cleared. A CheckoutStatus.eBayPaymentStatus value of 'NoPaymentFailure' and a CheckoutStatus.Status value of 'Complete' indicates that checkout is complete. • PaymentInProcess (out) This value indicates that the buyer's non-PayPal payment is in process. This value is only applicable if the buyer has selected a payment method other than PayPal. • PayPalPaymentInProcess (out) This value indicates that the buyer's PayPal payment is in process. This value is only applicable if the buyer has selected PayPal as the payment method. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .IntegratedMerchantCreditCardEnabled |
boolean | Always |
Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CheckoutStatus .LastModifiedTime |
dateTime | Always |
Indicates the last time that there was a change in value of the CheckoutStatus.Status field, such as 'Pending' to 'Complete'. This field is also applicable to Half.com orders (GetOrders only). DetailLevel: 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. This field is also applicable to Half.com orders (GetOrders only). Applicable values: See PaymentMethod. DetailLevel: 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 CheckoutStatus.Status value will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. This field is also applicable to Half.com orders (GetOrders only). Applicable values: • Complete (in/out) The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed. • CustomCode (in/out) Reserved for internal or future use • Incomplete (in/out) The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated. • Pending (in/out) The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.CreatedTime | dateTime | Always |
Timestamp that indicates the date and time that the order was created. For single line item orders, this value is the same as CreatedDate in the Transaction container. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .CreatingUserRole |
TradingRoleCodeType | Conditionally |
This value indicates whether a Combined Payment order was created by the buyer or by the seller. This field is only returned for Combined Payment orders.
Applicable values: • Buyer (in/out) The eBay user is acting as the buyer for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the buyer in the order. • CustomCode (in/out) This value is reserved for future or internal use. • Seller (in/out) The eBay user is acting as the seller for the order(s). In GetOrders, this value should be passed into the OrderRole field in the request to retrieve orders in which the calling eBay user is the seller in the order. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.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. 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. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ExternalTransaction |
ExternalTransactionType | Conditionally,
repeatable: [0..*] |
Container consisting of payment details for an eBay order. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned after payment for the order has occurred. For orders in which the seller's funds are being held by PayPal, the PaymentHoldDetails container and PaymentHoldStatus field will be returned instead of the ExternalTransaction container. Note: In an upcoming release, ExternalTransaction will be replaced by the more versatile MonetaryDetails container, so you are encouraged to start using MonetaryDetails now. Not applicable to Half.com. DetailLevel: ReturnAll. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionID |
string | Conditionally |
Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made.
DetailLevel: ReturnAll. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionStatus |
PaymentTransactionStatusCodeType | Conditionally |
The current processing status of a PayPal payment for an eBay order.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failed (out) The payment has been processed, but was not received by the payee. • Pending (out) Payment has been initiated and is being processed. • Succeeded (out) The payment was received by the payee. DetailLevel: ReturnAll. |
|
OrderArray.Order .ExternalTransaction .ExternalTransactionTime |
dateTime | Conditionally |
Timestamp for payment transaction.
DetailLevel: ReturnAll. |
|
OrderArray.Order .ExternalTransaction .FeeOrCreditAmount |
AmountType (double) | Conditionally |
Fee Amount is a positive value and Credit Amount is a negative value.
DetailLevel: ReturnAll. |
| OrderArray.Order .ExternalTransaction .FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ExternalTransaction .PaymentOrRefundAmount |
AmountType (double) | Conditionally |
If positive, the amount the buyer pays the seller through PayPal on the purchase of items. If negative, the amount refunded the buyer. Default = 0.
DetailLevel: ReturnAll. |
| OrderArray.Order .ExternalTransaction .PaymentOrRefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .IntegratedMerchantCreditCardEnabled |
boolean | Always |
Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .IsMultiLegShipping |
boolean | Conditionally |
If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the seller has specified InternationalPriorityShipping as the default international shipping service in the listings of all the items in the shipment. If IsMultilegShipping is false, the order or transaction doesn't use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails |
PaymentsInformationType | Conditionally |
Contains information about how funds exchanged for an order are allocated to payees. For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned. Note: In an upcoming release, MonetaryDetails will replace the ExternalTransaction container, so you are encouraged to start using MonetaryDetails now. DetailLevel: 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment |
PaymentTransactionType | Conditionally,
repeatable: [0..*] |
Contains information about the funds allocated to one payee from a buyer payment for a specified order.
DetailLevel: 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.Payee [ attribute type ] |
UserIdentityCodeType | Conditionally |
Type of user involved in an exchange of funds for an order. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.Payer |
UserIdentityType (string) | Conditionally |
The person or organization who submitted the payment.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.Payer [ attribute type ] |
UserIdentityCodeType | Conditionally |
Type of user involved in an exchange of funds for an order. 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MonetaryDetails.Payments .Payment.PaymentStatus |
PaymentTransactionStatusCodeType | Conditionally |
The current status of a buyer payment that is allocated to a specified payee.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failed (out) The payment has been processed, but was not received by the payee. • Pending (out) Payment has been initiated and is being processed. • Succeeded (out) The payment was received by the payee. DetailLevel: 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: 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MonetaryDetails.Payments .Payment.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
The type of transaction ID for this payment. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .MultiLegShippingDetails |
MultiLegShippingDetailsType | Conditionally |
Contains details about the domestic leg of a Global Shipping Program shipment. This information is not returned if IsMultilegShipping is false. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider |
MultiLegShipmentType | Conditionally |
Contains information about the domestic leg of a Global Shipping Programn shipment, including the seller-selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.
DetailLevel: 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: 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. 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: 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingServiceDetails .TotalShippingCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMax |
int | Conditionally |
The maximum guaranteed number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShippingTimeMin |
int | Conditionally |
The minimum number of days that the shipping carrier will take to ship an item for the domestic leg of a Global Shipping Program shipment (not including the handling time it takes the seller to deliver the item to the domestic shipping carrier).
DetailLevel: 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. 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressID |
string | Always |
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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.AddressOwner |
AddressOwnerCodeType | Always |
The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.
Applicable values: • CustomCode (out) Reserved for internal or future use. • eBay (out) eBay owns the address. • PayPal (out) PayPal owns the address. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CityName |
string | Always |
The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Country |
CountryCodeType | Always |
The two-digit code representing the country of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Also applicable to Half.com (for GetOrders). Applicable values: See Country. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.CountryName |
string | Always |
The name of the user's country. Also applicable to Half.com (for GetOrders). 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress .ExternalAddressID |
string | Always |
ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders). Max length: 20. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Name |
string | Always |
User's name for the address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Phone |
string | Always |
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. Also applicable to Half.com (for GetOrders). 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.PostalCode |
string | Always |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: 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" DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.StateOrProvince |
string | Always |
The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street1 |
string | Always |
Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .MultiLegShippingDetails .SellerShipmentToLogisticsProvider .ShipToAddress.Street2 |
string | Always |
Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders). In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.OrderID | OrderIDType (string) | Always |
A unique identifier that identifies a single line item or multiple line item order. For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call. An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request. Also applicable to Half.com (for GetOrders). DetailLevel: 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 to Half.com (for GetOrders). Applicable values: • Active (in/out) The cart is active. Items can only be added, deleted, or updated in the cart when status is Active. • All (out) All the orders with active and completed status • Authenticated (out) The cart was authenticated. • Cancelled (in/out) The cart was cancelled. • Completed (in/out) The order is completed. • CustomCode (out) Reserved for internal or future use. • Default (out) Default status. • Inactive (in/out) The cart is invalid; it does not exist. An example is a cart that has expired. • InProcess (out) After placing the order and before completion of checkout, the card is "in process." • Invalid (out) Invalid. • Shipped (in/out) The order was shipped. Half.com users can specify this in the GetOrders input. DetailLevel: 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 "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .PaymentHoldDetails |
PaymentHoldDetailType | Conditionally |
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 PayPal has placed a payment hold on the order. An American seller (selling on US or US Motors sites) and a Canadian seller (selling on CA and CA- FR sites) may be subject to PayPal payment holds (that last from three to 21 days) if that seller is new to selling on eBay or is classified as a "Below Standard" seller. For other reasons why a seller's funds may be held by PayPal, see the PaymentHoldReason field. |
|
OrderArray.Order .PaymentHoldDetails .ExpectedReleaseDate |
dateTime | Always | Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change. |
|
OrderArray.Order .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. |
|
OrderArray.Order .PaymentHoldDetails .PaymentHoldReason |
PaymentHoldReasonCodeType | Conditionally |
Enumerated value that indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account. A seller's funds for an order can be held by PayPal for as little as three days after the buyer receives the order, but the hold can be up to 21 days based on the scenario, and in some cases, the seller's lack of action in helping to expedite the release of funds.
Applicable values: • BelowStandardSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller. • CasualSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay. • CustomCode (out) This value is reserved for internal or future use. • EbpCaseOpen (out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field. • NewPaypalAccountAdded (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds. • NewSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:
• NotAvailable (out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known. • Other (out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values. • ReinstatementAfterSuspension (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period. |
|
OrderArray.Order .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. |
|
OrderArray.Order .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: • ContacteBayCS (out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account. • CustomCode (out) This value is reserved for internal or future use. • MarkAsShipped (out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date. • None (out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely. • ResolveBuyerMessageInr (out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account. • ResolveBuyerMessageSnad (out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account. • ResolveeBPCase (out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases. • ResolvePPPIcase (out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account. • ResolveReturn (out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item. • UploadTrackingInfo (out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered. |
|
OrderArray.Order .PaymentHoldStatus |
PaymentHoldStatusCodeType | Always |
This field indicates the type and/or status of a payment hold on the item.
Applicable values: • CustomCode (out) This value is reserved for internal or future use. • MerchantHold (out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • NewSellerHold (out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:
• None (out) This value indicates that there is no payment hold on the item. • PaymentHold (out) This value indicates that there is a payment hold on the item. • PaymentReview (out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • ReleaseConfirmed (out) This value indicates that the funds are available in the seller's PayPal account. • Released (out) This value indicates that a payment hold on the item has been released. • ReleasePending (out) This value indicates that the process for the release of funds for the order has been initiated. |
|
OrderArray.Order .PaymentMethods |
BuyerPaymentMethodCodeType | Always,
repeatable: [1..*] |
This field indicates a payment method available to the buyer to pay for the order. There can be multiple PaymentMethods fields. For DE and AT orders subject to the new eBay payment process, only one PaymentMethods field will be returned, and the value will always be 'StandardPayment'. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. Applicable to Half.com (for GetOrders). Applicable values: See PaymentMethods. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray | RefundArrayType | Conditionally |
Container consisting of one or more refunds for Half.com orders or DE/AT orders subject to the new eBay payment process. This container is returned only if a refund to a Half.com buyer has occurred or a refund was issued for an order subject to the new eBay payment Process. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund |
RefundType | Conditionally,
repeatable: [0..*] |
Contains information about one refund. Applicable to Half.com (for GetOrders). Applicable to refunds issued with eBay's new Payment Process. Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .EstimatedRefundCompletionTime |
dateTime | Conditionally |
The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.ExternalReferenceID |
string | Conditionally |
The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundAmount |
AmountType (double) | Conditionally |
The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray .Refund.RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order.RefundArray .Refund.RefundCompletionTime |
dateTime | Conditionally |
The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundFailureReason |
RefundFailureReasonType | Conditionally |
This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundFailureReason .RefundFailureCode |
RefundFailureCodeType | Conditionally |
An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites. Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely. Applicable values: • PaypalBillingAgreementCanceled (out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled. • PaypalRiskDeclinesTransaction (out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request. (Not all values in RefundFailureCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundFromSeller |
AmountType (double) | Conditionally |
Total amount refunded by the seller for this order line item. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray .Refund.RefundFromSeller [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray |
RefundFundingSourceArrayType | Conditionally |
This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource |
RefundFundingSourceType | Conditionally,
repeatable: [0..*] |
The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund. Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .AccountNumber |
string | Conditionally |
The account number of the funding source. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .BuyerExternalTransactionID |
string | Conditionally |
The external transaction ID of the buyer's account. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .RefundAmount |
AmountType (double) | Conditionally |
The amount of the refund. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .RefundingSourceType |
RefundingSourceTypeCodeType | Conditionally |
The source from which the refund was made. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. Applicable values: • BankAccount (out) The seller's bank account associated with the transaction. • CustomCode (out) Reserved for internal or future use. • Paypal (out) The seller's PayPal account associated with the transaction. • ScheduledPayout (out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund .RefundFundingSourceArray .RefundFundingSource .SellerExternalTransactionID |
string | Conditionally |
The external transaction ID of the seller's account. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundID |
string | Conditionally |
The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundRequestedTime |
dateTime | Conditionally |
The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundStatus |
RefundStatusCodeType | Conditionally |
A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failed (out) The refund request was rejected. • Pending (out) The refund request is being processed. • Successful (out) The refund request was successful. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTime |
dateTime | Conditionally |
The date and time at which the refund was issued. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray |
RefundTransactionArrayType | Conditionally |
A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction |
RefundTransactionType | Conditionally,
repeatable: [0..*] |
A container consisting of details about an order line item against which the seller issued a refund. Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction.ItemID |
string | Conditionally |
The item against which the refund was issued. This value must be accompanied by a TransactionID value. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction.OrderID |
string | Conditionally |
The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction .RefundLineArray |
RefundLineArrayType | Conditionally |
An array of refund lines identifying the order line items against which the refund was issued. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine |
RefundLineType (AmountType) | Conditionally,
repeatable: [0..*] |
This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type. RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine [ attribute type ] |
RefundLineTypeCodeType | Conditionally |
A code indicating the order line item to which the refund was applied. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. For a list of possible enumeration values, see RefundLineTypeCodeType. |
| OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order.RefundArray .Refund.RefundTransactionArray .RefundTransaction .TransactionID |
string | Conditionally |
The transaction against which the refund was issued. This value must be accompanied by an ItemID value. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.SellerNoteToBuyer |
string | Conditionally |
Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order.RefundArray .Refund.TotalRefundToBuyer |
AmountType (double) | Conditionally |
Total amount refunded to the buyer for this order line item. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.RefundArray .Refund.TotalRefundToBuyer [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.ShippedTime | dateTime | Conditionally |
Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped. Note that sellers have the ability to set the shipped time up to three calendar days in the future. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress |
AddressType | Always |
Container holding the shipping address of the buyer involved in the order. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.AddressID |
string | Always |
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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.AddressOwner |
AddressOwnerCodeType | Always |
The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com.
Applicable values: • CustomCode (out) Reserved for internal or future use. • eBay (out) eBay owns the address. • PayPal (out) PayPal owns the address. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.CityName |
string | Always |
The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Country |
CountryCodeType | Always |
The two-digit code representing the country of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Also applicable to Half.com (for GetOrders). Applicable values: See Country. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.CountryName |
string | Always |
The name of the user's country. Also applicable to Half.com (for GetOrders). 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress .ExternalAddressID |
string | Always |
ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders). Max length: 20. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Name |
string | Always |
User's name for the address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Phone |
string | Always |
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. Also applicable to Half.com (for GetOrders). 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.PostalCode |
string | Always |
User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress .StateOrProvince |
string | Always |
The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Street1 |
string | Always |
Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingAddress.Street2 |
string | Always |
Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders). In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails |
ShippingDetailsType | Always |
Container consisting of all shipping-related details for an order, including domestic and international shipping service options, shipment tracking information, and shipping insurance information. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate |
CalculatedShippingRateType | Conditionally |
Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts |
AmountType (double) | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .OriginatingPostalCode |
string | Conditionally |
Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .PackageDepth |
MeasureType (decimal) | Conditionally |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .PackageLength |
MeasureType (decimal) | Conditionally |
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .PackageWidth |
MeasureType (decimal) | Conditionally |
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts |
AmountType (double) | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .ShippingIrregular |
boolean | Conditionally |
Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .ShippingPackage |
ShippingPackageCodeType | Conditionally |
The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.
Applicable values: See ShippingPackage. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .WeightMajor |
MeasureType (decimal) | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .CalculatedShippingRate .WeightMinor |
MeasureType (decimal) | Conditionally |
See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.) Required on input when calculated shipping is used. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.CODCost |
AmountType (double) | Conditionally |
This dollar value indicates the money due from the buyer upon delivery of the item. This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request. This field is only returned if set for the listing. To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails.CODCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails.GetItFast |
boolean | Always |
Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Applicable to Half.com for GetOrders. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.InsuranceFee |
AmountType (double) | Always |
Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. Default: 0.00. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails.InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InsuranceOption |
InsuranceOptionCodeType | Always |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is only returned if the value is other than NotOffered. Valid only on the following sites: FR and IT If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing. Applicable to Half.com Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .InsuranceWanted |
boolean | Always |
Whether or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. DetailLevel: 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, only four other international shipping services may be offered (regardless of whether or not Global 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) 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost |
AmountType (double) | Conditionally |
The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Valid only on the following sites: AU, FR, and IT Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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: 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping. |
| OrderArray.Order .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. DetailLevel: 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Specifying Locations to Where You Ship. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
OrderArray.Order .ShippingDetails.SalesTax |
SalesTaxType | Always |
Sales tax details. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. Flat and calculated shipping. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxAmount |
AmountType (double) | Always |
The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. 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. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxPercent |
float | Always |
Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .SalesTaxState |
string | Always |
State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Always |
(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders). DetailLevel: 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. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for a single or a multiple line item order. Applicable to Half.com (for GetOrders). DetailLevel: 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 changes to eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShipmentTrackingDetails .ShipmentTrackingNumber |
string | Conditionally |
Required if ShippingCarrierUsed is supplied. The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set. Returned for Half.com as well.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShipmentTrackingDetails .ShippingCarrierUsed |
string | Conditionally |
Required if ShipmentTrackingNumber is supplied. Name of the shipping carrier used to ship the item. Although this value can be any value, since it is not checked by eBay, commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierCodeTypes. For those using UPS Mail Innovations, supply the value UPS-MI for UPS Mail Innnovations. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking. For those using FedEx SmartPost in a CompleteSale callsupply the value FedEx. Buyers will subsequently be sent to the appropriate web site for tracking status. (The buyer is sent to the UPS Mail Innovations website if UPS-MI is specified, or to the FedEx website if FedEx is specified.) Returned only if set. Returned for Half.com as well. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingCarrierCodeType |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. 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> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> 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. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema 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 |
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost |
AmountType (double) | Conditionally |
The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. DetailLevel: 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) 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 GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingDetails .ShippingServiceOptions .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 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. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected |
ShippingServiceOptionsType | Always |
Container consisting of details about the domestic or international shipping service selected by the buyer. Note: For GetOrders and GetOrderTransactions, if you provide OrderLineItemID values in the OrderID field, this container does not return accurate shipping service and cost information for multiple line item orders. You must provide the order's combined OrderID value to ensure that the ShippingService and ShippingServiceCost fields return the correct values for the order. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .ExpeditedService |
boolean | Conditionally |
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .ShippingServiceSelected .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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingInsuranceCost |
AmountType (double) | Conditionally |
The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingService |
token | Conditionally |
A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. DetailLevel: 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) 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 GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .ShippingServiceSelected .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .ShippingServiceSelected .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 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. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Subtotal | AmountType (double) | Always |
The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Subtotal [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
| OrderArray.Order.Total | AmountType (double) | Always |
The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order.Total [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 an order line item is stored in the Transaction container. For the AddOrder call, there will always be at least two order line items in the container, but no more than 40. We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same Combined Payment order. (In the future, AddOrder may enforce this recommendation.) Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction |
TransactionType | Always,
repeatable: [1..*] |
The Transaction container consists of detailed information on one order line item. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Listing an Item. |
|
OrderArray.Order .TransactionArray.Transaction .ActualHandlingCost |
AmountType (double) | Always |
The handling cost for the order line item. The value of this field is returned as zero dollars if the seller did not specify a handling cost for the listing. It also will show as 0.00 dollars until payment has been made on the order.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ActualHandlingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ActualShippingCost |
AmountType (double) | Always |
The shipping cost charged to the buyer for the order line item. For GetOrders, this field is returned only after checkout is completed on the order. A value of 0.00 indicates free shipping. For other calls, this field is always returned but defaults to 0.00 until payment has been made on the order. Note: This is different from the field of the same name returned by GetSellingManagerSaleRecord and ReviseSellingManagerSaleRecord, which contains the actual shipping cost paid by the seller. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ActualShippingCost [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer |
UserType | Conditionally |
UserType container consisting of eBay user data for the buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if the seller is making the request. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Buyer.BuyerInfo |
BuyerType | Conditionally |
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. 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. Also returned if DetailLevel is not provided on input. |
|
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 order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .CreatedDate |
dateTime | Always |
Indicates the creation time of the order line item. For auction listings, an order line item 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, an order line item is created once the buyer clicks the Buy button. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .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 the subscription plans and fees, see . 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. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .FinalValueFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
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 .Item |
ItemType | Always |
Container consisting of details about an item in a listing. The child fields returned are dependent on the call, the type of item or listing, and the listing site. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.AttributeArray |
AttributeArrayType | Always |
This container is used to specify one or more item attributes for a Half.com listing. This container is not applicable for eBay fixed-price or auction listings. You can use ReviseItem to modify attribute values for Half.com listings. Half.com listing attributes are not returned in GetItem. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Half.com. |
|
OrderArray.Order .TransactionArray.Transaction .Item.AttributeArray.Attribute |
AttributeType | Always,
repeatable: [1..*] |
This container is used by the seller to specify one or more attribute values for a Half.com item. This container can be used in ReviseItem to add, remove, or modify an attribute or its value. This field is not applicable for eBay listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Item.AttributeArray.Attribute [ attribute attributeLabel ] |
string | Always | Name of the attribute being specified. This is not part of eBay's standard Item Specifics format (i.e., there is no relationship to GetAttributesCS). For GetOrders, this is always returned for Half.com orders. (It is not applicable to orders on the eBay.com site.) For Half.com, see the eBay Web Services Guide for valid input values. For Half.com, this field is required when you use AddItem. You can revise this value for Half.com listings. |
|
OrderArray.Order .TransactionArray.Transaction .Item.AttributeArray.Attribute .Value |
ValType | Always,
repeatable: [1..*] |
A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.AttributeArray.Attribute .Value.ValueLiteral |
string | Always |
For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings. Max length: see description. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item .IntegratedMerchantCreditCardEnabled |
boolean | Conditionally |
Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.ItemID |
ItemIDType (string) | Always |
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In order retrieval calls (such as, GetOrders), use the OrderLineItemID (which is a concatenation of ItemID and TransactionID to uniquely identify an order line item. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. 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. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.SellerInventoryID |
string | Conditionally |
Unique identifier for a Half.com item. Must be an alphanumeric value (with no symbols) that is unique across the seller's active (unsold) inventory on Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. Only returned from GetOrders if the seller specified a value when the item was listed. You cannot revise this field. Not applicable to eBay.com listings. Max length: 100. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Site |
SiteCodeType | Conditionally |
The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches, and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing. When you specify Item.Site in AddItem or AddFixedPriceItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API). Not applicable to Half.com. Applicable values: See Site. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .Item.SKU |
SKUType (string) | Conditionally |
A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. A seller can specify a SKU when listing an item with AddItem and related calls. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.) A SKU is not required to be unique, when you track listings by their ItemID (the default tracking method). A seller can specify a particular SKU on one item or on multiple items. Different sellers can use the same SKUs. If you want to use SKU instead of ItemID as a unique identifier (such as when retrieving items and orders), you can set Item.InventoryTrackingMethod to SKU in AddFixedPriceItem and related calls. In this case, the SKU must be unique across your (the seller's) active listings. Note that if you relist the item, you must reset Item.InventoryTrackingMethod to SKU; otherwise the relisted item will default to ItemID as the tracking method. If both ItemID and SKU are specified in item-retrieval and order-retrieval calls that support the use of SKU as a unique identifier, the ItemID value takes precedence and is used to identify the listing. For multi-variation listings, the SKU can be used to uniquely identify a variation that is being revised or relisted. If InventoryTrackingMethod is ItemID, an ItemID is also required. When both SKU and VariationSpecifics are passed in the request, the variation specifics take precedence as the unique identifier. Note: The eBay Web site UI cannot identify listings by SKU. For example, My eBay pages and Search pages all identify listings by item ID. When a buyer contacts you via eBay's messaging functionality, eBay uses the item ID as the identifier. Buyer-focused APIs (like the Shopping API) also do not support SKU as an identifier. For revising and relisting only: To remove a SKU when you revise or relist an item, use DeletedField. (You cannot remove a SKU when Item.InventoryTrackingMethod is set to SKU.) For GetMyeBaySelling, this is only returned if set. Not applicable to Half.com. Max length: 50. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem. |
|
OrderArray.Order .TransactionArray.Transaction .Item.Title |
string | Always |
Name of the item as it appears in the listing or search results. Title is required for most items. This field is only optional if you leverage Pre-filled Item Information by using the Item.ProductListingDetails or Item.ExternalProductID containers. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For the AddItem family of calls: Not applicable to Half.com. For ReviseItem and ReviseFixedPriceItem You can only add or change the item title if the listing has no bids (for auctions) or sales (for fixed-price listings) and the listing does not end within 12 hours. For GetItemRecommendations: More keywords in the title usually result in more relevant Listing Analyzer recommendations. Max length: 80. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ListingCheckoutRedirectPreference |
ListingCheckoutRedirectPreferenceType | Conditionally |
ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if Item.ThirdPartyCheckout is true.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ListingCheckoutRedirectPreference .SellerThirdPartyUsername |
string | Conditionally |
The user name of the ProStores store. To remove this value when revising or relisting an item, use DeletedField. Max length: 200. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails |
PaymentsInformationType | Conditionally |
Contains information about how funds exchanged for an order are allocated to payees. For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned. Note: In an upcoming release, MonetaryDetails will replace the ExternalTransaction container, so you are encouraged to start using MonetaryDetails now. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
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: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment |
PaymentTransactionType | Conditionally,
repeatable: [0..*] |
Contains information about the funds allocated to one payee from a buyer payment for a specified order.
DetailLevel: 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.FeeOrCreditAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payee [ attribute type ] |
UserIdentityCodeType | Conditionally |
Type of user involved in an exchange of funds for an order. For a list of possible enumeration values, see UserIdentityCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payer |
UserIdentityType (string) | Conditionally |
The person or organization who submitted the payment.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.Payer [ attribute type ] |
UserIdentityCodeType | Conditionally |
Type of user involved in an exchange of funds for an order. 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.PaymentAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
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: • CustomCode (out) Reserved for internal or future use. • Failed (out) The payment has been processed, but was not received by the payee. • Pending (out) Payment has been initiated and is being processed. • Succeeded (out) The payment was received by the payee. DetailLevel: 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: 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .MonetaryDetails.Payments .Payment.ReferenceID [ attribute type ] |
TransactionReferenceCodeType | Conditionally |
The type of transaction ID for this payment. For a list of possible enumeration values, see TransactionReferenceCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .OrderLineItemID |
string | Always |
A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. Max length: 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.). DetailLevel: 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 PayPal has placed a payment hold on the order line item. An American seller (selling on US or US Motors sites) and a Canadian seller (selling on CA and CA- FR sites) may be subject to PayPal payment holds (that last from three to 21 days) if that seller is new to selling on eBay or is classified as a "Below Standard" seller. For other reasons why a seller's funds may be held by PayPal, see the PaymentHoldReason field. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .ExpectedReleaseDate |
dateTime | Always | Timestamp that indicates the expected date in which eBay/PayPal will distribute the funds to the seller's account. This is not a firm date and is subject to change. |
|
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. |
|
OrderArray.Order .TransactionArray.Transaction .PaymentHoldDetails .PaymentHoldReason |
PaymentHoldReasonCodeType | Conditionally |
Enumerated value that indicates why the buyer's payment for the order is being held by PayPal instead of being distributed to the seller's account. A seller's funds for an order can be held by PayPal for as little as three days after the buyer receives the order, but the hold can be up to 21 days based on the scenario, and in some cases, the seller's lack of action in helping to expedite the release of funds.
Applicable values: • BelowStandardSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has been classified as a Below Standard seller. • CasualSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is classified as a casual seller on eBay. • CustomCode (out) This value is reserved for internal or future use. • EbpCaseOpen (out) This value indicates that the buyer's payment for the order is being held by PayPal because an eBay Buyer Protection case has been filed against the order. If this value is returned, the seller can expedite the release of PayPal funds into their account by resolving the eBay Buyer Protection case, as indicated by a value of 'ResolveeBPCase' returned in a PaymentHoldDetails.RequiredSellerActionArray.RequiredSellerAction field. • NewPaypalAccountAdded (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller's PayPal account (identified in Transaction.PayPalEmailAddress) is new and is not fully set up to receive funds. • NewSeller (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller is new to selling on eBay. Sellers are considered "new" until they have met all three criteria below:
• NotAvailable (out) This value indicates that the reason for the buyer's payment for the order being held by PayPal is not known. • Other (out) This value is returned if the reason for the buyer's payment for the order being held by PayPal cannot be classified by any of the other enumeration values. • ReinstatementAfterSuspension (out) This value indicates that the buyer's payment for the order is being held by PayPal because the seller has recently been reinstated as an active eBay seller after their account went through a suspension/restricted period. |
|
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. |
|
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: • ContacteBayCS (out) This value indicates that the seller should contact eBay Customer Support to discover the next required action to expedite the release of funds into their account. • CustomCode (out) This value is reserved for internal or future use. • MarkAsShipped (out) This value indicates that the seller must mark the order line item as shipped to expedite the release of funds into their account. The seller can use the CompleteSale call to mark an item as shipped. If an order line item is marked as shipped, it is possible that the seller's funds for the order will be released as soon as seven days after the latest estimated delivery date. • None (out) This value is not currently applicable since the new eBay Payment Process for DE and AT sellers has been rolled back indefinitely. • ResolveBuyerMessageInr (out) This value indicates that the buyer has not received the item, and the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account. • ResolveBuyerMessageSnad (out) This value indicates that the buyer has received the item, but the item is not as described in the listing; hence, the buyer has contacted the seller through the eBay system in an effort to resolve the issue with the seller. The seller must make it right with the buyer in order to expedite the release of funds into their account. • ResolveeBPCase (out) This value indicates that there is an open eBay Buyer Protection case involving the seller and the item. The seller must address and get the case resolved before the funds can be scheduled for release to the seller's account. See the Resolution Case Management API User Guide for information about retrieving and managing eBay Buyer Protection cases. • ResolvePPPIcase (out) This value indicates that the seller must resolve the PayPal Buyer Protection case filed against the order line item to expedite the release of funds into their account. • ResolveReturn (out) This value indicates that the buyer is returning the item through eBay's managed return process. Upon receiving the returned item from the buyer, the seller must issue a refund to the buyer within five business days, and shortly after this happens, eBay will credit the seller's account with the Final Value Fee that was originally assessed on the sale of the item. • UploadTrackingInfo (out) This value indicates that the seller must provide the buyer the tracking information for the order line item to expedite the release of funds into their account. The seller can use the CompleteSale call to provide tracking information for an order line item. If the tracking information for an order line item is provided, it is possible that the seller's funds for the order will be released as soon as three days after eBay has confirmed that the item has been delivered. |
|
OrderArray.Order .TransactionArray.Transaction .QuantityPurchased |
int | Always |
This value indicates the number of identical items 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. In either case, this field is tied to the same order line item. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray |
RefundArrayType | Conditionally |
Container consisting of one or more refund transactions to Half.com buyers. Container consisting of one or more refund transactions for eBay's new payment process. This container is only returned if a refund to a Half.com buyer has occurred or an refund was issued through eBay's new payment process
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund |
RefundType | Conditionally,
repeatable: [0..*] |
Contains information about one refund. Applicable to Half.com (for GetOrders). Applicable to refunds issued with eBay's new Payment Process. Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .EstimatedRefundCompletionTime |
dateTime | Conditionally |
The estimated date and time that the refund is expected to be completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .ExternalReferenceID |
string | Conditionally |
The unique external reference ID that was passed by the seller when requesting the refund. This ID helps to prevent duplication of refund requests. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundAmount |
AmountType (double) | Conditionally |
The total amount of the refund requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundCompletionTime |
dateTime | Conditionally |
The date and time that the refund was completed. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFailureReason |
RefundFailureReasonType | Conditionally |
This describes the reason why a refund was not issued by the seller. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFailureReason .RefundFailureCode |
RefundFailureCodeType | Conditionally |
An enumerated value indicating the reason why a German or Austrian seller's attempt to distribute a refund to a buyer through the Order Adjustment API's issueRefund call failed. This field is only applicable to orders subject to the new eBay payment process on the German and Austrian sites. Note: The new eBay payment process for German and Austrian sites has been put on hold indefinitely. Applicable values: • PaypalBillingAgreementCanceled (out) The refund attempt failed because the seller's billing agreement with PayPal has been cancelled. • PaypalRiskDeclinesTransaction (out) The refund attempt failed because because the PayPayl Risk team declined the transaction. The seller should log in to their PayPal account to proceed with the refund request. (Not all values in RefundFailureCodeType apply to this field.) DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFromSeller |
AmountType (double) | Conditionally |
Total amount refunded by the seller for this order line item. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFromSeller [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray |
RefundFundingSourceArrayType | Conditionally |
This container lists the funding sources for the refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource |
RefundFundingSourceType | Conditionally,
repeatable: [0..*] |
The funding source for the refund issued by the seller through the Order Adjusment API's issueRefund call. It is possible that more than one funding source may be used for this refund. Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .AccountNumber |
string | Conditionally |
The account number of the funding source. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .BuyerExternalTransactionID |
string | Conditionally |
The external transaction ID of the buyer's account. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .RefundAmount |
AmountType (double) | Conditionally |
The amount of the refund. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .RefundAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .RefundingSourceType |
RefundingSourceTypeCodeType | Conditionally |
The source from which the refund was made. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. Applicable values: • BankAccount (out) The seller's bank account associated with the transaction. • CustomCode (out) Reserved for internal or future use. • Paypal (out) The seller's PayPal account associated with the transaction. • ScheduledPayout (out) The seller's scheduled payout account with eBay. When a buyer pays for an item the purchase amount goes into this account. This value indicates that the refund has been issued from the seller's scheduled payout account. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundFundingSourceArray .RefundFundingSource .SellerExternalTransactionID |
string | Conditionally |
The external transaction ID of the seller's account. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund.RefundID |
string | Conditionally |
The refund ID for this refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundRequestedTime |
dateTime | Conditionally |
The date and time when the refund was requested. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundStatus |
RefundStatusCodeType | Conditionally |
A code indicating the status of the refund request. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failed (out) The refund request was rejected. • Pending (out) The refund request is being processed. • Successful (out) The refund request was successful. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund.RefundTime |
dateTime | Conditionally |
The date and time at which the refund was issued. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray |
RefundTransactionArrayType | Conditionally |
A container consisting of details about an order line item against which the seller issued a refund. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction |
RefundTransactionType | Conditionally,
repeatable: [0..*] |
A container consisting of details about an order line item against which the seller issued a refund. Note: The new eBay payment process on the German and Austrian sites has been put on hold indefinitely. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction.ItemID |
string | Conditionally |
The item against which the refund was issued. This value must be accompanied by a TransactionID value. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction.OrderID |
string | Conditionally |
The order against which the refund was issued. The presence of this value indicates that the refund was issued against the entire order. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction .RefundLineArray |
RefundLineArrayType | Conditionally |
An array of refund lines identifying the order line items against which the refund was issued. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine |
RefundLineType (AmountType) | Conditionally,
repeatable: [0..*] |
This field indicates the type and amount of the refund to the buyer involved in an DE/AT order order subject to the new eBay payment process. The type attribute indicates whether the refund is being applied against the purchase price or the shipping price. Using the issueRefund call of the Order Adjustment API, the seller can also issue an optional/additional refund that does not apply to the purchase price or shipping price. The type values are defined in the RefundLineTypeCodeType enumeration type. RefundLine fields will only be returned if a refund has been issued from the seller to the buyer for a DE/AT order going through the new eBay payment process. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine [ attribute type ] |
RefundLineTypeCodeType | Conditionally |
A code indicating the order line item to which the refund was applied. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. For a list of possible enumeration values, see RefundLineTypeCodeType. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction .RefundLineArray.RefundLine [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .RefundTransactionArray .RefundTransaction .TransactionID |
string | Conditionally |
The transaction against which the refund was issued. This value must be accompanied by an ItemID value. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .SellerNoteToBuyer |
string | Conditionally |
Comments made by the the seller to the buyer. For eBay orders, Refund containers are only returned for DE/AT orders subject to the new eBay payment process. Note:The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .TotalRefundToBuyer |
AmountType (double) | Conditionally |
Total amount refunded to the buyer for this order line item. Note: This field is returned only if a refund has been issued against a Half.com order line item. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .RefundArray.Refund .TotalRefundToBuyer [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts |
SellerDiscountsType | Conditionally |
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 | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. Note that shipping discounts have not yet been enabled for seller discount campaigns.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .OriginalItemShippingCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
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. Note that shipping discounts have not yet been enabled for seller discount campaigns. Seller discount campaigns are created through the Order Size Discounts API.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See:
|
|
OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .CampaignDisplayName |
string | Conditionally |
The name of the seller discount campaign. A name can be associated with a seller discount campaign when the seller uses the createCampaigns or updateCampaigns calls of the Order Size Discounts API. The name for a discount campaign is optional, so 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ItemDiscountAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. Note that shipping discounts have not yet been enabled for seller discount campaigns, so this field will not be returned until shipping discounts are enabled.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .SellerDiscounts .SellerDiscount .ShippingDiscountAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippedTime |
dateTime | Always |
Indicates the time when the item(s) associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay or through Selling Manager Pro, or programmatically by the seller through the CompleteSale call. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails |
ShippingDetailsType | Conditionally |
Container consisting of shipping-related details for an order. Shipping details include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, shipping insurance information, sales tax information (if applicable), and shipment tracking details (if shipped). For GetSellerTransactions and GetItemTransactions, the ShippingDetails container is returned in the Transaction container. For GetOrders and GetOrderTransactions, the ShippingDetails container is returned at the Order level. Applicable to Half.com (for GetOrders only). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate |
CalculatedShippingRateType | Conditionally |
Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts |
AmountType (double) | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .OriginatingPostalCode |
string | Conditionally |
Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .PackageDepth |
MeasureType (decimal) | Conditionally |
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .PackageLength |
MeasureType (decimal) | Conditionally |
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .PackageWidth |
MeasureType (decimal) | Conditionally |
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts |
AmountType (double) | Conditionally |
Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .ShippingIrregular |
boolean | Conditionally |
Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .ShippingPackage |
ShippingPackageCodeType | Conditionally |
The nature of the package used to ship the item(s). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.
Applicable values: See ShippingPackage. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .WeightMajor |
MeasureType (decimal) | Conditionally |
WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .CalculatedShippingRate .WeightMinor |
MeasureType (decimal) | Conditionally |
See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.) Required on input when calculated shipping is used. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.CODCost |
AmountType (double) | Conditionally |
This dollar value indicates the money due from the buyer upon delivery of the item. This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request. This field is only returned if set for the listing. To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails.CODCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.GetItFast |
boolean | Always |
Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Applicable to Half.com for GetOrders. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.InsuranceFee |
AmountType (double) | Always |
Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. Default: 0.00. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails.InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InsuranceOption |
InsuranceOptionCodeType | Always |
Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is only returned if the value is other than NotOffered. Valid only on the following sites: FR and IT If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing. Applicable to Half.com Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InsuranceWanted |
boolean | Always |
Whether or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. DetailLevel: 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, only four other international shipping services may be offered (regardless of whether or not Global 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) 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost |
AmountType (double) | Conditionally |
The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Valid only on the following sites: AU, FR, and IT Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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: 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Shipping. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. DetailLevel: 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.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Specifying Locations to Where You Ship. Applicable values: See CountryCodeType, ShippingRegionCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax |
SalesTaxType | Always |
Sales tax details. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. Flat and calculated shipping. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxAmount |
AmountType (double) | Always |
The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. 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. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxPercent |
float | Always |
Percent of an item's price to be charged as the sales tax for the order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .SalesTaxState |
string | Always |
State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails.SalesTax .ShippingIncludedInTax |
boolean | Always |
(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders). DetailLevel: 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. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for a single or a multiple line item order. Applicable to Half.com (for GetOrders). DetailLevel: 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 changes to eBay's Top-rated seller program, see the Becoming a Top Rated Seller and qualifying for Top Rated Plus page. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShipmentTrackingDetails .ShipmentTrackingNumber |
string | Conditionally |
Required if ShippingCarrierUsed is supplied. The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set. Returned for Half.com as well.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShipmentTrackingDetails .ShippingCarrierUsed |
string | Conditionally |
Required if ShipmentTrackingNumber is supplied. Name of the shipping carrier used to ship the item. Although this value can be any value, since it is not checked by eBay, commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierCodeTypes. For those using UPS Mail Innovations, supply the value UPS-MI for UPS Mail Innnovations. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking. For those using FedEx SmartPost in a CompleteSale callsupply the value FedEx. Buyers will subsequently be sent to the appropriate web site for tracking status. (The buyer is sent to the UPS Mail Innovations website if UPS-MI is specified, or to the FedEx website if FedEx is specified.) Returned only if set. Returned for Half.com as well. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. Applicable values: See ShippingCarrierCodeType |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. 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> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> 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. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). 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. Not applicable to Half.com or eBay Motors vehicle listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. See Overview of the API Schema 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 |
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost |
AmountType (double) | Conditionally |
The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, 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. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. DetailLevel: 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 beyond the first item. For input, this is required if the listing is for multiple items. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceCost |
AmountType (double) | Conditionally |
The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) 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 GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .ShippingDetails .ShippingServiceOptions .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 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. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status |
TransactionStatusType | Conditionally |
Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements. For GetOrders, only the IntegratedMerchantCreditCardEnabled and PaymentMethodUsed child elements are returned. The PaymentHoldStatus container will be returned for those sellers subject to the new eBay payment process. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container. Not applicable to Half.com. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status .eBayPaymentMismatchDetails |
eBayPaymentMismatchDetailsType | Conditionally |
This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and when the buyer has selected EFT as the payment method. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status .eBayPaymentMismatchDetails .ActionRequiredBy |
dateTime | Conditionally |
This dateTime value indicates the date by which the seller needs to accept or reject the overpayment/underpayment. If the seller doesn't take action by this date, eBay returns the payment to the buyer and essentially voids the sale. This field is always returned with the eBayPaymentMismatchDetails container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status .eBayPaymentMismatchDetails .MismatchAmount |
AmountType (double) | Conditionally |
This value indicates the amount in which the buyer's payment was either over (MismatchType=OverPayment) or under (MismatchType=UnderPayment) the actual total cost of an order going through the new eBay payment process. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Status .eBayPaymentMismatchDetails .MismatchAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Status .eBayPaymentMismatchDetails .MismatchType |
MismatchTypeCodeType | Conditionally |
This enumeration value indicates if the buyer has overpaid or underpaid for an order going through the new eBay payment process. This field is always returned with the eBayPaymentMismatchDetails container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. Applicable values: • CustomCode (out) Reserved for internal or future use • OverPayment (out) This value indicates that the buyer paid more than the required amount. • UnderPayment (out) This value indicates that the buyer paid less than the required amount. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status .IntegratedMerchantCreditCardEnabled |
boolean | Always |
Indicates whether the item can be paid for through a payment gateway account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway (Payflow) account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account.
DetailLevel: 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.
Applicable values: • CustomCode (out) This value is reserved for internal or future use. • MerchantHold (out) This value indicates a possible issue with a seller. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as PaidWithPayPal in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • NewSellerHold (out) This value indicates that there is a "new seller hold" on the item. PayPal may hold payments to a new seller for up to 21 days. Sellers are considered "new" until they have met all three criteria below:
• None (out) This value indicates that there is no payment hold on the item. • PaymentHold (out) This value indicates that there is a payment hold on the item. • PaymentReview (out) This value indicates a possible issue with a buyer. If this value is returned, the TransactionArray.Transaction.SellerPaidStatus field is returned as NotPaid in GetMyeBaySelling, and the TransactionArray.Transaction.BuyerPaidStatus field is returned as PaidWithPayPal in GetMyeBayBuying. • ReleaseConfirmed (out) This value indicates that the funds are available in the seller's PayPal account. • Released (out) This value indicates that a payment hold on the item has been released. • ReleasePending (out) This value indicates that the process for the release of funds for the order has been initiated. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Status.PaymentMethodUsed |
BuyerPaymentMethodCodeType | Always |
The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.
Applicable values: See PaymentMethodUsed. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes |
TaxesType | Conditionally |
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
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 sales tax type. A separate TaxDetails container is required for each unique imposition (tax type).
Applicable values: • CustomCode (out) Reserved for internal or future use. • SalesTax (out) A standard sales tax charge. • WasteRecyclingFee (out) A charge for an electronic waste recycling fee. 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 sales tax for the order line item for the corresponding impositiion (tax type). 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 | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .Taxes.TaxDetails .TaxDescription |
TaxDescriptionCodeType | Conditionally |
This field indicates the description of the sales tax.
Applicable values: • CustomCode (out) Reserved for internal or future use. • ElectronicWasteRecyclingFee (out) A charge for an electronic waste recycling fee. • SalesTax (out) A standard sales tax charge. • TireRecyclingFee (out) A charge for a tire recycling fee. 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 | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .Taxes.TotalTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .TransactionID |
string | Always |
Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. Applicable to Half.com (for GetOrders only). Max length: 19 (Note: The eBay database specifies 38. Transaction IDs are usually 9 to 12 digits.). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .TransactionPrice |
AmountType (double) | Always |
The price of one order line item. This price is returned only for Best Offer items. This amount does not take into account shipping, sales tax, and other costs related to the order line item. If multiple units were purchased through Best Offer, this value is the per-unit price. For eBay Motors Vehicle listings, TransactionPrice is the deposit amount. Applicable to Half.com (for GetOrders). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrderArray.Order .TransactionArray.Transaction .TransactionPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem |
UnpaidItemType | Conditionally |
Container consisting of details related to the type and status of an Unpaid Item case. This container is only returned if there is an open or closed Unpaid Item case associated with the order line item.
DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem.Status |
UnpaidItemCaseStatusTypeCodeType | Conditionally |
This field indicates the status of the Unpaid Item case. This field is always returned with the UnpaidItem container.
Applicable values: • ClosedWithoutPayment (out) This value indicates that the Unpaid Item case is closed with no payment received from the buyer. • ClosedWithPayment (out) This value indicates that the Unpaid Item case is closed with payment received from the buyer. • CustomCode (out) This value is reserved for future or internal use. • Open (out) This value indicates that the Unpaid Item case is open. DetailLevel: ReturnAll. |
|
OrderArray.Order .TransactionArray.Transaction .UnpaidItem.Type |
UnpaidItemCaseOpenTypeCodeType | Conditionally |
This field indicates if the Unpaid Item case was opened manually by the customer or opened automatically by eBay's Unpaid Item Assistant feature. This field is always returned with the UnpaidItem container.
Applicable values: • Auto (out) This value indicates that the Unpaid Item case was opened automatically through eBay's Unpaid Item Assistant feature. • CustomCode (out) This value is reserved for future or internal use. • Manual (out) This value indicates that the seller opened an Unpaid Item case manually through the Resolution Center or by using the Trading API's AddDispute call. DetailLevel: ReturnAll. See Using Unpaid Item Assistant for more information about managing the Unpaid Item Assistant feature. |
|
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 items 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: 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 an identifier defined by a seller. It is only intended for the seller's use (not for buyers). Many sellers assign a SKU to an item of a specific type, size, and color. For the seller's convenience, eBay preserves the SKU on the variation, and also on corresponding order line items. This enables you (as a seller) use the SKU to reconcile your eBay inventory with your own inventory system instead of using the variation specifics. It is a good idea to track how many items of each type, size, and color are selling so that you can restock your shelves or update the variation quantity on eBay according to customer demand. (eBay does not use the SKU.) 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 set Item.InventoryTrackingMethod to true, the variation SKU values are required and they must be unique across all the seller's active listings. For GetItem and related calls: Only returned if the seller specified a SKU for the variation. Max length: 80. DetailLevel: 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 names, and each variation must provide a unique combination of values for those names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and 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 in variation specifics by using ModifyNameList. 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, variation specifics are not returned if the variation has a SKU. If the variation has no SKU, then variation specifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force variation specifics to be returned, even when the SKU is returned. DetailLevel: 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. 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 varations, 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: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics .NameValueList.Name |
string | Conditionally |
A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40. DetailLevel: ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input. |
|
OrderArray.Order .TransactionArray.Transaction .Variation.VariationSpecifics .NameValueList.Value |
string | Conditionally,
repeatable: [0..*] |
A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50. 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 the VariationSpecifics. 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]. PayPal may also use this value to identify item variations(for buyers and sellers).
DetailLevel: 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: ReturnAll. Also returned if DetailLevel is not provided on input. |
| OrdersPerPage | int | Always |
Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual).
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| PageNumber | int | Always |
Indicates the page number of data returned in the response. This is the same value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| PaginationResult | PaginationResultType | Always |
Contains information regarding the pagination of data, including the total number of pages and the total number of orders.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfEntries |
int | Always |
Indicates the total number of entries that could be returned by repeated call requests. Returned with a value of 0 if no entries are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
PaginationResult .TotalNumberOfPages |
int | Always |
Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| ReturnedOrderCountActual | int | Always |
Indicates the total number of orders returned.
DetailLevel: 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 Ack.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.) |
| 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.
See Error Handling. |
| Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. |
| 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 the "Errors by Number" document. |
| 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 | The index of the parameter in the list of parameter types returned within the error type. |
| Errors.ErrorParameters.Value | string | Conditionally | The value of the variable (e.g., the attribute set ID) |
| 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: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error |
| 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 Time Values in the eBay Web Services 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Input Output Samples Change History Top Errors for GetOrders User Notes |
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.
| 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. |
| Input Output Detail Controls Change History Top Errors for GetOrders User Notes |
New to making API calls? Please see Routing the Request.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Requests all active orders created by the seller within a specified time range.
Description
The seller (Magical Bookseller) wants to review all her orders that are active within the time range from 12/01/2007 to 12/10/2007. She uses the CreateTimeFrom and CreateTimeTo input fields to specify the time range, and the OrderStatus field to specify Active orders.
Input
XML format (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetOrdersRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <eBayAuthToken>ABC...123</eBayAuthToken> </RequesterCredentials> <CreateTimeFrom>2007-12-01T20:34:44.000Z</CreateTimeFrom> <CreateTimeTo>2007-12-10T20:34:44.000Z</CreateTimeTo> <OrderRole>Seller</OrderRole> <OrderStatus>Active</OrderStatus> </GetOrdersRequest>
Output
XML format. Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetOrdersResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2007-12-10T16:12:55.184Z</Timestamp> <Ack>Success</Ack> <Version>539</Version> <Build>e539_core_Bundled_5642307_R1</Build> <OrderArray> <Order> <OrderID>865826</OrderID> <OrderStatus>Active</OrderStatus> <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount> <AmountSaved currencyID="USD">0.0</AmountSaved> <CheckoutStatus> <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus> <LastModifiedTime>2007-12-10T16:09:47.000Z</LastModifiedTime> <PaymentMethod>None</PaymentMethod> <Status>Incomplete</Status> </CheckoutStatus> <ShippingDetails> <SalesTax> <SalesTaxPercent>0.0</SalesTaxPercent> <SalesTaxState/> <ShippingIncludedInTax>false</ShippingIncludedInTax> <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount> </SalesTax> <ShippingServiceOptions> <ShippingService>ShippingMethodStandard</ShippingService> <ShippingServicePriority>1</ShippingServicePriority> <ExpeditedService>false</ExpeditedService> </ShippingServiceOptions> <SellingManagerSalesRecordNumber>111</SellingManagerSalesRecordNumber> <GetItFast>false</GetItFast> </ShippingDetails> <CreatingUserRole>Seller</CreatingUserRole> <CreatedTime>2007-12-10T16:09:47.000Z</CreatedTime> <PaymentMethods>PayPal</PaymentMethods> <ShippingAddress> <Name>Test User</Name> <Street1>address</Street1> <Street2/> <CityName>city</CityName> <StateOrProvince>WA</StateOrProvince> <Country>CustomCode</Country> <CountryName/> <Phone>1-800-111-1111</Phone> <PostalCode>98102</PostalCode> <AddressID>3839387</AddressID> <AddressOwner>eBay</AddressOwner> <ExternalAddressID/> </ShippingAddress> <Subtotal currencyID="USD">36.0</Subtotal> <Total currencyID="USD">36.0</Total> <DigitalDelivery>false</DigitalDelivery> <TransactionArray> <Transaction> <Buyer> <Email>magicalbookseller@yahoo.com</Email> </Buyer> <ShippingDetails> <SellingManagerSalesRecordNumber>104</SellingManagerSalesRecordNumber> </ShippingDetails> <Item> <ItemID>110025788368</ItemID> </Item> <QuantityPurchased>1</QuantityPurchased> <TransactionID>0</TransactionID> <TransactionPrice currencyID="USD">18.0</TransactionPrice> </Transaction> <Transaction> <Buyer> <Email>magicalbookseller@yahoo.com</Email> </Buyer> <ShippingDetails> <SellingManagerSalesRecordNumber>103</SellingManagerSalesRecordNumber> </ShippingDetails> <Item> <ItemID>110025788765</ItemID> </Item> <QuantityPurchased>1</QuantityPurchased> <TransactionID>0</TransactionID> <TransactionPrice currencyID="USD">18.0</TransactionPrice> </Transaction> </TransactionArray> <BuyerUserID>magicalbookseller</BuyerUserID> </Order> </OrderArray> </GetOrdersResponse>
| Input Output Detail Controls Samples Top Errors for GetOrders User Notes |
| Version | Description |
|---|---|
| 827 2013-06-05 |
|
| 821 2013-04-24 |
|
| 811 2013-02-13 |
|
| 807 2013-01-23 |
|
| 799 2012-11-07 |
|
| 795 2012-10-10 |
|
| 793 2012-09-26 |
|
| 791 2012-09-12 |
|
| 789 2012-08-29 |
|
| 783 2012-07-18 |
|
| 781 2012-07-04 |
|
| 777 2012-06-06 |
|
| 771 2012-04-25 |
|
| 765 2012-03-14 |
|
| 741 2011-09-28 |
|
| 739 2011-09-14 |
|
| 735 2011-08-17 |
|
| 731 2011-07-20 |
|
| 719 2011-04-27 |
|
| 705 2011-01-19 |
|
| 691 2010-10-14 |
|
| 675 2010-06-23 |
|
| 663 2010-03-31 |
|
| 653 2010-01-13 |
|
| 635 2009-09-16 |
|
| 605 2009-02-18 |
|
| 603 2009-02-04 |
|
| 555 2008-03-05 |
|
| 551 2008-02-06 |
|
| 537 2007-10-31 |
|
| 535 2007-10-17 |
|
| 491 2006-12-13 |
|
| 485 2006-11-01 |
|
| 483 2006-10-18 |
|
| 477 2006-09-06 |
|
| 427 2005-09-21 |
|
| 415 2005-6-29 |
|
| 403 2005-4-6 |
|
| Input Output Detail Controls Samples Change History Top Errors for GetOrders User Notes |
Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.