XML Reference for Sell Feed LMS Feed TypesVersion 1355
 

OrderReport

Note: You must wrap the file to be uploaded within BulkDataExchangeRequest tags, which will also be returned in the response. This container is not shown in the standard Output section for this call, but is shown in the Samples. For additional information, see XML data files overview in the LMS Feed API Guide. OrderReport shows detailed information on all unacknowledged orders, and all unacknowledged line items in each order from the past 30 days. The unique identifier of each order is shown in the Order.OrderID response field, and unique identifier of each order line item is shown in a separate Transaction.OrderLineItemID response field. Only unfulfilled orders will appear in the response, and orders that have already shipped will not. Sellers use the information in OrderReport to make inventory updates and start order fulfillment.

Note: Once orders and order line items have been acknowledged with the OrderAck call, those orders and order line items will no longer appear in the OrderReport response. See Acknowledging Sales for more information.



Output Samples Change History

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<OrderReport xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Ack> string </Ack>
  <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> dateTime </HardExpirationWarning>
  <OrderArray> OrderArrayType
    <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 ... -->
    <Order> OrderType
      <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
      <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid>
      <AmountSaved currencyID="CurrencyCodeType"> AmountType (double) </AmountSaved>
      <BuyerCheckoutMessage> string </BuyerCheckoutMessage>
      <BuyerPackageEnclosures> BuyerPackageEnclosuresType
        <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
        <!-- ... more BuyerPackageEnclosure values allowed here ... -->
      </BuyerPackageEnclosures>
      <BuyerTaxIdentifier> TaxIdentifierType
        <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
        <!-- ... more Attribute values allowed here ... -->
        <ID> string </ID>
        <Type> ValueTypeCodeType </Type>
      </BuyerTaxIdentifier>
      <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
      <BuyerUserID> UserIDType (string) </BuyerUserID>
      <CancelReason> token </CancelReason>
      <CancelStatus> CancelStatusCodeType </CancelStatus>
      <CheckoutStatus> CheckoutStatusType
        <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
        <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
        <LastModifiedTime> dateTime </LastModifiedTime>
        <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument>
        <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
        <Status> CompleteStatusCodeType </Status>
      </CheckoutStatus>
      <ContainseBayPlusTransaction> boolean </ContainseBayPlusTransaction>
      <CreatedTime> dateTime </CreatedTime>
      <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
      <eBayCollectAndRemitTax> boolean </eBayCollectAndRemitTax>
      <EIASToken> string </EIASToken>
      <ExtendedOrderID> string </ExtendedOrderID>
      <IsMultiLegShipping> boolean </IsMultiLegShipping>
      <LogisticsPlanType> token </LogisticsPlanType>
      <MonetaryDetails> PaymentsInformationType
        <Payments> PaymentInformationType
          <Payment> PaymentTransactionType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
            <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
            <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
            <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
            <!-- ... more PaymentReferenceID values allowed here ... -->
            <PaymentTime> dateTime </PaymentTime>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
          </Payment>
          <!-- ... more Payment nodes allowed here ... -->
        </Payments>
        <Refunds> RefundInformationType
          <Refund> RefundTransactionInfoType
            <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
            <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
            <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
            <RefundTime> dateTime </RefundTime>
            <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
            <RefundType> RefundSourceTypeCodeType </RefundType>
          </Refund>
          <!-- ... more Refund nodes allowed here ... -->
        </Refunds>
      </MonetaryDetails>
      <MultiLegShippingDetails> MultiLegShippingDetailsType
        <SellerShipmentToLogisticsProvider> MultiLegShipmentType
          <ShippingServiceDetails> MultiLegShippingServiceType
            <ShippingService> token </ShippingService>
            <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
          </ShippingServiceDetails>
          <ShippingTimeMax> int </ShippingTimeMax>
          <ShippingTimeMin> int </ShippingTimeMin>
          <ShipToAddress> AddressType
            <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
            <!-- ... more AddressAttribute values allowed here ... -->
            <AddressID> string </AddressID>
            <AddressOwner> AddressOwnerCodeType </AddressOwner>
            <CityName> string </CityName>
            <Country> CountryCodeType </Country>
            <CountryName> string </CountryName>
            <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>
      <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods values allowed here ... -->
      <PickupDetails> PickupDetailsType
        <PickupOptions> PickupOptionsType
          <PickupMethod> token </PickupMethod>
          <PickupPriority> int </PickupPriority>
        </PickupOptions>
        <!-- ... more PickupOptions nodes allowed here ... -->
      </PickupDetails>
      <PickupMethodSelected> PickupMethodSelectedType
        <MerchantPickupCode> string </MerchantPickupCode>
        <PickupFulfillmentTime> dateTime </PickupFulfillmentTime>
        <PickupLocationUUID> string </PickupLocationUUID>
        <PickupMethod> token </PickupMethod>
        <PickupStatus> PickupStatusCodeType </PickupStatus>
        <PickupStoreID> string </PickupStoreID>
      </PickupMethodSelected>
      <SellerEIASToken> string </SellerEIASToken>
      <SellerEmail> string </SellerEmail>
      <SellerUserID> UserIDType (string) </SellerUserID>
      <ShippingAddress> AddressType
        <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
        <!-- ... more AddressAttribute values allowed here ... -->
        <AddressID> string </AddressID>
        <AddressOwner> AddressOwnerCodeType </AddressOwner>
        <CityName> string </CityName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <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>
          <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
        </CalculatedShippingRate>
        <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
          <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
          <ShipToLocation> string </ShipToLocation>
          <!-- ... more ShipToLocation values allowed here ... -->
        </InternationalShippingServiceOption>
        <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
        <SalesTax> SalesTaxType
          <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
          <SalesTaxPercent> float </SalesTaxPercent>
          <SalesTaxState> string </SalesTaxState>
          <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
        </SalesTax>
        <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
        <ShippingServiceOptions> ShippingServiceOptionsType
          <ExpeditedService> boolean </ExpeditedService>
          <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
          <ShippingPackageInfo> ShippingPackageInfoType
            <ShippingTrackingEvent> token </ShippingTrackingEvent>
            <StoreID> string </StoreID>
          </ShippingPackageInfo>
          <!-- ... more ShippingPackageInfo nodes allowed here ... -->
          <ShippingService> token </ShippingService>
          <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
          <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
          <ShippingServicePriority> int </ShippingServicePriority>
        </ShippingServiceOptions>
        <!-- ... more ShippingServiceOptions nodes allowed here ... -->
        <TaxTable> TaxTableType
          <TaxJurisdiction> TaxJurisdictionType
            <JurisdictionID> string </JurisdictionID>
            <SalesTaxPercent> float </SalesTaxPercent>
            <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
          </TaxJurisdiction>
          <!-- ... more TaxJurisdiction nodes allowed here ... -->
        </TaxTable>
      </ShippingDetails>
      <ShippingServiceSelected> ShippingServiceOptionsType
        <ExpeditedService> boolean </ExpeditedService>
        <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
        <ShippingPackageInfo> ShippingPackageInfoType
          <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax>
          <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin>
          <HandleByTime> dateTime </HandleByTime>
          <MaxNativeEstimatedDeliveryTime> dateTime </MaxNativeEstimatedDeliveryTime>
          <MinNativeEstimatedDeliveryTime> dateTime </MinNativeEstimatedDeliveryTime>
          <ShippingTrackingEvent> token </ShippingTrackingEvent>
          <StoreID> string </StoreID>
        </ShippingPackageInfo>
        <!-- ... more ShippingPackageInfo nodes allowed here ... -->
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
      </ShippingServiceSelected>
      <Subtotal currencyID="CurrencyCodeType"> AmountType (double) </Subtotal>
      <Total currencyID="CurrencyCodeType"> AmountType (double) </Total>
      <TransactionArray> TransactionArrayType
        <Transaction> TransactionType
          <ActualHandlingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualHandlingCost>
          <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
          <BundlePurchase> boolean </BundlePurchase>
          <Buyer> UserType
            <BuyerInfo> BuyerType
              <BuyerTaxIdentifier> TaxIdentifierType
                <Attribute name="TaxIdentifierAttributeCodeType"> TaxIdentifierAttributeType (string) </Attribute>
                <!-- ... more Attribute values allowed here ... -->
                <ID> string </ID>
                <Type> ValueTypeCodeType </Type>
              </BuyerTaxIdentifier>
              <!-- ... more BuyerTaxIdentifier nodes allowed here ... -->
            </BuyerInfo>
            <Email> string </Email>
            <UserFirstName> string </UserFirstName>
            <UserLastName> string </UserLastName>
          </Buyer>
          <BuyerPackageEnclosures> BuyerPackageEnclosuresType
            <BuyerPackageEnclosure type="PaymentInstructionCodeType"> BuyerPackageEnclosureType (string) </BuyerPackageEnclosure>
            <!-- ... more BuyerPackageEnclosure values allowed here ... -->
          </BuyerPackageEnclosures>
          <CreatedDate> dateTime </CreatedDate>
          <DigitalDeliverySelected> DigitalDeliverySelectedType
            <DeliveryDetails> DeliveryDetailsType
              <Recipient> DigitalDeliveryUserType
                <Email> string </Email>
                <Name> string </Name>
              </Recipient>
              <Sender> DigitalDeliveryUserType
                <Email> string </Email>
                <Name> string </Name>
              </Sender>
            </DeliveryDetails>
            <DeliveryMethod> token </DeliveryMethod>
            <DeliveryStatus> DeliveryStatusType
              <Email> token </Email>
            </DeliveryStatus>
          </DigitalDeliverySelected>
          <eBayCollectAndRemitTax> boolean </eBayCollectAndRemitTax>
          <eBayCollectAndRemitTaxes> TaxesType
            <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference>
            <TaxDetails> TaxDetailsType
              <CollectionMethod> CollectionMethodCodeType </CollectionMethod>
              <Imposition> TaxTypeCodeType </Imposition>
              <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
              <TaxCode> string </TaxCode>
              <TaxDescription> TaxDescriptionCodeType </TaxDescription>
              <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount>
              <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount>
              <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount>
            </TaxDetails>
            <!-- ... more TaxDetails nodes allowed here ... -->
            <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount>
          </eBayCollectAndRemitTaxes>
          <eBayPlusTransaction> boolean </eBayPlusTransaction>
          <ExtendedOrderID> string </ExtendedOrderID>
          <FinalValueFee currencyID="CurrencyCodeType"> AmountType (double) </FinalValueFee>
          <Gift> boolean </Gift>
          <GiftSummary> GiftSummaryType
            <Message> string </Message>
          </GiftSummary>
          <GuaranteedDelivery> boolean </GuaranteedDelivery>
          <GuaranteedShipping> boolean </GuaranteedShipping>
          <InventoryReservationID> string </InventoryReservationID>
          <InvoiceSentTime> dateTime </InvoiceSentTime>
          <Item> ItemType
            <ItemID> ItemIDType (string) </ItemID>
            <Site> SiteCodeType </Site>
            <SKU> SKUType (string) </SKU>
            <Title> string </Title>
          </Item>
          <LinkedLineItemArray> LinkedLineItemArrayType
            <LinkedLineItem> LinkedLineItemType
              <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax>
              <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin>
              <Item> ItemType
                <ItemID> ItemIDType (string) </ItemID>
                <Site> SiteCodeType </Site>
                <SKU> SKUType (string) </SKU>
                <Title> string </Title>
              </Item>
              <OrderID> string </OrderID>
              <OrderLineItemID> string </OrderLineItemID>
              <SellerUserID> string </SellerUserID>
            </LinkedLineItem>
            <!-- ... more LinkedLineItem nodes allowed here ... -->
          </LinkedLineItemArray>
          <LogisticsPlanType> token </LogisticsPlanType>
          <MonetaryDetails> PaymentsInformationType
            <Payments> PaymentInformationType
              <Payment> PaymentTransactionType
                <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
                <Payee type="UserIdentityCodeType"> UserIdentityType (string) </Payee>
                <Payer type="UserIdentityCodeType"> UserIdentityType (string) </Payer>
                <PaymentAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentAmount>
                <PaymentReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </PaymentReferenceID>
                <!-- ... more PaymentReferenceID values allowed here ... -->
                <PaymentTime> dateTime </PaymentTime>
                <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
              </Payment>
              <!-- ... more Payment nodes allowed here ... -->
            </Payments>
            <Refunds> RefundInformationType
              <Refund> RefundTransactionInfoType
                <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
                <ReferenceID type="TransactionReferenceCodeType"> TransactionReferenceType (string) </ReferenceID>
                <RefundAmount currencyID="CurrencyCodeType"> AmountType (double) </RefundAmount>
                <RefundTime> dateTime </RefundTime>
                <RefundTo type="UserIdentityCodeType"> UserIdentityType (string) </RefundTo>
                <RefundType> RefundSourceTypeCodeType </RefundType>
              </Refund>
              <!-- ... more Refund nodes allowed here ... -->
            </Refunds>
          </MonetaryDetails>
          <MultiLegShippingDetails> MultiLegShippingDetailsType
            <SellerShipmentToLogisticsProvider> MultiLegShipmentType
              <ShippingServiceDetails> MultiLegShippingServiceType
                <ShippingService> token </ShippingService>
                <TotalShippingCost currencyID="CurrencyCodeType"> AmountType (double) </TotalShippingCost>
              </ShippingServiceDetails>
              <ShippingTimeMax> int </ShippingTimeMax>
              <ShippingTimeMin> int </ShippingTimeMin>
              <ShipToAddress> AddressType
                <AddressAttribute type="AddressAttributeCodeType"> AddressAttributeType (string) </AddressAttribute>
                <!-- ... more AddressAttribute values allowed here ... -->
                <AddressID> string </AddressID>
                <AddressOwner> AddressOwnerCodeType </AddressOwner>
                <CityName> string </CityName>
                <Country> CountryCodeType </Country>
                <CountryName> string </CountryName>
                <Name> string </Name>
                <Phone> string </Phone>
                <PostalCode> string </PostalCode>
                <ReferenceID> string </ReferenceID>
                <StateOrProvince> string </StateOrProvince>
                <Street1> string </Street1>
                <Street2> string </Street2>
              </ShipToAddress>
            </SellerShipmentToLogisticsProvider>
          </MultiLegShippingDetails>
          <OrderLineItemID> string </OrderLineItemID>
          <PaidTime> dateTime </PaidTime>
          <PickupMethodSelected> PickupMethodSelectedType
            <MerchantPickupCode> string </MerchantPickupCode>
            <PickupFulfillmentTime> dateTime </PickupFulfillmentTime>
            <PickupLocationUUID> string </PickupLocationUUID>
            <PickupMethod> token </PickupMethod>
            <PickupStatus> PickupStatusCodeType </PickupStatus>
            <PickupStoreID> string </PickupStoreID>
          </PickupMethodSelected>
          <Program> TransactionProgramType
            <AuthenticityVerification> AuthenticityVerificationType
              <OutcomeReason> string </OutcomeReason>
              <ServiceCost> ServiceCostType
                <Amount currencyID="CurrencyCodeType"> AmountType (double) </Amount>
                <ConvertedFromAmount currencyID="CurrencyCodeType"> AmountType (double) </ConvertedFromAmount>
              </ServiceCost>
              <Status> string </Status>
            </AuthenticityVerification>
            <Fulfillment> FulfillmentType
              <FulfillmentBy> string </FulfillmentBy>
              <FulfillmentRefId> string </FulfillmentRefId>
            </Fulfillment>
          </Program>
          <QuantityPurchased> int </QuantityPurchased>
          <SellerDiscounts> SellerDiscountsType
            <OriginalItemPrice currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemPrice>
            <OriginalItemShippingCost currencyID="CurrencyCodeType"> AmountType (double) </OriginalItemShippingCost>
            <OriginalShippingService> token </OriginalShippingService>
            <SellerDiscount> SellerDiscountType
              <CampaignDisplayName> string </CampaignDisplayName>
              <CampaignID> long </CampaignID>
              <ItemDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ItemDiscountAmount>
              <ShippingDiscountAmount currencyID="CurrencyCodeType"> AmountType (double) </ShippingDiscountAmount>
            </SellerDiscount>
            <!-- ... more SellerDiscount nodes allowed here ... -->
          </SellerDiscounts>
          <ShippingDetails> ShippingDetailsType
            <CalculatedShippingRate> CalculatedShippingRateType
              <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
              <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
            </CalculatedShippingRate>
            <InternationalShippingServiceOption> InternationalShippingServiceOptionsType
              <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
              <ShippingService> token </ShippingService>
              <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
              <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              <ShippingServicePriority> int </ShippingServicePriority>
              <ShipToLocation> string </ShipToLocation>
              <!-- ... more ShipToLocation values allowed here ... -->
            </InternationalShippingServiceOption>
            <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
            <SalesTax> SalesTaxType
              <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
              <SalesTaxPercent> float </SalesTaxPercent>
              <SalesTaxState> string </SalesTaxState>
              <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
            </SalesTax>
            <SellingManagerSalesRecordNumber> int </SellingManagerSalesRecordNumber>
            <ShippingServiceOptions> ShippingServiceOptionsType
              <ExpeditedService> boolean </ExpeditedService>
              <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
              <ShippingPackageInfo> ShippingPackageInfoType
                <ShippingTrackingEvent> token </ShippingTrackingEvent>
                <StoreID> string </StoreID>
              </ShippingPackageInfo>
              <!-- ... more ShippingPackageInfo nodes allowed here ... -->
              <ShippingService> token </ShippingService>
              <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
              <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
              <ShippingServicePriority> int </ShippingServicePriority>
            </ShippingServiceOptions>
            <!-- ... more ShippingServiceOptions nodes allowed here ... -->
            <TaxTable> TaxTableType
              <TaxJurisdiction> TaxJurisdictionType
                <JurisdictionID> string </JurisdictionID>
                <SalesTaxPercent> float </SalesTaxPercent>
                <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
              </TaxJurisdiction>
              <!-- ... more TaxJurisdiction nodes allowed here ... -->
            </TaxTable>
          </ShippingDetails>
          <ShippingServiceSelected> ShippingServiceOptionsType
            <ExpeditedService> boolean </ExpeditedService>
            <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
            <ShippingPackageInfo> ShippingPackageInfoType
              <EstimatedDeliveryTimeMax> dateTime </EstimatedDeliveryTimeMax>
              <EstimatedDeliveryTimeMin> dateTime </EstimatedDeliveryTimeMin>
              <HandleByTime> dateTime </HandleByTime>
              <MaxNativeEstimatedDeliveryTime> dateTime </MaxNativeEstimatedDeliveryTime>
              <MinNativeEstimatedDeliveryTime> dateTime </MinNativeEstimatedDeliveryTime>
              <ShippingTrackingEvent> token </ShippingTrackingEvent>
              <StoreID> string </StoreID>
            </ShippingPackageInfo>
            <!-- ... more ShippingPackageInfo nodes allowed here ... -->
            <ShippingService> token </ShippingService>
            <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
            <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
            <ShippingServicePriority> int </ShippingServicePriority>
          </ShippingServiceSelected>
          <Status> TransactionStatusType
            <DigitalStatus> DigitalStatusCodeType </DigitalStatus>
            <InquiryStatus> InquiryStatusCodeType </InquiryStatus>
            <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
            <PaymentInstrument> BuyerPaymentInstrumentCodeType </PaymentInstrument>
            <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
            <ReturnStatus> ReturnStatusCodeType </ReturnStatus>
          </Status>
          <Taxes> TaxesType
            <eBayReference name="string"> eBayTaxReferenceValue (string) </eBayReference>
            <TaxDetails> TaxDetailsType
              <Imposition> TaxTypeCodeType </Imposition>
              <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
              <TaxCode> string </TaxCode>
              <TaxDescription> TaxDescriptionCodeType </TaxDescription>
              <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount>
              <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount>
              <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount>
            </TaxDetails>
            <!-- ... more TaxDetails nodes allowed here ... -->
            <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount>
          </Taxes>
          <TransactionID> string </TransactionID>
          <TransactionPrice currencyID="CurrencyCodeType"> AmountType (double) </TransactionPrice>
          <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>
  <Version> string </Version>
