complexType "ns:SetShippingDiscountProfilesRequestType"

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:SetShippingDiscountProfilesRequestType"

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

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:SetShippingDiscountProfilesRequest

Known Usage Locations

As direct type of elements (1):

ns:SetShippingDiscountProfilesRequest

Annotation

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.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:SetShippingDiscountProfilesRequestType

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

<xs:complexType name="SetShippingDiscountProfilesRequestType">

<xs:complexContent>

<xs:extension base="ns:AbstractRequestType">

<xs:sequence>

<xs:element minOccurs="0" name="CurrencyID" type="ns:CurrencyCodeType"/>

<xs:element minOccurs="0" name="CombinedDuration" type="ns:CombinedPaymentPeriodCodeType"/>

<xs:element minOccurs="0" name="ModifyActionCode" type="ns:ModifyActionCodeType"/>

<xs:element minOccurs="0" name="FlatShippingDiscount" type="ns:FlatShippingDiscountType"/>

<xs:element minOccurs="0" name="CalculatedShippingDiscount" type="ns:CalculatedShippingDiscountType"/>

<xs:element minOccurs="0" name="CalculatedHandlingDiscount" type="ns:CalculatedHandlingDiscountType"/>

<xs:element minOccurs="0" name="PromotionalShippingDiscountDetails" type="ns:PromotionalShippingDiscountDetailsType"/>

<xs:element minOccurs="0" name="ShippingInsurance" type="ns:ShippingInsuranceType"/>

<xs:element minOccurs="0" name="InternationalShippingInsurance" type="ns:ShippingInsuranceType"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

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

ns:CalculatedHandlingDiscount

Type:

ns:CalculatedHandlingDiscountType, complex content

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

Component Diagram

XML Representation Summary

<ns:CalculatedHandlingDiscount>

Content:

ns:DiscountName?, ns:OrderHandlingAmount?, ns:EachAdditionalAmount?, ns:EachAdditionalOffAmount?, ns:EachAdditionalPercentOff?, {any}*

</ns:CalculatedHandlingDiscount>

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

<xs:element minOccurs="0" name="CalculatedHandlingDiscount" type="ns:CalculatedHandlingDiscountType"/>

ns:CalculatedShippingDiscount

Type:

ns:CalculatedShippingDiscountType, complex content

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

Component Diagram

XML Representation Summary

<ns:CalculatedShippingDiscount>

Content:

ns:DiscountName?, ns:DiscountProfile*, {any}*

</ns:CalculatedShippingDiscount>

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

<xs:element minOccurs="0" name="CalculatedShippingDiscount" type="ns:CalculatedShippingDiscountType"/>

ns:CombinedDuration

Type:

ns:CombinedPaymentPeriodCodeType, simple content

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.

XML Representation Summary

<ns:CombinedDuration>

Content:

{ enumeration of xs:token }

</ns:CombinedDuration>

Simple Content

Enumeration:

"Days_3"	-	This value indicates that an unpaid order can be combined into a Combined Invoice order within three days after purchase (creation of order).
"Days_5"	-	This value indicates that an unpaid order can be combined into a Combined Invoice order within five days after purchase (creation of order).
"Days_7"	-	This value indicates that an unpaid order can be combined into a Combined Invoice order within seven days after purchase (creation of order).
"Days_14"	-	This value indicates that an unpaid order can be combined into a Combined Invoice order within 14 days after purchase (creation of order).
"Days_30"	-	This value indicates that an unpaid order can be combined into a Combined Invoice order within 30 days after purchase (creation of order).
"Ineligible"	-	This value indicates that an order is not eligible to be combined into a Combined Payment order.
"CustomCode"	-	This value is reserved for internal or future use.

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

<xs:element minOccurs="0" name="CombinedDuration" type="ns:CombinedPaymentPeriodCodeType"/>

ns:CurrencyID

Type:

ns:CurrencyCodeType, simple content

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.

XML Representation Summary

<ns:CurrencyID>

Content:

{ enumeration of xs:token }

</ns:CurrencyID>

Simple Content

Enumeration:

see details at ns:CurrencyCodeType

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

<xs:element minOccurs="0" name="CurrencyID" type="ns:CurrencyCodeType"/>

ns:FlatShippingDiscount

Type:

ns:FlatShippingDiscountType, complex content

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

Component Diagram

XML Representation Summary

<ns:FlatShippingDiscount>

Content:

ns:DiscountName?, ns:DiscountProfile*, {any}*

</ns:FlatShippingDiscount>

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

<xs:element minOccurs="0" name="FlatShippingDiscount" type="ns:FlatShippingDiscountType"/>

ns:InternationalShippingInsurance

Type:

ns:ShippingInsuranceType, complex content

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

Component Diagram

XML Representation Summary

<ns:InternationalShippingInsurance>

Content:

ns:InsuranceOption?, ns:FlatRateInsuranceRangeCost*, {any}*

</ns:InternationalShippingInsurance>

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

<xs:element minOccurs="0" name="InternationalShippingInsurance" type="ns:ShippingInsuranceType"/>

ns:ModifyActionCode

Type:

ns:ModifyActionCodeType, simple content

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.

XML Representation Summary

<ns:ModifyActionCode>

Content:

{ enumeration of xs:token }

</ns:ModifyActionCode>

Simple Content

Enumeration:

"Add"	-	This value is used in a SetShippingDiscountProfiles request to create a new shipping discount profile.
"Delete"	-	This value is used in a SetShippingDiscountProfiles request to delete an existing shipping discount profile.
"Update"	-	This value is used in a SetShippingDiscountProfiles request to modify an existing shipping discount profile.
"CustomCode"	-	Reserved for future use.

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

<xs:element minOccurs="0" name="ModifyActionCode" type="ns:ModifyActionCodeType"/>

ns:PromotionalShippingDiscountDetails

Type:

ns:PromotionalShippingDiscountDetailsType, complex content

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

Component Diagram

XML Representation Summary

<ns:PromotionalShippingDiscountDetails>

Content:

ns:DiscountName?, ns:ShippingCost?, ns:OrderAmount?, ns:ItemCount?, {any}*

</ns:PromotionalShippingDiscountDetails>

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

<xs:element minOccurs="0" name="PromotionalShippingDiscountDetails" type="ns:PromotionalShippingDiscountDetailsType"/>

ns:ShippingInsurance

Type:

ns:ShippingInsuranceType, complex content

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

Component Diagram

XML Representation Summary

<ns:ShippingInsurance>

Content:

ns:InsuranceOption?, ns:FlatRateInsuranceRangeCost*, {any}*

</ns:ShippingInsurance>

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

<xs:element minOccurs="0" name="ShippingInsurance" type="ns:ShippingInsuranceType"/>

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.