complexType "SetShippingDiscountProfilesRequestType"

Component	Type / Value	Occurs	Required?	Nillable?	Description
SEQUENCE		1..1	yes
DetailLevel	DetailLevelCodeType : enumeration of token	0..∞	no	no	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. »
ErrorLanguage	string	0..1	no	no	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. »
MessageID	string	0..1	no	no	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »
Version	string	0..1	no	no	The version number of the API code that you are programming against (e.g., 1149). »
EndUserIP	string	0..1	no	no	The public IP address of the machine from which the request is sent. »
ErrorHandling	ErrorHandlingCodeType : enumeration of token	0..1	no	no	Error tolerance level for the call. »
InvocationID	UUIDType : restriction of string	0..1	no	no	A unique identifier for a particular call. »
OutputSelector	string	0..∞	no	no	You can use the OutputSelector field to restrict the data returned by a call. »
WarningLevel	WarningLevelCodeType : enumeration of token	0..1	no	no	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. »
BotBlock	BotBlockRequestType	0..1	no	no	This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response. »
{any}	from any namespace	0..∞	no
CurrencyID	CurrencyCodeType : enumeration of token	0..1	no	no	The three-digit code of the currency to be used for shipping discounts on Combined Invoice orders. A discount profile can only be associated with a listing if the CurrencyID value of the profile matches the Item.Currency value specified in a listing. This field is required if the user is adding or updating one or more shipping discount profiles. Note that There is a currencyID attribute on all SetShippingDiscountProfiles elements involving money. To avoid a call error, be sure to use the same currency type in these attributes as what is set for the CurrencyID field.
CombinedDuration	CombinedPaymentPeriodCodeType : enumeration of token	0..1	no	no	This field is used to specify the number of days after the purchase of an item that the buyer or seller can combine multiple and mutual order line items into one Combined Invoice order. In a Combined Invoice order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Invoice order.
ModifyActionCode	ModifyActionCodeType : enumeration of token	0..1	no	no	This field is used to set which action is being taken (`Add`, `Update`, or `Delete`) in the call. If you are adding a shipping discount rule, you will have to supply a name for that shipping discount profile. If you want to update or delete a shipping discount profile, you'll have to provide the unique identifier of this rule through the corresponding containers. The unique identifiers of these rules can be retrieved with the GetShippingDiscountRules call, or the seller can view these identifiers in My eBay Shipping Preferences.
FlatShippingDiscount	FlatShippingDiscountType	0..1	no	no	This container allows you to create, update, or delete a flat-rate shipping discount profile.
CalculatedShippingDiscount	CalculatedShippingDiscountType	0..1	no	no	This container allows you to create, update, or delete a calculated shipping discount profile.
CalculatedHandlingDiscount	CalculatedHandlingDiscountType	0..1	no	no	This container allows you to create, update, or delete a calculated handling discount profile.
PromotionalShippingDiscountDetails	PromotionalShippingDiscountDetailsType	0..1	no	no	This container allows you to create, update, or delete a promotional shipping discount profile.

Component

Type / Value

Occurs

Required?

Nillable?

Description

SEQUENCE

1..1

yes

DetailLevel

DetailLevelCodeType : enumeration of token

0..∞

Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. »

ErrorLanguage

string

0..1

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

MessageID

string

0..1

Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »

Version

string

0..1

The version number of the API code that you are programming against (e.g., 1149). »

EndUserIP

string

0..1

The public IP address of the machine from which the request is sent. »

ErrorHandling

ErrorHandlingCodeType : enumeration of token

0..1

Error tolerance level for the call. »

InvocationID

UUIDType : restriction of string

0..1

A unique identifier for a particular call. »

OutputSelector

string

0..∞

You can use the OutputSelector field to restrict the data returned by a call. »

WarningLevel

WarningLevelCodeType : enumeration of token

0..1

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

BotBlock

BotBlockRequestType

0..1

This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response. »

{any}

from any namespace

0..∞

CurrencyID

CurrencyCodeType : enumeration of token

0..1

The three-digit code of the currency to be used for shipping discounts on Combined Invoice orders. A discount profile can only be associated with a listing if the CurrencyID value of the profile matches the Item.Currency value specified in a listing. This field is required if the user is adding or updating one or more shipping discount profiles.

Note that There is a currencyID attribute on all SetShippingDiscountProfiles elements involving money. To avoid a call error, be sure to use the same currency type in these attributes as what is set for the CurrencyID field.

CombinedDuration

CombinedPaymentPeriodCodeType : enumeration of token

0..1

This field is used to specify the number of days after the purchase of an item that the buyer or seller can combine multiple and mutual order line items into one Combined Invoice order. In a Combined Invoice order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Invoice order.

ModifyActionCode

ModifyActionCodeType : enumeration of token

0..1

This field is used to set which action is being taken (Add, Update, or Delete) in the call. If you are adding a shipping discount rule, you will have to supply a name for that shipping discount profile. If you want to update or delete a shipping discount profile, you'll have to provide the unique identifier of this rule through the corresponding containers. The unique identifiers of these rules can be retrieved with the GetShippingDiscountRules call, or the seller can view these identifiers in My eBay Shipping Preferences.

FlatShippingDiscount

FlatShippingDiscountType

0..1

This container allows you to create, update, or delete a flat-rate shipping discount profile.

CalculatedShippingDiscount

CalculatedShippingDiscountType

0..1

This container allows you to create, update, or delete a calculated shipping discount profile.

CalculatedHandlingDiscount

CalculatedHandlingDiscountType

0..1

This container allows you to create, update, or delete a calculated handling discount profile.

PromotionalShippingDiscountDetails

PromotionalShippingDiscountDetailsType

0..1

This container allows you to create, update, or delete a promotional shipping discount profile.

This call enables a seller to create and manage shipping discounts rules. These are the same shipping discount rules that can be created or managed in My eBay Shipping Preferences.

The types of shipping discount rules that can be created and managed with this call include flat-rate shipping rules, calculated shipping rules, and promotional shipping rules. This call can also be used by sellers to set whether or not they allow buyers to combine separate line items into one Combined Invoice order, and how many days they allow buyers to perform that action.

A seller can only create, update, or delete one discount rule type with each call. The action to take (either Add, Update, or Delete) is set and controlled with the ModifyActionCode field.

Web-Service	Methods
eBayAPIInterfaceService	SetShippingDiscountProfiles

Web-Service

Methods

eBayAPIInterfaceService

SetShippingDiscountProfiles

Namespace:	urn:ebay:apis:eBLBaseComponents
Derived By:	extension of AbstractRequestType
Content:	complex, 17 elements, elem. wildcard
Defined:	in ebaySvc.wsdl/Schema
Includes:	declarations of 7 elements
Referenced:	by 2 locations