ReviseSellingManagerSaleRecord

Note: The ReviseSellingManagerSaleRecord call is being deprecated. No new features and/or fields will be added to ReviseSellingManagerSaleRecord, and it will no longer be supported after March 30, 2021. eBay recommends that sellers use the CompleteSale Trading API call to mark orders as paid, mark orders as shipped, and provide shipment tracking details.

Revises a Selling Manager sale record when you specify either an ItemID, a TransactionID, an OrderID, or an an OrderLineItemID. To use this call, you must be a Selling Manager Pro subscriber.

To use this call, first call AddSellingManagerTemplate and use the OrderLineItemID output field from GetSellingManagerSaleRecord as the input for ReviseSellingManagerSaleRecord. Include the SellingManagerSoldOrder for any new revisions to the Selling Manager sale record.

See:
Using Selling Manager Calls in the Trading API
Selling Manager Pro page on the eBay Site

See also the reference documentation for this call:

GetSellingManagerSaleRecord - Retrieves the data for one or more Selling Manager sale records.

Input

See also Samples.

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

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<ReviseSellingManagerSaleRecordRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ItemID> ItemIDType (string) </ItemID>
  <OrderID> OrderIDType (string) </OrderID>
  <OrderLineItemID> string </OrderLineItemID>
  <SellingManagerSoldOrder> SellingManagerSoldOrderType
    <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
    <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
    <CashOnDeliveryCost currencyID="CurrencyCodeType"> AmountType (double) </CashOnDeliveryCost>
    <ItemCost currencyID="CurrencyCodeType"> AmountType (double) </ItemCost>
    <NotesToBuyer> string </NotesToBuyer>
    <NotesToSeller> string </NotesToSeller>
    <OrderStatus> SellingManagerOrderStatusType
      <PaidStatus> SellingManagerPaidStatusCodeType </PaidStatus>
      <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
      <ShippedStatus> SellingManagerShippedStatusCodeType </ShippedStatus>
    </OrderStatus>
    <ShippingAddress> AddressType
      <CityName> string </CityName>
      <Country> CountryCodeType </Country>
      <StateOrProvince> string </StateOrProvince>
      <Street1> string </Street1>
    </ShippingAddress>
    <ShippingDetails> ShippingDetailsType
      <SalesTax> SalesTaxType
        <SalesTaxPercent> float </SalesTaxPercent>
      </SalesTax>
      <ShippingServiceOptions> ShippingServiceOptionsType
        <ShippingService> token </ShippingService>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      </ShippingServiceOptions>
      <!-- ... more ShippingServiceOptions nodes allowed here ... -->
    </ShippingDetails>
    <VATRate> VATRateType
      <ItemID> ItemIDType (string) </ItemID>
      <OrderLineItemID> string </OrderLineItemID>
      <TransactionID> string </TransactionID>
      <VATPercent> float </VATPercent>
    </VATRate>
    <!-- ... more VATRate nodes allowed here ... -->
  </SellingManagerSoldOrder>
  <TransactionID> string </TransactionID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</ReviseSellingManagerSaleRecordRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

