ReviseInventoryStatus
This call enables a seller to change the price and/or quantity of up to four active, fixed-price listings. The fixed-price listing(s) to modify are identified with the ItemID of the listing or the SKU value of the item (if a seller-defined SKU value exists for the listing).
This call can be used to update both single-variation and multiple-variation listings. For a multiple-variation listing, the SKU value of the item variation is required in order to identify a specific item variation.
Note: The ReviseFixedPriceItem call can also be used to update the price and/or quantity of a variation within a multiple-variation listing, passing in the updated price or quantity information through the corresponding Variations.Variation node for that product variation.
This call also has the following restrictions/limitations. Make sure you read these before proceeding to make ReviseInventoryStatus calls.
Daily ReviseInventoryStatus call limit for German sellers: Sellers on the German marketplace have a daily limit on ReviseInventoryStatus calls per listing. For these sellers, the ReviseInventoryStatus calls can be used up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from using this call on the listing until the next calendar day.
Short-duration call rate limit: The ReviseInventoryStatus call is one of five Trading API calls where eBay has implemented a short-duration call rate limit to restrict bursts of very high traffic, and to protect eBay's infrastructure and servers from being overloaded and/or destabilized.
Per (seller) user ID, no more than 6000 ReviseInventoryStatus calls can be executed within any 15-second interval. If this call rate limit is exceeded at any time, the application making the called is blocked. Each time an application is blocked, the user/application must wait until the block is reset after 15 seconds. This short-duration call rate limit applies to all seller accounts, and sellers/developers cannot appeal or request for a higher limit.
Incompatibility with Inventory model listings: An active listing that was created with the new Inventory model (using the Inventory API or Merchant Integration Platform) cannot be revised using the ReviseFixedPriceItem, ReviseItem, or ReviseInventoryStatus calls. Instead, the seller will need to use the Inventory API or MIP.
See Revising a Listing.
See also the reference documentation for this call:
- ReviseItem - Enables a seller to revise a listing on a specified eBay site.
Output Samples Change History |
Input
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
<?xml version="1.0" encoding="utf-8"?> <ReviseInventoryStatusRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <InventoryStatus> InventoryStatusType <ItemID> ItemIDType (string) </ItemID> <Quantity> int </Quantity> <SKU> SKUType (string) </SKU> <StartPrice> AmountType (double) </StartPrice> </InventoryStatus> <!-- ... more InventoryStatus nodes allowed here ... --> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </ReviseInventoryStatusRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
InventoryStatus | InventoryStatusType | Required,
repeatable: [1..4] |
One InventoryStatus container is required for each item or item variation that is being revised. Whether updating the price and/or quantity of a single-variation listing or a specific variation within a multiple-variation listing, the limit of items or item variations that can be modified with one call is four. |
InventoryStatus.ItemID | ItemIDType (string) | Conditional |
The unique identifier of the listing being revised. For a single-variation listing, either the ItemID of the listing or the SKU value of the item (if it exists) is required, and which one to use will depend on the value of the InventoryTrackingMethod setting. If the value of InventoryTrackingMethod is ItemID , the ItemID field should be used. If the value of InventoryTrackingMethod is SKU , the SKU field should be used. ItemID is the default value of InventoryTrackingMethod, and its value can only be set/changed to SKU through either an AddFixedPriceItem or RelistFixedPriceItem call. For a multiple-variation listing, the SKU value of the item variation is required in order to identify a specific item variation. An ItemID field is also required if the InventoryTrackingMethod value is set to ItemID . However, if the InventoryTrackingMethod value is set to SKU , only the SKU value of the item variation is needed to identify a specific item variation. Note that a seller-defined SKU value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU. Please note that the same ItemID value can be used multiple times in the same call if you revise several item variations from the same multiple-variation listing. The ItemID field is always returned in the response, even if an ItemID value was not included in the request. |
InventoryStatus.Quantity | int | Conditional |
Note: The Quantity response field is being deprecated, and it will no longer be supported after April 30, 2022. eBay has found that the value returned for this field is not reliably accurate and recommends that the response for this field be ignored. The Quantity request field can still be used, and sellers can leverage the GetItem call to verify that the requested quantity updates were successful. This field is used to set the revised quantity of the listing (or of a variation within a multiple-variation listing). In each InventoryStatus container, either StartPrice or Quantity (or both) are required. The Quantity field is always returned in the response, regardless of whether the quantity was changed or not through a Quantity field in the call request. However, the Quantity field in the response is actually a total of the quantity available for sale plus the quantity already sold for the item or item variation. For example, suppose the item or item variation originally had a quantity of 10, and then a quantity of 8 was sold. Now, you restock your inventory, and you pass in a quantity of 10 in the ReviseInventoryStatus request. In this case, the response of this ReviseInventoryStatus call would show a quantity of 18 (10 available + 8 sold). To determine the quantity available, use the GetItem or GetSellerList call, and subtract the SellingStatus.QuantitySold value from the Quantity value. Or, you can also use the GetMyeBaySelling call, search for the correct item or item variation in the response by ItemID or SKU value, and then look at the QuantityAvailable field for that item or item variation. It is a good idea to maintain an adequate quantity available for fixed-price GTC listings to prevent the search rankings from dropping. Best Match search ranking is based on buyer activity, and one of the factors affecting search ranking for fixed-price listings is the recent sales score. Fixed-price items that are selling the fastest are given a relative lift in search results. |
InventoryStatus.SKU | SKUType (string) | Conditional |
This value is the seller-defined SKU value of the item being revised. For a single-variation listing, either the ItemID of the listing or the SKU value of the item (if it exists) is required, and which one to use will depend on the value of the InventoryTrackingMethod setting. If the value of InventoryTrackingMethod is ItemID , the ItemID field should be used. If the value of InventoryTrackingMethod is SKU , the SKU field should be used. ItemID is the default value of InventoryTrackingMethod, and its value can only be set/changed to SKU through either an AddFixedPriceItem or RelistFixedPriceItem call. For a multiple-variation listing, the SKU value of the item variation is required in order to identify a specific item variation. An ItemID field is also required if the InventoryTrackingMethod value is set to ItemID . However, if the InventoryTrackingMethod value is set to SKU , only the SKU value of the item variation is needed to identify a specific item variation. Note that a seller-defined SKU value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU. The SKU field is always returned in the response, and if a SKU value doesn't exist for a single-variation listing, it is returned as an empty tag. |
InventoryStatus.StartPrice | AmountType (double) | Conditional |
Note: The StartPrice response field is being deprecated, and it will no longer be supported after April 30, 2022. eBay has found that the value returned for this field is not reliably accurate and recommends that the response for this field be ignored. The StartPrice request field can still be used, and sellers can leverage the GetItem call to verify that the requested price updates were successful. This field is used to set the revised price of the listing (or of a variation within a multiple-variation listing). In each InventoryStatus container, either StartPrice or Quantity (or both) are required. The StartPrice field is always returned in the response and reveals the current price of the item or item variation, regardless of whether the price was changed or not through a StartPrice field in the call 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.
|
||||||||||||||||||||||||||||||||||||||||
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:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Samples Change History |
Output
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <ReviseInventoryStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <Fees> InventoryFeesType <Fee> FeeType <Fee currencyID="CurrencyCodeType"> AmountType (double) </Fee> <Name> string </Name> <PromotionalDiscount currencyID="CurrencyCodeType"> AmountType (double) </PromotionalDiscount> </Fee> <!-- ... more Fee nodes allowed here ... --> <ItemID> ItemIDType (string) </ItemID> </Fees> <!-- ... more Fees nodes allowed here ... --> <InventoryStatus> InventoryStatusType <ItemID> ItemIDType (string) </ItemID> <Quantity> int </Quantity> <SKU> SKUType (string) </SKU> <StartPrice currencyID="CurrencyCodeType"> AmountType (double) </StartPrice> </InventoryStatus> <!-- ... more InventoryStatus nodes allowed here ... --> <!-- 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> </ReviseInventoryStatusResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
Fees | InventoryFeesType | Always,
repeatable: [1..4] |
A Fees container is returned for each fixed-price listing that was modified with the ReviseInventoryStatus call. This container consists of the estimated listing fees for the revised listing, and the listing is identified in the ItemID field. Each type of fee is returned even if it is not appplicable (has a value of 0.0 . The Final Value Fee (FVF) is not in this container, as this value cannot be determined until a sale is made. Note that these fees are at the listing level, so if multiple variations within a multiple-variation listing were modified, the fees in this container would be cumulative totals, and would not single out the fees associated with each modified item variation. Please note that since fees are returned at the listing level, it is possible that the response will include one Fees container and four InventoryStatus containers if you made revisions to four different item variations within the same multiple-variation listing. See:
|
Fees.Fee | FeeType | Always,
repeatable: [1..*] |
Contains the data for one fee (such as name and amount). |
Fees.Fee.Fee | AmountType (double) | Always |
Amount of the fee that eBay will charge the member for the associated listing feature.
See eBay.com Fees for a current list of listing features and their associated fees.. |
Fees.Fee.Fee [ attribute currencyID ] |
CurrencyCodeType | Always |
Amount of the fee that eBay will charge the member for the associated listing feature. For a list of possible enumeration values, see CurrencyCodeType. |
Fees.Fee.Name | string | Always |
This is the name of the listing feature, such as ListingFee , SubtitleFee , or BoldFee .
|
Fees.Fee.PromotionalDiscount | AmountType (double) | Always |
This field exists in the response when the user has selected a feature that participates in a promotional discount. Note: Verify calls might not return the PromotionalDiscount fee in the response. See Standard selling fees for A current schedule of listing features and their associated fees.. |
Fees.Fee.PromotionalDiscount [ attribute currencyID ] |
CurrencyCodeType | Always |
This field exists in the response when the user has selected a feature that participates in a promotional discount. Note: Verify calls might not return the PromotionalDiscount fee in the response. For a list of possible enumeration values, see CurrencyCodeType. |
Fees.ItemID | ItemIDType (string) | Always |
The unique identifier of the listing being changed. The ReviseInventoryStatus response includes a separate set of fees for each item that was successfully revised. Use the ItemID to correlate the Fees data with the Inventory Status data in the response. |
InventoryStatus | InventoryStatusType | Always,
repeatable: [1..4] |
One InventoryStatus container is returned for each item or item variation that was revised. Whether updating the price and/or quantity of a single-variation listing or a specific variation within a multiple-variation listing, the limit of items or item variations that can be modified with one call is four. Note that all four elements of this container are returned even if these fields would not supplied in the call request. The SKU field is returned as an empty tag if it is not defined for a single-variation listing. |
InventoryStatus.ItemID | ItemIDType (string) | Always |
The unique identifier of the listing being revised. For a single-variation listing, either the ItemID of the listing or the SKU value of the item (if it exists) is required, and which one to use will depend on the value of the InventoryTrackingMethod setting. If the value of InventoryTrackingMethod is ItemID , the ItemID field should be used. If the value of InventoryTrackingMethod is SKU , the SKU field should be used. ItemID is the default value of InventoryTrackingMethod, and its value can only be set/changed to SKU through either an AddFixedPriceItem or RelistFixedPriceItem call. For a multiple-variation listing, the SKU value of the item variation is required in order to identify a specific item variation. An ItemID field is also required if the InventoryTrackingMethod value is set to ItemID . However, if the InventoryTrackingMethod value is set to SKU , only the SKU value of the item variation is needed to identify a specific item variation. Note that a seller-defined SKU value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU. Please note that the same ItemID value can be used multiple times in the same call if you revise several item variations from the same multiple-variation listing. The ItemID field is always returned in the response, even if an ItemID value was not included in the request. |
InventoryStatus.Quantity | int | Always |
Note: The Quantity response field is being deprecated, and it will no longer be supported after April 30, 2022. eBay has found that the value returned for this field is not reliably accurate and recommends that the response for this field be ignored. The Quantity request field can still be used, and sellers can leverage the GetItem call to verify that the requested quantity updates were successful. This field is used to set the revised quantity of the listing (or of a variation within a multiple-variation listing). In each InventoryStatus container, either StartPrice or Quantity (or both) are required. The Quantity field is always returned in the response, regardless of whether the quantity was changed or not through a Quantity field in the call request. However, the Quantity field in the response is actually a total of the quantity available for sale plus the quantity already sold for the item or item variation. For example, suppose the item or item variation originally had a quantity of 10, and then a quantity of 8 was sold. Now, you restock your inventory, and you pass in a quantity of 10 in the ReviseInventoryStatus request. In this case, the response of this ReviseInventoryStatus call would show a quantity of 18 (10 available + 8 sold). To determine the quantity available, use the GetItem or GetSellerList call, and subtract the SellingStatus.QuantitySold value from the Quantity value. Or, you can also use the GetMyeBaySelling call, search for the correct item or item variation in the response by ItemID or SKU value, and then look at the QuantityAvailable field for that item or item variation. It is a good idea to maintain an adequate quantity available for fixed-price GTC listings to prevent the search rankings from dropping. Best Match search ranking is based on buyer activity, and one of the factors affecting search ranking for fixed-price listings is the recent sales score. Fixed-price items that are selling the fastest are given a relative lift in search results. |
InventoryStatus.SKU | SKUType (string) | Always |
This value is the seller-defined SKU value of the item being revised. For a single-variation listing, either the ItemID of the listing or the SKU value of the item (if it exists) is required, and which one to use will depend on the value of the InventoryTrackingMethod setting. If the value of InventoryTrackingMethod is ItemID , the ItemID field should be used. If the value of InventoryTrackingMethod is SKU , the SKU field should be used. ItemID is the default value of InventoryTrackingMethod, and its value can only be set/changed to SKU through either an AddFixedPriceItem or RelistFixedPriceItem call. For a multiple-variation listing, the SKU value of the item variation is required in order to identify a specific item variation. An ItemID field is also required if the InventoryTrackingMethod value is set to ItemID . However, if the InventoryTrackingMethod value is set to SKU , only the SKU value of the item variation is needed to identify a specific item variation. Note that a seller-defined SKU value is required when a seller creates a multiple-variation listing, regardless of whether they decide to track inventory by Item ID or SKU. The SKU field is always returned in the response, and if a SKU value doesn't exist for a single-variation listing, it is returned as an empty tag. |
InventoryStatus.StartPrice | AmountType (double) | Always |
Note: The StartPrice response field is being deprecated, and it will no longer be supported after April 30, 2022. eBay has found that the value returned for this field is not reliably accurate and recommends that the response for this field be ignored. The StartPrice request field can still be used, and sellers can leverage the GetItem call to verify that the requested price updates were successful. This field is used to set the revised price of the listing (or of a variation within a multiple-variation listing). In each InventoryStatus container, either StartPrice or Quantity (or both) are required. The StartPrice field is always returned in the response and reveals the current price of the item or item variation, regardless of whether the price was changed or not through a StartPrice field in the call request. |
InventoryStatus.StartPrice [ attribute currencyID ] |
CurrencyCodeType | Always |
Note: The StartPrice response field is being deprecated, and it will no longer be supported after April 30, 2022. eBay has found that the value returned for this field is not reliably accurate and recommends that the response for this field be ignored. The StartPrice request field can still be used, and sellers can leverage the GetItem call to verify that the requested price updates were successful. This field is used to set the revised price of the listing (or of a variation within a multiple-variation listing). In each InventoryStatus container, either StartPrice or Quantity (or both) are required. The StartPrice field is always returned in the response and reveals the current price of the item or item variation, regardless of whether the price was changed or not through a StartPrice field in the call request. For a list of possible enumeration values, see CurrencyCodeType. |
Standard Output Fields |
Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See 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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Change History |
Samples
Code samples not yet added for this call's documentation.
Input Output Samples |
Change History
Change Date | Description |
---|