</OrderReport>
Return Value Type Occurrence Meaning
Ack string Always An enumeration value that indicates the status of the current job. Values may include 'Success', 'Warning', 'Failure', or 'Partial Failure'. If any value other that 'Success' is displayed, the error(s)/issue(s) should be displayed under an Errors container.
Errors ErrorType Conditionally,
repeatable: [0..*]		 An Errors container is returned for each warning or error that occurs when the call is processed. Each Errors container consists of detailed information on the warning or error, including the actual error message and information on any input parameters that actually triggered the warning or error.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
Reserved for internal or future use.
RequestError
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
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.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors By Number.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
Reserved for internal or future use.
Error
The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Error handling section of the Making a Trading API call guide for more information.
Warning
The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning dateTime Conditionally Contains information about Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration
OrderArray OrderArrayType Always This container is an array of unacknowledged orders for the seller that occurred within the last 30 days (or less based on the Bulk Data Exchange job).
OrderArray.Errors ErrorType Conditionally,
repeatable: [0..*]		 This container will be returned if there are one or more errors or warnings with the corresponding order. This container consists of detailed information on the warning or error, including the actual error message and information on any input parameters that actually triggered the warning or error.
OrderArray.Errors
  .ErrorClassification 		ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
Reserved for internal or future use.
RequestError
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
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.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors By Number.
OrderArray.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.
OrderArray.Errors
  .ErrorParameters
  [ attribute ParamID ]		 string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
OrderArray.Errors
  .ErrorParameters.Value 		string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
OrderArray.Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
OrderArray.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
Reserved for internal or future use.
Error
The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, 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.


See the Error handling section of the Making a Trading API call guide for more information.
Warning
The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
OrderArray.Order OrderType Always,
repeatable: [1..*]		 Details of an eBay order. One eBay order can have one or more order line items (Transaction objects).

See Combined Invoice.
OrderArray.Order
  .AdjustmentAmount 		AmountType (double) Always This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
OrderArray.Order
  .AdjustmentAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.AmountPaid AmountType (double) Conditionally This value indicates the total amount paid by the buyer for the order. This amount includes the sale price of each line item, shipping and handling charges, additional services, and any sales tax applied towards the order. This value is only returned after the buyer has paid for the order.
Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher.
OrderArray.Order.AmountPaid
  [ attribute currencyID ]		 CurrencyCodeType Always This value indicates the total amount paid by the buyer for the order. This amount includes the sale price of each line item, shipping and handling charges, additional services, and any sales tax applied towards the order. This value is only returned after the buyer has paid for the order.
Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.AmountSaved AmountType (double) Always This value indicates the amount that the buyer saved on the order due to any discounts (item, shipping, promotional) applied to the purchase, or if the seller 'manually' reduced the order total. This field is always returned even when it is '0.0'.
OrderArray.Order.AmountSaved
  [ attribute currencyID ]		 CurrencyCodeType Always This value indicates the amount that the buyer saved on the order due to any discounts (item, shipping, promotional) applied to the purchase, or if the seller 'manually' reduced the order total. This field is always returned even when it is '0.0'.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .BuyerCheckoutMessage 		string Conditionally This field is returned if the buyer left a message for the seller during checkout.
OrderArray.Order
  .BuyerPackageEnclosures 		BuyerPackageEnclosuresType Conditionally
This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.
Note: The ContainingOrder.BuyerPackageEnclosures container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure 		BuyerPackageEnclosureType (string) Conditionally,
repeatable: [0..*]		 A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
OrderArray.Order
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
  [ attribute type ]		 PaymentInstructionCodeType Conditionally A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

For a list of possible enumeration values, see PaymentInstructionCodeType.
OrderArray.Order
  .BuyerTaxIdentifier 		TaxIdentifierType Conditionally,
repeatable: [0..*]
This container will either consist of VAT or Codice Fiscale taxpayer identification information for the buyer.

It is required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.

On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.

This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier container will be returned for each tax ID that is associated with the buyer's account.
Note: The ContainingOrder.BuyerTaxIdentifier container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .BuyerTaxIdentifier.Attribute 		TaxIdentifierAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.
OrderArray.Order
  .BuyerTaxIdentifier.Attribute
  [ attribute name ]		 TaxIdentifierAttributeCodeType Conditionally
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

For a list of possible enumeration values, see TaxIdentifierAttributeCodeType.
OrderArray.Order
  .BuyerTaxIdentifier.ID 		string Conditionally
This value is the actual tax ID for the buyer. The type of tax ID is shown in the Type field.
OrderArray.Order
  .BuyerTaxIdentifier.Type 		ValueTypeCodeType Conditionally
This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process.

Applicable values: See Type.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order.BuyerUserID UserIDType (string) Always The eBay user ID of the order's buyer.
OrderArray.Order.CancelReason token Conditionally This value indicates the reason why the order cancellation was initiated. This field is only returned if an order cancellation has been initiated by the buyer or seller. Typical buyer-initiated cancellation reasons include 'OrderPlacedByMistake', 'WontArriveInTime', or 'FoundCheaperPrice'. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as 'BuyerCancelOrder'. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as 'OutOfStock'. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. See CancelReasonCodeType for the complete list of enumeration values that can be returned in this field.

Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request.

Applicable values: See CancelReasonCodeType
OrderArray.Order.CancelStatus CancelStatusCodeType Conditionally The current status for the order cancellation request (if it exists for the order). This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.

Note: Only the CancelReason and CancelStatus fields are returned. The CancelDetail container and the CancelReasonDetails field are no longer returned. A seller can use the Search Cancellations method of the Post-Order API to retrieve more details on a cancelled order. If the seller does use this method, they can use the Order ID or Item ID as a filter in the request to retrieve the correct cancellation request.

Applicable values: See CancelStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .CheckoutStatus 		CheckoutStatusType Always This container indicates the current status of the order, including a timestamp that indicates the last time that the status of the order changed. For orders that have been paid for, the Status value will show as Complete.
OrderArray.Order
  .CheckoutStatus
  .eBayPaymentStatus 		PaymentStatusCodeType Always Indicates the status of the buyer's payment for an order. If the payment was successfuly processed, a value of NoPaymentFailure will be returned.

Applicable values:

BuyerFailedPaymentReportedBySeller
This value indicates that the seller reported the buyer's offline payment as failed. This enumeration value would only be applicable for a sales transaction that occurred off of eBay's platform.
CustomCode
Reserved for internal or future use.
NoPaymentFailure
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
This value indicates that the buyer's payment is in process, but has not yet cleared.

Note: This value may also get returned for a sales transaction that occurred off of eBay's platform, and the payment status may stay in this state unless the seller marks the order as paid.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .CheckoutStatus
  .IntegratedMerchantCreditCardEnabled 		boolean Always This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments.
OrderArray.Order
  .CheckoutStatus
  .LastModifiedTime 		dateTime Always This timestamp indicates when the order was last modified.
OrderArray.Order
  .CheckoutStatus
  .PaymentInstrument 		BuyerPaymentInstrumentCodeType Conditionally The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethod field.

Applicable values: See PaymentInstrument.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .CheckoutStatus.PaymentMethod 		BuyerPaymentMethodCodeType Always The payment method that the buyer selected to pay for the order.

Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.

Applicable values:

CashOnPickup
This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
Reserved for internal or future use.
MOCC
This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .CheckoutStatus.Status 		CompleteStatusCodeType Always Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status field reads Incomplete when payment has yet to be initiated, Pending when payment has been initiated but is in process, and Complete when the payment process has completed.

Note: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The Status value will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

Applicable values:

Complete
This value indicates that the order or order line item is complete. Generally speaking, an order or order line item is complete when payment from the buyer has been initiated and has been processed.

Note: If the PaymentMethodUsed is CashOnPickup, the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
CustomCode
Reserved for internal or future use
Incomplete
This value indicates that the order or order line item is in the incomplete state. Generally speaking, an order or order line item is considered incomplete when payment from the buyer has yet to be initiated.
Pending
This value indicates that the order or order line item is in the pending state. Generally speaking, an order is considered pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the payment method is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller changes the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .ContainseBayPlusTransaction 		boolean Conditionally If true, the order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia.

See eBay Plus for more details.
OrderArray.Order.CreatedTime dateTime Always Timestamp that indicates the date and time that the order was created.

Note: For single line item orders, this timestamp value is often the same as the CreatedDate field in the corresponding Transaction container.
OrderArray.Order
  .CreatingUserRole 		TradingRoleCodeType Conditionally This value indicates whether a 'Combined Invoice' order was initiated/created by the buyer or by the seller. This field is only returned for Combined Invoice orders.

An AddOrder call can be used by a seller or buyer to combine two or more unpaid order line items into a 'Combined Invoice' order. Once two or more line items are successfully combined into one order, the buyer only needs to make one payment (instead of multiple payments - one for each order line item). The CreatingUserRole field is required in the AddOrder call request.

Note: Except for listings that required immediate payment, buyers also may have the opportunity to combine multiple line items (from the same seller) into a 'Combined Invoice' order through the buy/checkout flow. This may include accepted Best Offers or auctions that the buyer wins.

Applicable values:

Buyer
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
This value is reserved for future or internal use.
Seller
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.

Code so that your app gracefully handles any future changes to this list.

See Combined Invoice.
OrderArray.Order
  .eBayCollectAndRemitTax 		boolean Always
This boolean field is returned as true if one or more line items in the order are subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false (not subject to eBay Collect and Remit). A Transaction.eBayCollectAndRemitTaxes container is returned for any order line items subject to such a tax, and the type and amount of this tax is displayed in the Transaction.eBayCollectAndRemitTaxes.TaxDetails container.

Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic.

As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.
Note: The ContainingOrder.eBayCollectAndRemitTax field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order.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.
OrderArray.Order
  .ExtendedOrderID 		string Conditionally A unique identifier for an eBay order in the eBay REST API model. ExtendedOrderID values will be used to identify orders in REST-based APIs, including the Post-Order API and the Fulfillment API.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties.

Note: As of June 2019, eBay has changed the format of order identifier values, and this new format is relevant to both legacy and REST API-based order ID fields. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.
OrderArray.Order
  .IsMultiLegShipping 		boolean Conditionally
If IsMultilegShipping is true, at least one order line item in the order will not be shipped directly to the buyer. Orders requiring multiple shipping legs include international orders being shipped through the Global Shipping Program or through eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program. For both international shipping options, the address of the shipping logistics provider is shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. Similarly, for Authenticity Guarantee orders, the authentication partner's shipping address is shown in the same container.

If an order line item is subject to the Authenticity Guarantee service, the <b>Transaction.Program</b> container will be returned.
Note: The ContainingOrder.IsMultiLegShipping field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .LogisticsPlanType 		token Conditionally
This field will be returned at the order level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.

Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.
Note: The ContainingOrder.LogisticsPlanType field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See LogisticsPlanCodeType
OrderArray.Order
  .MonetaryDetails 		PaymentsInformationType Conditionally
Contains information about each monetary transaction that occurs for the order, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container.
Note: The ContainingOrder.MonetaryDetails container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
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.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment 		PaymentTransactionType Conditionally,
repeatable: [0..*]		 This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government.

Note: Australia import tax is only applicable to the Australia site.
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.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payee 		UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]		 UserIdentityCodeType Conditionally The person or organization who is to receive the payment allocation.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payer 		UserIdentityType (string) Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]		 UserIdentityCodeType Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentAmount 		AmountType (double) Conditionally The amount of the payment that is allocated to the payee.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount of the payment that is allocated to the payee.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID 		TransactionReferenceType (string) Conditionally,
repeatable: [0..*]		 The payment transaction ID.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally The payment transaction ID.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.PaymentTime 		dateTime Conditionally The date and time when the payment is received by the payee.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.ReferenceID 		TransactionReferenceType (string) Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
OrderArray.Order
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .MonetaryDetails.Refunds 		RefundInformationType Conditionally This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund 		RefundTransactionInfoType Conditionally,
repeatable: [0..*]		 This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount 		AmountType (double) Conditionally This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.ReferenceID 		TransactionReferenceType (string) Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundAmount 		AmountType (double) Conditionally This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundTime 		dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundTo 		UserIdentityType (string) Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundTo
  [ attribute type ]		 UserIdentityCodeType Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .MonetaryDetails.Refunds
  .Refund.RefundType 		RefundSourceTypeCodeType Conditionally This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

CustomCode
This value is reserved for internal or future use.
PaymentRefund
This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
StoreCredit
This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .MultiLegShippingDetails 		MultiLegShippingDetailsType Conditionally
This container consists of details related to the first leg of an order requiring multiple shipping legs. Types of orders that require multiple shipping legs include international orders going through Global Shipping Program or eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program. If the item is subject to the Authenticity Guarantee service program, the seller ships the item to the authentication partner, and if the item passes an authentication inspection, the authentication partner ships it directly to the buyer.

This container is only returned if the order has one or more order line items requiring multiple shipping legs.
Note: The ContainingOrder.MultiLegShippingDetails container will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider 		MultiLegShipmentType Conditionally Contains information about the domestic leg of a international order being shipped through the Global Shipping Program or eBay International Shipping, including the selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.
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.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .ShippingService 		token Conditionally The shipping service specified for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost 		AmountType (double) Conditionally The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
  [ attribute currencyID ]		 CurrencyCodeType Always The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax 		int Conditionally The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin 		int Conditionally The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress 		AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a Global Shipping Program shipment, this container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order. For an eBay International Shipping shipment, the eBay Virtual Tracking Number is returned in the field.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute 		AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
  [ attribute type ]		 AddressAttributeCodeType Conditionally
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.

For a list of possible enumeration values, see AddressAttributeCodeType.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID 		string 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.

Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner 		AddressOwnerCodeType Always This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.

Applicable values:

