Types

TaxItem

Contains tax item details.

Fields

Example

{
  "amount": Money,
  "rate": 123.45,
  "title": "xyz789"
}

TaxWrappingEnum

Values

Example

""DISPLAY_EXCLUDING_TAX""

TextSwatchData

Fields

Example

{"value": "xyz789"}

TierPrice

Defines a price based on the quantity purchased.

Fields

Example

{
  "discount": ProductDiscount,
  "final_price": Money,
  "quantity": 123.45
}

UpdateCartItemsInput

Modifies the specified items in the cart.

Input Fields

Example

{
  "cart_id": "abc123",
  "cart_items": [CartItemUpdateInput]
}

UpdateCartItemsOutput

Contains details about the cart after updating items.

Fields

Example

{"cart": Cart}

UpdateCompanyOutput

Contains the response to the request to update the company.

Fields

Example

{"company": Company}

UpdateCompanyRoleOutput

Contains the response to the request to update the company role.

Fields

Example

{"role": CompanyRole}

UpdateCompanyStructureOutput

Contains the response to the request to update the company structure.

Fields

Example

{"company": Company}

UpdateCompanyTeamOutput

Contains the response to the request to update a company team.

Fields

Example

{"team": CompanyTeam}

UpdateCompanyUserOutput

Contains the response to the request to update the company user.

Fields

Example

{"user": Customer}

UpdateGiftRegistryInput

Defines updates to a GiftRegistry object.

Input Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "xyz789",
  "message": "abc123",
  "privacy_settings": "PRIVATE",
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

UpdateGiftRegistryItemInput

Defines updates to an item in a gift registry.

Input Fields

Example

{
  "gift_registry_item_uid": "4",
  "note": "xyz789",
  "quantity": 123.45
}

UpdateGiftRegistryItemsOutput

Contains the results of a request to update gift registry items.

Fields

Example

{"gift_registry": GiftRegistry}

UpdateGiftRegistryOutput

Contains the results of a request to update a gift registry.

Fields

Example

{"gift_registry": GiftRegistry}

UpdateGiftRegistryRegistrantInput

Defines updates to an existing registrant.

Input Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "xyz789",
  "firstname": "abc123",
  "gift_registry_registrant_uid": 4,
  "lastname": "abc123"
}

UpdateGiftRegistryRegistrantsOutput

Contains the results a request to update registrants.

Fields

Example

{"gift_registry": GiftRegistry}

UpdateNegotiableQuoteItemsQuantityOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

UpdateNegotiableQuoteQuantitiesInput

Specifies the items to update.

Input Fields

Example

{
  "items": [NegotiableQuoteItemQuantityInput],
  "quote_uid": 4
}

UpdateNegotiableQuoteTemplateItemsQuantityOutput

Contains the updated negotiable quote template.

Fields

Example

{"quote_template": NegotiableQuoteTemplate}

UpdateNegotiableQuoteTemplateQuantitiesInput

Specifies the items to update.

Input Fields

Example

{
  "items": [NegotiableQuoteTemplateItemQuantityInput],
  "template_id": "4"
}

UpdateProductsInWishlistOutput

Contains the customer's wish list and any errors encountered.

Fields

Example

