| Package | Description |
|---|---|
| com.adobe.cq.commerce.magento.graphql |
Copyright 2019 Adobe.
|
| com.shopify.graphql.support |
Copyright 2019 Adobe.
|
| Modifier and Type | Method and Description |
|---|---|
Input<CartAddressInput> |
ShippingAddressInput.getAddressInput() |
Input<CartAddressInput> |
BillingAddressInput.getAddressInput() |
Input<Boolean> |
CustomerUpdateInput.getAllowRemoteShoppingAssistanceInput()
Indicates whether the customer has enabled remote shopping assistance
|
Input<Boolean> |
CustomerCreateInput.getAllowRemoteShoppingAssistanceInput()
Indicates whether the customer has enabled remote shopping assistance
|
Input<String> |
AttributeInput.getAttributeCodeInput()
The unique identifier for an attribute code.
|
Input<BraintreeCcVaultInput> |
PaymentMethodInput.getBraintreeCcVaultInput() |
Input<BraintreeInput> |
PaymentMethodInput.getBraintreeInput() |
Input<String> |
createEmptyCartInput.getCartIdInput() |
Input<Integer> |
RemoveItemFromCartInput.getCartItemIdInput()
Deprecated.
|
Input<Integer> |
CartItemUpdateInput.getCartItemIdInput()
Deprecated.
|
Input<ID> |
RemoveItemFromCartInput.getCartItemUidInput()
Required field.
|
Input<ID> |
CartItemUpdateInput.getCartItemUidInput()
The unique ID for a `CartItemInterface` object
|
Input<FilterTypeInput> |
ProductFilterInput.getCategoryIdInput()
Category ID the product belongs to.
|
Input<FilterEqualTypeInput> |
ProductAttributeFilterInput.getCategoryIdInput()
Deprecated: use `category_uid` to filter product by category id.
|
Input<FilterEqualTypeInput> |
ProductAttributeFilterInput.getCategoryUidInput()
Filter product by the unique ID for a `CategoryInterface` object.
|
Input<FilterEqualTypeInput> |
CategoryFilterInput.getCategoryUidInput()
Filter by the unique category ID for a `CategoryInterface` object.
|
Input<SortEnum> |
PickupLocationSortInput.getCityInput()
City where pickup location is placed.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getCityInput()
Filter by city.
|
Input<String> |
CustomerAddressInput.getCityInput()
The city or town
|
Input<String> |
RequestReturnInput.getCommentTextInput()
Text the buyer entered that describes the reason for the refund request
|
Input<String> |
CustomerAddressInput.getCompanyInput()
The customer's company
|
Input<String> |
CartAddressInput.getCompanyInput() |
Input<String> |
RequestReturnInput.getContactEmailInput()
An email address the buyer enters to receive notifications about the status of the return
|
Input<SortEnum> |
PickupLocationSortInput.getContactNameInput()
Name of the contact person.
|
Input<CountryCodeEnum> |
CustomerAddressInput.getCountryCodeInput()
The customer's country
|
Input<SortEnum> |
PickupLocationSortInput.getCountryIdInput()
Id of the country in two letters.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getCountryIdInput()
Filter by country.
|
Input<CountryCodeEnum> |
CustomerAddressInput.getCountryIdInput()
Deprecated: use `country_code` instead.
|
Input<SortEnum> |
ProductSortInput.getCountryOfManufactureInput()
The product's country of origin.
|
Input<FilterTypeInput> |
ProductFilterInput.getCountryOfManufactureInput()
The product's country of origin.
|
Input<SortEnum> |
ProductSortInput.getCreatedAtInput()
Timestamp indicating when the product was created.
|
Input<FilterTypeInput> |
ProductFilterInput.getCreatedAtInput()
Timestamp indicating when the product was created.
|
Input<List<CustomerAddressAttributeInput>> |
CustomerAddressInput.getCustomAttributesInput()
Deprecated: Custom attributes should not be put into container.
|
Input<Integer> |
ShippingAddressInput.getCustomerAddressIdInput() |
Input<Integer> |
BillingAddressInput.getCustomerAddressIdInput() |
Input<String> |
ShippingAddressInput.getCustomerNotesInput() |
Input<List<CustomizableOptionInput>> |
VirtualProductCartItemInput.getCustomizableOptionsInput() |
Input<List<CustomizableOptionInput>> |
SimpleProductCartItemInput.getCustomizableOptionsInput() |
Input<List<CustomizableOptionInput>> |
DownloadableProductCartItemInput.getCustomizableOptionsInput() |
Input<List<CustomizableOptionInput>> |
ConfigurableProductCartItemInput.getCustomizableOptionsInput() |
Input<List<CustomizableOptionInput>> |
CartItemUpdateInput.getCustomizableOptionsInput() |
Input<List<CustomizableOptionInput>> |
BundleProductCartItemInput.getCustomizableOptionsInput() |
Input<SortEnum> |
ProductSortInput.getCustomLayoutInput()
The name of a custom layout.
|
Input<FilterTypeInput> |
ProductFilterInput.getCustomLayoutInput()
The name of a custom layout.
|
Input<SortEnum> |
ProductSortInput.getCustomLayoutUpdateInput()
XML code that is applied as a layout update to the product page.
|
Input<FilterTypeInput> |
ProductFilterInput.getCustomLayoutUpdateInput()
XML code that is applied as a layout update to the product page.
|
Input<String> |
CustomerUpdateInput.getDateOfBirthInput()
The customer's date of birth
|
Input<String> |
CustomerInput.getDateOfBirthInput()
The customer's date of birth
|
Input<String> |
CustomerCreateInput.getDateOfBirthInput()
The customer's date of birth
|
Input<Boolean> |
CustomerAddressInput.getDefaultBillingInput()
Indicates whether the address is the default billing address
|
Input<Boolean> |
CustomerAddressInput.getDefaultShippingInput()
Indicates whether the address is the default shipping address
|
Input<String> |
WishlistItemUpdateInput.getDescriptionInput()
Customer-entered comments about the item
|
Input<SortEnum> |
ProductSortInput.getDescriptionInput()
Detailed information about the product.
|
Input<FilterTypeInput> |
ProductFilterInput.getDescriptionInput()
Detailed information about the product.
|
Input<FilterMatchTypeInput> |
ProductAttributeFilterInput.getDescriptionInput()
Attribute label: Description
|
Input<SortEnum> |
PickupLocationSortInput.getDescriptionInput()
Description of the pickup location.
|
Input<String> |
BraintreeCcVaultInput.getDeviceDataInput() |
Input<String> |
BraintreeInput.getDeviceDataInput()
Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details
to the Braintree payment gateway.
|
Input<SortEnum> |
PickupLocationSortInput.getDistanceInput()
Distance to the address, requested by distance filter.
|
Input<String> |
CustomerUpdateInput.getDobInput()
Deprecated: Use `date_of_birth` instead
|
Input<String> |
CustomerInput.getDobInput()
Deprecated: Use `date_of_birth` instead
|
Input<String> |
CustomerCreateInput.getDobInput()
Deprecated: Use `date_of_birth` instead
|
Input<List<DownloadableProductLinksInput>> |
DownloadableProductCartItemInput.getDownloadableProductLinksInput() |
Input<SortEnum> |
PickupLocationSortInput.getEmailInput()
Contact email of the pickup location.
|
Input<String> |
CustomerInput.getEmailInput()
The customer's email address.
|
Input<List<EnteredCustomAttributeInput>> |
RequestReturnItemInput.getEnteredCustomAttributesInput()
Contains details about a custom attribute that was entered, such as text or a file
|
Input<List<EnteredOptionInput>> |
WishlistItemUpdateInput.getEnteredOptionsInput()
An array of options that the customer entered
|
Input<List<EnteredOptionInput>> |
WishlistItemInput.getEnteredOptionsInput()
An array of options that the customer entered
|
Input<List<EnteredOptionInput>> |
CartItemInput.getEnteredOptionsInput()
An array of entered options for the base product, such as personalization text
|
Input<String> |
AttributeInput.getEntityTypeInput()
The type of entity that defines the attribute
|
Input<String> |
FilterTypeInput.getEqInput()
Equals
|
Input<String> |
FilterStringTypeInput.getEqInput()
Filters items that are exactly the same as the specified string.
|
Input<String> |
FilterEqualTypeInput.getEqInput()
A string to filter on
|
Input<Boolean> |
PaypalExpressTokenInput.getExpressButtonInput()
Indicates whether the buyer selected the quick checkout button.
|
Input<SortEnum> |
PickupLocationSortInput.getFaxInput()
Contact fax of the pickup location.
|
Input<String> |
CustomerAddressInput.getFaxInput()
The fax number
|
Input<List<String>> |
FilterTypeInput.getFinsetInput() |
Input<String> |
CustomerUpdateInput.getFirstnameInput()
The customer's first name
|
Input<String> |
CustomerInput.getFirstnameInput()
The customer's first name
|
Input<String> |
CustomerAddressInput.getFirstnameInput()
The first name of the person associated with the shipping/billing address
|
Input<String> |
FilterTypeInput.getFromInput()
From.
|
Input<String> |
FilterRangeTypeInput.getFromInput()
The beginning of the range
|
Input<Integer> |
CustomerUpdateInput.getGenderInput()
The customer's gender (Male - 1, Female - 2)
|
Input<Integer> |
CustomerInput.getGenderInput()
The customer's gender (Male - 1, Female - 2)
|
Input<Integer> |
CustomerCreateInput.getGenderInput()
The customer's gender (Male - 1, Female - 2)
|
Input<SortEnum> |
ProductSortInput.getGiftMessageAvailableInput()
Indicates whether a gift message is available.
|
Input<FilterTypeInput> |
ProductFilterInput.getGiftMessageAvailableInput()
Indicates whether a gift message is available.
|
Input<GiftMessageInput> |
SetGiftOptionsOnCartInput.getGiftMessageInput()
Gift message details for the cart
|
Input<GiftMessageInput> |
CartItemUpdateInput.getGiftMessageInput()
Gift message details for the cart item
|
Input<ID> |
SetGiftOptionsOnCartInput.getGiftWrappingIdInput()
The unique ID for a `GiftWrapping` object to be used for the cart
|
Input<ID> |
CartItemUpdateInput.getGiftWrappingIdInput()
The unique ID for a `GiftWrapping` object to be used for the cart item
|
Input<String> |
FilterTypeInput.getGteqInput()
Greater than or equal to
|
Input<String> |
FilterTypeInput.getGtInput()
Greater than
|
Input<SortEnum> |
ProductSortInput.getHasOptionsInput()
Indicates whether additional attributes have been created for the product.
|
Input<FilterTypeInput> |
ProductFilterInput.getHasOptionsInput()
Indicates whether additional attributes have been created for the product.
|
Input<HostedProInput> |
PaymentMethodInput.getHostedProInput()
Required input for PayPal Hosted pro payments
|
Input<Integer> |
CustomizableOptionInput.getIdInput()
The customizable option id of the product
|
Input<FilterEqualTypeInput> |
CategoryFilterInput.getIdsInput()
Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
|
Input<SortEnum> |
ProductSortInput.getImageInput()
The relative path to the main image on the product page.
|
Input<FilterTypeInput> |
ProductFilterInput.getImageInput()
The relative path to the main image on the product page.
|
Input<SortEnum> |
ProductSortInput.getImageLabelInput()
The label assigned to a product image.
|
Input<FilterTypeInput> |
ProductFilterInput.getImageLabelInput()
The label assigned to a product image.
|
Input<List<String>> |
FilterTypeInput.getInInput()
In.
|
Input<List<String>> |
FilterStringTypeInput.getInInput()
Filters items that are exactly the same as entries specified in an array of strings.
|
Input<List<String>> |
FilterEqualTypeInput.getInInput()
An array of values to filter on
|
Input<Boolean> |
PayflowProInput.getIsActivePaymentTokenEnablerInput()
States whether details about the customer's credit/debit card should be tokenized for later usage.
|
Input<SortEnum> |
ProductSortInput.getIsReturnableInput()
Indicates whether the product can be returned
|
Input<FilterTypeInput> |
ProductFilterInput.getIsReturnableInput()
Indicates whether the product can be returned
|
Input<Boolean> |
CustomerUpdateInput.getIsSubscribedInput()
Indicates whether the customer is subscribed to the company's newsletter
|
Input<Boolean> |
CustomerInput.getIsSubscribedInput()
Indicates whether the customer is subscribed to the company's newsletter
|
Input<Boolean> |
CustomerCreateInput.getIsSubscribedInput()
Indicates whether the customer is subscribed to the company's newsletter
|
Input<KlarnaInput> |
PaymentMethodInput.getKlarnaInput() |
Input<String> |
CustomerUpdateInput.getLastnameInput()
The customer's family name
|
Input<String> |
CustomerInput.getLastnameInput()
The customer's family name
|
Input<String> |
CustomerAddressInput.getLastnameInput()
The family name of the person associated with the shipping/billing address
|
Input<SortEnum> |
PickupLocationSortInput.getLatitudeInput()
Geographic latitude where pickup location is placed.
|
Input<String> |
FilterTypeInput.getLikeInput()
Like.
|
Input<SortEnum> |
PickupLocationSortInput.getLongitudeInput()
Geographic longitude where pickup location is placed.
|
Input<String> |
FilterTypeInput.getLteqInput()
Less than or equal to
|
Input<String> |
FilterTypeInput.getLtInput()
Less than
|
Input<SortEnum> |
ProductSortInput.getManufacturerInput()
A number representing the product's manufacturer.
|
Input<FilterTypeInput> |
ProductFilterInput.getManufacturerInput()
A number representing the product's manufacturer.
|
Input<String> |
FilterStringTypeInput.getMatchInput()
Defines a filter that performs a fuzzy search using the specified string.
|
Input<String> |
FilterMatchTypeInput.getMatchInput()
One or more words to filter on
|
Input<FilterTypeInput> |
ProductFilterInput.getMaxPriceInput()
The numeric maximal price of the product.
|
Input<SortEnum> |
ProductSortInput.getMetaDescriptionInput()
A brief overview of the product for search results listings, maximum 255 characters.
|
Input<FilterTypeInput> |
ProductFilterInput.getMetaDescriptionInput()
A brief overview of the product for search results listings, maximum 255 characters.
|
Input<SortEnum> |
ProductSortInput.getMetaKeywordInput()
A comma-separated list of keywords that are visible only to search engines.
|
Input<FilterTypeInput> |
ProductFilterInput.getMetaKeywordInput()
A comma-separated list of keywords that are visible only to search engines.
|
Input<SortEnum> |
ProductSortInput.getMetaTitleInput()
A string that is displayed in the title bar and tab of the browser and in search results lists.
|
Input<FilterTypeInput> |
ProductFilterInput.getMetaTitleInput()
A string that is displayed in the title bar and tab of the browser and in search results lists.
|
Input<String> |
CustomerUpdateInput.getMiddlenameInput()
The customer's middle name
|
Input<String> |
CustomerInput.getMiddlenameInput()
The customer's middle name
|
Input<String> |
CustomerCreateInput.getMiddlenameInput()
The customer's middle name
|
Input<String> |
CustomerAddressInput.getMiddlenameInput()
The middle name of the person associated with the shipping/billing address
|
Input<FilterTypeInput> |
ProductFilterInput.getMinPriceInput()
The numeric minimal price of the product.
|
Input<String> |
FilterTypeInput.getMoreqInput()
More than or equal to
|
Input<SortEnum> |
ProductSortInput.getNameInput()
The product name.
|
Input<FilterTypeInput> |
ProductFilterInput.getNameInput()
The product name.
|
Input<SortEnum> |
ProductAttributeSortInput.getNameInput()
Attribute label: Product Name
|
Input<FilterMatchTypeInput> |
ProductAttributeFilterInput.getNameInput()
Attribute label: Product Name
|
Input<SortEnum> |
PickupLocationSortInput.getNameInput()
The pickup location name.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getNameInput()
Filter by pickup location name.
|
Input<FilterMatchTypeInput> |
CategoryFilterInput.getNameInput()
Filter by the display name of the category.
|
Input<String> |
FilterTypeInput.getNeqInput()
Not equal to
|
Input<SortEnum> |
ProductSortInput.getNewsFromDateInput()
The beginning date for new product listings, and determines if the product is featured as a new
product.
|
Input<FilterTypeInput> |
ProductFilterInput.getNewsFromDateInput()
The beginning date for new product listings, and determines if the product is featured as a new
product.
|
Input<SortEnum> |
ProductSortInput.getNewsToDateInput()
The end date for new product listings.
|
Input<FilterTypeInput> |
ProductFilterInput.getNewsToDateInput()
The end date for new product listings.
|
Input<List<String>> |
FilterTypeInput.getNinInput()
Not in.
|
Input<String> |
FilterTypeInput.getNotnullInput()
Not null
|
Input<String> |
FilterTypeInput.getNullInput()
Is null
|
Input<FilterStringTypeInput> |
CustomerOrdersFilterInput.getNumberInput()
Filters by order number.
|
Input<SortEnum> |
ProductSortInput.getOptionsContainerInput()
If the product has multiple options, determines where they appear on the product page.
|
Input<FilterTypeInput> |
ProductFilterInput.getOptionsContainerInput()
If the product has multiple options, determines where they appear on the product page.
|
Input<ProductFilterInput> |
ProductFilterInput.getOrInput()
The keyword required to perform a logical OR comparison.
|
Input<FilterEqualTypeInput> |
CategoryFilterInput.getParentCategoryUidInput()
Filter by the unique parent category ID for a `CategoryInterface` object.
|
Input<FilterEqualTypeInput> |
CategoryFilterInput.getParentIdInput()
Filter by the unique parent category ID for a `CategoryInterface` object.
|
Input<String> |
WishlistItemInput.getParentSkuInput()
For complex product types, the SKU of the parent product
|
Input<String> |
ConfigurableProductCartItemInput.getParentSkuInput()
Configurable product SKU.
|
Input<String> |
CartItemInput.getParentSkuInput()
For child products, the SKU of its parent product
|
Input<String> |
CustomerInput.getPasswordInput()
The customer's password
|
Input<String> |
CustomerCreateInput.getPasswordInput()
The customer's password
|
Input<PayflowExpressInput> |
PaymentMethodInput.getPayflowExpressInput()
Required input for Payflow Express Checkout payments
|
Input<PayflowLinkInput> |
PaymentMethodInput.getPayflowLinkInput()
Required input for PayPal Payflow Link and Payments Advanced payments
|
Input<VaultTokenInput> |
PaymentMethodInput.getPayflowproCcVaultInput()
Required input type for PayPal Payflow Pro vault payments
|
Input<PayflowProInput> |
PaymentMethodInput.getPayflowproInput()
Required input type for PayPal Payflow Pro and Payment Pro payments
|
Input<PaypalExpressInput> |
PaymentMethodInput.getPaypalExpressInput()
Required input for Express Checkout and Payments Standard payments
|
Input<String> |
PaypalExpressUrlsInput.getPendingUrlInput()
The relative URL of the page that PayPal will redirect to when the payment has been put on hold for
additional review.
|
Input<SortEnum> |
PickupLocationSortInput.getPhoneInput()
Contact phone number of the pickup location.
|
Input<String> |
ShippingAddressInput.getPickupLocationCodeInput()
The code of Pickup Location which will be used for In-Store Pickup.
|
Input<SortEnum> |
PickupLocationSortInput.getPickupLocationCodeInput()
A code assigned to pickup location to identify the source.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getPickupLocationCodeInput()
Filter by pickup location code.
|
Input<SortEnum> |
ProductAttributeSortInput.getPositionInput()
Sort by the position assigned to each product.
|
Input<SortEnum> |
PickupLocationSortInput.getPostcodeInput()
Postcode where pickup location is placed.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getPostcodeInput()
Filter by postcode.
|
Input<String> |
CustomerAddressInput.getPostcodeInput()
The customer's ZIP or postal code
|
Input<String> |
CartAddressInput.getPostcodeInput() |
Input<String> |
CustomerUpdateInput.getPrefixInput()
An honorific, such as Dr., Mr., or Mrs.
|
Input<String> |
CustomerInput.getPrefixInput()
An honorific, such as Dr., Mr., or Mrs.
|
Input<String> |
CustomerCreateInput.getPrefixInput()
An honorific, such as Dr., Mr., or Mrs.
|
Input<String> |
CustomerAddressInput.getPrefixInput()
An honorific, such as Dr., Mr., or Mrs.
|
Input<SortEnum> |
ProductSortInput.getPriceInput()
The price of the item.
|
Input<FilterTypeInput> |
ProductFilterInput.getPriceInput()
The price of an item.
|
Input<SortEnum> |
ProductAttributeSortInput.getPriceInput()
Attribute label: Price
|
Input<FilterRangeTypeInput> |
ProductAttributeFilterInput.getPriceInput()
Attribute label: Price
|
Input<List<ID>> |
CreateCompareListInput.getProductsInput()
An array of product IDs to add to the compare list
|
Input<String> |
PaymentMethodInput.getPurchaseOrderNumberInput()
Purchase order number
|
Input<Double> |
WishlistItemUpdateInput.getQuantityInput()
The new amount or number of this item
|
Input<Double> |
WishlistItemMoveInput.getQuantityInput()
The quantity of this item to move to the destination wish list.
|
Input<Double> |
WishlistItemCopyInput.getQuantityInput()
The quantity of this item to copy to the destination wish list.
|
Input<Double> |
CartItemUpdateInput.getQuantityInput() |
Input<String> |
CustomerAddressRegionInput.getRegionCodeInput()
The address region code
|
Input<SortEnum> |
PickupLocationSortInput.getRegionIdInput()
Id of the region.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getRegionIdInput()
Filter by region id.
|
Input<Integer> |
CustomerAddressRegionInput.getRegionIdInput()
The unique ID for a pre-defined region
|
Input<Integer> |
CartAddressInput.getRegionIdInput() |
Input<SortEnum> |
PickupLocationSortInput.getRegionInput()
Name of the region.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getRegionInput()
Filter by region.
|
Input<String> |
CustomerAddressRegionInput.getRegionInput()
The state or province name
|
Input<CustomerAddressRegionInput> |
CustomerAddressInput.getRegionInput()
An object containing the region name, region code, and region ID
|
Input<String> |
CartAddressInput.getRegionInput() |
Input<SortEnum> |
ProductAttributeSortInput.getRelevanceInput()
Sort by the search relevance score (default).
|
Input<SortEnum> |
ProductSortInput.getRequiredOptionsInput()
Indicates whether the product has required options.
|
Input<FilterTypeInput> |
ProductFilterInput.getRequiredOptionsInput()
Indicates whether the product has required options.
|
Input<Boolean> |
BillingAddressInput.getSameAsShippingInput()
Set billing address same as shipping
|
Input<Boolean> |
CartAddressInput.getSaveInAddressBookInput()
Determines whether to save the address in the customer's address book.
|
Input<List<SelectedCustomAttributeInput>> |
RequestReturnItemInput.getSelectedCustomAttributesInput()
An array of selected custom option IDs associated with the item to be returned.
|
Input<List<ID>> |
WishlistItemUpdateInput.getSelectedOptionsInput()
An array of strings corresponding to options the customer selected
|
Input<List<ID>> |
WishlistItemInput.getSelectedOptionsInput()
An array of strings corresponding to options the customer selected
|
Input<List<ID>> |
CartItemInput.getSelectedOptionsInput()
The selected options for the base product, such as color or size with unique ID for a
`CustomizableRadioOption`, `CustomizableDropDownOption`, `ConfigurableProductOptionsValues`, etc.
|
Input<SortEnum> |
ProductSortInput.getShortDescriptionInput()
A short description of the product.
|
Input<FilterTypeInput> |
ProductFilterInput.getShortDescriptionInput()
A short description of the product.
|
Input<FilterMatchTypeInput> |
ProductAttributeFilterInput.getShortDescriptionInput()
Attribute label: Short Description
|
Input<SortEnum> |
ProductSortInput.getSkuInput()
A number or code assigned to a product to identify the product, options, price, and manufacturer.
|
Input<FilterTypeInput> |
ProductFilterInput.getSkuInput()
A number or code assigned to a product to identify the product, options, price, and manufacturer.
|
Input<FilterEqualTypeInput> |
ProductAttributeFilterInput.getSkuInput()
Attribute label: SKU
|
Input<SortEnum> |
ProductSortInput.getSmallImageInput()
The relative path to the small image, which is used on catalog pages.
|
Input<FilterTypeInput> |
ProductFilterInput.getSmallImageInput()
The relative path to the small image, which is used on catalog pages.
|
Input<SortEnum> |
ProductSortInput.getSmallImageLabelInput()
The label assigned to a product's small image.
|
Input<FilterTypeInput> |
ProductFilterInput.getSmallImageLabelInput()
The label assigned to a product's small image.
|
Input<SortEnum> |
ProductSortInput.getSpecialFromDateInput()
The beginning date that a product has a special price.
|
Input<FilterTypeInput> |
ProductFilterInput.getSpecialFromDateInput()
The beginning date that a product has a special price.
|
Input<SortEnum> |
ProductSortInput.getSpecialPriceInput()
The discounted price of the product.
|
Input<FilterTypeInput> |
ProductFilterInput.getSpecialPriceInput()
The discounted price of the product.
|
Input<SortEnum> |
ProductSortInput.getSpecialToDateInput()
The end date that a product has a special price.
|
Input<FilterTypeInput> |
ProductFilterInput.getSpecialToDateInput()
The end date that a product has a special price.
|
Input<SortEnum> |
PickupLocationSortInput.getStreetInput()
Street where pickup location is placed.
|
Input<FilterTypeInput> |
PickupLocationFilterInput.getStreetInput()
Filter by street.
|
Input<List<String>> |
CustomerAddressInput.getStreetInput()
An array of strings that define the street number and name
|
Input<String> |
PaypalExpressUrlsInput.getSuccessUrlInput()
The relative URL of the order confirmation page that PayPal will redirect to when the payment is
successful and additional confirmation is not needed.
|
Input<String> |
CustomerUpdateInput.getSuffixInput()
A value such as Sr., Jr., or III
|
Input<String> |
CustomerInput.getSuffixInput()
A value such as Sr., Jr., or III
|
Input<String> |
CustomerCreateInput.getSuffixInput()
A value such as Sr., Jr., or III
|
Input<String> |
CustomerAddressInput.getSuffixInput()
A value such as Sr., Jr., or III
|
Input<SortEnum> |
ProductSortInput.getSwatchImageInput()
The file name of a swatch image
|
Input<FilterTypeInput> |
ProductFilterInput.getSwatchImageInput()
The file name of a swatch image
|
Input<String> |
CustomerUpdateInput.getTaxvatInput()
The customer's Tax/VAT number (for corporate customers)
|
Input<String> |
CustomerInput.getTaxvatInput()
The customer's Tax/VAT number (for corporate customers)
|
Input<String> |
CustomerCreateInput.getTaxvatInput()
The customer's Tax/VAT number (for corporate customers)
|
Input<String> |
CustomerAddressInput.getTelephoneInput()
The telephone number
|
Input<SortEnum> |
ProductSortInput.getThumbnailInput()
The relative path to the product's thumbnail image.
|
Input<FilterTypeInput> |
ProductFilterInput.getThumbnailInput()
The relative path to the product's thumbnail image.
|
Input<SortEnum> |
ProductSortInput.getThumbnailLabelInput()
The label assigned to a product's thumbnail image.
|
Input<FilterTypeInput> |
ProductFilterInput.getThumbnailLabelInput()
The label assigned to a product's thumbnail image.
|
Input<SortEnum> |
ProductSortInput.getTierPriceInput()
The price when tier pricing is in effect and the items purchased threshold has been reached.
|
Input<FilterTypeInput> |
ProductFilterInput.getTierPriceInput()
The price when tier pricing is in effect and the items purchased threshold has been reached.
|
Input<String> |
FilterTypeInput.getToInput()
To.
|
Input<String> |
FilterRangeTypeInput.getToInput()
The end of the range
|
Input<SortEnum> |
ProductSortInput.getUpdatedAtInput()
Timestamp indicating when the product was updated.
|
Input<FilterTypeInput> |
ProductFilterInput.getUpdatedAtInput()
Timestamp indicating when the product was updated.
|
Input<SortEnum> |
ProductSortInput.getUrlKeyInput()
The part of the URL that identifies the product
|
Input<FilterTypeInput> |
ProductFilterInput.getUrlKeyInput()
The part of the URL that identifies the product
|
Input<FilterEqualTypeInput> |
ProductAttributeFilterInput.getUrlKeyInput()
The part of the URL that identifies the product
|
Input<FilterEqualTypeInput> |
CategoryFilterInput.getUrlKeyInput()
Filter by the part of the URL that identifies the category.
|
Input<SortEnum> |
ProductSortInput.getUrlPathInput() |
Input<FilterTypeInput> |
ProductFilterInput.getUrlPathInput() |
Input<FilterEqualTypeInput> |
CategoryFilterInput.getUrlPathInput()
Filter by the URL path for the category.
|
Input<Boolean> |
BillingAddressInput.getUseForShippingInput()
Deprecated: use `same_as_shipping` field instead
|
Input<Boolean> |
PaypalExpressTokenInput.getUsePaypalCreditInput()
Indicates whether the buyer clicked the PayPal credit button.
|
Input<String> |
ConfigurableProductCartItemInput.getVariantSkuInput()
Deprecated.
|
Input<String> |
CustomerAddressInput.getVatIdInput()
The customer's Tax/VAT number (for corporate customers)
|
Input<SortEnum> |
ProductSortInput.getWeightInput()
The weight of the item, in units defined by the store.
|
Input<FilterTypeInput> |
ProductFilterInput.getWeightInput()
The weight of the item, in units defined by the store.
|
| Modifier and Type | Method and Description |
|---|---|
ShippingAddressInput |
ShippingAddressInput.setAddressInput(Input<CartAddressInput> address) |
BillingAddressInput |
BillingAddressInput.setAddressInput(Input<CartAddressInput> address) |
CustomerUpdateInput |
CustomerUpdateInput.setAllowRemoteShoppingAssistanceInput(Input<Boolean> allowRemoteShoppingAssistance)
Indicates whether the customer has enabled remote shopping assistance
|
CustomerCreateInput |
CustomerCreateInput.setAllowRemoteShoppingAssistanceInput(Input<Boolean> allowRemoteShoppingAssistance)
Indicates whether the customer has enabled remote shopping assistance
|
AttributeInput |
AttributeInput.setAttributeCodeInput(Input<String> attributeCode)
The unique identifier for an attribute code.
|
PaymentMethodInput |
PaymentMethodInput.setBraintreeCcVaultInput(Input<BraintreeCcVaultInput> braintreeCcVault) |
PaymentMethodInput |
PaymentMethodInput.setBraintreeInput(Input<BraintreeInput> braintree) |
createEmptyCartInput |
createEmptyCartInput.setCartIdInput(Input<String> cartId) |
RemoveItemFromCartInput |
RemoveItemFromCartInput.setCartItemIdInput(Input<Integer> cartItemId)
Deprecated.
|
CartItemUpdateInput |
CartItemUpdateInput.setCartItemIdInput(Input<Integer> cartItemId)
Deprecated.
|
RemoveItemFromCartInput |
RemoveItemFromCartInput.setCartItemUidInput(Input<ID> cartItemUid)
Required field.
|
CartItemUpdateInput |
CartItemUpdateInput.setCartItemUidInput(Input<ID> cartItemUid)
The unique ID for a `CartItemInterface` object
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setCategoryIdInput(Input<FilterEqualTypeInput> categoryId)
Deprecated: use `category_uid` to filter product by category id.
|
ProductFilterInput |
ProductFilterInput.setCategoryIdInput(Input<FilterTypeInput> categoryId)
Category ID the product belongs to.
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setCategoryUidInput(Input<FilterEqualTypeInput> categoryUid)
Filter product by the unique ID for a `CategoryInterface` object.
|
CategoryFilterInput |
CategoryFilterInput.setCategoryUidInput(Input<FilterEqualTypeInput> categoryUid)
Filter by the unique category ID for a `CategoryInterface` object.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setCityInput(Input<FilterTypeInput> city)
Filter by city.
|
PickupLocationSortInput |
PickupLocationSortInput.setCityInput(Input<SortEnum> city)
City where pickup location is placed.
|
CustomerAddressInput |
CustomerAddressInput.setCityInput(Input<String> city)
The city or town
|
RequestReturnInput |
RequestReturnInput.setCommentTextInput(Input<String> commentText)
Text the buyer entered that describes the reason for the refund request
|
CustomerAddressInput |
CustomerAddressInput.setCompanyInput(Input<String> company)
The customer's company
|
CartAddressInput |
CartAddressInput.setCompanyInput(Input<String> company) |
RequestReturnInput |
RequestReturnInput.setContactEmailInput(Input<String> contactEmail)
An email address the buyer enters to receive notifications about the status of the return
|
PickupLocationSortInput |
PickupLocationSortInput.setContactNameInput(Input<SortEnum> contactName)
Name of the contact person.
|
CustomerAddressInput |
CustomerAddressInput.setCountryCodeInput(Input<CountryCodeEnum> countryCode)
The customer's country
|
CustomerAddressInput |
CustomerAddressInput.setCountryIdInput(Input<CountryCodeEnum> countryId)
Deprecated: use `country_code` instead.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setCountryIdInput(Input<FilterTypeInput> countryId)
Filter by country.
|
PickupLocationSortInput |
PickupLocationSortInput.setCountryIdInput(Input<SortEnum> countryId)
Id of the country in two letters.
|
ProductFilterInput |
ProductFilterInput.setCountryOfManufactureInput(Input<FilterTypeInput> countryOfManufacture)
The product's country of origin.
|
ProductSortInput |
ProductSortInput.setCountryOfManufactureInput(Input<SortEnum> countryOfManufacture)
The product's country of origin.
|
ProductFilterInput |
ProductFilterInput.setCreatedAtInput(Input<FilterTypeInput> createdAt)
Timestamp indicating when the product was created.
|
ProductSortInput |
ProductSortInput.setCreatedAtInput(Input<SortEnum> createdAt)
Timestamp indicating when the product was created.
|
CustomerAddressInput |
CustomerAddressInput.setCustomAttributesInput(Input<List<CustomerAddressAttributeInput>> customAttributes)
Deprecated: Custom attributes should not be put into container.
|
ShippingAddressInput |
ShippingAddressInput.setCustomerAddressIdInput(Input<Integer> customerAddressId) |
BillingAddressInput |
BillingAddressInput.setCustomerAddressIdInput(Input<Integer> customerAddressId) |
ShippingAddressInput |
ShippingAddressInput.setCustomerNotesInput(Input<String> customerNotes) |
VirtualProductCartItemInput |
VirtualProductCartItemInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
SimpleProductCartItemInput |
SimpleProductCartItemInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
DownloadableProductCartItemInput |
DownloadableProductCartItemInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
ConfigurableProductCartItemInput |
ConfigurableProductCartItemInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
CartItemUpdateInput |
CartItemUpdateInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
BundleProductCartItemInput |
BundleProductCartItemInput.setCustomizableOptionsInput(Input<List<CustomizableOptionInput>> customizableOptions) |
ProductFilterInput |
ProductFilterInput.setCustomLayoutInput(Input<FilterTypeInput> customLayout)
The name of a custom layout.
|
ProductSortInput |
ProductSortInput.setCustomLayoutInput(Input<SortEnum> customLayout)
The name of a custom layout.
|
ProductFilterInput |
ProductFilterInput.setCustomLayoutUpdateInput(Input<FilterTypeInput> customLayoutUpdate)
XML code that is applied as a layout update to the product page.
|
ProductSortInput |
ProductSortInput.setCustomLayoutUpdateInput(Input<SortEnum> customLayoutUpdate)
XML code that is applied as a layout update to the product page.
|
CustomerUpdateInput |
CustomerUpdateInput.setDateOfBirthInput(Input<String> dateOfBirth)
The customer's date of birth
|
CustomerInput |
CustomerInput.setDateOfBirthInput(Input<String> dateOfBirth)
The customer's date of birth
|
CustomerCreateInput |
CustomerCreateInput.setDateOfBirthInput(Input<String> dateOfBirth)
The customer's date of birth
|
CustomerAddressInput |
CustomerAddressInput.setDefaultBillingInput(Input<Boolean> defaultBilling)
Indicates whether the address is the default billing address
|
CustomerAddressInput |
CustomerAddressInput.setDefaultShippingInput(Input<Boolean> defaultShipping)
Indicates whether the address is the default shipping address
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setDescriptionInput(Input<FilterMatchTypeInput> description)
Attribute label: Description
|
ProductFilterInput |
ProductFilterInput.setDescriptionInput(Input<FilterTypeInput> description)
Detailed information about the product.
|
ProductSortInput |
ProductSortInput.setDescriptionInput(Input<SortEnum> description)
Detailed information about the product.
|
PickupLocationSortInput |
PickupLocationSortInput.setDescriptionInput(Input<SortEnum> description)
Description of the pickup location.
|
WishlistItemUpdateInput |
WishlistItemUpdateInput.setDescriptionInput(Input<String> description)
Customer-entered comments about the item
|
BraintreeCcVaultInput |
BraintreeCcVaultInput.setDeviceDataInput(Input<String> deviceData) |
BraintreeInput |
BraintreeInput.setDeviceDataInput(Input<String> deviceData)
Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details
to the Braintree payment gateway.
|
PickupLocationSortInput |
PickupLocationSortInput.setDistanceInput(Input<SortEnum> distance)
Distance to the address, requested by distance filter.
|
CustomerUpdateInput |
CustomerUpdateInput.setDobInput(Input<String> dob)
Deprecated: Use `date_of_birth` instead
|
CustomerInput |
CustomerInput.setDobInput(Input<String> dob)
Deprecated: Use `date_of_birth` instead
|
CustomerCreateInput |
CustomerCreateInput.setDobInput(Input<String> dob)
Deprecated: Use `date_of_birth` instead
|
DownloadableProductCartItemInput |
DownloadableProductCartItemInput.setDownloadableProductLinksInput(Input<List<DownloadableProductLinksInput>> downloadableProductLinks) |
PickupLocationSortInput |
PickupLocationSortInput.setEmailInput(Input<SortEnum> email)
Contact email of the pickup location.
|
CustomerInput |
CustomerInput.setEmailInput(Input<String> email)
The customer's email address.
|
RequestReturnItemInput |
RequestReturnItemInput.setEnteredCustomAttributesInput(Input<List<EnteredCustomAttributeInput>> enteredCustomAttributes)
Contains details about a custom attribute that was entered, such as text or a file
|
WishlistItemUpdateInput |
WishlistItemUpdateInput.setEnteredOptionsInput(Input<List<EnteredOptionInput>> enteredOptions)
An array of options that the customer entered
|
WishlistItemInput |
WishlistItemInput.setEnteredOptionsInput(Input<List<EnteredOptionInput>> enteredOptions)
An array of options that the customer entered
|
CartItemInput |
CartItemInput.setEnteredOptionsInput(Input<List<EnteredOptionInput>> enteredOptions)
An array of entered options for the base product, such as personalization text
|
AttributeInput |
AttributeInput.setEntityTypeInput(Input<String> entityType)
The type of entity that defines the attribute
|
FilterTypeInput |
FilterTypeInput.setEqInput(Input<String> eq)
Equals
|
FilterStringTypeInput |
FilterStringTypeInput.setEqInput(Input<String> eq)
Filters items that are exactly the same as the specified string.
|
FilterEqualTypeInput |
FilterEqualTypeInput.setEqInput(Input<String> eq)
A string to filter on
|
PaypalExpressTokenInput |
PaypalExpressTokenInput.setExpressButtonInput(Input<Boolean> expressButton)
Indicates whether the buyer selected the quick checkout button.
|
PickupLocationSortInput |
PickupLocationSortInput.setFaxInput(Input<SortEnum> fax)
Contact fax of the pickup location.
|
CustomerAddressInput |
CustomerAddressInput.setFaxInput(Input<String> fax)
The fax number
|
FilterTypeInput |
FilterTypeInput.setFinsetInput(Input<List<String>> finset) |
CustomerUpdateInput |
CustomerUpdateInput.setFirstnameInput(Input<String> firstname)
The customer's first name
|
CustomerInput |
CustomerInput.setFirstnameInput(Input<String> firstname)
The customer's first name
|
CustomerAddressInput |
CustomerAddressInput.setFirstnameInput(Input<String> firstname)
The first name of the person associated with the shipping/billing address
|
FilterTypeInput |
FilterTypeInput.setFromInput(Input<String> from)
From.
|
FilterRangeTypeInput |
FilterRangeTypeInput.setFromInput(Input<String> from)
The beginning of the range
|
CustomerUpdateInput |
CustomerUpdateInput.setGenderInput(Input<Integer> gender)
The customer's gender (Male - 1, Female - 2)
|
CustomerInput |
CustomerInput.setGenderInput(Input<Integer> gender)
The customer's gender (Male - 1, Female - 2)
|
CustomerCreateInput |
CustomerCreateInput.setGenderInput(Input<Integer> gender)
The customer's gender (Male - 1, Female - 2)
|
ProductFilterInput |
ProductFilterInput.setGiftMessageAvailableInput(Input<FilterTypeInput> giftMessageAvailable)
Indicates whether a gift message is available.
|
ProductSortInput |
ProductSortInput.setGiftMessageAvailableInput(Input<SortEnum> giftMessageAvailable)
Indicates whether a gift message is available.
|
SetGiftOptionsOnCartInput |
SetGiftOptionsOnCartInput.setGiftMessageInput(Input<GiftMessageInput> giftMessage)
Gift message details for the cart
|
CartItemUpdateInput |
CartItemUpdateInput.setGiftMessageInput(Input<GiftMessageInput> giftMessage)
Gift message details for the cart item
|
SetGiftOptionsOnCartInput |
SetGiftOptionsOnCartInput.setGiftWrappingIdInput(Input<ID> giftWrappingId)
The unique ID for a `GiftWrapping` object to be used for the cart
|
CartItemUpdateInput |
CartItemUpdateInput.setGiftWrappingIdInput(Input<ID> giftWrappingId)
The unique ID for a `GiftWrapping` object to be used for the cart item
|
FilterTypeInput |
FilterTypeInput.setGteqInput(Input<String> gteq)
Greater than or equal to
|
FilterTypeInput |
FilterTypeInput.setGtInput(Input<String> gt)
Greater than
|
ProductFilterInput |
ProductFilterInput.setHasOptionsInput(Input<FilterTypeInput> hasOptions)
Indicates whether additional attributes have been created for the product.
|
ProductSortInput |
ProductSortInput.setHasOptionsInput(Input<SortEnum> hasOptions)
Indicates whether additional attributes have been created for the product.
|
PaymentMethodInput |
PaymentMethodInput.setHostedProInput(Input<HostedProInput> hostedPro)
Required input for PayPal Hosted pro payments
|
CustomizableOptionInput |
CustomizableOptionInput.setIdInput(Input<Integer> id)
The customizable option id of the product
|
CategoryFilterInput |
CategoryFilterInput.setIdsInput(Input<FilterEqualTypeInput> ids)
Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
|
ProductFilterInput |
ProductFilterInput.setImageInput(Input<FilterTypeInput> image)
The relative path to the main image on the product page.
|
ProductSortInput |
ProductSortInput.setImageInput(Input<SortEnum> image)
The relative path to the main image on the product page.
|
ProductFilterInput |
ProductFilterInput.setImageLabelInput(Input<FilterTypeInput> imageLabel)
The label assigned to a product image.
|
ProductSortInput |
ProductSortInput.setImageLabelInput(Input<SortEnum> imageLabel)
The label assigned to a product image.
|
FilterTypeInput |
FilterTypeInput.setInInput(Input<List<String>> in)
In.
|
FilterStringTypeInput |
FilterStringTypeInput.setInInput(Input<List<String>> in)
Filters items that are exactly the same as entries specified in an array of strings.
|
FilterEqualTypeInput |
FilterEqualTypeInput.setInInput(Input<List<String>> in)
An array of values to filter on
|
PayflowProInput |
PayflowProInput.setIsActivePaymentTokenEnablerInput(Input<Boolean> isActivePaymentTokenEnabler)
States whether details about the customer's credit/debit card should be tokenized for later usage.
|
ProductFilterInput |
ProductFilterInput.setIsReturnableInput(Input<FilterTypeInput> isReturnable)
Indicates whether the product can be returned
|
ProductSortInput |
ProductSortInput.setIsReturnableInput(Input<SortEnum> isReturnable)
Indicates whether the product can be returned
|
CustomerUpdateInput |
CustomerUpdateInput.setIsSubscribedInput(Input<Boolean> isSubscribed)
Indicates whether the customer is subscribed to the company's newsletter
|
CustomerInput |
CustomerInput.setIsSubscribedInput(Input<Boolean> isSubscribed)
Indicates whether the customer is subscribed to the company's newsletter
|
CustomerCreateInput |
CustomerCreateInput.setIsSubscribedInput(Input<Boolean> isSubscribed)
Indicates whether the customer is subscribed to the company's newsletter
|
PaymentMethodInput |
PaymentMethodInput.setKlarnaInput(Input<KlarnaInput> klarna) |
CustomerUpdateInput |
CustomerUpdateInput.setLastnameInput(Input<String> lastname)
The customer's family name
|
CustomerInput |
CustomerInput.setLastnameInput(Input<String> lastname)
The customer's family name
|
CustomerAddressInput |
CustomerAddressInput.setLastnameInput(Input<String> lastname)
The family name of the person associated with the shipping/billing address
|
PickupLocationSortInput |
PickupLocationSortInput.setLatitudeInput(Input<SortEnum> latitude)
Geographic latitude where pickup location is placed.
|
FilterTypeInput |
FilterTypeInput.setLikeInput(Input<String> like)
Like.
|
PickupLocationSortInput |
PickupLocationSortInput.setLongitudeInput(Input<SortEnum> longitude)
Geographic longitude where pickup location is placed.
|
FilterTypeInput |
FilterTypeInput.setLteqInput(Input<String> lteq)
Less than or equal to
|
FilterTypeInput |
FilterTypeInput.setLtInput(Input<String> lt)
Less than
|
ProductFilterInput |
ProductFilterInput.setManufacturerInput(Input<FilterTypeInput> manufacturer)
A number representing the product's manufacturer.
|
ProductSortInput |
ProductSortInput.setManufacturerInput(Input<SortEnum> manufacturer)
A number representing the product's manufacturer.
|
FilterStringTypeInput |
FilterStringTypeInput.setMatchInput(Input<String> match)
Defines a filter that performs a fuzzy search using the specified string.
|
FilterMatchTypeInput |
FilterMatchTypeInput.setMatchInput(Input<String> match)
One or more words to filter on
|
ProductFilterInput |
ProductFilterInput.setMaxPriceInput(Input<FilterTypeInput> maxPrice)
The numeric maximal price of the product.
|
ProductFilterInput |
ProductFilterInput.setMetaDescriptionInput(Input<FilterTypeInput> metaDescription)
A brief overview of the product for search results listings, maximum 255 characters.
|
ProductSortInput |
ProductSortInput.setMetaDescriptionInput(Input<SortEnum> metaDescription)
A brief overview of the product for search results listings, maximum 255 characters.
|
ProductFilterInput |
ProductFilterInput.setMetaKeywordInput(Input<FilterTypeInput> metaKeyword)
A comma-separated list of keywords that are visible only to search engines.
|
ProductSortInput |
ProductSortInput.setMetaKeywordInput(Input<SortEnum> metaKeyword)
A comma-separated list of keywords that are visible only to search engines.
|
ProductFilterInput |
ProductFilterInput.setMetaTitleInput(Input<FilterTypeInput> metaTitle)
A string that is displayed in the title bar and tab of the browser and in search results lists.
|
ProductSortInput |
ProductSortInput.setMetaTitleInput(Input<SortEnum> metaTitle)
A string that is displayed in the title bar and tab of the browser and in search results lists.
|
CustomerUpdateInput |
CustomerUpdateInput.setMiddlenameInput(Input<String> middlename)
The customer's middle name
|
CustomerInput |
CustomerInput.setMiddlenameInput(Input<String> middlename)
The customer's middle name
|
CustomerCreateInput |
CustomerCreateInput.setMiddlenameInput(Input<String> middlename)
The customer's middle name
|
CustomerAddressInput |
CustomerAddressInput.setMiddlenameInput(Input<String> middlename)
The middle name of the person associated with the shipping/billing address
|
ProductFilterInput |
ProductFilterInput.setMinPriceInput(Input<FilterTypeInput> minPrice)
The numeric minimal price of the product.
|
FilterTypeInput |
FilterTypeInput.setMoreqInput(Input<String> moreq)
More than or equal to
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setNameInput(Input<FilterMatchTypeInput> name)
Attribute label: Product Name
|
CategoryFilterInput |
CategoryFilterInput.setNameInput(Input<FilterMatchTypeInput> name)
Filter by the display name of the category.
|
ProductFilterInput |
ProductFilterInput.setNameInput(Input<FilterTypeInput> name)
The product name.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setNameInput(Input<FilterTypeInput> name)
Filter by pickup location name.
|
ProductSortInput |
ProductSortInput.setNameInput(Input<SortEnum> name)
The product name.
|
ProductAttributeSortInput |
ProductAttributeSortInput.setNameInput(Input<SortEnum> name)
Attribute label: Product Name
|
PickupLocationSortInput |
PickupLocationSortInput.setNameInput(Input<SortEnum> name)
The pickup location name.
|
FilterTypeInput |
FilterTypeInput.setNeqInput(Input<String> neq)
Not equal to
|
ProductFilterInput |
ProductFilterInput.setNewsFromDateInput(Input<FilterTypeInput> newsFromDate)
The beginning date for new product listings, and determines if the product is featured as a new
product.
|
ProductSortInput |
ProductSortInput.setNewsFromDateInput(Input<SortEnum> newsFromDate)
The beginning date for new product listings, and determines if the product is featured as a new
product.
|
ProductFilterInput |
ProductFilterInput.setNewsToDateInput(Input<FilterTypeInput> newsToDate)
The end date for new product listings.
|
ProductSortInput |
ProductSortInput.setNewsToDateInput(Input<SortEnum> newsToDate)
The end date for new product listings.
|
FilterTypeInput |
FilterTypeInput.setNinInput(Input<List<String>> nin)
Not in.
|
FilterTypeInput |
FilterTypeInput.setNotnullInput(Input<String> notnull)
Not null
|
FilterTypeInput |
FilterTypeInput.setNullInput(Input<String> nullValue)
Is null
|
CustomerOrdersFilterInput |
CustomerOrdersFilterInput.setNumberInput(Input<FilterStringTypeInput> number)
Filters by order number.
|
ProductFilterInput |
ProductFilterInput.setOptionsContainerInput(Input<FilterTypeInput> optionsContainer)
If the product has multiple options, determines where they appear on the product page.
|
ProductSortInput |
ProductSortInput.setOptionsContainerInput(Input<SortEnum> optionsContainer)
If the product has multiple options, determines where they appear on the product page.
|
ProductFilterInput |
ProductFilterInput.setOrInput(Input<ProductFilterInput> or)
The keyword required to perform a logical OR comparison.
|
CategoryFilterInput |
CategoryFilterInput.setParentCategoryUidInput(Input<FilterEqualTypeInput> parentCategoryUid)
Filter by the unique parent category ID for a `CategoryInterface` object.
|
CategoryFilterInput |
CategoryFilterInput.setParentIdInput(Input<FilterEqualTypeInput> parentId)
Filter by the unique parent category ID for a `CategoryInterface` object.
|
WishlistItemInput |
WishlistItemInput.setParentSkuInput(Input<String> parentSku)
For complex product types, the SKU of the parent product
|
ConfigurableProductCartItemInput |
ConfigurableProductCartItemInput.setParentSkuInput(Input<String> parentSku)
Configurable product SKU.
|
CartItemInput |
CartItemInput.setParentSkuInput(Input<String> parentSku)
For child products, the SKU of its parent product
|
CustomerInput |
CustomerInput.setPasswordInput(Input<String> password)
The customer's password
|
CustomerCreateInput |
CustomerCreateInput.setPasswordInput(Input<String> password)
The customer's password
|
PaymentMethodInput |
PaymentMethodInput.setPayflowExpressInput(Input<PayflowExpressInput> payflowExpress)
Required input for Payflow Express Checkout payments
|
PaymentMethodInput |
PaymentMethodInput.setPayflowLinkInput(Input<PayflowLinkInput> payflowLink)
Required input for PayPal Payflow Link and Payments Advanced payments
|
PaymentMethodInput |
PaymentMethodInput.setPayflowproCcVaultInput(Input<VaultTokenInput> payflowproCcVault)
Required input type for PayPal Payflow Pro vault payments
|
PaymentMethodInput |
PaymentMethodInput.setPayflowproInput(Input<PayflowProInput> payflowpro)
Required input type for PayPal Payflow Pro and Payment Pro payments
|
PaymentMethodInput |
PaymentMethodInput.setPaypalExpressInput(Input<PaypalExpressInput> paypalExpress)
Required input for Express Checkout and Payments Standard payments
|
PaypalExpressUrlsInput |
PaypalExpressUrlsInput.setPendingUrlInput(Input<String> pendingUrl)
The relative URL of the page that PayPal will redirect to when the payment has been put on hold for
additional review.
|
PickupLocationSortInput |
PickupLocationSortInput.setPhoneInput(Input<SortEnum> phone)
Contact phone number of the pickup location.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setPickupLocationCodeInput(Input<FilterTypeInput> pickupLocationCode)
Filter by pickup location code.
|
PickupLocationSortInput |
PickupLocationSortInput.setPickupLocationCodeInput(Input<SortEnum> pickupLocationCode)
A code assigned to pickup location to identify the source.
|
ShippingAddressInput |
ShippingAddressInput.setPickupLocationCodeInput(Input<String> pickupLocationCode)
The code of Pickup Location which will be used for In-Store Pickup.
|
ProductAttributeSortInput |
ProductAttributeSortInput.setPositionInput(Input<SortEnum> position)
Sort by the position assigned to each product.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setPostcodeInput(Input<FilterTypeInput> postcode)
Filter by postcode.
|
PickupLocationSortInput |
PickupLocationSortInput.setPostcodeInput(Input<SortEnum> postcode)
Postcode where pickup location is placed.
|
CustomerAddressInput |
CustomerAddressInput.setPostcodeInput(Input<String> postcode)
The customer's ZIP or postal code
|
CartAddressInput |
CartAddressInput.setPostcodeInput(Input<String> postcode) |
CustomerUpdateInput |
CustomerUpdateInput.setPrefixInput(Input<String> prefix)
An honorific, such as Dr., Mr., or Mrs.
|
CustomerInput |
CustomerInput.setPrefixInput(Input<String> prefix)
An honorific, such as Dr., Mr., or Mrs.
|
CustomerCreateInput |
CustomerCreateInput.setPrefixInput(Input<String> prefix)
An honorific, such as Dr., Mr., or Mrs.
|
CustomerAddressInput |
CustomerAddressInput.setPrefixInput(Input<String> prefix)
An honorific, such as Dr., Mr., or Mrs.
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setPriceInput(Input<FilterRangeTypeInput> price)
Attribute label: Price
|
ProductFilterInput |
ProductFilterInput.setPriceInput(Input<FilterTypeInput> price)
The price of an item.
|
ProductSortInput |
ProductSortInput.setPriceInput(Input<SortEnum> price)
The price of the item.
|
ProductAttributeSortInput |
ProductAttributeSortInput.setPriceInput(Input<SortEnum> price)
Attribute label: Price
|
CreateCompareListInput |
CreateCompareListInput.setProductsInput(Input<List<ID>> products)
An array of product IDs to add to the compare list
|
PaymentMethodInput |
PaymentMethodInput.setPurchaseOrderNumberInput(Input<String> purchaseOrderNumber)
Purchase order number
|
WishlistItemUpdateInput |
WishlistItemUpdateInput.setQuantityInput(Input<Double> quantity)
The new amount or number of this item
|
WishlistItemMoveInput |
WishlistItemMoveInput.setQuantityInput(Input<Double> quantity)
The quantity of this item to move to the destination wish list.
|
WishlistItemCopyInput |
WishlistItemCopyInput.setQuantityInput(Input<Double> quantity)
The quantity of this item to copy to the destination wish list.
|
CartItemUpdateInput |
CartItemUpdateInput.setQuantityInput(Input<Double> quantity) |
CustomerAddressRegionInput |
CustomerAddressRegionInput.setRegionCodeInput(Input<String> regionCode)
The address region code
|
PickupLocationFilterInput |
PickupLocationFilterInput.setRegionIdInput(Input<FilterTypeInput> regionId)
Filter by region id.
|
CustomerAddressRegionInput |
CustomerAddressRegionInput.setRegionIdInput(Input<Integer> regionId)
The unique ID for a pre-defined region
|
CartAddressInput |
CartAddressInput.setRegionIdInput(Input<Integer> regionId) |
PickupLocationSortInput |
PickupLocationSortInput.setRegionIdInput(Input<SortEnum> regionId)
Id of the region.
|
CustomerAddressInput |
CustomerAddressInput.setRegionInput(Input<CustomerAddressRegionInput> region)
An object containing the region name, region code, and region ID
|
PickupLocationFilterInput |
PickupLocationFilterInput.setRegionInput(Input<FilterTypeInput> region)
Filter by region.
|
PickupLocationSortInput |
PickupLocationSortInput.setRegionInput(Input<SortEnum> region)
Name of the region.
|
CustomerAddressRegionInput |
CustomerAddressRegionInput.setRegionInput(Input<String> region)
The state or province name
|
CartAddressInput |
CartAddressInput.setRegionInput(Input<String> region) |
ProductAttributeSortInput |
ProductAttributeSortInput.setRelevanceInput(Input<SortEnum> relevance)
Sort by the search relevance score (default).
|
ProductFilterInput |
ProductFilterInput.setRequiredOptionsInput(Input<FilterTypeInput> requiredOptions)
Indicates whether the product has required options.
|
ProductSortInput |
ProductSortInput.setRequiredOptionsInput(Input<SortEnum> requiredOptions)
Indicates whether the product has required options.
|
BillingAddressInput |
BillingAddressInput.setSameAsShippingInput(Input<Boolean> sameAsShipping)
Set billing address same as shipping
|
CartAddressInput |
CartAddressInput.setSaveInAddressBookInput(Input<Boolean> saveInAddressBook)
Determines whether to save the address in the customer's address book.
|
RequestReturnItemInput |
RequestReturnItemInput.setSelectedCustomAttributesInput(Input<List<SelectedCustomAttributeInput>> selectedCustomAttributes)
An array of selected custom option IDs associated with the item to be returned.
|
WishlistItemUpdateInput |
WishlistItemUpdateInput.setSelectedOptionsInput(Input<List<ID>> selectedOptions)
An array of strings corresponding to options the customer selected
|
WishlistItemInput |
WishlistItemInput.setSelectedOptionsInput(Input<List<ID>> selectedOptions)
An array of strings corresponding to options the customer selected
|
CartItemInput |
CartItemInput.setSelectedOptionsInput(Input<List<ID>> selectedOptions)
The selected options for the base product, such as color or size with unique ID for a
`CustomizableRadioOption`, `CustomizableDropDownOption`, `ConfigurableProductOptionsValues`, etc.
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setShortDescriptionInput(Input<FilterMatchTypeInput> shortDescription)
Attribute label: Short Description
|
ProductFilterInput |
ProductFilterInput.setShortDescriptionInput(Input<FilterTypeInput> shortDescription)
A short description of the product.
|
ProductSortInput |
ProductSortInput.setShortDescriptionInput(Input<SortEnum> shortDescription)
A short description of the product.
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setSkuInput(Input<FilterEqualTypeInput> sku)
Attribute label: SKU
|
ProductFilterInput |
ProductFilterInput.setSkuInput(Input<FilterTypeInput> sku)
A number or code assigned to a product to identify the product, options, price, and manufacturer.
|
ProductSortInput |
ProductSortInput.setSkuInput(Input<SortEnum> sku)
A number or code assigned to a product to identify the product, options, price, and manufacturer.
|
ProductFilterInput |
ProductFilterInput.setSmallImageInput(Input<FilterTypeInput> smallImage)
The relative path to the small image, which is used on catalog pages.
|
ProductSortInput |
ProductSortInput.setSmallImageInput(Input<SortEnum> smallImage)
The relative path to the small image, which is used on catalog pages.
|
ProductFilterInput |
ProductFilterInput.setSmallImageLabelInput(Input<FilterTypeInput> smallImageLabel)
The label assigned to a product's small image.
|
ProductSortInput |
ProductSortInput.setSmallImageLabelInput(Input<SortEnum> smallImageLabel)
The label assigned to a product's small image.
|
ProductFilterInput |
ProductFilterInput.setSpecialFromDateInput(Input<FilterTypeInput> specialFromDate)
The beginning date that a product has a special price.
|
ProductSortInput |
ProductSortInput.setSpecialFromDateInput(Input<SortEnum> specialFromDate)
The beginning date that a product has a special price.
|
ProductFilterInput |
ProductFilterInput.setSpecialPriceInput(Input<FilterTypeInput> specialPrice)
The discounted price of the product.
|
ProductSortInput |
ProductSortInput.setSpecialPriceInput(Input<SortEnum> specialPrice)
The discounted price of the product.
|
ProductFilterInput |
ProductFilterInput.setSpecialToDateInput(Input<FilterTypeInput> specialToDate)
The end date that a product has a special price.
|
ProductSortInput |
ProductSortInput.setSpecialToDateInput(Input<SortEnum> specialToDate)
The end date that a product has a special price.
|
PickupLocationFilterInput |
PickupLocationFilterInput.setStreetInput(Input<FilterTypeInput> street)
Filter by street.
|
CustomerAddressInput |
CustomerAddressInput.setStreetInput(Input<List<String>> street)
An array of strings that define the street number and name
|
PickupLocationSortInput |
PickupLocationSortInput.setStreetInput(Input<SortEnum> street)
Street where pickup location is placed.
|
PaypalExpressUrlsInput |
PaypalExpressUrlsInput.setSuccessUrlInput(Input<String> successUrl)
The relative URL of the order confirmation page that PayPal will redirect to when the payment is
successful and additional confirmation is not needed.
|
CustomerUpdateInput |
CustomerUpdateInput.setSuffixInput(Input<String> suffix)
A value such as Sr., Jr., or III
|
CustomerInput |
CustomerInput.setSuffixInput(Input<String> suffix)
A value such as Sr., Jr., or III
|
CustomerCreateInput |
CustomerCreateInput.setSuffixInput(Input<String> suffix)
A value such as Sr., Jr., or III
|
CustomerAddressInput |
CustomerAddressInput.setSuffixInput(Input<String> suffix)
A value such as Sr., Jr., or III
|
ProductFilterInput |
ProductFilterInput.setSwatchImageInput(Input<FilterTypeInput> swatchImage)
The file name of a swatch image
|
ProductSortInput |
ProductSortInput.setSwatchImageInput(Input<SortEnum> swatchImage)
The file name of a swatch image
|
CustomerUpdateInput |
CustomerUpdateInput.setTaxvatInput(Input<String> taxvat)
The customer's Tax/VAT number (for corporate customers)
|
CustomerInput |
CustomerInput.setTaxvatInput(Input<String> taxvat)
The customer's Tax/VAT number (for corporate customers)
|
CustomerCreateInput |
CustomerCreateInput.setTaxvatInput(Input<String> taxvat)
The customer's Tax/VAT number (for corporate customers)
|
CustomerAddressInput |
CustomerAddressInput.setTelephoneInput(Input<String> telephone)
The telephone number
|
ProductFilterInput |
ProductFilterInput.setThumbnailInput(Input<FilterTypeInput> thumbnail)
The relative path to the product's thumbnail image.
|
ProductSortInput |
ProductSortInput.setThumbnailInput(Input<SortEnum> thumbnail)
The relative path to the product's thumbnail image.
|
ProductFilterInput |
ProductFilterInput.setThumbnailLabelInput(Input<FilterTypeInput> thumbnailLabel)
The label assigned to a product's thumbnail image.
|
ProductSortInput |
ProductSortInput.setThumbnailLabelInput(Input<SortEnum> thumbnailLabel)
The label assigned to a product's thumbnail image.
|
ProductFilterInput |
ProductFilterInput.setTierPriceInput(Input<FilterTypeInput> tierPrice)
The price when tier pricing is in effect and the items purchased threshold has been reached.
|
ProductSortInput |
ProductSortInput.setTierPriceInput(Input<SortEnum> tierPrice)
The price when tier pricing is in effect and the items purchased threshold has been reached.
|
FilterTypeInput |
FilterTypeInput.setToInput(Input<String> to)
To.
|
FilterRangeTypeInput |
FilterRangeTypeInput.setToInput(Input<String> to)
The end of the range
|
ProductFilterInput |
ProductFilterInput.setUpdatedAtInput(Input<FilterTypeInput> updatedAt)
Timestamp indicating when the product was updated.
|
ProductSortInput |
ProductSortInput.setUpdatedAtInput(Input<SortEnum> updatedAt)
Timestamp indicating when the product was updated.
|
ProductAttributeFilterInput |
ProductAttributeFilterInput.setUrlKeyInput(Input<FilterEqualTypeInput> urlKey)
The part of the URL that identifies the product
|
CategoryFilterInput |
CategoryFilterInput.setUrlKeyInput(Input<FilterEqualTypeInput> urlKey)
Filter by the part of the URL that identifies the category.
|
ProductFilterInput |
ProductFilterInput.setUrlKeyInput(Input<FilterTypeInput> urlKey)
The part of the URL that identifies the product
|
ProductSortInput |
ProductSortInput.setUrlKeyInput(Input<SortEnum> urlKey)
The part of the URL that identifies the product
|
CategoryFilterInput |
CategoryFilterInput.setUrlPathInput(Input<FilterEqualTypeInput> urlPath)
Filter by the URL path for the category.
|
ProductFilterInput |
ProductFilterInput.setUrlPathInput(Input<FilterTypeInput> urlPath) |
ProductSortInput |
ProductSortInput.setUrlPathInput(Input<SortEnum> urlPath) |
BillingAddressInput |
BillingAddressInput.setUseForShippingInput(Input<Boolean> useForShipping)
Deprecated: use `same_as_shipping` field instead
|
PaypalExpressTokenInput |
PaypalExpressTokenInput.setUsePaypalCreditInput(Input<Boolean> usePaypalCredit)
Indicates whether the buyer clicked the PayPal credit button.
|
ConfigurableProductCartItemInput |
ConfigurableProductCartItemInput.setVariantSkuInput(Input<String> variantSku)
Deprecated.
|
CustomerAddressInput |
CustomerAddressInput.setVatIdInput(Input<String> vatId)
The customer's Tax/VAT number (for corporate customers)
|
ProductFilterInput |
ProductFilterInput.setWeightInput(Input<FilterTypeInput> weight)
The weight of the item, in units defined by the store.
|
ProductSortInput |
ProductSortInput.setWeightInput(Input<SortEnum> weight)
The weight of the item, in units defined by the store.
|
| Modifier and Type | Method and Description |
|---|---|
static <T> Input<T> |
Input.optional(T value) |
static <T> Input<T> |
Input.undefined() |
static <T> Input<T> |
Input.value(T value) |
Copyright © 2022 Adobe. All rights reserved.