CustomCode
Reserved for internal or future use.
eBay
This value indicates that the buyer's shipping address being referenced is on file with eBay.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName 		string Conditionally The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Country 		CountryCodeType Always The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.



Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName 		string Always The full name of the country associated with an address on file with eBay.

Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Name 		string Conditionally
The eBay user's name associated with an address on file with eBay.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
Max length: 128.
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.

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. .
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode 		string Always User's postal code.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID 		string Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince 		string Conditionally The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1 		string Always The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2 		string Always The second line of the user's street address (such as an apartment number or suite number).

Returned if the user specified a second street value for their address.
Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order.OrderID OrderIDType (string) Always A unique identifier for a single or multiple line item eBay order. In the ContainingOrder container of a GetItemTransactions or GetSellerTransactions response, this identifier identifies the parent order of the order line item. A single buyer payment is made for each order.

For order management calls only: This field is returned with the correct order ID only to the buyer and the seller. For third parties:
  • If using Trading WSDL version 1019 or newer (or Compatibility Level is set to '1019' or newer), the Order ID will be returned to third parties as an empty field (<OrderID/>).
  • If using a Trading WSDL older than version 1019, the Order ID will be returned to third parties as dummy data in the form of 1000000000000 or 1000000000000-1000000000000.

Note: The unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including GetOrders calls, will support the identifiers for both unpaid and paid orders. The revised order ID format (introduced in June 2019) is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders calls, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.
Max length: 40.
OrderArray.Order.OrderStatus OrderStatusCodeType Always This enumeration value indicates the current status of the order.

Applicable values: See OrderStatus.
Code so that your app gracefully handles any future changes to this list.
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 API data types section of the Making a Trading API call guide for information about converting between GMT and other time zones.
OrderArray.Order
  .PaymentHoldStatus 		PaymentHoldStatusCodeType Always This field indicates the type and/or status of a payment hold on the item. It is always returned for GetOrders, even if there are no payment holds (in which case, an enumeration value of None is shown).
Note: For the GetItemTransactions and GetOrders calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party. Note: This field will stop being returned by GetItemTransactions and GetSellerTransactions on January 31, 2024.

Applicable values: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .PaymentMethods 		BuyerPaymentMethodCodeType Always,
repeatable: [1..*]		 In GetOrders and OrderReport, a PaymentMethods field will appear for each payment method available to the buyer for the order's purchase. However, once the buyer pays for the order, any and all of these PaymentMethods fields will stop being returned, and instead, the actual payment method used will be returned in the PaymentMethod field of the CheckoutStatus container.

In an AddOrder call, the seller can use one or more PaymentMethods fields to override whatever available payment methods were already defined for each individual line item.

Note: For AddOrder, the seller can only specify offline payment methods (if offline payment is supported for the listing), as eBay now controls all electronic payment methods avaialable to buyers, and sellers have no control over these payment methods.

Applicable values:

CashOnPickup
This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
Reserved for internal or future use.
MOCC
This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order.PickupDetails PickupDetailsType Conditionally Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

For GetOrders, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.
OrderArray.Order.PickupDetails
  .PickupOptions 		PickupOptionsType Conditionally,
repeatable: [0..*]		 Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.
OrderArray.Order.PickupDetails
  .PickupOptions.PickupMethod 		token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

Applicable values: See PickupMethodCodeType
OrderArray.Order.PickupDetails
  .PickupOptions.PickupPriority 		int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
OrderArray.Order
  .PickupMethodSelected 		PickupMethodSelectedType Conditionally Container consisting of details related to the selected pickup method, including the pickup method type, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant).

This container is only returned when the buyer has selected the In-Store Pickup or Click and Collect option and has paid for the order. All fields in the PickupMethodSelected container are static, except for the PickupStatus field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for these features. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.
OrderArray.Order
  .PickupMethodSelected
  .MerchantPickupCode 		string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .PickupMethodSelected
  .PickupFulfillmentTime 		dateTime Conditionally Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.
OrderArray.Order
  .PickupMethodSelected
  .PickupLocationUUID 		string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.
OrderArray.Order
  .PickupMethodSelected
  .PickupMethod 		token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

Applicable values: See PickupMethodCodeType
OrderArray.Order
  .PickupMethodSelected
  .PickupStatus 		PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .PickupMethodSelected
  .PickupStoreID 		string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .SellerEIASToken 		string Conditionally This is a unique identifier for the seller that does not change when the eBay user name is changed. This is useful when an application needs to associate a new eBay user name with the corresponding eBay user.

Note: For the GetOrders call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
OrderArray.Order.SellerEmail string Conditionally The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.

Note: For the GetOrders calls, this field is only returned to the seller of the order; this field is not returned to the buyer or to a third party.
OrderArray.Order.SellerUserID UserIDType (string) Conditionally This is the eBay user ID of the order's seller.
OrderArray.Order
  .ShippingAddress 		AddressType Always This container shows the shipping address for the order.

Note: For an Authenticity Guarantee program shipment, this is the address of the authenticator's warehouse. The authenticator is responsible for delivery to the buyer's shipping address.

Note: For transactions completed offline, the shipping address detail may be empty.

Note: For In-Store Pickup and Click and Collect orders, this is the address of the merchant's store where the buyer will pick up the order.

Note: For eBay Vault scenarios: GetOrders and GetItemTransactions calls, mock address details are returned for:

- Vault to vault orders: Buyer and Seller View

- Ship to vault orders: Mock addresses are returned for the Buyer View (only); the address returned for the Seller View will be the authenticator's address.

- Vault in-hand submission orders: the address returned for the Buyer View will be the authenticator's address.

The following address details are returned for mock addresses: 

 <ShippingAddress> 
   <Name>eBay Vault</Name> 
   <AddressID>Invalid Request</AddressID> 
   <AddressOwner>eBay</AddressOwner> 
   <AddressUsage>Invalid</AddressUsage> 
   <CityName>Invalid Request</CityName> 
   <Country>US</Country> 
   <CountryName>Invalid Request</CountryName> 
   <ExternalAddressID>Invalid Request</ExternalAddressID> 
   <Phone>Invalid Request</Phone> 
   <PostalCode>Invalid Request</PostalCode> 
   <StateOrProvince>Invalid Request</StateOrProvince> 
   <Street1>Invalid Request</Street1> 
   <Street2></Street2> 
 </ShippingAddress>

OrderArray.Order
  .ShippingAddress
  .AddressAttribute 		AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .ShippingAddress
  .AddressAttribute
  [ attribute type ]		 AddressAttributeCodeType Conditionally
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.

For a list of possible enumeration values, see AddressAttributeCodeType.
OrderArray.Order
  .ShippingAddress.AddressID 		string 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.

Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .ShippingAddress.AddressOwner 		AddressOwnerCodeType Always This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.

Applicable values:

CustomCode
Reserved for internal or future use.
eBay
This value indicates that the buyer's shipping address being referenced is on file with eBay.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .ShippingAddress.CityName 		string Conditionally The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .ShippingAddress.Country 		CountryCodeType Always The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.



Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .ShippingAddress.CountryName 		string Always The full name of the country associated with an address on file with eBay.

Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .
OrderArray.Order
  .ShippingAddress.Name 		string Conditionally
The eBay user's name associated with an address on file with eBay.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
Max length: 128.
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.

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. .
OrderArray.Order
  .ShippingAddress.PostalCode 		string Always User's postal code.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .ShippingAddress
  .StateOrProvince 		string Conditionally The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .ShippingAddress.Street1 		string Always The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .ShippingAddress.Street2 		string Always The second line of the user's street address (such as an apartment number or suite number).

Returned if the user specified a second street value for their address.
Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .ShippingDetails 		ShippingDetailsType Always Container consisting of order-level shipping details. More shipping-related details can be found at the line item level for each line item in the order.

In an AddOrder call, the seller can use the ShippingDetails container to make adjustments to shipping details, including the available shipping service options and shipping cost. Sometimes, sellers will reduce the cost of shipping if one or more order line items can be shipped together in the same package.
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.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead.
OrderArray.Order
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts 		AmountType (double) Conditionally This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.
OrderArray.Order
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Always This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.
OrderArray.Order
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Always 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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption 		InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge 		AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService 		token Conditionally An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails.

To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

For flat and calculated shipping.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-types-rates.html.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation 		string Conditionally,
repeatable: [0..*]		 An international location or region to where the item seller will ship the item.

Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

For the AddItem family of calls, this field is required if any international shipping service is specified.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

See Shipping information.



Applicable values: See CountryCodeType, ShippingRegionCodeType
OrderArray.Order
  .ShippingDetails.SalesTax 		SalesTaxType Conditionally This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.

This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions.

This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).

See Multi-jurisdiction sales tax.
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxAmount 		AmountType (double) Conditionally The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince.
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxPercent 		float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .ShippingDetails.SalesTax
  .SalesTaxState 		string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same.

The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction.
OrderArray.Order
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax 		boolean Conditionally This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with the SalesTax container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
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, and GetOrders.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of 0 will be returned to all third parties.

The sale record ID can be for a single or a multiple line item order.

Note: For the GetItemTransactions and GetOrderscalls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<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. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup.
For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService 		boolean Conditionally This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge 		AmountType (double) Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo 		ShippingPackageInfoType Conditionally,
repeatable: [0..*]		 This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo
  .ShippingTrackingEvent 		token Conditionally This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

Applicable values: See ShippingTrackingEventCodeType
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo.StoreID 		string Conditionally The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService 		token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order
  .ShippingDetails.TaxTable 		TaxTableType Conditionally Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned.

For GetItem, a tax table is returned if it exists when:
  • DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter)
  • IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes
OrderArray.Order
  .ShippingDetails.TaxTable
  .TaxJurisdiction 		TaxJurisdictionType Conditionally,
repeatable: [0..*]		 In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table.

If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.

This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID 		string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction.

The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction.
OrderArray.Order
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent 		float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax 		boolean Conditionally This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with each TaxJurisdiction container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .ShippingServiceSelected 		ShippingServiceOptionsType Always Container consisting of details about the domestic or international shipping service selected by the buyer for delivery of the order. Note that more shipping service information may be returned at the order line item level in the Transaction.ShippingServiceSelected container.
OrderArray.Order
  .ShippingServiceSelected
  .ExpeditedService 		boolean Conditionally This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
OrderArray.Order
  .ShippingServiceSelected
  .ImportCharge 		AmountType (double) Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
OrderArray.Order
  .ShippingServiceSelected
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo 		ShippingPackageInfoType Conditionally,
repeatable: [0..*]		 This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMax 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMin 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .HandleByTime 		dateTime Conditionally This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MaxNativeEstimatedDeliveryTime 		dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MinNativeEstimatedDeliveryTime 		dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ShippingTrackingEvent 		token Conditionally This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

Applicable values: See ShippingTrackingEventCodeType
OrderArray.Order
  .ShippingServiceSelected
  .ShippingPackageInfo.StoreID 		string Conditionally The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingService 		token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .ShippingServiceSelected
  .ShippingServicePriority 		int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order.Subtotal AmountType (double) Always The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item.
OrderArray.Order.Subtotal
  [ attribute currencyID ]		 CurrencyCodeType Always The cumulative item cost for all line items in the order. This value does not take into account any shipping/handling costs, sales tax costs, or any discounts. For a single line item order, the amount in this field should be the same as the amount in the Transaction.TransactionPrice field. For a multiple line item order, the amount in this field should equal the cumulative amount of each Transaction.TransactionPrice fields for each order line item.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order.Total AmountType (double) Always The Total amount shows the total cost for the order, including total item cost (shown in Subtotal field), shipping charges (shown in ShippingServiceSelected.ShippingServiceCost field), and sales tax (shown in SalesTax.SalesTaxAmount field).
Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher.
In an AddOrder call, the seller can pass in the Total amount for the 'Combined Invoice' order, and this is what the buyer will be expected to pay for the order.
OrderArray.Order.Total
  [ attribute currencyID ]		 CurrencyCodeType Always The Total amount shows the total cost for the order, including total item cost (shown in Subtotal field), shipping charges (shown in ShippingServiceSelected.ShippingServiceCost field), and sales tax (shown in SalesTax.SalesTaxAmount field).
Note: For GetOrders only: If using Trading WSDL Version 1307 or above, the amount in this field will include sales tax. If using a Trading WSDL older than Version 1307, the amount in this field will not include sales tax. To incorporate the new logic while using a Trading WSDL that is older than 1307, developers can also use the X-EBAY-API-COMPATIBILITY-LEVEL header and set its value to 1307 or higher.
In an AddOrder call, the seller can pass in the Total amount for the 'Combined Invoice' order, and this is what the buyer will be expected to pay for the order.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray 		TransactionArrayType Always Container consisting of one or more line items that comprise an order. The data for each order line item in the order is stored in a separate Transaction container.

Under the TransactionArray container in an AddOrder call, a seller or buyer specifies two or more (up to 40) order line items into a 'Combined Invoice' order.

See Combined Invoice.
OrderArray.Order
  .TransactionArray.Transaction 		TransactionType Always,
repeatable: [1..*]		 A Transaction container is returned for each line item in the order. This container consists of detailed information on one order line item.

For the AddOrder call, a Transaction container is used to identified the unpaid order line items that are being combined into one Combined Invoice order.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualHandlingCost 		AmountType (double) Conditionally The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete.

The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualHandlingCost
  [ attribute currencyID ]		 CurrencyCodeType Always The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete.

The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualShippingCost 		AmountType (double) Conditionally The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
OrderArray.Order
  .TransactionArray.Transaction
  .ActualShippingCost
  [ attribute currencyID ]		 CurrencyCodeType Always The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .BundlePurchase 		boolean Conditionally Boolean value indicating whether or not an order line item is part of a bundle purchase using Product Configurator.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer 		UserType Conditionally Container consisting of user and shipping details for the order's buyer. To be returned by GetItemsAwaitingFeedback the seller must be the one making the request.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
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.

See Anonymous user information.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier 		TaxIdentifierType Conditionally,
repeatable: [0..*]		 This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.

It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.

On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.

This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier will be returned for each tax ID that is associated with the buyer's account.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Attribute 		TaxIdentifierAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Attribute
  [ attribute name ]		 TaxIdentifierAttributeCodeType Conditionally
This field shows an attribute, and its corresponding value for the buyer's tax identification card. Currently, this field is only used to indicate which country issued the buyer's tax ID, but in the future, other attributes related to the tax ID may be returned in this field. This field's value will be an ISO 3166-1 two-digit code that represents the issuing country.

For a list of possible enumeration values, see TaxIdentifierAttributeCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.ID 		string Conditionally
This value is the actual tax ID for the buyer. The type of tax ID is shown in the Type field.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.BuyerInfo
  .BuyerTaxIdentifier.Type 		ValueTypeCodeType Conditionally
This enumeration value identifies the type of tax ID that was supplied by the buyer during the checkout process.

Applicable values: See Type.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.Email 		string Conditionally Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site.

An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.

For the GetOrders call, the buyer's email address will be returned (to the seller only) for orders less than two weeks old, but for orders that occurred more than two weeks in the past, the buyer's email address will no longer be returned. This Email field will still be returned, but 'dummy data', such as Invalid Request will replace the actual email address.

Note: For the GetItemTransactions call, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field .

See:
    Anonymous user information
    Member communications

OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.UserFirstName 		string Conditionally
The first name of the buyer or seller involved in the order.
Note: The Seller.UserFirstName field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .TransactionArray.Transaction
  .Buyer.UserLastName 		string Conditionally
The last name of the buyer or seller involved in the order.
Note: The Seller.UserLastName field will stop being returned in GetItemTransactions and GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .TransactionArray.Transaction
  .BuyerPackageEnclosures 		BuyerPackageEnclosuresType Conditionally This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the Germany site.
OrderArray.Order
  .TransactionArray.Transaction
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure 		BuyerPackageEnclosureType (string) Conditionally,
repeatable: [0..*]		 A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.
OrderArray.Order
  .TransactionArray.Transaction
  .BuyerPackageEnclosures
  .BuyerPackageEnclosure
  [ attribute type ]		 PaymentInstructionCodeType Conditionally A BuyerPackageEnclosure container will be returned for each shipping package containing payment instructions. The 'Pay Upon Invoice' option is only available on the German site.

