com.ebay.sdk.call.ReviseInventoryStatusCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the ReviseInventoryStatus call of eBay SOAP API.
*
* Title: SOAP API wrapper library.
* Description: Contains wrapper classes for eBay SOAP APIs.
* Copyright: Copyright (c) 2009
* Company: eBay Inc.
*
Input property: InventoryStatus - 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.
*
Output property: ReturnedInventoryStatus - 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.
*
Output property: ReturnedFees - 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.
*
* @author Ron Murphy
* @version 1.0
*/
public class ReviseInventoryStatusCall extends com.ebay.sdk.ApiCall
{
private InventoryStatusType[] inventoryStatus = null;
private InventoryStatusType[] returnedInventoryStatus=null;
private InventoryFeesType[] returnedFees=null;
/**
* Constructor.
*/
public ReviseInventoryStatusCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public ReviseInventoryStatusCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Enables a seller to change the price and/or quantity of one to four
* active, fixed-price listings. The fixed-price listing to modify is identified with the ItemID of the listing and/or the SKU value of the item (if a seller-defined SKU value exists for the listing). If the seller is modifying one or more variations within a multiple-variation listing, the ItemID and SKU fields in the InventoryStatus container become required, with the ItemID value identifying the listing, and the SKU value identifying the specific product variation within that multiple-variation listing. Each variation within a multiple-variation listing requires a seller-defined SKU value.
*
* 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.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The InventoryStatusType[] object.
*/
public InventoryStatusType[] reviseInventoryStatus()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
ReviseInventoryStatusRequestType req;
req = new ReviseInventoryStatusRequestType();
if (this.inventoryStatus != null)
req.setInventoryStatus(this.inventoryStatus);
ReviseInventoryStatusResponseType resp = (ReviseInventoryStatusResponseType) execute(req);
this.returnedInventoryStatus = resp.getInventoryStatus();
this.returnedFees = resp.getFees();
return this.getReturnedInventoryStatus();
}
/**
* Gets the ReviseInventoryStatusRequestType.inventoryStatus.
* @return InventoryStatusType[]
*/
public InventoryStatusType[] getInventoryStatus()
{
return this.inventoryStatus;
}
/**
* Sets the ReviseInventoryStatusRequestType.inventoryStatus.
* @param inventoryStatus InventoryStatusType[]
*/
public void setInventoryStatus(InventoryStatusType[] inventoryStatus)
{
this.inventoryStatus = inventoryStatus;
}
/**
* Valid after executing the API.
* Gets the returned ReviseInventoryStatusResponseType.returnedFees.
*
* @return InventoryFeesType[]
*/
public InventoryFeesType[] getReturnedFees()
{
return this.returnedFees;
}
/**
* Valid after executing the API.
* Gets the returned ReviseInventoryStatusResponseType.returnedInventoryStatus.
*
* @return InventoryStatusType[]
*/
public InventoryStatusType[] getReturnedInventoryStatus()
{
return this.returnedInventoryStatus;
}
}