@plentymarkets/shop-api / shippingProviderGetters
Variable: shippingProviderGetters ​
constshippingProviderGetters:object
Defined in: getters/shippingProviderGetters.ts:96
Type Declaration ​
getDataPrivacyAgreementHint ​
getDataPrivacyAgreementHint: (
shippingMethod) =>boolean
Returns whether the data privacy agreement hint should be shown for a shipping method.
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
boolean
true if the data privacy hint should be displayed, otherwise false.
getParcelServicePresetId ​
getParcelServicePresetId: (
shippingMethod) =>string
Returns the parcel service preset ID of a shipping method as a string.
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
string
The preset ID string, or "0" if not set.
getShippingAmount ​
getShippingAmount: (
shippingMethod) =>string
Returns the shipping amount for a shipping method as a string.
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
string
The shipping amount string, or "0" if not set.
getShippingMethodImage ​
getShippingMethodImage: (
shippingMethod) =>string
Parameters ​
shippingMethod ​
The shipping method (currently unused).
Returns ​
string
A placeholder image URL string.
Deprecated ​
Not yet implemented — always returns a placeholder image URL.
getShippingMethodName ​
getShippingMethodName: (
shippingMethod) =>string
Returns the combined shipping method name in "<parcelServiceName> - <parcelServicePresetName>" format.
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
string
The combined name string.
getShippingPrivacyInformation ​
getShippingPrivacyInformation: (
shippingMethod) =>ShippingPrivacyInformation
Returns the first privacy information entry for a shipping method.
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
The first ShippingPrivacyInformation object.
getShippingProfileId ​
getShippingProfileId: (
cart) =>string
Returns the active shipping profile ID from the cart as a string.
Parameters ​
cart ​
The cart object.
Returns ​
string
The shipping profile ID string.
getShippingProviders ​
getShippingProviders: (
shippingProvider) =>ShippingMethod[]
Returns the list of available shipping methods from a shipping provider.
Parameters ​
shippingProvider ​
The shipping provider object.
Returns ​
An array of ShippingMethod objects, or an empty array if none exist.
getValue ​
getValue: (
shippingMethod) =>ShippingMethod
Returns the shipping method object itself (used when the full object is needed as a value).
Parameters ​
shippingMethod ​
The shipping method object.
Returns ​
The same ShippingMethod object.