For a list of possible enumeration values, see PaymentInstructionCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .CreatedDate 		dateTime Always This timestamp indicates date/time when the sales transaction occurred. A sales transaction is created when there is a commitment to buy, or when the buyer purchases the item through a 'Buy it Now' option. For auction listings, a sales transaction is created when that listing ends with a high bidder whose bid meets or exceeds the Reserve Price (if set). For a fixed-price listing or a 'Buy It Now' auction listing, a sales transaction is created once the buyer clicks the Buy button.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected 		DigitalDeliverySelectedType Conditionally This container is only returned by GetOrders and other order management calls if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift (in this case, the Gift boolean field will be returned with a value of true). The DigitalDeliverySelected container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails 		DeliveryDetailsType Conditionally This container is returned by GetOrders and other order management calls to provide details on the recipient of a digital gift card that was purchased. The DeliveryDetails container is only returned if the buyer is buying a digital gift card and giving that gift card to another person.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient 		DigitalDeliveryUserType Conditionally This container consists of the name and email of the person who is receiving the digital gift card. If the buyer has purchased the gift card for themselves, the buyer's name and email will appear in this container. If the buyer is giving the gift card to another individual, that individual's name and email will appear in this container. This container is always returned for a digital gift card line item.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient
  .Email 		string Conditionally This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Recipient
  .Name 		string Conditionally This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender 		DigitalDeliveryUserType Conditionally This container consists of the name and email of the person who purchased the digital gift card. This container is only returned if the purchaser of the digital gift card is giving the gift card to someone else, and that individual's name and email will appear in the Recipient container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this container will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and dummy/masked data will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender.Email 		string Conditionally This field displays the email address of the sender/purchaser of the digital gift card (applicable for the Sender container) or the email address of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient email address is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryDetails.Sender.Name 		string Conditionally This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card (applicable for the Sender container) or the actual name of the recipient of the digital gift card (applicable for the Recipient container). Both the sender and recipient name is provided by the purchaser of the digital gift card at time of purchase.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryMethod 		token Conditionally This value indicates the method in which the digital gift card will be delivered to the buyer or to the person whom the purchaser is giving the digital gift card to. Currently, the only supported delivery method is by email.

Applicable values: See DeliveryMethodCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryStatus 		DeliveryStatusType Conditionally This container consists of the current status of whatever delivery method is being used (indicated in the DigitalDeliverySelected.DeliveryMethod field). Currently, the only supported delivery method is by email.
OrderArray.Order
  .TransactionArray.Transaction
  .DigitalDeliverySelected
  .DeliveryStatus.Email 		token Conditionally This value indicates the current delivery status for the digital gift card that is being delivered by email. Currently, the only supported delivery status value is 'Notified', which indicates that the link to download the digital gift card has been sent to the recipient by email.

Applicable values: See DeliveryStatusEmailCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTax 		boolean Conditionally This boolean field is returned as true if the line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false (not subject to eBay Collect and Remit). An eBayCollectAndRemitTaxes container is returned if the order line item is subject to such a tax, and the type and amount of this tax is displayed in the eBayCollectAndRemitTaxes.TaxDetails container.

Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic.

As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes 		TaxesType Conditionally This container is returned if the order line item is subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. The type of tax will be shown in the TaxDetails.Imposition and TaxDetails.TaxDescription fields, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field.

Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Sellers on the Australia site do not have to take any extra steps to enable the collection of GST, as this tax is collected by eBay and remitted to the Australian government. For more information about Australian GST, see the Taxes and import charges help topic.

As of January 2023, buyers in all US states will automatically be charged sales tax for purchases, and the seller does not set this rate. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. For more US state-level information on sales tax, see the eBay sales tax collection help topic.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .eBayReference 		eBayTaxReferenceValue (string) Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .eBayReference
  [ attribute name ]		 string Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails 		TaxDetailsType Conditionally,
repeatable: [0..*]		 Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.CollectionMethod 		CollectionMethodCodeType Conditionally This field indicates the collection method used to collect the 'eBay Collect and Remit' or 'Good and Services' tax for the order. This field is always returned for orders subject to 'Collect and Remit' or 'Good and Services' tax, and its value is always NET.

Note: Although the CollectionMethod field is returned for all orders subject to 'Collect and Remit' sales tax or 'Good and Services' tax, the CollectionMethod field and CollectionMethodCodeType are not currently of any practical use, although this field may have use in the future. If and when the logic of this field is changed, this note will be updated and a note will also be added to the Release Notes.

Applicable values:

NET
This value is always returned, but because the CollectionMethod field and CollectionMethodCodeType are not currently applicable, this value does not have any purpose at this time.

(Not all values in CollectionMethodCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.Imposition 		TaxTypeCodeType Conditionally This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).

Applicable values: See Imposition.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxAmount 		AmountType (double) Conditionally This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxCode 		string Conditionally This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails.TaxDescription 		TaxDescriptionCodeType Conditionally This enumeration value indicates the type of tax charged against the item.

Applicable values:

CustomCode
Reserved for internal or future use.
ElectronicWasteRecyclingFee
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
GST
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

Note: At this time, this tax type is only applicable to the Australia site.
SalesTax
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
TireRecyclingFee
This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnHandlingAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnHandlingAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnShippingAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnShippingAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnSubtotalAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TaxDetails
  .TaxOnSubtotalAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TotalTaxAmount 		AmountType (double) Conditionally This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayCollectAndRemitTaxes
  .TotalTaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .eBayPlusTransaction 		boolean Conditionally If true, the buyer of the order line item has a eBay Plus program subscription, and is eligible to receive the benefits of this program, such as fast, free shipping and free returns. Top-Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany and Australia.

See eBay Plus for more details.
OrderArray.Order
  .TransactionArray.Transaction
  .ExtendedOrderID 		string Conditionally A unique identifier for an eBay order. This field is only returned for paid orders, and not unpaid orders.
Note: ExtendedOrderID was first created when eBay changed the format of Order IDs back in June 2019. For a short period, the OrderID field showed the old Order ID format and the ExtendedOrderID field showed the new Order ID format. For paid orders, both OrderID and ExtendedOrderID now show the same Order ID value.
For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties.

Max length: 40.
OrderArray.Order
  .TransactionArray.Transaction
  .FinalValueFee 		AmountType (double) Conditionally A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.
OrderArray.Order
  .TransactionArray.Transaction
  .FinalValueFee
  [ attribute currencyID ]		 CurrencyCodeType Always A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. Note that this fee is created before the buyer makes a payment. As long as the IncludeFinalValueFee field is included in the call request and set to 'true', the Final Value Fee for each order line item is returned, regardless of the checkout status.

If a seller requests a Final Value Fee credit, the value of Transaction.FinalValueFee will not change if a credit is issued. The credit only appears in the seller's account data.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Gift 		boolean Conditionally This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
OrderArray.Order
  .TransactionArray.Transaction
  .GiftSummary 		GiftSummaryType Conditionally This container is returned in GetOrders and other order management calls if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient. The GiftSummary container consists of the message that the buyer wrote for the recipient of the digital gift card. A digital gift card line item is indicated if the DigitalDeliverySelected container is returned in the response, and if the digital gift card is sent to another individual as a gift, the Gift boolean field will be returned with a value of true.
OrderArray.Order
  .TransactionArray.Transaction
  .GiftSummary.Message 		string Conditionally This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.

For GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, real data is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .GuaranteedDelivery 		boolean Always This field is deprecated, and can be ignored if returned. The Guaranteed Delivery program is no longer supported on any eBay marketplace.
OrderArray.Order
  .TransactionArray.Transaction
  .GuaranteedShipping 		boolean Conditionally Note: This field is for future use, as the eBay Guaranteed Shipping feature has been put on hold. eBay Guaranteed Shipping should not be confused with eBay Guaranteed Delivery, which is a completely different feature. This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time. With eBay's Guaranteed Shipping, the seller will never pay more for shipping than what is charged to the buyer. eBay recommends the shipping service option for the seller to use based on the dimensions and weight of the shipping package.
OrderArray.Order
  .TransactionArray.Transaction
  .InventoryReservationID 		string Conditionally The unique identifier of the inventory reservation.
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.
OrderArray.Order
  .TransactionArray.Transaction
  .Item 		ItemType Always This container consists of relevant details about the listing associated with the sales transaction. Which listing fields are returned under this container will depend on the listing, the eBay marketplace, and the API call.

In an AddOrder call, only the unique identifier of the listing (ItemID) is needed to help identify the sales transaction to combine into a 'Combined Invoice' order.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.ItemID 		ItemIDType (string) Always The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Site 		SiteCodeType Conditionally The name of the eBay listing site. 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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.SKU 		SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

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

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.
OrderArray.Order
  .TransactionArray.Transaction
  .Item.Title 		string Always This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
Max length: 80.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray 		LinkedLineItemArrayType Conditionally Note: This array is only returned if the order has associated linked line items. Container consisting of an array of linked line item objects.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem 		LinkedLineItemType Conditionally,
repeatable: [0..*]		 This container shows a line item that is related to the corresponding order, but not a part of that order. Details can identify the linked seller and also include delivery times, item information, and order information.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem
  .EstimatedDeliveryTimeMax 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the original estimated window during which delivery can be expected. The EstimatedDeliveryTimeMax value indicates the latest date and time to receive the order.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem
  .EstimatedDeliveryTimeMin 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the original estimated window during which delivery can be expected. The EstimatedDeliveryTimeMin value indicates the earliest date and time to receive the order.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.Item 		ItemType Conditionally Container consisting of details about the linked item. Note: All item specifics for the listing are returned. The name/value pairs returned are in the language of the linked line item's listing site, which may vary from the seller's language.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.Item.ItemID 		ItemIDType (string) Always The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. Once an item is successfully created, the ItemID cannot be modified.

Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. Your code should be prepared to handle IDs of up to 19 digits.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.Item.Site 		SiteCodeType Conditionally The name of the eBay listing site. 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 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 site, the visibility of the item in some types of searches (e.g., GetCategoryListings), 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).

Applicable values: See Site.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.Item.SKU 		SKUType (string) Conditionally A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. Each product within a seller's inventory should be unique. Most large-volume sellers use SKUs, but eBay only requires a SKU value if the InventoryTrackingMethod field is included in an AddFixedPriceItem call and its value is set to SKU. Setting the InventoryTrackingMethod field to SKU allows the seller to use a SKU value instead of an ItemID value as a unique identifier in calls such as GetItem and ReviseInventoryStatus

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

If both ItemID and SKU are specified in calls that support the use of SKU as a unique identifier, the ItemID value takes precedence.

If a seller wants to use SKUs for multiple-variation listings, the SKU value for each product variation is actually specified at the variation level (Item.Variations.Variation.SKU) field, and the Item.SKU) field should not be included in the call request.

Note: The eBay site 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 GetItem, GetMyeBaySelling, and other 'Get' call, the SKU value will only be returned if defined for the listing.

Max length: 50.

See eBay Merchant Data API for AddFixedPriceItem and ReviseFixedPriceItem.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.Item.Title 		string Always This field is used to specify the title of the listing. This field is conditionally required in an Add call unless the seller successfully uses the ProductListingDetails container to find an eBay catalog product match. When the seller successfully uses an eBay catalog product to create a listing, the listing title, listing description, Item Specifics, and stock photo defined in the catalog product are used to create the listing.

You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.)

The listing title can only be changed if the active listing has yet to have any bids or sales, and the listing does not end within 12 hours.
Note: When making a GetSellerEvents call, this field will be returned masked as ***************** for on-hold listings. Note: When making a GetSellerTransactions or GetMyeBaySelling call, the item ID value of the listing will be returned in this field to indicate that the listing is on hold.
Max length: 80.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.OrderID 		string Conditionally The unique identifier of the order to which the linked line item belongs.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem
  .OrderLineItemID 		string Conditionally The unique identifier of the linked order line item. For example, the order line item ID of the tire.
OrderArray.Order
  .TransactionArray.Transaction
  .LinkedLineItemArray
  .LinkedLineItem.SellerUserID 		string Conditionally The eBay user ID of the seller who sold the linked line item. For example, the user ID of the tire seller.
OrderArray.Order
  .TransactionArray.Transaction
  .LogisticsPlanType 		token Conditionally This field will be returned at the order line item level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.

Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order line item is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.

Applicable values: See LogisticsPlanCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails 		PaymentsInformationType Conditionally Contains information about each monetary transaction that occurs for the order line item, including order payment, any refund, a credit, etc. Both the payer and payee are shown in this container.

Note: MonetaryDetails can already be used instead of the older ExternalTransaction container, and the ExternalTransaction container may eventually get deprecated. Due to this possibility, you are encouraged to start using MonetaryDetails as soon as it is convenient.
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.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment 		PaymentTransactionType Conditionally,
repeatable: [0..*]		 This container consists of detailed information about each payment made by the buyer to pay for an order. In many cases, there may be only one payment - the payment made from the buyer to the seller, but in the case of an order going through the Global Shipping Program, one payment goes to the seller for the price of the order, and then an import charge and a portion of the shipping charges may go to eBay Global Shipping Program partner. In the case of an order that is subject to Australia import tax, one payment goes to the seller for the total price of the order, and the import tax goes to eBay for remittance to the Australian government.

Note: Australia import tax is only applicable to the Australia site.
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.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.FeeOrCreditAmount
  [ attribute currencyID ]		 CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

This field is not returned if the Payee field's type attribute is eBayPartner.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee 		UserIdentityType (string) Conditionally The person or organization who is to receive the payment allocation.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payee
  [ attribute type ]		 UserIdentityCodeType Conditionally The person or organization who is to receive the payment allocation.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer 		UserIdentityType (string) Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.Payer
  [ attribute type ]		 UserIdentityCodeType Conditionally This field indicates the eBay user or eBay partner who submitted the payment.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payer is returned to the buyer or seller, but the identity of the payer will be masked to all third parties.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentAmount 		AmountType (double) Conditionally The amount of the payment that is allocated to the payee.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount of the payment that is allocated to the payee.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID 		TransactionReferenceType (string) Conditionally,
repeatable: [0..*]		 The payment transaction ID.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally The payment transaction ID.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.PaymentTime 		dateTime Conditionally The date and time when the payment is received by the payee.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.ReferenceID 		TransactionReferenceType (string) Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Payments
  .Payment.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally A unique transaction ID for the payment.

This field is not returned if the Payee field's type attribute is eBayPartner.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds 		RefundInformationType Conditionally This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

This container is only returned if the buyer has returned an In-Store Pickup item to the merchant at a physical store, and the merchant has notified eBay through the ORDER.RETURNED notification of the Inbound Notifications API.

Note: At this time, the In-Store Pickup feature is generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund 		RefundTransactionInfoType Conditionally,
repeatable: [0..*]		 This container consists of detailed information on an In-Store Pickup item refund. This container is only returned if the merchant is refunding (or providing a store credit) the buyer for an In-Store Pickup item. A separate Refund container will be returned for each ORDER.RETURNED notification that the merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants on the US site, and can only be applied to multi-quantity, fixed-price listings. Eligible Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount 		AmountType (double) Conditionally This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.FeeOrCreditAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This dollar value is the total amount of the refund to the buyer for the In-Store Pickup order. Typically, this dollar value will be the same as the RefundAmount value, unless the merchant is issuing multiple refund transactions to the buyer, in which case, the FeeOrCreditAmount value will be the cumulative amount for multiple refund transactions. This field is not returned if the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.ReferenceID 		TransactionReferenceType (string) Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.ReferenceID
  [ attribute type ]		 TransactionReferenceCodeType Conditionally This value is a merchant-defined identifier used to track In-Store Pickup refunds. This value is picked up by eBay when the merchant passes in the REFUND_ID parameter through the payload of an ORDER.RETURNED notification sent to eBay. This field is not returned if the merchant does not set this value through ORDER.RETURNED notification.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct payment identifier is returned to the buyer or seller, but the payment identifier will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see TransactionReferenceCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundAmount 		AmountType (double) Conditionally This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This dollar value is the amount of the refund to the buyer for this specific refund transaction. This field is not returned for In-Store Pick or Click and Collect orders where the merchant issued the buyer a store credit instead of a refund (RefundType=STORE_CREDIT).
Note: For GetItemTransactions and GetSellerTransactions, the final value fee amount deducted from the seller's payout funds for the sale is not included in this field, which means that the amount in this field may not reflect the buyer's actual refund amount.

The logic will remain the same for GetItemTransactions and GetSellerTransactions, but the GetOrders call will be updated to include the the seller's final value fee amount in this field, so the amount in this field should match the buyer's actual refund amount. To pick up this new logic in GetOrders responses, a Trading WSDL version of 1311 or above must be used, or the user can use an older Trading WSDL version but include and set the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1311 or above.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTime 		dateTime Conditionally This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTo 		UserIdentityType (string) Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundTo
  [ attribute type ]		 UserIdentityCodeType Conditionally This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. This field is always returned with the Refund container.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the correct refund recipient is returned to the buyer or seller, but the refund recipient will be masked to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

For a list of possible enumeration values, see UserIdentityCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MonetaryDetails.Refunds
  .Refund.RefundType 		RefundSourceTypeCodeType Conditionally This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. Applicable values are 'REFUND' and 'STORE_CREDIT'. This value is picked up by eBay when the merchant passes in the REFUND_TYPE parameter through the payload of an ORDER.RETURNED notification sent to eBay.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values:

