Types

CancelNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to cancel

Input Fields

Example

{
  "cancellation_comment": "abc123",
  "template_id": 4
}

CancelOrderError

Fields

Example

{
  "code": "ORDER_CANCELLATION_DISABLED",
  "message": "abc123"
}

CancelOrderErrorCode

Values

Example

""ORDER_CANCELLATION_DISABLED""

CancelOrderInput

Defines the order to cancel.

Input Fields

Example

{
  "order_id": "4",
  "reason": "xyz789"
}

CancelOrderOutput

Contains the updated customer order and error message if any.

Fields

Example

{
  "error": "abc123",
  "errorV2": CancelOrderError,
  "order": CustomerOrder
}

CancellationReason

Fields

Example

{"description": "abc123"}

Card

Fields

Example

{
  "bin_details": CardBin,
  "card_expiry_month": "abc123",
  "card_expiry_year": "xyz789",
  "last_digits": "xyz789",
  "name": "xyz789"
}

CardBin

Fields

Example

{"bin": "abc123"}

CardPaymentSourceInput

The card payment source information

Input Fields

Example

{
  "billing_address": BillingAddressPaymentSourceInput,
  "name": "abc123"
}

CardPaymentSourceOutput

The card payment source information

Fields

Example

{
  "brand": "abc123",
  "expiry": "abc123",
  "last_digits": "xyz789"
}

Cart

Contains the contents and other details about a guest or customer cart.

Fields

Example

{
  "applied_coupon": AppliedCoupon,
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [AppliedGiftCard],
  "applied_reward_points": RewardPointsAmount,
  "applied_store_credit": AppliedStoreCredit,
  "available_gift_wrappings": [GiftWrapping],
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": BillingCartAddress,
  "email": "xyz789",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "is_virtual": false,
  "items": [CartItemInterface],
  "itemsV2": CartItems,
  "prices": CartPrices,
  "printed_card_included": true,
  "rules": [CartRule],
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [ShippingCartAddress],
  "total_quantity": 987.65
}

CartAddressCountry

Contains details the country in a billing or shipping address.

Fields

Example

{
  "code": "xyz789",
  "label": "xyz789"
}

CartAddressInput

Defines the billing or shipping address to be applied to the cart.

Input Fields

Example

{
  "city": "abc123",
  "company": "xyz789",
  "country_code": "xyz789",
  "custom_attributes": [AttributeValueInput],
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": "abc123",
  "region_id": 987,
  "save_in_address_book": true,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

CartAddressInterface

Fields

Possible Types

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "fax": "xyz789",
  "firstname": "xyz789",
  "id": 987,
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "uid": "abc123",
  "vat_id": "abc123"
}

CartAddressRegion

Contains details about the region in a billing or shipping address.

Fields

Example

{
  "code": "xyz789",
  "label": "xyz789",
  "region_id": 987
}

CartDiscount

Contains information about discounts applied to the cart.

Fields

Example

{
  "amount": Money,
  "label": ["xyz789"]
}

CartDiscountType

Values

Example

""ITEM""

CartItemError

Fields

Example

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

CartItemErrorType

Values

Example

""UNDEFINED""

CartItemInput

Defines an item to be added to the cart.

Input Fields

Example

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

CartItemInterface

An interface for products in a cart.

Fields

Possible Types

Example

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

CartItemPrices

Contains details about the price of the item, including taxes and discounts.

Fields

Example

