complexType "ns:DiscountProfileType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:DiscountProfileType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 7 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 7 elements, elem. wildcard
Used:	at 2 locations

Component Diagram

XML Representation Summary

<...>

Content:

ns:DiscountProfileID?, ns:DiscountProfileName?, ns:EachAdditionalAmount?, ns:EachAdditionalAmountOff?, ns:EachAdditionalPercentOff?, ns:WeightOff?, ns:MappedDiscountProfileID?, {any}*

</...>

All Direct / Indirect Based Elements (2):

ns:DiscountProfile (defined in ns:CalculatedShippingDiscountType complexType),

ns:DiscountProfile (defined in ns:FlatShippingDiscountType complexType)

Known Usage Locations

As direct type of elements (2):

ns:DiscountProfile (defined in ns:CalculatedShippingDiscountType complexType),

ns:DiscountProfile (defined in ns:FlatShippingDiscountType complexType)

Annotation

Details of a flat or calculated shipping discount rule. Shipping Discount Rules can be set up through the SetShippingDiscountProfiles call or through My eBay.

XML Source (w/o annotations (8); see within schema source)

<xs:complexType name="DiscountProfileType">

<xs:sequence>

<xs:element minOccurs="0" name="DiscountProfileID" type="xs:string"/>

<xs:element minOccurs="0" name="DiscountProfileName" type="xs:string"/>

<xs:element minOccurs="0" name="EachAdditionalAmount" type="ns:AmountType"/>

<xs:element minOccurs="0" name="EachAdditionalAmountOff" type="ns:AmountType"/>

<xs:element minOccurs="0" name="EachAdditionalPercentOff" type="xs:float"/>

<xs:element minOccurs="0" name="WeightOff" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="MappedDiscountProfileID" type="xs:string"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 8/8)

ns:DiscountProfileID

Type:

xs:string, predefined, simple content

The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created.
In a SetShippingDiscountProfiles call,

If the value of ModifyActionCode is set to Add, this field is not applicable and is ignored
If provided.
If the value of Mod
IfyActionCode is set to Update, all fields of the modified rule must be provided, even if the values are not changing.
If the value of ModifyActionCode is set to Delete, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored.

XML Representation Summary

<ns:DiscountProfileID>

Content:

{ xs:string }

</ns:DiscountProfileID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DiscountProfileID" type="xs:string"/>

ns:DiscountProfileName

Type:

xs:string, predefined, simple content

The seller-provided title for the shipping discount rule.
In a SetShippingDiscountProfiles call,

If the value of ModifyActionCode is set to Add, this field is ignored (if provided) if this is the first shipping discount rule being created, but this field is required if there is more than one existing shipping discount rule of that type (flat rate or calculated)
If the value of ModifyActionCode is set to Update, all fields of the modified rule must be provided, even if the values are not changing
If the value of ModifyActionCode is set to Delete, the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored
If the value of ModifyActionCode is set to Delete, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored

XML Representation Summary

<ns:DiscountProfileName>

Content:

{ xs:string }

</ns:DiscountProfileName>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="DiscountProfileName" type="xs:string"/>

ns:EachAdditionalAmount

Type:

ns:AmountType, simple content

The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping.

Component Diagram

XML Representation Summary

<ns:EachAdditionalAmount

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:EachAdditionalAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EachAdditionalAmount" type="ns:AmountType"/>

ns:EachAdditionalAmountOff

Type:

ns:AmountType, simple content

The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.

Component Diagram

XML Representation Summary

<ns:EachAdditionalAmountOff

currencyID

Content:

{ xs:double }

</ns:EachAdditionalAmountOff>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EachAdditionalAmountOff" type="ns:AmountType"/>

ns:EachAdditionalPercentOff

Type:

xs:float, predefined, simple content

The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of $8), the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.

XML Representation Summary

<ns:EachAdditionalPercentOff>

Content:

{ xs:float }

</ns:EachAdditionalPercentOff>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EachAdditionalPercentOff" type="xs:float"/>

ns:MappedDiscountProfileID

Type:

xs:string, predefined, simple content

For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is set to Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed.

XML Representation Summary

<ns:MappedDiscountProfileID>

Content:

{ xs:string }

</ns:MappedDiscountProfileID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MappedDiscountProfileID" type="xs:string"/>

ns:WeightOff

Type:

ns:MeasureType, simple content

The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping.

Component Diagram

XML Representation Summary

<ns:WeightOff

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:WeightOff>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="WeightOff" type="ns:MeasureType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.