CustomCode
This value is reserved for internal or future use.
PaymentRefund
This value indicates that the merchant issued a cash refund (or debit card/credit card reversal) to the buyer for the amount of the returned item(s).
StoreCredit
This value indicates that the merchant issued a store credit to the buyer for the amount of the returned item(s).

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails 		MultiLegShippingDetailsType Conditionally This container consists of details related to the first leg of an order requiring multiple shipping legs. Types of orders that require multiple shipping legs include international orders going through the Global Shipping Program or through eBay International Shipping, as well as orders subject to/eligible for the Authenticity Guarantee program.If the item is subject to the Authenticity Guarantee service program, the seller ships the item to the authentication partner, and if the item passes an authentication inspection, the authentication partner ships it directly to the buyer.

This container is only returned if the order has one or more order line items requiring multiple shipping legs.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider 		MultiLegShipmentType Conditionally Contains information about the domestic leg of a international order being shipped through the Global Shipping Program or eBay International Shipping, including the selected shipping service, the domestic shipping cost, the domestic address of the international shipping provider, and the estimated shipping time range.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails 		MultiLegShippingServiceType Conditionally Contains information about the shipping service and cost of the domestic leg of a Global Shipping Program shipment.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .ShippingService 		token Conditionally The shipping service specified for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For the domestic leg, the value of this field can be any available shipping service that ships to the domestic address of the international shipping provider.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost 		AmountType (double) Conditionally The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingServiceDetails
  .TotalShippingCost
  [ attribute currencyID ]		 CurrencyCodeType Always The total shipping cost of the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMax 		int Conditionally The integer value returned here indicates the maximum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShippingTimeMin 		int Conditionally The integer value returned here indicates the minimum number of business days that the corresponding shipping service (indicated in ShippingServiceDetails.ShippingService field) will take to be delivered to eBay's domestic shipping partner.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to eBay's domestic shipping partner. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress 		AddressType Conditionally Contains shipping address information for the domestic leg of a Global Shipping Program shipment or an eBay International Shipping shipment. For a Global Shipping Program shipment, this container includes the ReferenceID field, which can be printed on the package to give the international shipping provider a unique identifier for the order. For an eBay International Shipping shipment, the eBay Virtual Tracking Number is returned in the field.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute 		AddressAttributeType (string) Conditionally,
repeatable: [0..*]
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress
  .AddressAttribute
  [ attribute type ]		 AddressAttributeCodeType Conditionally
This field shows an attribute for the address, and its corresponding value. Currently, this field is only used to display the reference ID for a "Click and Collect" order, but in the future, other address attributes may be returned in this field.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.

For a list of possible enumeration values, see AddressAttributeCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressID 		string 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.

Note: For orders subject to Australian 'Goods and Services' tax (GST), in addition to the unique identifier for the address, the last two digits of the user's Australian Business Number (ABN) will also appear in this field. Australian 'Goods and Services' tax (GST) is automatically charged to buyers outside of Australia when they purchase items on the eBay Australia site. Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.AddressOwner 		AddressOwnerCodeType Always This enumeration value returned here indicates the company that has the address on file. The value returned here should always be eBay.

Applicable values:

CustomCode
Reserved for internal or future use.
eBay
This value indicates that the buyer's shipping address being referenced is on file with eBay.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CityName 		string Conditionally The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so SG would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Country 		CountryCodeType Always The two-digit code representing the country of the user.

If not provided as input, eBay uses the country associated with the eBay Site ID when the call is made.



Applicable values: See Country.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.CountryName 		string Always The full name of the country associated with an address on file with eBay.

Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. .
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Name 		string Conditionally
The eBay user's name associated with an address on file with eBay.
Note: The Seller.RegistrationAddress container and its child fields will stop being returned in GetSellerTransactions on January 31, 2024.
Max length: 128.
OrderArray.Order
  .TransactionArray.Transaction
  .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.

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. .
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.PostalCode 		string Always User's postal code.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.ReferenceID 		string Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider.

Example: "Reference #1234567890123456" Note: International orders being sent through eBay International Shipping also contain reference IDs, but reference IDs for eBay International Shipping will be returned in the Street2 field instead.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.StateOrProvince 		string Conditionally The state or province associated with an address on file with eBay. Whether it's a state or a province will depend on the region and/or country. This field should only be passed in or returned if applicable/defined.

Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street1 		string Always The first line of the user's street address.

Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields.
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .TransactionArray.Transaction
  .MultiLegShippingDetails
  .SellerShipmentToLogisticsProvider
  .ShipToAddress.Street2 		string Always The second line of the user's street address (such as an apartment number or suite number).

Returned if the user specified a second street value for their address.
Note: In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Note: Note the different maximum lengths noted below for different countries. If a street name exceeds the maximum length for the applicable country, the full street name may be expressed through both the Street1 and Street2 fields. Note: In the case of TransactionArray.Transaction.MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress, if the item is being shipped through eBay International Shipping and this address refers to an intermediated warehouse address, the eBay Virtual Tracking number (eVTN) that is used for the domestic leg of the shipment is appended to Street2. This value is generated by eBay when the order is completed. Example:"Reference #1234567890123456"
Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
OrderArray.Order
  .TransactionArray.Transaction
  .OrderLineItemID 		string Always A unique identifier for an eBay order line item. This identifier is created as soon as there is a commitment to buy from the seller, or the buyer actually purchases the item using a 'Buy it Now' option.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, order line item ID is only returned to the buyer or seller, and a dummy value of 10000000000000 will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .PaidTime 		dateTime Conditionally Indicates the time when the buyer paid for the order and/or order was marked as 'Paid' by the seller. This field is returned once payment has been made by the buyer.

This value will only be visible to the user on either side of the order. An order can be marked as 'Paid' in the following ways:
  • Automatically when a payment is made through eBay's system
  • Seller marks the item as paid in My eBay or through Selling Manager Pro
  • Programmatically by the seller through the CompleteSale call.
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected 		PickupMethodSelectedType Conditionally This container consists of details related to the selected In-Store pickup method, including the pickup method, the merchant's store ID, the status of the In-Store pickup, and the pickup reference code (if provided by merchant).
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .MerchantPickupCode 		string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupFulfillmentTime 		dateTime Conditionally Timestamp indicating the date/time when the order is expected to be fulfilled by the merchant and available for pick up by the buyer.
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupLocationUUID 		string Conditionally The unique identifier of the merchant's store where the "Click and Collect" item will be picked up. This field will only be returned if supplied by the merchant.
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupMethod 		token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

Applicable values: See PickupMethodCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStatus 		PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .PickupMethodSelected
  .PickupStoreID 		string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderArray.Order
  .TransactionArray.Transaction
  .Program 		TransactionProgramType Conditionally This container gives the status of an order line item going through the Authenticity Guarantee service process. In the Authenticity Guarantee service program, a third-party authenticator must verify the authenticity of the item before it can be sent to the buyer.

This container is only returned for order line items subject to the Authenticity Guarantee service process, and if it is returned, the seller must make sure to send the item to the third-party authenticator's address (shown in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress field), and not to the buyer's shipping address. If the item is successfully authenticated, the authenticator will ship the item to the buyer.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification 		AuthenticityVerificationType Conditionally This container gives status on whether the order line item has passed or failed the authenticity inspection.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .OutcomeReason 		string Conditionally This field is returned after the third-party authenticator has performed the authentication inspection on the order line item.

Different values will be returned based on whether the item passed or failed the authentication inspection. This field is not returned when the status value of the order line item is PENDING or PASSED. The possible values returned here are CUSTOMIZED, MISCATEGORIZED, NOT_AUTHENTIC, NOT_AS_DESCRIBED, or NOT_AUTHENTIC_NO_RETURN.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost 		ServiceCostType Conditionally This container shows service cost to the buyer for an item that will go through the Authenticity Guarantee process.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost.Amount 		AmountType (double) Conditionally The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost.Amount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is given in the currency of the listing site.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost
  .ConvertedFromAmount 		AmountType (double) Conditionally The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .ServiceCost
  .ConvertedFromAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount (in the buyer's currency) charged to the buyer for any service cost related to an item going through the Authenticity Guarantee process. This amount is only applicable if the buyer resides in another country that uses a different currency than the currency of the listing site.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Program
  .AuthenticityVerification
  .Status 		string Conditionally The value in this field indicates whether the order line item has passed or failed the authenticity inspection, or if the test and/or results are still pending. The possible values returned here are PENDING, PASSED, PASSED_WITH_EXCEPTION, PASSED_WITH_PARTIAL_FAILURE, or FAILED.
OrderArray.Order
  .TransactionArray.Transaction
  .Program.Fulfillment 		FulfillmentType Conditionally This container provides details about an order line item being handled by eBay fulfillment. It is only returned for paid orders being fulfilled by eBay or an eBay fulfillment partner.
OrderArray.Order
  .TransactionArray.Transaction
  .Program.Fulfillment
  .FulfillmentBy 		string Conditionally The value returned in this field indicates the party that is handling fulfillment of the order line item.

For eBay Vault scenarios, for the GetOrders GetItemTransactions, and GetSellerTransactions calls, this value is returned as EBAY for either of the following fulfillment options:
  • Vault to Vault
  • Vault to Buyer
OrderArray.Order
  .TransactionArray.Transaction
  .Program.Fulfillment
  .FulfillmentRefId 		string Conditionally The value in this field identifies the warehouse where the order line item is located.

For eBay Vault scenarios: GetOrders and GetSellerTransactions calls, if FulfillmentBy is returned as EBAY, FulfillmentRefId is not returned.
OrderArray.Order
  .TransactionArray.Transaction
  .QuantityPurchased 		int Always This value indicates the quantity of the line item purchased at the same time by the same buyer from one listing. For auction listings, this value is always '1'. For fixed-price, non-variation listings, this value can be greater than 1.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts 		SellerDiscountsType Conditionally A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item. This container is only returned if the order line item is eligible for seller discounts.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemPrice 		AmountType (double) Conditionally The original purchase price of the order line item (before any seller discounts are applied).
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemPrice
  [ attribute currencyID ]		 CurrencyCodeType Always The original purchase price of the order line item (before any seller discounts are applied).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemShippingCost 		AmountType (double) Conditionally The original shipping cost for the order line item (before any seller discounts are applied).
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalItemShippingCost
  [ attribute currencyID ]		 CurrencyCodeType Always The original shipping cost for the order line item (before any seller discounts are applied).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .OriginalShippingService 		token Conditionally The original shipping service offered by the seller to ship an item to a buyer.

Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount 		SellerDiscountType Conditionally,
repeatable: [0..*]		 A container consisting of name and ID of the seller's discount campaign, as well as the discount amount that is being applied to the order line item.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .CampaignDisplayName 		string Conditionally The name of the seller discount campaign. This field will only be returned with the SellerDiscount container if defined for the seller discount campaign.
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.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ItemDiscountAmount 		AmountType (double) Conditionally The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign.

Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ItemDiscountAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The dollar amount of the order line item discount. The original purchase price (denoted in OriginalItemPrice) will be reduced by this value. The amount of the item discount will depend on the rules defined in the the seller discount campaign.

Note: Prior to Version 895, this field worked a little differently. Instead of this field showing the amount of the discount, it was actually showing the final item price after the discount was applied. So, if an item price is 10.0 dollars and the discount is 2.0 dollars, someone using Version 895 (and going forward) will see a value of '2.0' (amount of the discount) in this field, but anyone using Version 893 or lower will see a value of '8.0' (item price after discount) in this field.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ShippingDiscountAmount 		AmountType (double) Conditionally The dollar amount of the shipping discount applied to the order line item.
OrderArray.Order
  .TransactionArray.Transaction
  .SellerDiscounts
  .SellerDiscount
  .ShippingDiscountAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The dollar amount of the shipping discount applied to the order line item.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails 		ShippingDetailsType Conditionally Container consisting of shipping-related details for a sales transaction. Shipping details may include shipping rates, package dimensions, handling costs, excluded shipping locations (if specified), shipping service options, sales tax information (if applicable), and shipment tracking details (if shipped).

Note: For GetOrders, a ShippingDetails container is returned at the order at line item level.
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.

Note: The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts and/or PackagingHandlingCosts fields. The rest of the fields in the CalculatedShippingRate container are used to specify package dimensions and package weight, and these values should now be specified in the ShippingPackageDetails container instead.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts 		AmountType (double) Conditionally This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .InternationalPackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Always This field shows any package handling cost applied to international shipping. This cost will be in addition to any shipping cost applicable to each international shipping service option.

For international calculated shipping only.

For a list of possible enumeration values, see CurrencyCodeType.
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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .CalculatedShippingRate
  .PackagingHandlingCosts
  [ attribute currencyID ]		 CurrencyCodeType Always 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. Note: If the listing only has one domestic shipping service and it is free shipping, the domestic package handling cost will be ignored and will not be applied to the listing.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption 		InternationalShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions.

If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes.

All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping or eBay International Shipping is offered for the listing).

If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program or eBay International Shipping) from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing.

For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge 		AmountType (double) Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Min: 0.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingService 		token Conditionally An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails.

To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

For flat and calculated shipping.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

See https://developer.ebay.com/api-docs/user-guides/static/trading-user-guide/shipping-types-rates.html.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority 		int Conditionally This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. If the Global Shipping Program is enabled on the listing for international shipping, only four additional shipping services may be specified.

If this field is omitted from international shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .InternationalShippingServiceOption
  .ShipToLocation 		string Conditionally,
repeatable: [0..*]		 An international location or region to where the item seller will ship the item.

Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields.

For the AddItem family of calls, this field is required if any international shipping service is specified.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, ShipToLocation fields will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, ShipToLocation fields are only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

See Shipping information.



Applicable values: See CountryCodeType, ShippingRegionCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax 		SalesTaxType Conditionally This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites.

This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to true. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions.

This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).

See Multi-jurisdiction sales tax.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount 		AmountType (double) Conditionally The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always The amount of sales tax calculated for an order line item based on the sale price and the sales tax rate for the buyer's tax jurisdiction. For a multiple line item order, the SalesTaxAmount returned at the order level will be the cumulative amount for all line items in the order.

GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxPercent 		float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call.

Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .SalesTaxState 		string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all two-digit identifiers for all states/territories/provinces for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction. Please note that both GetTaxTable and GeteBayDetails calls use a JurisdictionID field to express these tax jurisdiction identifiers instead of SalesTaxState, but the values used in these fields are the same.

The SalesTaxState field is conditionally required in an Add/Revise/Relist/Verify call if the seller is applying sales tax to a listing for a particular jurisdiction, and is returned with each SalesTax container to identify the tax jurisdiction.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.SalesTax
  .ShippingIncludedInTax 		boolean Conditionally This field is included in an Add/Revise/Relist/Verify call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with the SalesTax container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
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, and GetOrders.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real record number is only returned to the buyer or seller, and a dummy value of 0 will be returned to all third parties.

The sale record ID can be for a single or a multiple line item order.

Note: For the GetItemTransactions and GetOrderscalls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions 		ShippingServiceOptionsType Conditionally,
repeatable: [0..*]		 This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required.

If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them:

<ShippingServiceOptions>...</ShippingServiceOptions>
<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. However, if the seller is opted in to the Global Shipping Program or eBay International Shipping, only four other international shipping services may be offered (regardless of whether or not Global Shipping shipment or eBay International Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated).

Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup.
For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned.

See Repeating (unbounded) fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ExpeditedService 		boolean Conditionally This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge 		AmountType (double) Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo 		ShippingPackageInfoType Conditionally,
repeatable: [0..*]		 This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo
  .ShippingTrackingEvent 		token Conditionally This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

Applicable values: See ShippingTrackingEventCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingPackageInfo.StoreID 		string Conditionally The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingService 		token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails
  .ShippingServiceOptions
  .ShippingServicePriority 		int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.TaxTable 		TaxTableType Conditionally Tax details for a jurisdiction, such as a state or province. If no tax table is associated with the item, a tax table is not returned.

For GetItem, a tax table is returned if it exists when:
  • DetailLevel is set to ReturnAll or ItemReturnDescription (in this case, the value of IncludeTaxTable does not matter)
  • IncludeTaxTable is set to true and DetailLevel is not set or it is set to ItemReturnAttributes
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction 		TaxJurisdictionType Conditionally,
repeatable: [0..*]		 In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table.

If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll, all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions.

This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID 		string Conditionally This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll, or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction.

The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent 		float Conditionally This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###).

This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set.

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax 		boolean Conditionally This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified.

This field is always returned with each TaxJurisdiction container (whether true or false).

Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process.

Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI).
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected 		ShippingServiceOptionsType Conditionally The shipping service actually selected by the buyer from the shipping services offered by the seller. The buyer typically selects the shipping service at checkout/payment time.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ExpeditedService 		boolean Conditionally This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge 		AmountType (double) Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ImportCharge
  [ attribute currencyID ]		 CurrencyCodeType Conditionally For orders using eBay International Shipping, when using the GetOrders call, the OrderArray.Order.ShippingServiceSelected.ImportCharge field contains only customs charges.

For the Global Shipping Program, which is only supported in the UK, this field contains the total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo 		ShippingPackageInfoType Conditionally,
repeatable: [0..*]		 This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMax 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMax value indicates the latest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .EstimatedDeliveryTimeMin 		dateTime Conditionally The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. The EstimatedDeliveryTimeMin value indicates the earliest date and time that the buyer can expect to receive the order.

