withdrawOfferByInventoryItemGroup: eBay Inventory API

POST/offer/withdraw_by_inventory_item_group

This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. This call only ends multiple-variation eBay listing associated with the inventory item group but does not delete the inventory item group object. Similarly, this call also does not delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. If the seller wanted to relist the multiple-variation eBay listing, they could use the publishOfferByInventoryItemGroup method.

Input

Resource URI

POST https://api.ebay.com/sell/inventory/v1/offer/withdraw_by_inventory_item_group

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* WithdrawByInventoryItemGroupRequest */

"inventoryItemGroupKey" : "string",

"marketplaceId" : "MarketplaceEnum : [EBAY_US,EBAY_MOTORS,EBAY_CA...]"

}

Request fields

Input container/field	Type	Description
inventoryItemGroupKey	string	This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created. To retrieve an inventoryItemGroupKey value, you can use the getInventoryItem method to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the groupIds container in the response of that call. Occurrence: Required
marketplaceId	MarketplaceEnum	This is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for supported values. Occurrence: Required

Input container/field

Type

Description

inventoryItemGroupKey

string

This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created.

To retrieve an inventoryItemGroupKey value, you can use the getInventoryItem method to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the groupIds container in the response of that call.

Occurrence: Required

marketplaceId

MarketplaceEnum

This is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for supported values.

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

Status	Meaning
204	No Content
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
25001	API_INVENTORY	APPLICATION	Any System error. {additionalInfo}
25725	API_INVENTORY	REQUEST	No offer found

Warnings

For more on warnings, plus the codes of other common warnings, see Handling errors.

Code	Domain	Category	Meaning
25726	API_INVENTORY	APPLICATION	Please specify a published InventoryItemGroup

Samples

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

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Withdrawing an Offer by Inventory Item Group

This call will end the multiple-variation eBay listing that is associated with the inventory item group. However, the Inventory Item Group and Offer objects (associated with the group) will still remain. The Offer objects will be converted from the published to unpublished state. If the seller wanted to relist the multiple-variation eBay listing, they could use the publishOfferByInventoryItemGroup call.

Input

The inventoryItemGroupKey value associated with the inventory item group (on which the multiple-variation eBay listing is based on) to withdraw is passed into the request payload. The identifier of the eBay Marketplace is also required.

POSThttps://api.ebay.com/sell/inventory/v1/offer/withdraw_by_inventory_item_group

Output

There is no response payload for this call, but an HTTP status code value of 204 is returned for a successful call that ends the multiple-variation listing.