{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

UpdatePurchaseOrderApprovalRuleInput

Defines the changes to be made to an approval rule.

Input Fields

Example

{
  "applies_to": ["4"],
  "approvers": ["4"],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "abc123",
  "name": "abc123",
  "status": "ENABLED",
  "uid": 4
}

UpdateRequisitionListInput

An input object that defines which requistion list characteristics to update.

Input Fields

Example

{
  "description": "xyz789",
  "name": "xyz789"
}

UpdateRequisitionListItemsInput

Defines which items in a requisition list to update.

Input Fields

Example

{
  "entered_options": [EnteredOptionInput],
  "item_id": "4",
  "quantity": 987.65,
  "selected_options": ["abc123"]
}

UpdateRequisitionListItemsOutput

Output of the request to update items in the specified requisition list.

Fields

Example

{"requisition_list": RequisitionList}

UpdateRequisitionListOutput

Output of the request to rename the requisition list.

Fields

Example

{"requisition_list": RequisitionList}

UpdateWishlistOutput

Contains the name and visibility of an updated wish list.

Fields

Example

{
  "name": "abc123",
  "uid": 4,
  "visibility": "PUBLIC"
}

UrlRewrite

Contains URL rewrite details.

Fields

Example

{
  "parameters": [HttpQueryParameter],
  "url": "xyz789"
}

UrlRewriteEntityTypeEnum

This enumeration defines the entity type.

Values

Example

""CMS_PAGE""

UseInLayeredNavigationOptions

Defines whether the attribute is filterable in layered navigation.

Values

Example

""NO""

UserCompaniesInput

Defines the input for returning matching companies the customer is assigned to.

Input Fields

Example

{
  "currentPage": 987,
  "pageSize": 123,
  "sort": [CompaniesSortInput]
}

UserCompaniesOutput

An object that contains a list of companies customer is assigned to.

Fields

Example

{
  "items": [CompanyBasicInfo],
  "page_info": SearchResultPageInfo
}

ValidatePurchaseOrderError

Contains details about a failed validation attempt.

Fields

Example

{"message": "xyz789", "type": "NOT_FOUND"}

ValidatePurchaseOrderErrorType

Values

Example

""NOT_FOUND""

ValidatePurchaseOrdersInput

Defines the purchase orders to be validated.

Input Fields

Example

{"purchase_order_uids": [4]}

ValidatePurchaseOrdersOutput

Contains the results of validation attempts.

Fields

Example

{
  "errors": [ValidatePurchaseOrderError],
  "purchase_orders": [PurchaseOrder]
}

ValidationRule

Defines a customer attribute validation rule.

Fields

Example

{
  "name": "DATE_RANGE_MAX",
  "value": "abc123"
}

ValidationRuleEnum

List of validation rule names applied to a customer attribute.

Values

Example

""DATE_RANGE_MAX""

VaultMethodInput

Vault payment inputs

Input Fields

Example

{
  "payment_source": "xyz789",
  "payments_order_id": "abc123",
  "paypal_order_id": "abc123",
  "public_hash": "xyz789"
}

VaultTokenInput

Contains required input for payment methods with Vault support.

Input Fields

Example

{"public_hash": "abc123"}

VirtualCartItem

An implementation for virtual product cart items.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": true,
  "max_qty": 123.45,
  "min_qty": 123.45,
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

VirtualProduct

Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

Fields

Example

{
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": "xyz789",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "rating_summary": 123.45,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

VirtualProductCartItemInput

Defines a single product to add to the cart.

Input Fields

Example

{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

VirtualRequisitionListItem

Contains details about virtual products added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

VirtualWishlistItem

Contains a virtual product wish list item.

Fields

Example

{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": "4",
  "product": ProductInterface,
  "quantity": 123.45
}

Website

Deprecated. It should not be used on the storefront. Contains information about a website.

Fields

Example

{
  "code": "xyz789",
  "default_group_id": "xyz789",
  "id": 987,
  "is_default": true,
  "name": "xyz789",
  "sort_order": 987
}

WishListUserInputError

An error encountered while performing operations with WishList.

Fields

Example

{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789"
}

WishListUserInputErrorType

A list of possible error types.

Values

Example

""PRODUCT_NOT_FOUND""

Wishlist

Contains a customer wish list.

Fields

Example

{
  "id": "4",
  "items": [WishlistItem],
  "items_count": 123,
  "items_v2": WishlistItems,
  "name": "xyz789",
  "sharing_code": "xyz789",
  "updated_at": "abc123",
  "visibility": "PUBLIC"
}

WishlistCartUserInputError

Contains details about errors encountered when a customer added wish list items to the cart.

Fields

Example

{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123",
  "wishlistId": 4,
  "wishlistItemId": 4
}

WishlistCartUserInputErrorType

A list of possible error types.

Values

Example

""PRODUCT_NOT_FOUND""

WishlistItem

Contains details about a wish list item.

Fields

Example

{
  "added_at": "abc123",
  "description": "xyz789",
  "id": 123,
  "product": ProductInterface,
  "qty": 123.45
}

WishlistItemCopyInput

Specifies the IDs of items to copy and their quantities.

Input Fields

Example

{"quantity": 123.45, "wishlist_item_id": 4}

WishlistItemInput

Defines the items to add to a wish list.

Input Fields

Example

{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "abc123",
  "quantity": 987.65,
  "selected_options": ["4"],
  "sku": "xyz789"
}

WishlistItemInterface

The interface for wish list items.

Fields

Possible Types

Example

{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

WishlistItemMoveInput

Specifies the IDs of the items to move and their quantities.

Input Fields

Example

{
  "quantity": 987.65,
  "wishlist_item_id": "4"
}

WishlistItemUpdateInput

Defines updates to items in a wish list.

Input Fields

Example

{
  "description": "abc123",
  "entered_options": [EnteredOptionInput],
  "quantity": 123.45,
  "selected_options": [4],
  "wishlist_item_id": "4"
}

WishlistItems

Contains an array of items in a wish list.

Fields

Example

{
  "items": [WishlistItemInterface],
  "page_info": SearchResultPageInfo
}

WishlistOutput

Deprecated: Use the Wishlist type instead.

Fields

Example

{
  "items": [WishlistItem],
  "items_count": 987,
  "name": "xyz789",
  "sharing_code": "xyz789",
  "updated_at": "xyz789"
}

WishlistVisibilityEnum

Defines the wish list visibility types.

Values

Example

""PUBLIC""