The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax dates are only estimates made by eBay, and their accuracy will depend on the seller meeting the handling time deadline. Once the seller ships the order, and marks it as shipped/provides tracking information, the more accurate delivery dates can be found in the the ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax fields.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .HandleByTime 		dateTime Conditionally This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. This date/time is calculated by adding the handling time (in days) to the purchase time.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MaxNativeEstimatedDeliveryTime 		dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MaxNativeEstimatedDeliveryTime value indicates the latest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .MinNativeEstimatedDeliveryTime 		dateTime Conditionally The MinNativeEstimatedDeliveryTime and MaxNativeEstimatedDeliveryTime timestamps indicate the window during which the buyer can expect delivery based on the seller's handling time and selected shipping service. The MinNativeEstimatedDeliveryTime value indicates the earliest date and time that the buyer can expect to receive the order.

This field is applicable for domestic shipping services, and for Click and Collect orders in the UK and Australia.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo
  .ShippingTrackingEvent 		token Conditionally This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.

Applicable values: See ShippingTrackingEventCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingPackageInfo.StoreID 		string Conditionally The unique identifier of the store from where the order will be delivered. This field is only applicable to 'In-Store Pickup' and 'Click and Collect' orders.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingService 		token Conditionally This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards, and to coins & paper money, postcards, stamps, patches, and similar eligible categories, and is only available on the US marketplace. See eBay standard envelope for details, restrictions, and an envelope size template. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope.

For the REST equivalent, see Using the eBay standard envelope (eSE) service.

See GeteBayDetails.



Applicable values: See ShippingServiceCodeType
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost 		AmountType (double) Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost 		AmountType (double) Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServiceCost
  [ attribute currencyID ]		 CurrencyCodeType Conditionally The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .ShippingServiceSelected
  .ShippingServicePriority 		int Conditionally Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
OrderArray.Order
  .TransactionArray.Transaction
  .Status 		TransactionStatusType Conditionally Container consisting of checkout/payment status details for an order line item. Several of these fields change values during the checkout flow.

For GetOrders, only a limited number of applicable fields are returned at the order line item level. The fields indicating the status of the order are actually found in the OrderArray.Order.CheckoutStatus container.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.DigitalStatus 		DigitalStatusCodeType Conditionally This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.

Applicable values:

Activated
This enumeration value indicates that the digital gift card has been activated by the buyer or recipient of gift card.
CustomCode
This value is reserved for internal or future use.
Deactivated
This enumeration value indicates that the digital gift card has been deactivated.
Downloaded
This enumeration value indicates that the digital gift card has been downloaded by the buyer or recipient of gift card. The next step would be to activate the gift card.
Inactive
This enumeration value indicates that the digital gift card has yet to be activated by the buyer or recipient of gift card.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.InquiryStatus 		InquiryStatusCodeType Conditionally This field gives the status of a buyer's Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.

Applicable values: See InquiryStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentHoldStatus 		PaymentHoldStatusCodeType Conditionally This field indicates the type and/or status of a payment hold on the item.
Note: For the GetItemTransactions and GetOrders, calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.

Applicable values: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentInstrument 		BuyerPaymentInstrumentCodeType Conditionally The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethodUsed field by the GetItemTransactions call.

Applicable values: See PaymentInstrument.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.PaymentMethodUsed 		BuyerPaymentMethodCodeType Always The payment method that the buyer selected to pay for the order.
Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.

Applicable values:

CashOnPickup
This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments.
CustomCode
Reserved for internal or future use.
MOCC
This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.
PersonalCheck
This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces.

Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Status.ReturnStatus 		ReturnStatusCodeType Conditionally This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return request, or has escalated an existing return request into a return case.

Applicable values: See ReturnStatus.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes 		TaxesType Conditionally A container consisting of detailed tax information (sales tax, Goods and Services tax, or VAT) for a sales transaction. The Taxes container is returned if the order line item is subject to any taxes on the buyer's purchase. The information in this container supercedes/overrides any sales tax information in the ShippingDetails.SalesTax container.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.eBayReference 		eBayTaxReferenceValue (string) Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.eBayReference
  [ attribute name ]		 string Conditionally The value returned in this field is the VAT ID for eBay, and this value may vary based on the region or country. The eBayReference field's name attribute will show the type of VAT ID, such as IOSS, OSS, or ABN. This field will be returned if VAT tax is applicable for the order. See the eBayTaxReferenceValue type page for more information on the VAT tax type strings that may appear for the name attribute.

Note: For all VAT ID/VATIN values to be returned (except for France), developers will need to use a Trading WSDL with a version number of 1211 (or newer). For French VAT ID/VATIN values to be returned, developers will need to use a Trading WSDL with a version number of 1225 (or newer). Otherwise, the VAT information will be returned in the Order.ShippingAddress.Street2 field. Developers will also have the option of using older version, but setting the X-EBAY-API-COMPATIBILITY-LEVEL header value to 1211 or 1225 or higher.

On January 31, 2022, the Order.ShippingAddress.Street2 will stop being used to return VAT information regardless of WSDL version or compatibility level.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails 		TaxDetailsType Conditionally,
repeatable: [0..*]		 Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails.Imposition 		TaxTypeCodeType Conditionally This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).

Applicable values: See Imposition.
Code so that your app gracefully handles any future changes to this list.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails.TaxAmount 		AmountType (double) Conditionally This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails.TaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the total amount of tax charges for the order line item for the corresponding tax type (see Imposition value).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails.TaxCode 		string Conditionally This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process. If the Order.BuyerTaxIdentifier container is returned, the type of tax ID can be found in the BuyerTaxIdentifier.Type field.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxDescription 		TaxDescriptionCodeType Conditionally This enumeration value indicates the type of tax charged against the item.

Applicable values:

CustomCode
Reserved for internal or future use.
ElectronicWasteRecyclingFee
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
GST
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

Note: At this time, this tax type is only applicable to the Australia site.
SalesTax
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
TireRecyclingFee
This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.
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).
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnHandlingAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnShippingAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnShippingAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnSubtotalAmount 		AmountType (double) Conditionally This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TaxDetails
  .TaxOnSubtotalAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TotalTaxAmount 		AmountType (double) Conditionally This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.
OrderArray.Order
  .TransactionArray.Transaction
  .Taxes.TotalTaxAmount
  [ attribute currencyID ]		 CurrencyCodeType Always This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionID 		string Always Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item, or if/when the buyer actually purchases the line item through a 'Buy it Now' option. An ItemID/TransactionID pair can be used and referenced during an order checkout flow to identify a line item.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.

For GetOrders and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer and seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, transaction ID is only returned to the buyer and seller, and a dummy value of 10000000000000 will be returned to all third parties.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice 		AmountType (double) Always The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value.

For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount.

For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead.
OrderArray.Order
  .TransactionArray.Transaction
  .TransactionPrice
  [ attribute currencyID ]		 CurrencyCodeType Always The sale price for one unit of the line item. This price does not include any other costs like shipping charges or sales tax, and its value will remain the same before and after payment. If multiple units were purchased through a single-variation, fixed-price listing, to get the subtotal of the units purchased, the TransactionPrice value would have to be multiplied by the Transaction.QuantityPurchased value.

For a motor vehicle listing that required a deposit/down payment, the amount in the TransactionPrice is actually the deposit amount.

For GetMyeBaySelling: this field is only returned if the transaction came as a result of a buyer's Best Offer accepted by the seller. Otherwise, the Transaction.TotalPrice field should be viewed instead.

For a list of possible enumeration values, see CurrencyCodeType.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation 		VariationType Conditionally In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design, and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple quanity of the same variation are purchased.

The Variation node contains information about which variation was purchased. Therefore, applications that process orders should always check to see if this node is present.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.SKU 		SKUType (string) Conditionally
A SKU (stock keeping unit) is a seller-defined identifier. It is only intended for the seller's use (not for buyers). A SKU value is not required, but many large sellers like to add SKU value to their listings. If defined on a listing, a SKU value can be used by sellers to reconcile their eBay inventory with your own inventory system, instead of using the VariationSpecifics identifying values.

If specified, all SKU values must be unique within the Variations node. That is, no two variations within the same listing can have the same SKU.

If you include the Item.InventoryTrackingMethod field in an 'FixedPriceItem' call and set its value to SKU, the Variation.SKU values become required for each variation..

For GetItem, GetOrders and other 'Get' calls: Only returned if the seller specified a SKU for the variation.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.
Max length: 80.

See SKU identifiers.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics 		NameValueListArrayType Conditionally,
repeatable: [2..5]
A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of Item Specific names, but each variation must provide a unique combination of values for those Item Specific names. For example, if the items vary by color and size, then every variation must specify 'Color' and 'Size' as Item Specific names, but no two variations can specify the same combination of 'Color' and 'Size' values.

When you revise a listing that includes variations, you can change names of Variationpecifics by using the Variations.ModifyNameList container. You can also add, delete, or replace individual variations as needed to match your current inventory. Use the Variation.Delete field to delete a variation that has no sales (order line items). If the variation has sales, then set the Quantity to 0.

For GetSellerEvents To keep the GetSellerEvents response smaller, Variationpecifics are not returned if the variation has a SKU. If the variation has no SKU, then Variationpecifics are returned instead. Optionally, you can pass IncludeVariationSpecifics as true in the request to force Variationpecifics to be returned, even when the SKU is returned.
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.

See:
    Configure variation-selection widgets for buyers (View Item)
    Revise and relist with variations

OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList 		NameValueListType Conditionally,
repeatable: [0..*]		 For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

Note: The maximum number of item specifics that may be defined for a listing has increased from 30 to 45.
For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has variations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.
When you list with Item Variations:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required.

Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
  • The name of at least one listed chemical that prompted the warning
  • Text stating that the product 'can expose you to' the chemical(s) in the product
  • The URL for OEHHA's new Proposition 65 warnings website, which is www.P65Warnings.ca.gov
Unlike standard item specifics that allow a maximum of 65 characters in the Value field, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Name 		string Conditionally Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, the value in this field will either be the name of a required/recommended/optional item specific name for the category, or it may be a seller's customized item specific name.

For the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing.

Note: For required and recommended item specifics that are returned in the getItemAspectsForCategory method of the Taxonomy API, the seller should pass in the name of these item specifics just as they are shown in the getItemAspectsForCategory response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the getItemAspectsForCategory response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationSpecifics
  .NameValueList.Value 		string Conditionally,
repeatable: [0..*]		 Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier.

For the AddItem family of calls: Multiple values can only be specified for an Item Specific if the itemToAspectCardinality field of the getItemAspectsForCategory method shows a value of MULTI. If an item specific only supports a single value, only the first item specific value specified in the request will be used.

For the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

For PlaceOffer: Required if the line item being purchased is an item variation within a multiple-variation listing.

Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. For item specifics with max lengths greater than 65, the actual max length will be returned in a corresponding aspectMaxLength field. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description.
Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning').
OrderArray.Order
  .TransactionArray.Transaction
  .Variation.VariationTitle 		string Conditionally The title of the variation. This is a concatenation of the listing title plus the values (no names) from Variationpecifics. For example, if the Title is "Polo Shirt" and the variation is for a medium pink shirt, the variation title could be "Polo Shirt[Pink,M].
Note: The Item.Variations container and its child fields will stop being returned in GetItemTransactions on January 31, 2024.
Max length: 120.
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).
Version string Always This value indicates the version of the Merchant Data WSDL that eBay used to process the request.



Output Samples Change History

Samples

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

Sample: Acknowledging Single Line Item Orders

This call is used to shows detailed information on all unacknowledged orders, and all unacknowledged line items in each order from the past 30 days.

Description

Seller k*******@****.com wants to return detailed information on all unacknowledged orders, and all unacknowledged line items in each order from the past 30 days. The seller uses the Report download feed types flow and sends a createOrderTask call to return to completed orders.

Input

Since the LMS_ORDER_REPORT feed type report returns a pre-determined set of elements, there is no input request for a report. Instead, the report type is specified as a parameter of a createOrderTask call.

XML format.

 
Do not send a request file for reports. See description above.

Output