ItemID	ItemIDType (string)	Conditional	Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID value. An ItemID can be paired up with a corresponding TransactionID and used as an input filter for ReviseSellingManagerSaleRecord. The ItemID/TransactionID pair corresponds to a Selling Manager SaleRecordID, which can be retrieved with the GetSellingManagerSaleRecord call. Unless an OrderLineItemID is used to identify an order line item, or the OrderID is used to identify an order, the ItemID/TransactionID pair must be specified. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.
OrderID	OrderIDType (string)	Conditional	A unique identifier that identifies a single line item or multiple line item order associated with the Selling Manager sale record(s). If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are ignored if they are specified in the same request. Note: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to `1113` in API calls. Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level. Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the ReviseSellingManagerSaleRecord call, will support the identifiers for both unpaid and paid orders. The new order ID format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, 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.
OrderLineItemID	string	Conditional	A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). Unless an ItemID/TransactionID pair is used to identify an order line item, or the OrderID is used to identify an order, the OrderLineItemID must be specified. For a multiple line item order, OrderID should be used. If OrderLineItemID is specified, the ItemID/TransactionID pair are ignored if present in the same request.
SellingManagerSoldOrder	SellingManagerSoldOrderType	Conditional	Container consisting of order costs, shipping details, order status, and other information. The changes made under this container will update the order in Selling Manager.
SellingManagerSoldOrder .ActualShippingCost	AmountType (double)	Optional	The shipping cost paid by the seller to ship the order line item. For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00. Note: This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer.
SellingManagerSoldOrder .ActualShippingCost [ attribute currencyID ]	CurrencyCodeType	Optional	The shipping cost paid by the seller to ship the order line item. For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00. Note: This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .AdjustmentAmount	AmountType (double)	Optional	Discount, or charge, to which the buyer and seller have agreed. If this value is a positive value, the amount is the extra money that the buyer pays the seller. If this value is a negative value, the amount is a discount the seller gives the buyer.
SellingManagerSoldOrder .AdjustmentAmount [ attribute currencyID ]	CurrencyCodeType	Optional	Discount, or charge, to which the buyer and seller have agreed. If this value is a positive value, the amount is the extra money that the buyer pays the seller. If this value is a negative value, the amount is a discount the seller gives the buyer. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .CashOnDeliveryCost	AmountType (double)	Optional	The cost of cash-on-delivery.
SellingManagerSoldOrder .CashOnDeliveryCost [ attribute currencyID ]	CurrencyCodeType	Optional	The cost of cash-on-delivery. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .ItemCost	AmountType (double)	Optional	A SMPro seller can record the cost of the item, as calculated by the seller, in this field.
SellingManagerSoldOrder .ItemCost [ attribute currencyID ]	CurrencyCodeType	Optional	A SMPro seller can record the cost of the item, as calculated by the seller, in this field. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NotesToBuyer	string	Optional	Notes from the seller to the buyer.
SellingManagerSoldOrder .NotesToSeller	string	Optional	Notes to self from seller.
SellingManagerSoldOrder .OrderStatus	SellingManagerOrderStatusType	Optional	Status of the order regarding payment, shipping, feedback, and other communications.
SellingManagerSoldOrder .OrderStatus.PaidStatus	SellingManagerPaidStatusCodeType	Optional	The paid status of the order. Applicable values: See PaidStatus.
SellingManagerSoldOrder .OrderStatus.PaymentMethodUsed	BuyerPaymentMethodCodeType	Optional	The payment method the buyer selected for paying the seller for the order. If checkout is incomplete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page. Applicable values: See PaymentMethodUsed.
SellingManagerSoldOrder .OrderStatus.ShippedStatus	SellingManagerShippedStatusCodeType	Optional	The shipped status of the order. Applicable values: CustomCode (in/out) Reserved for internal or future use. Shipped (in/out) The shipped status is "shipped." Unshipped (in/out) The shipped status is "unshipped."
SellingManagerSoldOrder .ShippingAddress	AddressType	Optional	Shipping address of a buyer.
SellingManagerSoldOrder .ShippingAddress.CityName	string	Optional	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.
SellingManagerSoldOrder .ShippingAddress.Country	CountryCodeType	Optional	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. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Applicable values: See Country.
SellingManagerSoldOrder .ShippingAddress .StateOrProvince	string	Optional	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.
SellingManagerSoldOrder .ShippingAddress.Street1	string	Optional	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.
SellingManagerSoldOrder .ShippingDetails	ShippingDetailsType	Optional	The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.
SellingManagerSoldOrder .ShippingDetails.SalesTax	SalesTaxType	Optional	This container shows the sales tax rate percentage for a specific tax jurisdiction. Additionally, it indicates whether or not the seller applies sales tax to shipping charges in addition to the item cost. 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-related 'Get' calls if sales tax is applicable to the order line item. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied by the seller for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay during checkout process. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the eBay sales tax collection help topic. Note: For eBay managed payment orders that are subject to 'Collect and Remit' taxes, these taxes will only be shown in the eBayCollectAndRemitTaxes container for line items, and the SalesTax will not be returned at all. For non-eBay managed payment orders, the 'Collect and Remit' taxes will be shown in both the eBayCollectAndRemitTaxes and SalesTax containers. See Enabling Multi-Jurisdiction Sales Tax.
SellingManagerSoldOrder .ShippingDetails.SalesTax .SalesTaxPercent	float	Optional	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. Note: As of April 1, 2020, buyers in 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic.
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions	ShippingServiceOptionsType	Optional, 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, only four other international shipping services may be offered (regardless of whether or not Global 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).
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingService	token	Optional	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. See GeteBayDetails. Applicable values: See ShippingServiceCodeType
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Optional	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.
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Optional	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.
SellingManagerSoldOrder .VATRate	VATRateType	Optional, repeatable: [0..*]	Rate of applicable value added tax.
SellingManagerSoldOrder .VATRate.ItemID	ItemIDType (string)	Optional	Unique identifier for an eBay listing. A listing can have multiple order line items (transactions), but only one ItemID. An ItemID can be paired up with a corresponding TransactionID and used as an input filter for ReviseSellingManagerSaleRecord. However, if OrderID is passed in as an input filter for ReviseSellingManagerSaleRecord, the ItemID/TransactionID pair is ignored.
SellingManagerSoldOrder .VATRate.OrderLineItemID	string	Optional	OrderLineItemID is a unique identifier for an eBay order line item If a VAT rate is specified in the ReviseSellingManagerSaleRecord request, OrderLineItemID can be used instead of ItemID and TransactionID. Max length: 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.).
SellingManagerSoldOrder .VATRate.TransactionID	string	Optional	Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. The ItemID/TransactionID pair can be used as an input filter for ReviseSellingManagerSaleRecord. However, if OrderID is passed in as an input filter for ReviseSellingManagerSaleRecord, the ItemID/TransactionID pair is ignored.
SellingManagerSoldOrder .VATRate.VATPercent	float	Optional	The VAT (Value-Added Tax) rate for the order line item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Min: 0. Max: 30.
TransactionID	string	Conditional	Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). Since an auction listing can only have one sales transaction during the duration of the listing, the TransactionID value for auction listings is always `0`. The ItemID/TransactionID pair can be used to identify an order line item in a ReviseSellingManagerSaleRecord call. The ItemID/TransactionID pair corresponds to a Selling Manager SaleRecordID, which can be retrieved with the GetSellingManagerSaleRecord call. Unless an OrderLineItemID is used to identify an order line item, or the OrderID is used to identify an order, the ItemID/TransactionID pair must be specified. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.