{
  "catalog_discount": ProductDiscount,
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_item_price": Money,
  "original_row_total": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_catalog_discount": ProductDiscount,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

CartItemQuantity

Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

Fields

Example

{"cart_item_id": 987, "quantity": 123.45}

CartItemSelectedOptionValuePrice

Contains details about the price of a selected customizable value.

Fields

Example

{
  "type": "FIXED",
  "units": "abc123",
  "value": 987.65
}

CartItemUpdateInput

A single item to be updated.

Input Fields

Example

{
  "cart_item_id": 987,
  "cart_item_uid": "4",
  "customizable_options": [CustomizableOptionInput],
  "gift_message": GiftMessageInput,
  "gift_wrapping_id": "4",
  "quantity": 123.45
}

CartItems

Fields

Example

{
  "items": [CartItemInterface],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CartPrices

Contains details about the final price of items in the cart, including discount and tax information.

Fields

Example

{
  "applied_taxes": [CartTaxItem],
  "discount": CartDiscount,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excluding_tax": Money,
  "subtotal_excluding_tax": Money,
  "subtotal_including_tax": Money,
  "subtotal_with_discount_excluding_tax": Money
}

CartRule

Fields

Example

{"name": "abc123"}

CartTaxItem

Contains tax information about an item in the cart.

Fields

Example

{
  "amount": Money,
  "label": "abc123"
}

CartUserInputError

Fields

Example

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

CartUserInputErrorType

Values

Example

""PRODUCT_NOT_FOUND""

CatalogAttributeApplyToEnum

Values

Example

""SIMPLE""

CatalogAttributeMetadata

Swatch attribute metadata.

Fields

Example

{
  "apply_to": ["SIMPLE"],
  "code": "4",
  "default_value": "abc123",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "is_comparable": false,
  "is_filterable": false,
  "is_filterable_in_search": false,
  "is_html_allowed_on_front": true,
  "is_required": true,
  "is_searchable": false,
  "is_unique": true,
  "is_used_for_price_rules": true,
  "is_used_for_promo_rules": true,
  "is_visible_in_advanced_search": true,
  "is_visible_on_front": true,
  "is_wysiwyg_enabled": false,
  "label": "abc123",
  "options": [CustomAttributeOptionInterface],
  "swatch_input_type": "BOOLEAN",
  "update_product_preview_image": true,
  "use_product_image_for_swatch": true,
  "used_in_product_listing": false
}

CatalogRule

Fields

Example

{"name": "xyz789"}

CategoryFilterInput

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Example

{
  "category_uid": FilterEqualTypeInput,
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput,
  "parent_category_uid": FilterEqualTypeInput,
  "parent_id": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput,
  "url_path": FilterEqualTypeInput
}

CategoryInterface

Contains the full set of attributes that can be returned in a category search.

Fields

Possible Types

Example

{
  "automatic_sorting": "abc123",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "abc123",
  "children_count": "abc123",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "abc123",
  "description": "abc123",
  "display_mode": "xyz789",
  "filter_price_range": 123.45,
  "id": 123,
  "image": "xyz789",
  "include_in_menu": 987,
  "is_anchor": 987,
  "landing_page": 123,
  "level": 987,
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "xyz789",
  "name": "abc123",
  "path": "xyz789",
  "path_in_store": "abc123",
  "position": 987,
  "product_count": 987,
  "products": CategoryProducts,
  "staged": false,
  "uid": 4,
  "updated_at": "xyz789",
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_suffix": "abc123"
}

CategoryProducts

Contains details about the products assigned to a category.

Fields

Example

{
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CategoryResult

Contains a collection of CategoryTree objects and pagination information.

Fields

Example

{
  "items": [CategoryTree],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CategoryTree

Contains the hierarchy of categories.

Fields

Example

{
  "automatic_sorting": "xyz789",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "abc123",
  "children": [CategoryTree],
  "children_count": "abc123",
  "cms_block": CmsBlock,
  "created_at": "xyz789",
  "custom_layout_update_file": "abc123",
  "default_sort_by": "xyz789",
  "description": "abc123",
  "display_mode": "abc123",
  "filter_price_range": 123.45,
  "id": 987,
  "image": "abc123",
  "include_in_menu": 987,
  "is_anchor": 123,
  "landing_page": 987,
  "level": 987,
  "meta_description": "xyz789",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "name": "abc123",
  "path": "abc123",
  "path_in_store": "abc123",
  "position": 123,
  "product_count": 123,
  "products": CategoryProducts,
  "redirect_code": 123,
  "relative_url": "xyz789",
  "staged": true,
  "type": "CMS_PAGE",
  "uid": 4,
  "updated_at": "abc123",
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_suffix": "xyz789"
}

CheckoutAgreement

Defines details about an individual checkout agreement.

Fields

Example

{
  "agreement_id": 987,
  "checkbox_text": "xyz789",
  "content": "xyz789",
  "content_height": "xyz789",
  "is_html": true,
  "mode": "AUTO",
  "name": "abc123"
}

CheckoutAgreementMode

Indicates how agreements are accepted.

Values

Example

""AUTO""

CheckoutUserInputError

An error encountered while adding an item to the cart.

Fields

Example

{
  "code": "REORDER_NOT_AVAILABLE",
  "message": "xyz789",
  "path": ["xyz789"]
}

CheckoutUserInputErrorCodes

Values

Example

""REORDER_NOT_AVAILABLE""

ClearCartError

Contains details about errors encountered when a customer clear cart.

Fields

Example

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

ClearCartErrorType

Values

Example

""NOT_FOUND""

ClearCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Example

{"uid": "4"}

ClearCartOutput

Output of the request to clear the customer cart.

Fields

Example

{
  "cart": Cart,
  "errors": [ClearCartError]
}

ClearCustomerCartOutput

Output of the request to clear the customer cart.

Fields

Example

{"cart": Cart, "status": false}

CloseNegotiableQuoteError

Types

Example

NegotiableQuoteInvalidStateError

CloseNegotiableQuoteOperationFailure

Contains details about a failed close operation on a negotiable quote.

Fields

Example

{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": 4
}

CloseNegotiableQuoteOperationResult

Types

Example

NegotiableQuoteUidOperationSuccess

CloseNegotiableQuotesInput

Defines the negotiable quotes to mark as closed.

Input Fields

Example

{"quote_uids": ["4"]}

CloseNegotiableQuotesOutput

Contains the closed negotiable quotes and other negotiable quotes the company user can view.

Fields

Example

{
  "closed_quotes": [NegotiableQuote],
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

CmsBlock

Contains details about a specific CMS block.

Fields

Example

{
  "content": "xyz789",
  "identifier": "abc123",
  "title": "abc123"
}

CmsBlocks

Contains an array CMS block items.

Fields

Example

{"items": [CmsBlock]}

CmsPage

Contains details about a CMS page.

Fields

Example

{
  "content": "xyz789",
  "content_heading": "abc123",
  "identifier": "abc123",
  "meta_description": "abc123",
  "meta_keywords": "xyz789",
  "meta_title": "abc123",
  "page_layout": "xyz789",
  "redirect_code": 987,
  "relative_url": "xyz789",
  "title": "abc123",
  "type": "CMS_PAGE",
  "url_key": "abc123"
}

ColorSwatchData

Fields

Example

{"value": "xyz789"}

CompaniesSortFieldEnum

The fields available for sorting the customer companies.

Values

Example

""NAME""

CompaniesSortInput

Specifies which field to sort on, and whether to return the results in ascending or descending order.

Input Fields

Example

{"field": "NAME", "order": "ASC"}

Company

Contains the output schema for a company.

Fields

Example

{
  "acl_resources": [CompanyAclResource],
  "company_admin": Customer,
  "credit": CompanyCredit,
  "credit_history": CompanyCreditHistory,
  "email": "xyz789",
  "id": "4",
  "legal_address": CompanyLegalAddress,
  "legal_name": "xyz789",
  "name": "xyz789",
  "payment_methods": ["xyz789"],
  "reseller_id": "abc123",
  "role": CompanyRole,
  "roles": CompanyRoles,
  "sales_representative": CompanySalesRepresentative,
  "structure": CompanyStructure,
  "team": CompanyTeam,
  "user": Customer,
  "users": CompanyUsers,
  "vat_tax_id": "xyz789"
}

CompanyAclResource

Contains details about the access control list settings of a resource.

Fields

Example

{
  "children": [CompanyAclResource],
  "id": "4",
  "sort_order": 987,
  "text": "abc123"
}

CompanyAdminInput

Defines the input schema for creating a company administrator.

Input Fields

Example

{
  "custom_attributes": [AttributeValueInput],
  "email": "abc123",
  "firstname": "abc123",
  "gender": 123,
  "job_title": "abc123",
  "lastname": "xyz789",
  "telephone": "abc123"
}

CompanyBasicInfo

The minimal required information to identify and display the company.

Fields

Example

{
  "id": 4,
  "legal_name": "xyz789",
  "name": "xyz789"
}

CompanyCreateInput

Defines the input schema for creating a new company.

Input Fields

Example

{
  "company_admin": CompanyAdminInput,
  "company_email": "xyz789",
  "company_name": "xyz789",
  "legal_address": CompanyLegalAddressCreateInput,
  "legal_name": "xyz789",
  "reseller_id": "xyz789",
  "vat_tax_id": "xyz789"
}

CompanyCredit

Contains company credit balances and limits.

Fields

Example

{
  "available_credit": Money,
  "credit_limit": Money,
  "outstanding_balance": Money
}

CompanyCreditHistory

Contains details about prior company credit operations.

Fields

Example

{
  "items": [CompanyCreditOperation],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CompanyCreditHistoryFilterInput

Defines a filter for narrowing the results of a credit history search.

Input Fields

Example

{
  "custom_reference_number": "abc123",
  "operation_type": "ALLOCATION",
  "updated_by": "xyz789"
}

CompanyCreditOperation

Contains details about a single company credit operation.

Fields

Example

{
  "amount": Money,
  "balance": CompanyCredit,
  "custom_reference_number": "abc123",
  "date": "abc123",
  "type": "ALLOCATION",
  "updated_by": CompanyCreditOperationUser
}

CompanyCreditOperationType

Values

Example

""ALLOCATION""

CompanyCreditOperationUser

Defines the administrator or company user that submitted a company credit operation.

Fields

Example

{"name": "xyz789", "type": "CUSTOMER"}

CompanyCreditOperationUserType

Values

Example

""CUSTOMER""

CompanyInvitationInput

Defines the input schema for accepting the company invitation.

Input Fields

Example

{
  "code": "xyz789",
  "role_id": 4,
  "user": CompanyInvitationUserInput
}

CompanyInvitationOutput

The result of accepting the company invitation.

Fields

Example

{"success": true}

CompanyInvitationUserInput

Company user attributes in the invitation.

Input Fields

Example

{
  "company_id": "4",
  "customer_id": "4",
  "job_title": "xyz789",
  "status": "ACTIVE",
  "telephone": "abc123"
}

CompanyLegalAddress

Contains details about the address where the company is registered to conduct business.

Fields

Example

{
  "city": "abc123",
  "country_code": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegion,
  "street": ["xyz789"],
  "telephone": "abc123"
}

CompanyLegalAddressCreateInput

Defines the input schema for defining a company's legal address.

Input Fields

Example

{
  "city": "abc123",
  "country_id": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyLegalAddressUpdateInput

Defines the input schema for updating a company's legal address.

Input Fields

Example

{
  "city": "xyz789",
  "country_id": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyRole

Contails details about a single role.

Fields

Example

{
  "id": "4",
  "name": "abc123",
  "permissions": [CompanyAclResource],
  "users_count": 987
}

CompanyRoleCreateInput

Defines the input schema for creating a company role.

Input Fields

Example

{
  "name": "abc123",
  "permissions": ["abc123"]
}

CompanyRoleUpdateInput

Defines the input schema for updating a company role.

Input Fields

Example

{
  "id": "4",
  "name": "abc123",
  "permissions": ["xyz789"]
}

CompanyRoles

Contains an array of roles.

Fields

Example

{
  "items": [CompanyRole],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CompanySalesRepresentative

Contains details about a company sales representative.

Fields

Example

{
  "email": "xyz789",
  "firstname": "abc123",
  "lastname": "xyz789"
}

CompanyStructure

Contains an array of the individual nodes that comprise the company structure.

Fields

Example

{"items": [CompanyStructureItem]}

CompanyStructureEntity

Types

Example

CompanyTeam

CompanyStructureItem

Defines an individual node in the company structure.

Fields

Example

{
  "entity": CompanyTeam,
  "id": 4,
  "parent_id": "4"
}

CompanyStructureUpdateInput

Defines the input schema for updating the company structure.

Input Fields

Example

{"parent_tree_id": 4, "tree_id": 4}

CompanyTeam

Describes a company team.

Fields

Example

{
  "description": "xyz789",
  "id": 4,
  "name": "abc123",
  "structure_id": "4"
}

CompanyTeamCreateInput

Defines the input schema for creating a company team.

Input Fields

Example

{
  "description": "abc123",
  "name": "abc123",
  "target_id": 4
}

CompanyTeamUpdateInput

Defines the input schema for updating a company team.

Input Fields

Example

{
  "description": "abc123",
  "id": "4",
  "name": "abc123"
}

CompanyUpdateInput

Defines the input schema for updating a company.

Input Fields

Example

{
  "company_email": "abc123",
  "company_name": "abc123",
  "legal_address": CompanyLegalAddressUpdateInput,
  "legal_name": "abc123",
  "reseller_id": "abc123",
  "vat_tax_id": "xyz789"
}

CompanyUserCreateInput

Defines the input schema for creating a company user.

Input Fields

Example

{
  "email": "abc123",
  "firstname": "abc123",
  "job_title": "xyz789",
  "lastname": "abc123",
  "role_id": 4,
  "status": "ACTIVE",
  "target_id": "4",
  "telephone": "abc123"
}

CompanyUserStatusEnum

Defines the list of company user status values.

Values

Example

""ACTIVE""

CompanyUserUpdateInput

Defines the input schema for updating a company user.

Input Fields

Example

{
  "email": "xyz789",
  "firstname": "abc123",
  "id": 4,
  "job_title": "abc123",
  "lastname": "xyz789",
  "role_id": "4",
  "status": "ACTIVE",
  "telephone": "abc123"
}

CompanyUsers

Contains details about company users.

Fields

Example

{
  "items": [Customer],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CompanyUsersFilterInput

Defines the filter for returning a list of company users.

Input Fields

Example

{"status": "ACTIVE"}

ComparableAttribute

Contains an attribute code that is used for product comparisons.

Fields

Example

{
  "code": "abc123",
  "label": "abc123"
}

ComparableItem

Defines an object used to iterate through items for product comparisons.

Fields

Example

{
  "attributes": [ProductAttribute],
  "product": ProductInterface,
  "uid": 4
}

CompareList

Contains iterable information such as the array of items, the count, and attributes that represent the compare list.

Fields

Example

{
  "attributes": [ComparableAttribute],
  "item_count": 987,
  "items": [ComparableItem],
  "uid": 4
}

ComplexTextValue

Fields

Example

{"html": "abc123"}

ConfigurableAttributeOption

Contains details about a configurable product attribute option.

Fields

Example

{
  "code": "abc123",
  "label": "xyz789",
  "uid": "4",
  "value_index": 987
}

ConfigurableCartItem

An implementation for configurable product cart items.

Fields

Example

{
  "available_gift_wrapping": [GiftWrapping],
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "is_available": false,
  "max_qty": 987.65,
  "min_qty": 123.45,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": "4"
}

ConfigurableOptionAvailableForSelection

Describes configurable options that have been selected and can be selected as a result of the previous selections.

Fields

Example

{
  "attribute_code": "abc123",
  "option_value_uids": [4]
}

ConfigurableOrderItem

Fields

Example

{
  "discounts": [Discount],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "parent_sku": "xyz789",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 123.45,
  "quantity_returned": 123.45,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

ConfigurableProduct

Defines basic features of a configurable product and its simple product variants.

Fields

Example

{
  "activity": "abc123",
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "abc123",
  "collar": "abc123",
  "color": 987,
  "configurable_options": [ConfigurableProductOptions],
  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "eco_collection": 987,
  "erin_recommends": 123,
  "features_bags": "abc123",
  "format": 987,
  "gender": "xyz789",
  "gift_message_available": true,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 987,
  "material": "xyz789",
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "min_sale_qty": 987.65,
  "name": "xyz789",
  "new": 123,
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "abc123",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "quantity": 987.65,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "rules": [CatalogRule],
  "sale": 123,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "xyz789",
  "style_bottom": "xyz789",
  "style_general": "abc123",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "variants": [ConfigurableVariant],
  "websites": [Website],
  "weight": 987.65
}

ConfigurableProductCartItemInput

Input Fields

Example

{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "parent_sku": "xyz789",
  "variant_sku": "xyz789"
}

ConfigurableProductOption

Contains details about configurable product options.

Fields

Example

{
  "attribute_code": "xyz789",
  "label": "abc123",
  "uid": 4,
  "values": [ConfigurableProductOptionValue]
}

ConfigurableProductOptionValue

Defines a value for a configurable product option.

Fields

Example

{
  "is_available": true,
  "is_use_default": true,
  "label": "xyz789",
  "swatch": SwatchDataInterface,
  "uid": 4
}

ConfigurableProductOptions

Defines configurable attributes for the specified product.

Fields

Example

{
  "attribute_code": "xyz789",
  "attribute_id": "abc123",
  "attribute_id_v2": 987,
  "attribute_uid": 4,
  "id": 987,
  "label": "xyz789",
  "position": 123,
  "product_id": 987,
  "uid": "4",
  "use_default": true,
  "values": [ConfigurableProductOptionsValues]
}

ConfigurableProductOptionsSelection

Contains metadata corresponding to the selected configurable options.

Fields

Example

{
  "configurable_options": [ConfigurableProductOption],
  "media_gallery": [MediaGalleryInterface],
  "options_available_for_selection": [
    ConfigurableOptionAvailableForSelection
  ],
  "variant": SimpleProduct
}

ConfigurableProductOptionsValues

Contains the index number assigned to a configurable product option.

Fields

Example

{
  "default_label": "abc123",
  "label": "xyz789",
  "store_label": "abc123",
  "swatch_data": SwatchDataInterface,
  "uid": "4",
  "use_default_value": false,
  "value_index": 987
}

ConfigurableRequisitionListItem

Contains details about configurable products added to a requisition list.

Fields

Example

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

ConfigurableVariant

Contains all the simple product variants of a configurable product.

Fields

Example

{
  "attributes": [ConfigurableAttributeOption],
  "product": SimpleProduct
}

ConfigurableWishlistItem

A configurable product wish list item.

Fields

Example

{
  "added_at": "abc123",
  "child_sku": "abc123",
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "id": "4",
  "product": ProductInterface,
  "quantity": 123.45
}

ConfirmCancelOrderInput

Input Fields

Example

{
  "confirmation_key": "xyz789",
  "order_id": 4
}

ConfirmEmailInput

Contains details about a customer email address to confirm.

Input Fields

Example

{
  "confirmation_key": "abc123",
  "email": "xyz789"
}

ConfirmReturnInput

Input Fields

Example

{
  "confirmation_key": "abc123",
  "order_id": 4
}

ConfirmationStatusEnum

List of account confirmation statuses.

Values

Example

""ACCOUNT_CONFIRMED""

ContactUsInput

Input Fields

Example

{
  "comment": "abc123",
  "email": "abc123",
  "name": "xyz789",
  "telephone": "xyz789"
}

ContactUsOutput

Contains the status of the request.

Fields

Example

{"status": true}

CopyItemsBetweenRequisitionListsInput

An input object that defines the items in a requisition list to be copied.

Input Fields

Example

{"requisitionListItemUids": ["4"]}

CopyItemsFromRequisitionListsOutput

Output of the request to copy items to the destination requisition list.

Fields

Example

{"requisition_list": RequisitionList}

CopyProductsBetweenWishlistsOutput

Contains the source and target wish lists after copying products.

Fields

Example

{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

Country

Fields

Example

{
  "available_regions": [Region],
  "full_name_english": "abc123",
  "full_name_locale": "abc123",
  "id": "abc123",
  "three_letter_abbreviation": "abc123",
  "two_letter_abbreviation": "abc123"
}

CountryCodeEnum

The list of country codes.

Values

Example

""AF""

CreateCompanyOutput

Contains the response to the request to create a company.

Fields

Example

{"company": Company}

CreateCompanyRoleOutput

Contains the response to the request to create a company role.

Fields

Example

{"role": CompanyRole}

CreateCompanyTeamOutput

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

Fields

Example

{"team": CompanyTeam}

CreateCompanyUserOutput

Contains the response to the request to create a company user.

Fields

Example

{"user": Customer}

CreateCompareListInput

Contains an array of product IDs to use for creating a compare list.

Input Fields

Example

{"products": ["4"]}

CreateGiftRegistryInput

Defines a new gift registry.

Input Fields

Example

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

CreateGiftRegistryOutput

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

Fields

Example

{"gift_registry": GiftRegistry}

CreateGuestCartInput

Input Fields

Example

{"cart_uid": 4}

CreateGuestCartOutput

Fields

Example

{"cart": Cart}

CreatePayflowProTokenOutput

Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.

Fields

Example

{
  "response_message": "abc123",
  "result": 123,
  "result_code": 987,
  "secure_token": "abc123",
  "secure_token_id": "abc123"
}

CreatePaymentOrderInput

Contains payment order details that are used while processing the payment order

Input Fields

Example

{
  "cartId": "xyz789",
  "location": "PRODUCT_DETAIL",
  "methodCode": "abc123",
  "paymentSource": "abc123",
  "vaultIntent": false
}

CreatePaymentOrderOutput

Contains payment order details that are used while processing the payment order

Fields

Example

{
  "amount": 987.65,
  "currency_code": "abc123",
  "id": "abc123",
  "mp_order_id": "abc123",
  "status": "abc123"
}

CreateProductReviewInput

Defines a new product review.

Input Fields

Example

{
  "nickname": "xyz789",
  "ratings": [ProductReviewRatingInput],
  "sku": "xyz789",
  "summary": "abc123",
  "text": "abc123"
}

CreateProductReviewOutput

Contains the completed product review.

Fields

Example

{"review": ProductReview}

CreatePurchaseOrderApprovalRuleConditionAmountInput

Specifies the amount and currency to evaluate.

Input Fields

Example

{"currency": "AFN", "value": 123.45}

CreatePurchaseOrderApprovalRuleConditionInput

Defines a set of conditions that apply to a rule.

Input Fields

Example

{
  "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN",
  "quantity": 123
}

CreateRequisitionListInput

An input object that identifies and describes a new requisition list.

Input Fields

Example

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

CreateRequisitionListOutput

Output of the request to create a requisition list.

Fields

Example

{"requisition_list": RequisitionList}

CreateVaultCardPaymentTokenInput

Describe the variables needed to create a vault payment token

Input Fields

Example

{
  "card_description": "abc123",
  "setup_token_id": "xyz789"
}

CreateVaultCardPaymentTokenOutput

The vault token id and information about the payment source

Fields

Example

{
  "payment_source": PaymentSourceOutput,
  "vault_token_id": "abc123"
}

CreateVaultCardSetupTokenInput

Describe the variables needed to create a vault card setup token

Input Fields

Example

{
  "setup_token": VaultSetupTokenInput,
  "three_ds_mode": "OFF"
}

CreateVaultCardSetupTokenOutput

The setup token id information

Fields

Example

{"setup_token": "abc123"}

CreateWishlistInput

Defines the name and visibility of a new wish list.

Input Fields

Example

{"name": "xyz789", "visibility": "PUBLIC"}

CreateWishlistOutput

Contains the wish list.

Fields

Example

{"wishlist": Wishlist}

CreditCardDetailsInput

Required fields for Payflow Pro and Payments Pro credit card payments.

Input Fields

Example

{
  "cc_exp_month": 987,
  "cc_exp_year": 987,
  "cc_last_4": 123,
  "cc_type": "abc123"
}

CreditMemo

Contains credit memo details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": "4",
  "items": [CreditMemoItemInterface],
  "number": "abc123",
  "total": CreditMemoTotal
}

CreditMemoItem

Fields

Example

{
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 987.65
}

CreditMemoItemInterface

Credit memo item details.

Fields

Possible Types

Example

{
  "discounts": [Discount],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 987.65
}

CreditMemoTotal

Contains credit memo price details.

Fields

Example

{
  "adjustment": Money,
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

Currency

Fields

Example

{
  "available_currency_codes": ["abc123"],
  "base_currency_code": "abc123",
  "base_currency_symbol": "xyz789",
  "default_display_currecy_code": "abc123",
  "default_display_currecy_symbol": "xyz789",
  "default_display_currency_code": "abc123",
  "default_display_currency_symbol": "xyz789",
  "exchange_rates": [ExchangeRate]
}

CurrencyEnum

The list of available currency codes.

Values

Example

""AFN""

CustomAttributeMetadata

Defines an array of custom attributes.

Fields

Example

{"items": [Attribute]}

CustomAttributeMetadataInterface

An interface containing fields that define the EAV attribute.

Fields

Possible Types

Example

{
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "is_required": true,
  "is_unique": true,
  "label": "abc123",
  "options": [CustomAttributeOptionInterface]
}

CustomAttributeOptionInterface

Fields

Possible Types

Example

{
  "is_default": true,
  "label": "xyz789",
  "value": "abc123"
}

Customer

Defines the customer name, addresses, and other details.

Fields

Example

{
  "addresses": [CustomerAddress],
  "addressesV2": CustomerAddresses,
  "allow_remote_shopping_assistance": true,
  "companies": UserCompaniesOutput,
  "compare_list": CompareList,
  "confirmation_status": "ACCOUNT_CONFIRMED",
  "created_at": "xyz789",
  "custom_attributes": [AttributeValueInterface],
  "date_of_birth": "xyz789",
  "default_billing": "xyz789",
  "default_shipping": "xyz789",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "gift_registries": [GiftRegistry],
  "gift_registry": GiftRegistry,
  "group": CustomerGroup,
  "group_id": 123,
  "id": 987,
  "is_subscribed": true,
  "job_title": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "orders": CustomerOrders,
  "prefix": "abc123",
  "purchase_order": PurchaseOrder,
  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
  "purchase_orders": PurchaseOrders,
  "purchase_orders_enabled": false,
  "requisition_lists": RequisitionLists,
  "return": Return,
  "returns": Returns,
  "reviews": ProductReviews,
  "reward_points": RewardPoints,
  "role": CompanyRole,
  "segments": [CustomerSegment],
  "status": "ACTIVE",
  "store_credit": CustomerStoreCredit,
  "structure_id": "4",
  "suffix": "xyz789",
  "taxvat": "xyz789",
  "team": CompanyTeam,
  "telephone": "xyz789",
  "wishlist": Wishlist,
  "wishlist_v2": Wishlist,
  "wishlists": [Wishlist]
}

CustomerAddress

Contains detailed information about a customer's billing or shipping address.

Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "country_id": "abc123",
  "custom_attributes": [CustomerAddressAttribute],
  "custom_attributesV2": [AttributeValueInterface],
  "customer_id": 123,
  "default_billing": true,
  "default_shipping": true,
  "extension_attributes": [CustomerAddressAttribute],
  "fax": "abc123",
  "firstname": "abc123",
  "id": 987,
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": CustomerAddressRegion,
  "region_id": 987,
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CustomerAddressAttribute

Specifies the attribute code and value of a customer address attribute.

Fields

Example

{
  "attribute_code": "abc123",
  "value": "xyz789"
}

CustomerAddressAttributeInput

Specifies the attribute code and value of a customer attribute.

Input Fields

Example

{
  "attribute_code": "abc123",
  "value": "abc123"
}

CustomerAddressInput

Contains details about a billing or shipping address.

Input Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "AF",
  "country_id": "AF",
  "custom_attributes": [CustomerAddressAttributeInput],
  "custom_attributesV2": [AttributeValueInput],
  "default_billing": false,
  "default_shipping": true,
  "fax": "xyz789",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CustomerAddressRegionInput,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CustomerAddressRegion

Defines the customer's state or province.

Fields

Example

{
  "region": "abc123",
  "region_code": "abc123",
  "region_id": 123
}

CustomerAddressRegionInput

Defines the customer's state or province.

Input Fields

Example

{
  "region": "xyz789",
  "region_code": "abc123",
  "region_id": 987
}

CustomerAddresses

Fields

Example

{
  "items": [CustomerAddress],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CustomerAttributeMetadata

Customer attribute metadata.

Fields

Example

{
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": false,
  "is_unique": true,
  "label": "xyz789",
  "multiline_count": 123,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 123,
  "validate_rules": [ValidationRule]
}

CustomerCreateInput

An input object for creating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": true,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": false,
  "lastname": "abc123",
  "middlename": "xyz789",
  "password": "xyz789",
  "prefix": "xyz789",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomerDownloadableProduct

Contains details about a single downloadable product.

Fields

Example

{
  "date": "abc123",
  "download_url": "xyz789",
  "order_increment_id": "abc123",
  "remaining_downloads": "xyz789",
  "status": "xyz789"
}

CustomerDownloadableProducts

Contains a list of downloadable products.

Fields

Example

{"items": [CustomerDownloadableProduct]}

CustomerGroup

Data of customer group.

Fields

Example

{"name": "abc123"}

CustomerInput

An input object that assigns or updates customer attributes.

Input Fields

Example

{
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "abc123",
  "password": "xyz789",
  "prefix": "abc123",
  "suffix": "abc123",
  "taxvat": "abc123"
}

CustomerOrder

Contains details about each of the customer's orders.

Fields

Example

{
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [ApplyGiftCardToOrder],
  "available_actions": ["REORDER"],
  "billing_address": OrderAddress,
  "carrier": "xyz789",
  "comments": [SalesCommentItem],
  "created_at": "abc123",
  "credit_memos": [CreditMemo],
  "customer_info": OrderCustomerInfo,
  "email": "abc123",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "grand_total": 123.45,
  "id": 4,
  "increment_id": "abc123",
  "invoices": [Invoice],
  "is_virtual": true,
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "number": "xyz789",
  "order_date": "abc123",
  "order_number": "abc123",
  "order_status_change_date": "abc123",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": false,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "abc123",
  "status": "abc123",
  "token": "abc123",
  "total": OrderTotal
}

CustomerOrderSortInput

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Input Fields

Example

{"sort_direction": "ASC", "sort_field": "NUMBER"}

CustomerOrderSortableField

Specifies the field to use for sorting

Values

Example

""NUMBER""

CustomerOrders

The collection of orders that match the conditions defined in the filter.

Fields

Example

{
  "date_of_first_order": "xyz789",
  "items": [CustomerOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CustomerOrdersFilterInput

Identifies the filter to use for filtering orders.

Input Fields

Example

{
  "grand_total": FilterRangeTypeInput,
  "number": FilterStringTypeInput,
  "order_date": FilterRangeTypeInput,
  "status": FilterEqualTypeInput
}

CustomerOutput

Contains details about a newly-created or updated customer.

Fields

Example

{"customer": Customer}

CustomerPaymentTokens

Contains payment tokens stored in the customer's vault.

Fields

Example

{"items": [PaymentToken]}

CustomerSegment

Customer segment.

Fields

Example

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

CustomerSegmentApplyTo

Customer segment is applicable to visitor, registered customers or both.

Values

Example

""BOTH""

CustomerStoreCredit

Contains store credit information with balance and history.

Fields

Example

{
  "balance_history": CustomerStoreCreditHistory,
  "current_balance": Money,
  "enabled": true
}

CustomerStoreCreditHistory

Lists changes to the amount of store credit available to the customer.

Fields

Example

{
  "items": [CustomerStoreCreditHistoryItem],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerStoreCreditHistoryItem

Contains store credit history information.

Fields

Example

{
  "action": "xyz789",
  "actual_balance": Money,
  "balance_change": Money,
  "date_time_changed": "xyz789"
}

CustomerToken

Contains a customer authorization token.

Fields

Example

{"token": "abc123"}

CustomerUpdateInput

An input object for updating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": true,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "xyz789",
  "dob": "abc123",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": false,
  "lastname": "abc123",
  "middlename": "abc123",
  "prefix": "abc123",
  "suffix": "xyz789",
  "taxvat": "xyz789"
}

CustomizableAreaOption

Contains information about a text area that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "product_sku": "abc123",
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableAreaValue
}

CustomizableAreaValue

Defines the price and sku of a product whose page contains a customized text area.

Fields

Example

{
  "max_characters": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": "4"
}

CustomizableCheckboxOption

Contains information about a set of checkbox values that are defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableCheckboxValue]
}

CustomizableCheckboxValue

Defines the price and sku of a product whose page contains a customized set of checkbox values.

Fields

Example

{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 123,
  "title": "xyz789",
  "uid": "4"
}

CustomizableDateOption

Contains information about a date picker that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": CustomizableDateValue
}

CustomizableDateTypeEnum

Defines the customizable date type.

Values

Example

""DATE""

CustomizableDateValue

Defines the price and sku of a product whose page contains a customized date picker.

Fields

Example

{
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "type": "DATE",
  "uid": "4"
}

CustomizableDropDownOption

Contains information about a drop down menu that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableDropDownValue]
}

CustomizableDropDownValue

Defines the price and sku of a product whose page contains a customized drop down menu.

Fields

Example

{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "xyz789",
  "uid": "4"
}

CustomizableFieldOption

Contains information about a text field that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableFieldValue
}

CustomizableFieldValue

Defines the price and sku of a product whose page contains a customized text field.

Fields

Example

{
  "max_characters": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": 4
}

CustomizableFileOption

Contains information about a file picker that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 987,
  "title": "xyz789",
  "uid": "4",
  "value": CustomizableFileValue
}

CustomizableFileValue

Defines the price and sku of a product whose page contains a customized file picker.

Fields

Example

{
  "file_extension": "abc123",
  "image_size_x": 123,
  "image_size_y": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": 4
}

CustomizableMultipleOption

Contains information about a multiselect that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 987,
  "required": true,
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4,
  "value": [CustomizableMultipleValue]
}

CustomizableMultipleValue

Defines the price and sku of a product whose page contains a customized multiselect.

Fields

Example

{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "abc123",
  "uid": "4"
}

CustomizableOptionInput

Defines a customizable option.

Input Fields

Example

{
  "id": 987,
  "uid": "4",
  "value_string": "xyz789"
}

CustomizableOptionInterface

Contains basic information about a customizable option. It can be implemented by several types of configurable options.

Fields

Possible Types

Example

{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4
}

CustomizableProductInterface

Contains information about customizable product options.

Fields

Possible Types

Example

{"options": [CustomizableOptionInterface]}

CustomizableRadioOption

Contains information about a set of radio buttons that are defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "required": true,
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4,
  "value": [CustomizableRadioValue]
}

CustomizableRadioValue

Defines the price and sku of a product whose page contains a customized set of radio buttons.

Fields

Example

{
  "option_type_id": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4
}

DeleteCompanyRoleOutput

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

Fields

Example

{"success": true}

DeleteCompanyTeamOutput

Contains the status of the request to delete a company team.

Fields

Example

{"success": false}

DeleteCompanyUserOutput

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

Fields

Example

{"success": true}

DeleteCompareListOutput

Contains the results of the request to delete a compare list.

Fields

Example

{"result": true}

DeleteNegotiableQuoteError

Types

Example

NegotiableQuoteInvalidStateError

DeleteNegotiableQuoteOperationFailure

Contains details about a failed delete operation on a negotiable quote.

Fields

Example

{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": 4
}

DeleteNegotiableQuoteOperationResult

Types

Example

NegotiableQuoteUidOperationSuccess

DeleteNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to delete

Input Fields

Example

{"template_id": "4"}

DeleteNegotiableQuotesInput

Input Fields

Example

{"quote_uids": ["4"]}

DeleteNegotiableQuotesOutput

Contains a list of undeleted negotiable quotes the company user can view.

Fields

Example

{
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

DeletePaymentTokenOutput

Indicates whether the request succeeded and returns the remaining customer payment tokens.

Fields

Example

{
  "customerPaymentTokens": CustomerPaymentTokens,
  "result": true
}

DeletePurchaseOrderApprovalRuleError

Contains details about an error that occurred when deleting an approval rule .

Fields

Example

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

DeletePurchaseOrderApprovalRuleErrorType

Values

Example

""UNDEFINED""

DeletePurchaseOrderApprovalRuleInput

Specifies the IDs of the approval rules to delete.

Input Fields

Example

{"approval_rule_uids": [4]}

DeletePurchaseOrderApprovalRuleOutput

Contains any errors encountered while attempting to delete approval rules.

Fields

Example

{"errors": [DeletePurchaseOrderApprovalRuleError]}

DeleteRequisitionListItemsOutput

Output of the request to remove items from the requisition list.

Fields

Example

{"requisition_list": RequisitionList}

DeleteRequisitionListOutput

Indicates whether the request to delete the requisition list was successful.

Fields

Example

{"requisition_lists": RequisitionLists, "status": true}

DeleteWishlistOutput

Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.

Fields

Example

{"status": false, "wishlists": [Wishlist]}

Discount

Specifies the discount type and value for quote line item.

Fields

Example

{
  "amount": Money,
  "applied_to": "ITEM",
  "coupon": AppliedCoupon,
  "is_discounting_locked": false,
  "label": "xyz789",
  "type": "abc123",
  "value": 987.65
}

DownloadableCartItem

An implementation for downloadable product cart items.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": true,
  "links": [DownloadableProductLinks],
  "max_qty": 987.65,
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "samples": [DownloadableProductSamples],
  "uid": "4"
}

DownloadableCreditMemoItem

Defines downloadable product options for CreditMemoItemInterface.

Fields

Example

{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_refunded": 123.45
}

DownloadableFileTypeEnum

Values

Example

""FILE""

DownloadableInvoiceItem

Defines downloadable product options for InvoiceItemInterface.

Fields

Example

{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 987.65
}

DownloadableItemsLinks

Defines characteristics of the links for downloadable product.

Fields

Example

{
  "sort_order": 987,
  "title": "abc123",
  "uid": "4"
}

DownloadableOrderItem

Defines downloadable product options for OrderItemInterface.

Fields

Example

{
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

DownloadableProduct

Defines a product that the shopper downloads.

Fields

Example

{
  "activity": "abc123",
  "attribute_set_id": 987,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "xyz789",
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "downloadable_product_links": [
    DownloadableProductLinks
  ],
  "downloadable_product_samples": [
    DownloadableProductSamples
  ],
  "eco_collection": 987,
  "erin_recommends": 987,
  "features_bags": "xyz789",
  "format": 123,
  "gender": "xyz789",
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "links_purchased_separately": 123,
  "links_title": "abc123",
  "manufacturer": 987,
  "material": "abc123",
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new": 123,
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "abc123",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "quantity": 123.45,
  "rating_summary": 123.45,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "rules": [CatalogRule],
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "xyz789",
  "style_bottom": "xyz789",
  "style_general": "abc123",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

DownloadableProductCartItemInput

Defines a single downloadable product.

Input Fields

Example

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

DownloadableProductLinks

Defines characteristics of a downloadable product.

Fields

Example

{
  "id": 987,
  "is_shareable": false,
  "link_type": "FILE",
  "number_of_downloads": 123,
  "price": 987.65,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "abc123",
  "sort_order": 123,
  "title": "abc123",
  "uid": "4"
}

DownloadableProductLinksInput

Contains the link ID for the downloadable product.

Input Fields

Example

{"link_id": 123}

DownloadableProductSamples

Defines characteristics of a downloadable product.

Fields

Example

{
  "id": 123,
  "sample_file": "abc123",
  "sample_type": "FILE",
  "sample_url": "xyz789",
  "sort_order": 123,
  "title": "xyz789"
}

DownloadableRequisitionListItem

Contains details about downloadable products added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "links": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples],
  "uid": 4
}

DownloadableWishlistItem

A downloadable product wish list item.

Fields

Example

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

DuplicateNegotiableQuoteInput

Identifies a quote to be duplicated

Input Fields

Example

{
  "duplicated_quote_uid": 4,
  "quote_uid": "4"
}

DuplicateNegotiableQuoteOutput

Contains the newly created negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

DynamicBlock

Contains a single dynamic block.

Fields

Example

{
  "content": ComplexTextValue,
  "uid": "4"
}

DynamicBlockLocationEnum

Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.

Values

Example

""CONTENT""

DynamicBlockTypeEnum

Indicates the selected Dynamic Blocks Rotator inline widget.

Values

Example

""SPECIFIED""

DynamicBlocks

Contains an array of dynamic blocks.

Fields

Example

{
  "items": [DynamicBlock],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

DynamicBlocksFilterInput

Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

Input Fields

Example

{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"}

EnteredCustomAttributeInput

Contains details about a custom text attribute that the buyer entered.

Input Fields

Example

{
  "attribute_code": "xyz789",
  "value": "abc123"
}

EnteredOptionInput

Defines a customer-entered option.

Input Fields

Example

{
  "uid": "4",
  "value": "xyz789"
}

EntityUrl

Contains the uid, relative_url, and type attributes.

Fields

Example

{
  "canonical_url": "abc123",
  "entity_uid": 4,
  "id": 123,
  "redirectCode": 123,
  "relative_url": "abc123",
  "type": "CMS_PAGE"
}

Error

An error encountered while adding an item to the the cart.

Fields

Possible Types

Example

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

ErrorInterface

Fields

Possible Types

Example

{"message": "abc123"}

EstimateAddressInput

Contains details about an address.

Input Fields

Example

{
  "country_code": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput
}

EstimateTotalsInput

Input Fields

Example

{
  "address": EstimateAddressInput,
  "cart_id": "xyz789",
  "shipping_method": ShippingMethodInput
}

EstimateTotalsOutput

Estimate totals output.

Fields

Example

{"cart": Cart}

ExchangeRate

Lists the exchange rate.

Fields

Example

{"currency_to": "abc123", "rate": 123.45}

createEmptyCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Example

{"cart_id": "xyz789"}