The OrderReport response file includes an Order node for each order line item that is returned for the seller. Each Order node includes the unique identifier of the order (OrderID) and an OrderStatus. In this sample, both orders were completed but will still appear in the report until acknowledged (see Submitting an order acknowledgment file. Any errors or warnings at the OrderReport call level are contained in the response file in an Errors container.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
  <OrderReport>
    <ACK>Success</ACK>
    <Version>1257</Version>
    <OrderArray>
      <Order>
        <OrderID>2*-0***1-1***7</OrderID>
        <OrderStatus>Completed</OrderStatus>
        <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
        <AmountPaid currencyID="USD">91.0</AmountPaid>
        <AmountSaved currencyID="USD">0.0</AmountSaved>
        <CheckoutStatus>
          <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
          <LastModifiedTime>2023-03-13T12:59:06.543Z</LastModifiedTime>
          <PaymentMethod>CreditCard</PaymentMethod>
          <Status>Complete</Status>
          <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
          <PaymentInstrument>CreditCard</PaymentInstrument>
        </CheckoutStatus>
        <ShippingDetails>
          <SalesTax>
            <SalesTaxPercent>0.0</SalesTaxPercent>
            <ShippingIncludedInTax>false</ShippingIncludedInTax>
            <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
          </SalesTax>
          <ShippingServiceOptions>
            <ShippingService>Pickup</ShippingService>
            <ShippingServicePriority>1</ShippingServicePriority>
            <ExpeditedService>false</ExpeditedService>
          </ShippingServiceOptions>
          <SellingManagerSalesRecordNumber>602</SellingManagerSalesRecordNumber>
          <GetItFast>false</GetItFast>
        </ShippingDetails>
        <CreatedTime>2023-03-13T12:59:06.543Z</CreatedTime>
        <ShippingAddress>
          <Name>e******* b****</Name>
          <Street1>2*** H******* a**</Street1>
          <Street2>b******* *</Street2>
          <CityName>S** J***</CityName>
          <StateOrProvince>CA</StateOrProvince>
          <Country>US</Country>
          <CountryName>United States</CountryName>
          <Phone>4********0</Phone>
          <PostalCode>9****-****</PostalCode>
          <AddressID>1************9</AddressID>
          <AddressOwner>e***</AddressOwner>
        </ShippingAddress>
        <ShippingServiceSelected>
          <ShippingService>Pickup</ShippingService>
          <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
        </ShippingServiceSelected>
        <Subtotal currencyID="USD">91.0</Subtotal>
        <Total currencyID="USD">91.0</Total>
        <ExternalTransaction>
          <ExternalTransactionID>5**********1</ExternalTransactionID>
          <ExternalTransactionTime>2023-03-13T13:02:27.543Z</ExternalTransactionTime>
          <FeeOrCreditAmount currencyID="USD">0.0</FeeOrCreditAmount>
          <PaymentOrRefundAmount currencyID="USD">91.0</PaymentOrRefundAmount>
          <ExternalTransactionStatus>Succeeded</ExternalTransactionStatus>
        </ExternalTransaction>
        <eBayCollectAndRemitTax>false</eBayCollectAndRemitTax>
        <TransactionArray>
          <Transaction>
            <Buyer>
              <Email>0*******************@m**************.com</Email>
              <VATStatus>NoVATTax</VATStatus>
              <UserFirstName>I****************r</UserFirstName>
              <UserLastName>B***r</UserLastName>
            </Buyer>
            <ShippingDetails>
              <SalesTax>
                <SalesTaxPercent>0.0</SalesTaxPercent>
              </SalesTax>
              <SellingManagerSalesRecordNumber>602</SellingManagerSalesRecordNumber>
            </ShippingDetails>
            <CreatedDate>2023-03-13T12:59:06.543Z</CreatedDate>
            <Item>
              <ItemID>1**********6</ItemID>
              <Site>eBayMotors</Site>
              <Title>Tires Intallation Category_************_US</Title>
              <ConditionID>1000</ConditionID>
              <ConditionDisplayName>New</ConditionDisplayName>
            </Item>
            <QuantityPurchased>1</QuantityPurchased>
            <Status>
              <PaymentHoldStatus>None</PaymentHoldStatus>
              <InquiryStatus>NotApplicable</InquiryStatus>
              <ReturnStatus>NotApplicable</ReturnStatus>
            </Status>
            <TransactionID>1*********2</TransactionID>
            <TransactionPrice currencyID="USD">91.0</TransactionPrice>
            <eBayCollectAndRemitTax>false</eBayCollectAndRemitTax>
            <FinalValueFee currencyID="USD">8.78</FinalValueFee>
            <TransactionSiteID>US</TransactionSiteID>
            <Platform>eBay</Platform>
            <Taxes>
              <TotalTaxAmount currencyID="USD">0.0</TotalTaxAmount>
              <TaxDetails>
                <Imposition>SalesTax</Imposition>
                <TaxDescription>SalesTax</TaxDescription>
                <TaxAmount currencyID="USD">0.0</TaxAmount>
                <TaxOnSubtotalAmount currencyID="USD">0.0</TaxOnSubtotalAmount>
                <TaxOnShippingAmount currencyID="USD">0.0</TaxOnShippingAmount>
                <TaxOnHandlingAmount currencyID="USD">0.0</TaxOnHandlingAmount>
              </TaxDetails>
            </Taxes>
            <ActualShippingCost currencyID="USD">0.0</ActualShippingCost>
            <ActualHandlingCost currencyID="USD">0.0</ActualHandlingCost>
            <OrderLineItemID>1***********-1*********2</OrderLineItemID>
            <InventoryReservationID>1*********2</InventoryReservationID>
            <ExtendedOrderID>2*-0***1-1***7</ExtendedOrderID>
            <eBayPlusTransaction>false</eBayPlusTransaction>
            <GuaranteedShipping>false</GuaranteedShipping>
            <GuaranteedDelivery>false</GuaranteedDelivery>
            <LinkedLineItemArray>
              <LinkedLineItem>
                <OrderID>27-0***1-1***6</OrderID>
                <OrderLineItemID>1**********4--1</OrderLineItemID>
                <SellerUserID>1********3</SellerUserID>
                <EstimatedDeliveryTimeMin>2023-03-16T07:00:00.544Z</EstimatedDeliveryTimeMin>
                <EstimatedDeliveryTimeMax>2023-03-18T07:00:00.544Z</EstimatedDeliveryTimeMax>
                <Item>
                  <Title>Dev Tire Installation Bin</Title>
                  <ItemSpecifics>
                    <NameValueList>
                      <Name>Manufacturer Part Number</Name>
                      <Value>Does Not Apply</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Tire Type</Name>
                      <Value>All Season</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Overall Diameter</Name>
                      <Value>20</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>UPC</Name>
                      <Value>Does not apply</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Quantity</Name>
                      <Value>4</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Section Width</Name>
                      <Value>8</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Rim Diameter</Name>
                      <Value>14</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Aspect Ratio</Name>
                      <Value>30</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Brand</Name>
                      <Value>American</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Load Index</Name>
                      <Value>63</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Car Type</Name>
                      <Value>Passenger/Performance</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Speed Index</Name>
                      <Value>J</Value>
                    </NameValueList>
                    <NameValueList>
                      <Name>Tire Sizing System</Name>
                      <Value>Passenger</Value>
                    </NameValueList>
                  </ItemSpecifics>
                </Item>
              </LinkedLineItem>
            </LinkedLineItemArray>
          </Transaction>
        </TransactionArray>
        <BuyerUserID>u************************4</BuyerUserID>
        <PaidTime>2023-03-13T13:02:27.544Z</PaidTime>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
        <EIASToken>nY+s*********************************************Y+seQ==</EIASToken>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IsMultiLegShipping>false</IsMultiLegShipping>
        <MonetaryDetails>
          <Payments>
            <Payment>
              <PaymentStatus>Succeeded</PaymentStatus>
              <Payer type="eBayUser">u************************4</Payer>
              <Payee type="eBayUser">tiprov0</Payee>
              <PaymentTime>2023-03-13T13:02:27.545Z</PaymentTime>
              <PaymentAmount currencyID="USD">91.0</PaymentAmount>
              <ReferenceID type="ExternalTransactionID">5**********1</ReferenceID>
            </Payment>
          </Payments>
        </MonetaryDetails>
        <SellerUserID>tiprov0</SellerUserID>
        <SellerEIASToken>nY+s*********************************************Y+seQ==</SellerEIASToken>
        <CancelStatus>NotApplicable</CancelStatus>
        <ExtendedOrderID>2*-0***1-1***7</ExtendedOrderID>
        <ContainseBayPlusTransaction>false</ContainseBayPlusTransaction>
      </Order>  
      <Order>
        <OrderID>3***********-************1</OrderID>
        <OrderStatus>Completed</OrderStatus>
        <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
        <AmountPaid currencyID="USD">0.99</AmountPaid>
        <AmountSaved currencyID="USD">0.0</AmountSaved>
        <CheckoutStatus>
          <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
          <LastModifiedTime>2020-03-25T17:46:41.000Z</LastModifiedTime>
          <PaymentMethod>CashOnPickup</PaymentMethod>
          <Status>Complete</Status>
          <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
        </CheckoutStatus>
        <ShippingDetails>
          <SalesTax>
            <SalesTaxPercent>0.0</SalesTaxPercent>
            <SalesTaxState/>
            <ShippingIncludedInTax>false</ShippingIncludedInTax>
          </SalesTax>
          <ShippingServiceOptions>
            <ShippingService>Pickup</ShippingService>
            <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
            <ShippingServicePriority>1</ShippingServicePriority>
            <ExpeditedService>false</ExpeditedService>
          </ShippingServiceOptions>
          <SellingManagerSalesRecordNumber>104</SellingManagerSalesRecordNumber>
          <GetItFast>false</GetItFast>
        </ShippingDetails>
        <CreatedTime>2020-03-25T17:46:40.000Z</CreatedTime>
        <PaymentMethods>CashOnPickup</PaymentMethods>
        <PaymentMethods>PayPal</PaymentMethods>
        <SellerEmail>k*******@ebay.com</SellerEmail>
        <ShippingAddress>
          <Name>t***** ***e</Name>
          <Street1>3************e</Street1>
          <Street2/>
          <CityName>P******d</CityName>
          <StateOrProvince>OR</StateOrProvince>
          <Country>US</Country>
          <CountryName>United States</CountryName>
          <Phone>1********0</Phone>
          <PostalCode>9****-***4</PostalCode>
          <AddressID>1************4</AddressID>
          <AddressOwner>e***</AddressOwner>
          <ExternalAddressID/>
        </ShippingAddress>
        <ShippingServiceSelected>
          <ShippingService>Pickup</ShippingService>
          <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
        </ShippingServiceSelected>
        <Subtotal currencyID="USD">0.99</Subtotal>
        <Total currencyID="USD">0.99</Total>
        <TransactionArray>
          <Transaction>
            <Buyer>
              <Email>c*************@*****.com</Email>
              <UserFirstName/>
              <UserLastName/>
            </Buyer>
            <ShippingDetails>
              <SellingManagerSalesRecordNumber>104</SellingManagerSalesRecordNumber>
            </ShippingDetails>
            <CreatedDate>2020-03-25T17:46:40.000Z</CreatedDate>
            <Item>
              <ItemID>3**********3</ItemID>
              <Site>US</Site>
              <Title>t*******************y</Title>
              <SKU>T*****M</SKU>
            </Item>
            <QuantityPurchased>1</QuantityPurchased>
            <Status>
              <PaymentHoldStatus>None</PaymentHoldStatus>
            </Status>
            <TransactionID>2***********1</TransactionID>
            <TransactionPrice currencyID="USD">0.99</TransactionPrice>
            <FinalValueFee currencyID="USD">0.0</FinalValueFee>
            <TransactionSiteID>US</TransactionSiteID>
            <Platform>e***</Platform>
            <Taxes>
              <TotalTaxAmount currencyID="USD">0.0</TotalTaxAmount>
              <TaxDetails>
                <Imposition>SalesTax</Imposition>
                <TaxDescription>SalesTax</TaxDescription>
                <TaxAmount currencyID="USD">0.0</TaxAmount>
                <TaxOnSubtotalAmount currencyID="USD">0.0</TaxOnSubtotalAmount>
                <TaxOnShippingAmount currencyID="USD">0.0</TaxOnShippingAmount>
                <TaxOnHandlingAmount currencyID="USD">0.0</TaxOnHandlingAmount>
              </TaxDetails>
            </Taxes>
            <ActualShippingCost currencyID="USD">0.0</ActualShippingCost>
            <ActualHandlingCost currencyID="USD">0.0</ActualHandlingCost>
            <OrderLineItemID>3***********-************1</OrderLineItemID>
          </Transaction>
        </TransactionArray>
        <BuyerUserID>g*****************d</BuyerUserID>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
        <EIASToken>n******************************************************=</EIASToken>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IsMultiLegShipping>false</IsMultiLegShipping>
        <SellerUserID>k*******@****.com</SellerUserID>
        <SellerEIASToken>n*****************************************************==</SellerEIASToken>
      </Order>
      <Order>
        <OrderID>3***********-************2</OrderID>
        <OrderStatus>Completed</OrderStatus>
        <AdjustmentAmount currencyID="USD">0.0</AdjustmentAmount>
        <AmountPaid currencyID="USD">0.99</AmountPaid>
        <AmountSaved currencyID="USD">0.0</AmountSaved>
        <CheckoutStatus>
          <eBayPaymentStatus>NoPaymentFailure</eBayPaymentStatus>
          <LastModifiedTime>2020-03-25T17:47:41.000Z</LastModifiedTime>
          <PaymentMethod>CashOnPickup</PaymentMethod>
          <Status>Complete</Status>
          <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
        </CheckoutStatus>
        <ShippingDetails>
          <SalesTax>
            <SalesTaxPercent>0.0</SalesTaxPercent>
            <SalesTaxState/>
            <ShippingIncludedInTax>false</ShippingIncludedInTax>
            <SalesTaxAmount currencyID="USD">0.0</SalesTaxAmount>
          </SalesTax>
          <ShippingServiceOptions>
            <ShippingService>Pickup</ShippingService>
            <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
            <ShippingServicePriority>1</ShippingServicePriority>
            <ExpeditedService>false</ExpeditedService>
          </ShippingServiceOptions>
          <SellingManagerSalesRecordNumber>103</SellingManagerSalesRecordNumber>
          <GetItFast>false</GetItFast>
        </ShippingDetails>
        <CreatedTime>2020-03-25T17:45:37.000Z</CreatedTime>
        <PaymentMethods>CashOnPickup</PaymentMethods>
        <PaymentMethods>PayPal</PaymentMethods>
        <SellerEmail>k*******@****.com</SellerEmail>
        <ShippingAddress>
          <Name>T********r</Name>
          <Street1>6********* Ave</Street1>
          <Street2/>
          <CityName>p******d</CityName>
          <StateOrProvince>**</StateOrProvince>
          <Country>US</Country>
          <CountryName>United States</CountryName>
          <Phone>9********0</Phone>
          <PostalCode>9****-***5</PostalCode>
          <AddressID>1************4</AddressID>
          <AddressOwner>e***</AddressOwner>
          <ExternalAddressID/>
        </ShippingAddress>
        <ShippingServiceSelected>
          <ShippingService>Pickup</ShippingService>
          <ShippingServiceCost currencyID="USD">0.0</ShippingServiceCost>
        </ShippingServiceSelected>
        <Subtotal currencyID="USD">0.99</Subtotal>
        <Total currencyID="USD">0.99</Total>
        <TransactionArray>
          <Transaction>
            <Buyer>
              <Email>m*******@*****.com</Email>
              <UserFirstName/>
              <UserLastName/>
            </Buyer>
            <ShippingDetails>
              <SellingManagerSalesRecordNumber>103</SellingManagerSalesRecordNumber>
            </ShippingDetails>
            <CreatedDate>2020-03-25T17:45:37.000Z</CreatedDate>
            <Item>
              <ItemID>3**********3</ItemID>
              <Site>US</Site>
              <Title>te******** *********y</Title>
              <SKU>T******</SKU>
            </Item>
            <QuantityPurchased>1</QuantityPurchased>
            <Status>
              <PaymentHoldStatus>None</PaymentHoldStatus>
            </Status>
            <TransactionID>2***********1</TransactionID>
            <TransactionPrice currencyID="USD">0.99</TransactionPrice>
            <FinalValueFee currencyID="USD">0.0</FinalValueFee>
            <TransactionSiteID>US</TransactionSiteID>
            <Platform>e***</Platform>
            <Taxes>
              <TotalTaxAmount currencyID="USD">0.0</TotalTaxAmount>
              <TaxDetails>
                <Imposition>SalesTax</Imposition>
                <TaxDescription>SalesTax</TaxDescription>
                <TaxAmount currencyID="USD">0.0</TaxAmount>
                <TaxOnSubtotalAmount currencyID="USD">0.0</TaxOnSubtotalAmount>
                <TaxOnShippingAmount currencyID="USD">0.0</TaxOnShippingAmount>
                <TaxOnHandlingAmount currencyID="USD">0.0</TaxOnHandlingAmount>
              </TaxDetails>
            </Taxes>
            <ActualShippingCost currencyID="USD">0.0</ActualShippingCost>
            <ActualHandlingCost currencyID="USD">0.0</ActualHandlingCost>
            <OrderLineItemID>3***********-************1</OrderLineItemID>
          </Transaction>
        </TransactionArray>
        <BuyerUserID>t*************r</BuyerUserID>
        <PaidTime>2020-03-25T17:47:41.000Z</PaidTime>
        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
        <EIASToken>n******************************************************=</EIASToken>
        <PaymentHoldStatus>None</PaymentHoldStatus>
        <IsMultiLegShipping>false</IsMultiLegShipping>
        <SellerUserID>k*******@****.com</SellerUserID>
        <SellerEIASToken>n******************************************************=</SellerEIASToken>
      </Order>
    </OrderArray>
  </OrderReport>
</BulkDataExchangeResponses>



Output Samples Change History

Change History

Change Date Description
1303
2023-03-24
  • Transaction.LinkedLineItems (added): This container was added under the Transaction container. The new container consists of a list of linked line item objects.
  • Transaction.LinkedLineItems.LinkedLineItem (added): This container was added under the LinkedLineItems container. The new container links items from separate orders which may be from different sellers. This can be used to provide details about a component (purchased from one seller) needed for its installation (purchased from a different seller). Details can identify the linked seller and also include delivery times, item information, and order information.
  • LinkedLineItemArrayType (added): New type added consisting of a list of linked line item objects.
  • LinkedLineItemType (added): This type provides information to link items from separate orders which may be from different sellers.
  • TransactionType (modified): Added LinkedLineItems container.
  • ItemType (modified): Added context for LinkedLineItem.Item and Transaction.Item for GetOrders calls.
1225
2021-09-24
  • AuthenticityVerification.ServiceCost (added): The ServiceCost container was added under the AuthenticityVerification container. This new container shows the service cost to the buyer for an item that will go through the Authenticity Guarantee process.
  • TaxTypeCodeType (modified): ImportVAT and VAT enums added to indicate when VAT tax is being applied to an order line item.
  • eBayTaxReferenceValue (modified): VAT_ID added as a possible value for the Name attribute. This value is used for French VAT tax.
1209
2021-06-04
  • eBayCollectAndRemitTaxes.eBayReference (added): New field provides eBay's VAT tax ID.
  • eBayTaxReferenceValue (added): New type contains an attribute that indicates which type of VAT tax ID is returned in the eBayCollectAndRemitTaxes.eBayReference field.
  • ValueTypeCodeType (modified): A new VATIN value was added to support the use case when a buyer's VAT Identification Number is returned in the Order.BuyerTaxIdentifier.ID.
1207
2021-05-21
  • OrderArray.Errors (added): Although an Errors container has always been returned for OrderReport if errors and/or warnings are triggered at the order level, this container was previously missing from the merchantdataservice.xsd file and reference docs.
1201
2021-04-09
  • Variation.VariationTitle (doc change): Added max length constraint value of 120 characters to field description. The constraint value has always existed, but it was not documented until now.
1193
2021-02-12
  • FulfillmentType (added): New type provides details about an order line item being fulfilled by eBay or an eBay fulfillment partner.
  • Program.Fulfillment (added): New container provides details about an order line item being handled by eBay fulfillment.
1177
2020-10-23
  • AuthenticityVerificationType (modified): New enumeration values added. Values account for order line items that fail authentication and are not able to be returned to the seller because of legal constraints, and for order line items that are passed with exception.
1165
2020-07-31
  • AuthenticityVerificationType (added): New type gives status on whether the order line item has passed or failed the authenticity inspection, or if the test is still pending.
  • TransactionProgramType (added): New type provides details on whether the order line item has passed or failed the authenticity inspection.
  • Transaction.Program (added): New container gives the status of an order line item going through the authentication verification process.
1161
2020-07-06
  • Transaction.FinalValueFee (modified): The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in this field should only be considered as an estimated value.
1157
2020-06-05
  • Order.OrderID (modified): Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.
1145
2020-03-13
  • Order.OrderID (doc change): Updated OrderID field description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads.
  • PaymentTransactionStatusCodeType (modified): Modified the behavior of how the Succeeded and Pending enumeration values work for off-eBay platform payment transactions. As of March 2020, the Pending value will get returned instead of the Succeeded value for order payment transactions occurring off of eBay's platform. The seller can use the CompleteSale call to mark the order as paid, and then the payment status will change from Pending to Succeeded.
1129
2019-10-11
  • eBayCollectAndRemitTaxes.TaxDetails.CollectionMethod (added): This new field is returned for transactions that are subject to 'eBay Collect and Remit' taxes, which include US state-mandated sales tax or 'Goods and Services' tax applicable to Australian and New Zealand sellers. Although this field will always be returned under the eBayCollectAndRemitTaxes.TaxDetails container, it currently does not have any practical use, but may be used in the future.
  • Order.Total, Order.AmountPaid (modified): For orders subject to 'eBay Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia and New Zealand), the 'eBay Collect and Remit' tax amount will be included in the AmountPaid and ConvertedAmountPaid amounts. This logic change is not applicable to sellers opted in to eBay managed payments.
  • Transaction.AmountPaid, Transaction.ConvertedAmountPaid (modified): For orders subject to 'eBay Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia and New Zealand), the 'eBay Collect and Remit' tax amount will be included in the AmountPaid and ConvertedAmountPaid amounts. This logic change is not applicable to sellers opted in to eBay managed payments.
  • ExternalTransaction.PaymentOrRefundAmount, Payment.PaymentAmount (modified): For orders subject to 'eBay Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia and New Zealand), the 'eBay Collect and Remit' tax amount will be included in the ExternalTransaction.PaymentOrRefundAmount and Payment.PaymentAmount amounts (if these monetary transactions are corresponding to a buyer's payment for an order). This logic change is not applicable to sellers opted in to eBay managed payments.