Standard Input Fields

ErrorLanguage

string

Optional

Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.

ID	Country
en_AU	Australia
de_AT	Austria
nl_BE	Belgium (Dutch)
fr_BE	Belgium (French)
en_CA	Canada
fr_CA	Canada (French)
zh_CN	China
fr_FR	France
de_DE	Germany
zh_HK	Hong Kong
en_IN	India
en_IE	Ireland
it_IT	Italy
nl_NL	Netherlands
en_SG	Singapore
es_ES	Spain
de_CH	Switzerland
en_GB	United Kingdom
en_US	United States

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.

Version

string

Conditional

The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:

It indicates the version of the code lists and other data that eBay should use to process your request.
It indicates the schema version you are using.

You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP Headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel

WarningLevelCodeType

Optional

Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High

(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.

Low

(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.

Output

See also Samples.

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

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<ReviseSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</ReviseSellingManagerSaleRecordResponse>

Return Value	Type	Occurrence	Meaning

(No call-specific fields)

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field. Applicable values: CustomCode (out) Reserved for internal or future use. Failure (out) This value indicates that the call request processing failed. Success (out) This value indicates that the call request was processed successfully without any issues. Warning (out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request. (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list.
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: CustomCode (out) Reserved for internal or future use. RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. 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 the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	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 (out) Reserved for internal or future use. Error (out) 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 Compatible Application Check section of the eBay Features Guide for more information. Warning (out) 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	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

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: Basic Call

Revises a Selling Manager sale record.

Description

User magicalbookseller sold a Harry Potter Book to braggybuyer, but braggybuyer notified magicalbookseller that he had recently changed his shipping address from WhoVille to SomePlace. User magicalbookseller needs to update her sale records to reflect the address change. She makes a call to ReviseSellingManagerSaleRecord.

Input

In her ReviseSellingManagerSaleRecord request, magicalbookseller specifies the appropriate item ID.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<ReviseSellingManagerSaleRecordRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>170001996049</ItemID>
  <TransactionID>7426530007</TransactionID>
  <SellingManagerSoldOrder>
    <ShippingAddress>
      <Name>Vito De Niro</Name>
      <Street1>228476 2nd Street</Street1>
      <CityName>Ventura</CityName>
      <StateOrProvince>CA</StateOrProvince>
      <Country>US</Country>
      <PostalCode>93003</PostalCode>
    </ShippingAddress>
  </SellingManagerSoldOrder>
</ReviseSellingManagerSaleRecordRequest>

Output

The response includes the Ack field, indicating that the call succeeded.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<ReviseSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T22:28:08.811Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
</ReviseSellingManagerSaleRecordResponse>

Change History

Change Date	Description
1145 2020-03-13	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. In the case of the ReviseSellingManagerSaleRecord call, the seller should use the new order ID format in the OrderID field if the order has been paid for (checkout is complete).
1113 2019-06-21	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.
1107 2019-05-10	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	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.
1031 2017-09-01	ShippingDetails.InsuranceDetails (deprecated): This container and InsuranceDetailsType have been deprecated, as it is no longer possible/applicable for sellers to offer shipping insurance to buyers on any eBay site.
0947 2015-10-29	ShippingServiceCodeType (modified): A new enumeration value, FlatRateFreight, enables sellers to offer free or flat rate freight shipping on listings shipped within the United States. The seller negotiates the actual shipping cost with the freight carrier separately from the checkout process, so the sale can be completed quickly.
0945 2015-10-15	BuyerPaymentMethodCodeType (modified): Sellers can no longer specify Moneybookers, ProPay, or Paymate as values in a PaymentMethods field when adding, revising, or relisting an item. One of these values can only be used in the PaymentMethodUsed field if the order payment using one of these payment methods went through during checkout. Currently, sellers are not be forced to update existing listings that already feature these payment methods.
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.
0849 2013-11-05	OrderStatus.PaymentMethodUsed (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values should only be used to revise an active eBay Now order. ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value should only be used to revise an active eBay Now order.
0807 2013-01-23	SellingManagerSoldOrder.ActualShippingCost (doc change): Clarified that SellingManagerSoldOrder.ActualShippingCost is tThe shipping cost paid by the seller to ship an order line item. This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer.
0795 2012-10-10	SellingManagerSoldOrder.ShippingDetails (doc change): Added a note to emphasize that when revising a listing, you must include all of the ShippingDetails fields that were originally provided, or their values will be discarded.
0781 2012-07-04	ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
0719 2011-04-27	ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight. Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller.
0705 2011-01-19	OrderLineItemID (modified): The OrderLineItemID value can now be used in Production to identify a single line item order (instead of ItemID/TransactionID pair) at the root level and in the VATRate container. The OrderLineItemID value can also be passed into the OrderID field (for single line item orders only).
0691 2010-10-14	OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. OrderLineItemID can only be specified in the input or returned in the output if you set your request version to 705.
0635 2009-09-16	InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
0589 2008-10-29	(added) New call.