1113
2019-06-21
  • Order.OrderID (modified): The new format of order identifier values was rolled out. Both the new and old order ID format will be accepted in request payloads to identify an eBay order. The format (old or new) that is returned in response payloads is dependent on the WSDL version and/or compatibility level. See the 1113 Release Notes for more details.
  • Order.ExtendedOrderID, Transaction.ExtendedOrderID (modified): The new order ID format will now be returned in all cases, regardless of the WSDL version number or compatibility level. The ExtendedOrderID field was previously created to distinguish between legacy and REST API-based order identifiers. Now, with the rollout of the new order ID format, the same order identifiers will be used for both legacy and REST-based APIs, although the legacy APIs will support both the old and the new formats until 2020. Once a Merchant Data API user is integrated with the new order ID format, the values shown in the ExtendedOrderID and OrderID fields will be the same for each order.
1107
2019-05-10
  • Order.OrderID (modified): Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. To enable and use the new format, the user will need to use the 1107 WSDL (or newer as versions roll out) and set the compatibility level to 1113. There will be a nine-month transition period where the old format will still be supported.
1085
2018-10-26
  • OrderStatusCodeType (doc change): Cleaned up the enumerated type documentation to indicate which enumeration values are only applicable to the response of OrderReport.
  • Order.eBayCollectAndRemitTax (doc change): Provided a little more detail to the 'eBay Collect and Remit Tax' field description and added links to the Australian 'Good and Service Tax' and US Sales Tax Collection help topics.
  • Transaction.eBayCollectAndRemitTax, Transaction.eBayCollectAndRemitTaxes (doc change): Provided a little more detail to the 'eBay Collect and Remit Taxes' field descriptions and added links to the Australian 'Good and Service Tax' and US Sales Tax Collection help topics.
  • ShippingDetails.SalesTax (doc change): Added a note to state that the Sales Tax rate for a US tax jurisdiction that is subject to the 'eBay Collect and Remit Tax' program will be ignored during the checkout process, since eBay will be collecting and remitting this tax to the tax authorities without the seller's involvement.
  • Order.ExtendedOrderID, Transaction.ExtendedOrderID (doc change): Provided an example of an actual ExtendedOrderID value and added note that these values are used in the Post-Order and Fulfillment APIs to retrieve orders.
1073
2018-08-03
  • Transaction.TransactionPrice (doc change): Made a correction to the field description. This field was inaccurately described as including shipping charge and sales tax, when it accurately only indicates the sales price of one unit of the item.
1067
2018-06-22
  • OrderType.eBayCollectAndRemitTax (added): This boolean field is returned as true if the order was subject to Australian import tax charged to the buyer. This field is not returned if false. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.
  • TransactionType.eBayCollectAndRemitTax (added): This boolean field is returned as true if the order line item was subject to Australian import tax charged to the buyer. This field is not returned if false. Australian import tax charged to the buyer is collected by eBay and remitted to the Australian government.
  • TransactionType.eBayCollectAndRemitTaxes (added): This container will be returned for any order line items subject to the import tax charged to the buyer, and the amount of this tax will be displayed in the TaxDetails.TaxAmount field under this container.
  • TaxDescriptionCodeType (modified): GST added as an enumeration value, and indicates that a Goods and Services import tax was charged to the buyer against the order line item.
  • TaxTypeCodeType (modified): GST added as an enumeration value, and indicates that a Goods and Services import tax was charged to the buyer against the order line item.
1027
2017-08-04
  • AttributeArrayType (deprecated): This type is being deprecated. It is exclusively for Half.com listings, and API support for Half.com listings is being deprecated.
  • AttributeType (deprecated): This type is being deprecated. It is exclusively for Half.com listings, and API support for Half.com listings is being deprecated.
  • Item.SellerInventoryID (deprecated): This field is being deprecated. It is exclusively for Half.com listings, and API support for Half.com listings is being deprecated.
  • OrderStatusCodeType (modified): The Shipped enumeration value is being deprecated, as this value is only applicable to Half.com orders, and API support for Half.com listings is being deprecated.
  • Order.RefundArray, Transaction.RefundArray (deprecated): This container is being deprecated, as this container is only applicable to Half.com refunds, and API support for Half.com orders is being deprecated.
0981
2016-08-12
  • Transaction.GuaranteedShipping (added): New field returned for order line items where the seller chose to use eBay's Guaranteed Shipping feature. This field is for future use, as this feature will not be available until October 2016.
0955
2016-02-12
  • BuyerPaymentMethodCodeType (modified): The Moneybookers, ProPay, and Paymate enumeration values have been deprecated, and will no longer be returned in any calls.
0945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Moneybookers, ProPay, or Paymate will no longer be accepted as valid PaymentMethods for new listings. However, these payment methods will still be allowed for existing listings, so these values may still get returned until these payment methods are completely removed from all listings.
0933
2015-07-24
  • eBayPlusTransaction (added): This new field returns a boolean value that indicates whether a transaction is for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Sellers must commit to two-day delivery of eBay Plus items. Currently available only in Germany.
  • ContainseBayPlusTransaction (added): This new field returns a boolean value that indicates whether an order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Sellers must commit to two-day delivery of eBay Plus items. Currently available only in Germany.
  • DigitalDeliverySelectedType (added): This new type is used by the DigitalDeliverySelected container that is returned if the buyer purchased a digital gift card for themselves, or is giving the digital gift card to someone else as a gift. This container consists of information related to the digital gift card order line item, including the delivery method, delivery status, and recipient of the gift card (either the buyer, or another individual that is receiving the gift card as a gift from the buyer.
  • GiftSummaryType (added): This new type is used by the GiftSummary container that is returned if a buyer has purchased a digital gift card but has sent it to another individual as a gift, and has left a message for the recipient.
  • Transaction.Gift (added): This new boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
  • Transaction.Status.DigitalStatus (added): The enumeration in this new field indicates the current state of a purchased digital gift card. This field is only applicable and returned for digital gift card order line items.
  • LogisticsPlanCodeType (modified): New DigitalDelivery enumeration value added to type to indicate that the order or order line item is a digital gift card that will be delivered to the buyer, or the recipient of the gift card by email.
0909
2015-02-16
  • Order.PaidTime, Transaction.PaidTime (doc change): Clarified in the docs that this field is not returned for orders where the buyer has received a partial or full refund.
0905
2015-01-09
  • ShippingServiceOptions.EstimatedDeliveryTimeMax (doc change): This field was removed from the Call Reference documentation. This field is only returned under the ShippingServiceSelected container.
  • ShippingServiceOptions.EstimatedDeliveryTimeMin (doc change): This field was removed from the Call Reference documentation. This field is only returned under the ShippingServiceSelected container.
  • CalculatedShippingRateType (modified): Data fields in this container used to specify shipping package weight and dimensions should no longer be used. Instead, the equivalents fields in ShippingPackageDetailsType should be used.
0899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
0897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
0895
2014-10-07
  • Order.ExtendedOrderID (doc change): Added more content to the field description.
  • Transaction.ExtendedOrderID (doc change): Added more content to the field description.
  • SellerDiscount.ItemDiscountAmount (doc change): Field description updated to fit new behavior of this field.
0893
2014-09-23
  • Order.ExtendedOrderID (added): This field is for internal or future use.
  • Transaction.ExtendedOrderID (added): This field is for internal or future use.
0891
2014-09-09
  • Transaction.InventoryReservationID (added): A unique identifier used by the merchant to identify reserved merchandise.
  • Buyer.UserFirstName, Buyer.UserLastName (added): The first and last name of the buyer who purchased the order.
  • SellerDiscounts.OriginalShippingService (added): The original shipping service offered by the seller to ship an item to a buyer.
  • ValueTypeCodeType (modified): 'DriverLicense' and 'CNPJ' added as new enum values.
0887
2014-07-15
  • Order.BuyerPackageEnclosures, Transaction.BuyerPackageEnclosures (added): A BuyerPackageEnclosures container, containing one or more BuyerPackageEnclosure containers, is returned if a buyer on the Germany site is being offered the 'Pay Upon Invoice' option, and the seller has provided payment instructions to the buyer in the shipping package(s). Payment instructions are provided through the type attribute of BuyerPackageEnclosureType. The BuyerPackageEnclosures container is returned at the order level for single line item orders, and at the transaction level for multiple line item orders. The 'Pay Upon Invoice' option will become available on the Germany site with the rollout of Progressive Checkout in October 2014.
  • Order.CheckoutStatus.PaymentInstument, Transaction.Status.PaymentInstrument (added): A PaymentInstrument field is returned if a buyer on the Germany site is using the 'Pay Upon Invoice' option. The enumeration value in this field indicates the type of payment method that the buyer selected to pay for the 'Pay Upon Invoice' order. The PaymentInstrument field is returned at the order level for single line item orders, and at the transaction level for multiple line item orders. The 'Pay Upon Invoice' option will become available on the Germany site with the rollout of Progressive Checkout in October 2014.
  • CancelReasonCodeType (modified): 'BuyerCancelOrAddressIssue' and 'OutOfStockOrCannotFulfill' added as new enum values.
  • ReturnStatusCodeType (modified): 'ReturnEscalated', 'ReturnRequestPending', 'ReturnRequestClosedWithRefund', and 'ReturnRequestClosedNoRefund' added as new enum values.
0883
2014-07-15
  • EstimatedDeliveryTimeMin, EstimatedDeliveryTimeMax (added): EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax are new dateTime fields in the ShippingPackageInfo container, indicating the earliest and latest times, respectively, that the buyer can expect to take delivery of an order not being delivered via eBay Now.
  • BuyerPaymentMethodCodeType (modified): The 'PayUponInvoice' enumeration value was added. This buyer payment method is for future use and will become available to the Germany site with the rollout of Progressive Checkout in October 2014. eBay/PayPal makes the determination (based on several factors) during checkout whether the buyer is eligible for 'Pay Upon Invoice'. If the buyer is offered the 'Pay Upon Invoice' option, that buyer is not required to pay for the order until an order invoice is sent by the seller.
  • TaxDetails.TaxCode (added): This value is the actual tax ID for the buyer. This field will generally only be returned if a seller on the Italy or Spain sites required that the buyer supply a tax ID during the checkout process.
0879
2014-06-17
  • AddressType.AddressAttribute (added): New field that shows an attribute for the address, and its corresponding value.
  • AddressType.ReferenceID (added): New field that shows an attribute for the address, and its corresponding value.
  • AddressAttributeType (added): New type that is used to display the value of the type attribute of the AddressAttribute field.
  • AddressAttributeCodeType (added): New enumerated type that contains the possible values that can be returned in AddressAttribute field.
  • Order.BuyerTaxIdentifier (added): New container consists of taxpayer identification for the buyer. This container is returned at the order level to sellers on the Italy or Spain site if a tax ID has been provided by the buyer during the checkout flow.
  • BuyerInfo.BuyerTaxIdentifier (added): New container consists of taxpayer identification for the buyer. This container is returned at the order line item level to sellers on the Italy or Spain site if a tax ID has been provided by the buyer during the checkout flow.
  • TaxIdentifierType (added): New type that defines the BuyerTaxIdentifier container.
  • ValueTypeCodeType (modified): This existing enumerated type is now used by order management calls to indicate what type of tax ID was provided by the buyer.
  • TaxIdentifierAttributeType (added): New type that is used to display the value of the name attribute of the BuyerTaxIdentifier.Attribute field.
  • TaxIdentifierAttributeCodeType (added): New enumerated type that contains the possible values that can be returned in the name attribute of the BuyerTaxIdentifier.Attribute field.
  • CancelStatusCodeType (modified): The following values were added to handle more order cancellation states: 'Invalid', 'NotApplicable', 'CancelRequested', 'CancelRejected', 'CancelClosedNoRefund', 'CancelClosedWithRefund', 'CancelClosedUnknownRefund', and 'CancelClosedForCommitment'.
  • Transaction.Status.ReturnStatus (added): New field gives the status of a buyer's return request.
  • Transaction.Status.InquiryStatus (added): New field gives the status of a buyer's request for shipment tracking information.
  • ReturnStatusCodeType (added): New enumerated type that contains the possible values that can be returned in the Transaction.Status.ReturnStatus field.
  • InquiryStatusCodeType (added): New enumerated type that contains the possible values that can be returned in the Transaction.Status.InquiryStatus field.
  • PickuMethodCodeType (modified): 'PickUpDropOff' value added to handle the use case when the buyer selects "Click and Collect" as the pickup method. The "Click and Collect" feature is currently only available on the eBay UK site.
  • PickupMethodSelectedType (modified): 'PickupLocationUUID' value added to identify the the store where the "Click and Collect" item will be picked up.
  • Order.LogisticsPlanType (added): New field that indicates which type of logistics plan has been selected for the current order by the buyer. A logistics plan categorizes the means by which a package is transported from the seller to the buyer.
  • Transaction.LogisticsPlanType (added): New field that indicates which type of logistics plan has been selected for the current order line item by the buyer. A logistics plan categorizes the means by which a package is transported from the seller to the buyer.
0871
2014-04-22
  • TransactionArray.Transaction (doc change): All TransactionType fields were added to the OrderReport Call Reference document. Although TransactionType fields were already being returned with the OrderReport response, these fields were missing from the Call Reference document.
0867
2014-03-25
  • CancelDetailType (added): New type that provides details on the cancellation of an eBay Now Order.
  • CancelInitiatorCodeType (added): New type that defines the parties who can initiate the cancellation of an eBay Now Order.
  • CancelStatusCodeType (added): New type that defines the states of an eBay Now order cancellation.
  • PickupMethodSelected.PickupFulfillmentTime (added): Timestamp indicating when and In-Store Pickup order is available to be picked up by the buyer.
  • Order.ShippingConvenienceCharge (added): The convenience fee charged to the buyer for an eBay Now order.
  • Transaction.ShippingConvenienceCharge (added): The convenience fee charged to the buyer for one order line item in an eBay Now order.
  • CancelReasonCodeType (modified): 'OrderPlacedByMistake', 'PriceTooHigh', 'FoundCheaperPrice', and 'WontArriveInTime' added as new enum values.
  • OrderStatusCodeType (modified): 'CancelPending' added as new enum value.
  • PickupStatusCodeType (modified): 'PickupCancelled' added as new enum value.
0863
2014-02-25
  • TaxTableType (added): Although the TaxTable container was already being returned in OrderReport, it was not noted as being returned in the merchantdataservice.xsd file and it was not appearing in the OrderReport Call Reference. This problem has been corrected.
  • TaxJurisdictionType (added): Although the TaxJurisdiction container was already being returned in OrderReport, it was not noted as being returned in the merchantdataservice.xsd file and it was not appearing in the OrderReport Call Reference. This problem has been corrected.
0849
2013-11-05
  • ShippingServiceOptions.ShippingPackageInfo (added): New container consisting of details related to an eBay Now delivery. This container will only be returned for eBay Now-eligible orders. Once a buyer selects 'eBayNowImmediateDelivery' as the delivery/shipping option, this container will be replaced by the ShippingServiceSelected.ShippingPackageInfo container.
  • ShippingServiceSelected.ShippingPackageInfo (added): New container consisting of details related to an eBay Now delivery. This container will only be returned for eBay Now orders.
  • Order.CancelReason (added): New field indicating the reason for the cancellation of an eBay Now order. This field is only returned if an eBay Now order was cancelled.
  • MonetaryDetails.Payments.Payment.PaymentReferenceID (added): New field added to support buyer payment for an eBay Now order. The value in this field will be the unique identifier of the eBay Now payment transaction, and the value of this field's type attribute will be 'MandateReferenceNumber' for eBay Now payment transactions.
  • Item.PaymentMethods (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values will only be returned for eBay Now orders.
  • ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value will only be returned for eBay Now orders.
0845
2013-10-08
  • (added) New call