Adobe Developer
Adobe Commerce as a Cloud Service GraphQL API
The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries.
API Endpoint
https://<location>.api.commerce.adobe.com/<tenant-id>/graphqlHeaders
For header information, refer to GraphQL headers.
Version
SaaS
Queries
attributeMetadata
Description
Return a list of product attribute codes that can be used for sorting or filtering in a productSearch query
Response
Returns an AttributeMetadataResponse!
Example
Query
query attributeMetadata {
attributeMetadata {
filterableInSearch {
...FilterableInSearchAttributeFragment
}
sortable {
...SortableAttributeFragment
}
}
}
Response
{
"data": {
"attributeMetadata": {
"filterableInSearch": [FilterableInSearchAttribute],
"sortable": [SortableAttribute]
}
}
}
attributesForm
Description
Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.
Response
Returns an AttributesFormOutput!
Arguments
| Name | Description |
|---|---|
formCode - String!
|
Form code. |
Example
Query
query attributesForm($formCode: String!) {
attributesForm(formCode: $formCode) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{"formCode": "xyz789"}
Response
{
"data": {
"attributesForm": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
attributesList
Description
Returns a list of attributes metadata for a given entity type.
Response
Returns an AttributesMetadataOutput
Arguments
| Name | Description |
|---|---|
entityType - AttributeEntityTypeEnum!
|
Entity type. |
filters - AttributeFilterInput
|
Identifies which filter inputs to search for and return. |
Example
Query
query attributesList(
$entityType: AttributeEntityTypeEnum!,
$filters: AttributeFilterInput
) {
attributesList(
entityType: $entityType,
filters: $filters
) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{
"entityType": "CATALOG_PRODUCT",
"filters": AttributeFilterInput
}
Response
{
"data": {
"attributesList": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
availableStores
Description
Get a list of available store views and their config information.
Response
Returns [StoreConfig]
Arguments
| Name | Description |
|---|---|
useCurrentGroup - Boolean
|
Filter store views by the current store group. |
Example
Query
query availableStores($useCurrentGroup: Boolean) {
availableStores(useCurrentGroup: $useCurrentGroup) {
allow_gift_receipt
allow_gift_wrapping_on_order
allow_gift_wrapping_on_order_items
allow_items
allow_order
allow_printed_card
autocomplete_on_storefront
base_currency_code
base_link_url
base_media_url
base_static_url
base_url
cart_expires_in_days
cart_gift_wrapping
cart_merge_preference
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
category_fixed_product_tax_display_setting
category_url_suffix
check_money_order_enable_for_specific_countries
check_money_order_enabled
check_money_order_make_check_payable_to
check_money_order_max_order_total
check_money_order_min_order_total
check_money_order_new_order_status
check_money_order_payment_from_specific_countries
check_money_order_send_check_to
check_money_order_sort_order
check_money_order_title
configurable_product_image
configurable_thumbnail_source
contact_enabled
countries_with_required_region
create_account_confirmation
customer_access_token_lifetime
default_country
default_display_currency_code
display_product_prices_in_catalog
display_shipping_prices
display_state_if_optional
enable_multiple_wishlists
fixed_product_taxes_apply_tax_to_fpt
fixed_product_taxes_display_prices_in_emails
fixed_product_taxes_display_prices_in_product_lists
fixed_product_taxes_display_prices_in_sales_modules
fixed_product_taxes_display_prices_on_product_view_page
fixed_product_taxes_enable
fixed_product_taxes_include_fpt_in_subtotal
graphql_share_customer_group
grid_per_page
grid_per_page_values
grouped_product_image
is_checkout_agreements_enabled
is_default_store
is_default_store_group
is_guest_checkout_enabled
is_negotiable_quote_active
is_one_page_checkout_enabled
is_requisition_list_active
list_mode
list_per_page
list_per_page_values
locale
magento_reward_general_is_enabled
magento_reward_general_is_enabled_on_front
magento_reward_general_min_points_balance
magento_reward_general_publish_history
magento_reward_points_invitation_customer
magento_reward_points_invitation_customer_limit
magento_reward_points_invitation_order
magento_reward_points_invitation_order_limit
magento_reward_points_newsletter
magento_reward_points_order
magento_reward_points_register
magento_reward_points_review
magento_reward_points_review_limit
magento_wishlist_general_is_enabled
max_items_in_order_summary
maximum_number_of_wishlists
minicart_display
minicart_max_items
minimum_password_length
newsletter_enabled
optional_zip_countries
order_cancellation_enabled
order_cancellation_reasons {
...CancellationReasonFragment
}
orders_invoices_credit_memos_display_full_summary
orders_invoices_credit_memos_display_grandtotal
orders_invoices_credit_memos_display_price
orders_invoices_credit_memos_display_shipping_amount
orders_invoices_credit_memos_display_subtotal
orders_invoices_credit_memos_display_zero_tax
printed_card_priceV2 {
...MoneyFragment
}
product_fixed_product_tax_display_setting
product_url_suffix
quickorder_active
required_character_classes_number
returns_enabled
root_category_uid
sales_fixed_product_tax_display_setting
sales_gift_wrapping
sales_printed_card
secure_base_link_url
secure_base_media_url
secure_base_static_url
secure_base_url
share_active_segments
share_applied_cart_rule
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
shopping_cart_display_shipping
shopping_cart_display_subtotal
shopping_cart_display_tax_gift_wrapping
shopping_cart_display_zero_tax
store_code
store_group_code
store_group_name
store_name
store_sort_order
timezone
title_separator
use_store_in_url
website_code
website_name
weight_unit
zero_subtotal_enable_for_specific_countries
zero_subtotal_enabled
zero_subtotal_new_order_status
zero_subtotal_payment_action
zero_subtotal_payment_from_specific_countries
zero_subtotal_sort_order
zero_subtotal_title
}
}
Variables
{"useCurrentGroup": true}
Response
{
"data": {
"availableStores": [
{
"allow_gift_receipt": "abc123",
"allow_gift_wrapping_on_order": "abc123",
"allow_gift_wrapping_on_order_items": "xyz789",
"allow_items": "abc123",
"allow_order": "xyz789",
"allow_printed_card": "abc123",
"autocomplete_on_storefront": true,
"base_currency_code": "abc123",
"base_link_url": "abc123",
"base_media_url": "xyz789",
"base_static_url": "xyz789",
"base_url": "abc123",
"cart_expires_in_days": 123,
"cart_gift_wrapping": "abc123",
"cart_merge_preference": "xyz789",
"cart_printed_card": "abc123",
"cart_summary_display_quantity": 123,
"catalog_default_sort_by": "xyz789",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "abc123",
"check_money_order_enable_for_specific_countries": false,
"check_money_order_enabled": true,
"check_money_order_make_check_payable_to": "xyz789",
"check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "xyz789",
"check_money_order_payment_from_specific_countries": "abc123",
"check_money_order_send_check_to": "xyz789",
"check_money_order_sort_order": 123,
"check_money_order_title": "xyz789",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "xyz789",
"contact_enabled": true,
"countries_with_required_region": "abc123",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
"default_display_currency_code": "xyz789",
"display_product_prices_in_catalog": 987,
"display_shipping_prices": 123,
"display_state_if_optional": false,
"enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": true,
"fixed_product_taxes_display_prices_in_emails": 123,
"fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 123,
"fixed_product_taxes_display_prices_on_product_view_page": 123,
"fixed_product_taxes_enable": false,
"fixed_product_taxes_include_fpt_in_subtotal": false,
"graphql_share_customer_group": false,
"grid_per_page": 123,
"grid_per_page_values": "abc123",
"grouped_product_image": "ITSELF",
"is_checkout_agreements_enabled": true,
"is_default_store": true,
"is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": true,
"is_one_page_checkout_enabled": false,
"is_requisition_list_active": "abc123",
"list_mode": "xyz789",
"list_per_page": 123,
"list_per_page_values": "xyz789",
"locale": "xyz789",
"magento_reward_general_is_enabled": "abc123",
"magento_reward_general_is_enabled_on_front": "xyz789",
"magento_reward_general_min_points_balance": "abc123",
"magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "abc123",
"magento_reward_points_invitation_customer_limit": "xyz789",
"magento_reward_points_invitation_order": "abc123",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "abc123",
"magento_reward_points_order": "abc123",
"magento_reward_points_register": "xyz789",
"magento_reward_points_review": "xyz789",
"magento_reward_points_review_limit": "abc123",
"magento_wishlist_general_is_enabled": "abc123",
"max_items_in_order_summary": 123,
"maximum_number_of_wishlists": "xyz789",
"minicart_display": false,
"minicart_max_items": 123,
"minimum_password_length": "abc123",
"newsletter_enabled": false,
"optional_zip_countries": "xyz789",
"order_cancellation_enabled": true,
"order_cancellation_reasons": [
CancellationReason
],
"orders_invoices_credit_memos_display_full_summary": true,
"orders_invoices_credit_memos_display_grandtotal": false,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 987,
"orders_invoices_credit_memos_display_subtotal": 123,
"orders_invoices_credit_memos_display_zero_tax": false,
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_url_suffix": "abc123",
"quickorder_active": false,
"required_character_classes_number": "abc123",
"returns_enabled": "xyz789",
"root_category_uid": 4,
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"sales_gift_wrapping": "abc123",
"sales_printed_card": "xyz789",
"secure_base_link_url": "abc123",
"secure_base_media_url": "xyz789",
"secure_base_static_url": "xyz789",
"secure_base_url": "abc123",
"share_active_segments": false,
"share_applied_cart_rule": false,
"shopping_cart_display_full_summary": true,
"shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
"shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": false,
"store_code": 4,
"store_group_code": "4",
"store_group_name": "xyz789",
"store_name": "abc123",
"store_sort_order": 123,
"timezone": "xyz789",
"title_separator": "xyz789",
"use_store_in_url": true,
"website_code": "4",
"website_name": "abc123",
"weight_unit": "abc123",
"zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": true,
"zero_subtotal_new_order_status": "abc123",
"zero_subtotal_payment_action": "xyz789",
"zero_subtotal_payment_from_specific_countries": "abc123",
"zero_subtotal_sort_order": 123,
"zero_subtotal_title": "abc123"
}
]
}
}
cart
Description
Return information about the specified shopping cart.
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
cart_id - String!
|
The unique ID of the cart to query. |
Example
Query
query cart($cart_id: String!) {
cart(cart_id: $cart_id) {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
custom_attributes {
...CustomAttributeFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
rules {
...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{"cart_id": "xyz789"}
Response
{
"data": {
"cart": {
"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,
"custom_attributes": [CustomAttribute],
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": true,
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 987.65
}
}
}
categories
This field is deprecated and will be removed.
Response
Returns [CategoryView]
Example
Query
query categories(
$ids: [String!],
$roles: [String!],
$subtree: Subtree
) {
categories(
ids: $ids,
roles: $roles,
subtree: $subtree
) {
availableSortBy
children
defaultSortBy
id
level
name
parentId
path
roles
urlKey
urlPath
count
title
}
}
Variables
{
"ids": ["xyz789"],
"roles": ["xyz789"],
"subtree": Subtree
}
Response
{
"data": {
"categories": [
{
"availableSortBy": ["abc123"],
"children": ["xyz789"],
"defaultSortBy": "xyz789",
"id": 4,
"level": 987,
"name": "xyz789",
"parentId": "xyz789",
"path": "xyz789",
"roles": ["abc123"],
"urlKey": "abc123",
"urlPath": "xyz789",
"count": 123,
"title": "xyz789"
}
]
}
}
checkoutAgreements
Description
Return Terms and Conditions configuration information.
Response
Returns [CheckoutAgreement]
Example
Query
query checkoutAgreements {
checkoutAgreements {
agreement_id
checkbox_text
content
content_height
is_html
mode
name
}
}
Response
{
"data": {
"checkoutAgreements": [
{
"agreement_id": 987,
"checkbox_text": "abc123",
"content": "abc123",
"content_height": "abc123",
"is_html": true,
"mode": "AUTO",
"name": "xyz789"
}
]
}
}
company
Description
Return detailed information about the customer's company within the current company context.
Response
Returns a Company
Example
Query
query company {
company {
acl_resources {
...CompanyAclResourceFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
available_shipping_methods {
...CompanyAvailableShippingMethodFragment
}
company_admin {
...CustomerFragment
}
credit {
...CompanyCreditFragment
}
credit_history {
...CompanyCreditHistoryFragment
}
custom_attributes {
...CustomAttributeFragment
}
email
id
legal_address {
...CompanyLegalAddressFragment
}
legal_name
name
payment_methods
reseller_id
role {
...CompanyRoleFragment
}
roles {
...CompanyRolesFragment
}
sales_representative {
...CompanySalesRepresentativeFragment
}
structure {
...CompanyStructureFragment
}
team {
...CompanyTeamFragment
}
user {
...CustomerFragment
}
users {
...CompanyUsersFragment
}
vat_tax_id
}
}
Response
{
"data": {
"company": {
"acl_resources": [CompanyAclResource],
"available_payment_methods": [
AvailablePaymentMethod
],
"available_shipping_methods": [
CompanyAvailableShippingMethod
],
"company_admin": Customer,
"credit": CompanyCredit,
"credit_history": CompanyCreditHistory,
"custom_attributes": [CustomAttribute],
"email": "xyz789",
"id": "4",
"legal_address": CompanyLegalAddress,
"legal_name": "abc123",
"name": "abc123",
"payment_methods": ["xyz789"],
"reseller_id": "xyz789",
"role": CompanyRole,
"roles": CompanyRoles,
"sales_representative": CompanySalesRepresentative,
"structure": CompanyStructure,
"team": CompanyTeam,
"user": Customer,
"users": CompanyUsers,
"vat_tax_id": "xyz789"
}
}
}
compareList
Description
Return products that have been added to the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be queried. |
Example
Query
query compareList($uid: ID!) {
compareList(uid: $uid) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"compareList": {
"attributes": [ComparableAttribute],
"item_count": 123,
"items": [ComparableItem],
"uid": 4
}
}
}
countries
Description
The countries query provides information for all countries.
Response
Returns [Country]
Example
Query
query countries {
countries {
available_regions {
...RegionFragment
}
full_name_english
full_name_locale
id
three_letter_abbreviation
two_letter_abbreviation
}
}
Response
{
"data": {
"countries": [
{
"available_regions": [Region],
"full_name_english": "abc123",
"full_name_locale": "abc123",
"id": "xyz789",
"three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "xyz789"
}
]
}
}
country
Description
The countries query provides information for a single country.
Example
Query
query country($id: String) {
country(id: $id) {
available_regions {
...RegionFragment
}
full_name_english
full_name_locale
id
three_letter_abbreviation
two_letter_abbreviation
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"country": {
"available_regions": [Region],
"full_name_english": "abc123",
"full_name_locale": "xyz789",
"id": "xyz789",
"three_letter_abbreviation": "abc123",
"two_letter_abbreviation": "xyz789"
}
}
}
currency
Description
Return information about the store's currency.
Response
Returns a Currency
Example
Query
query currency {
currency {
available_currency_codes
base_currency_code
base_currency_symbol
default_display_currency_code
default_display_currency_symbol
exchange_rates {
...ExchangeRateFragment
}
}
}
Response
{
"data": {
"currency": {
"available_currency_codes": [
"abc123"
],
"base_currency_code": "xyz789",
"base_currency_symbol": "xyz789",
"default_display_currency_code": "xyz789",
"default_display_currency_symbol": "xyz789",
"exchange_rates": [ExchangeRate]
}
}
}
customAttributeMetadataV2
Description
Retrieve EAV attributes metadata.
Response
Returns an AttributesMetadataOutput!
Arguments
| Name | Description |
|---|---|
attributes - [AttributeInput!]
|
Example
Query
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
customAttributeMetadataV2(attributes: $attributes) {
errors {
...AttributeMetadataErrorFragment
}
items {
...CustomAttributeMetadataInterfaceFragment
}
}
}
Variables
{"attributes": [AttributeInput]}
Response
{
"data": {
"customAttributeMetadataV2": {
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
}
}
customer
Description
Return detailed information about a customer account.
Response
Returns a Customer
Example
Query
query customer {
customer {
addresses {
...CustomerAddressFragment
}
addressesV2 {
...CustomerAddressesFragment
}
allow_remote_shopping_assistance
companies {
...UserCompaniesOutputFragment
}
compare_list {
...CompareListFragment
}
confirmation_status
created_at
custom_attributes {
...AttributeValueInterfaceFragment
}
date_of_birth
default_billing
default_shipping
email
firstname
gender
gift_registries {
...GiftRegistryFragment
}
gift_registry {
...GiftRegistryFragment
}
group {
...CustomerGroupStorefrontFragment
}
is_subscribed
job_title
lastname
middlename
orders {
...CustomerOrdersFragment
}
prefix
purchase_order {
...PurchaseOrderFragment
}
purchase_order_approval_rule {
...PurchaseOrderApprovalRuleFragment
}
purchase_order_approval_rule_metadata {
...PurchaseOrderApprovalRuleMetadataFragment
}
purchase_order_approval_rules {
...PurchaseOrderApprovalRulesFragment
}
purchase_orders {
...PurchaseOrdersFragment
}
purchase_orders_enabled
requisition_lists {
...RequisitionListsFragment
}
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
reward_points {
...RewardPointsFragment
}
role {
...CompanyRoleFragment
}
segments {
...CustomerSegmentStorefrontFragment
}
status
store_credit {
...CustomerStoreCreditFragment
}
structure_id
suffix
taxvat
team {
...CompanyTeamFragment
}
telephone
wishlist_v2 {
...WishlistFragment
}
wishlists {
...WishlistFragment
}
}
}
Response
{
"data": {
"customer": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
"allow_remote_shopping_assistance": false,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "xyz789",
"default_billing": "xyz789",
"default_shipping": "abc123",
"email": "abc123",
"firstname": "xyz789",
"gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group": CustomerGroupStorefront,
"is_subscribed": false,
"job_title": "xyz789",
"lastname": "abc123",
"middlename": "abc123",
"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,
"reward_points": RewardPoints,
"role": CompanyRole,
"segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
"suffix": "abc123",
"taxvat": "xyz789",
"team": CompanyTeam,
"telephone": "abc123",
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
}
}
customerCart
Description
Return information about the customer's shopping cart.
Response
Returns a Cart!
Example
Query
query customerCart {
customerCart {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
custom_attributes {
...CustomAttributeFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
rules {
...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Response
{
"data": {
"customerCart": {
"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,
"custom_attributes": [CustomAttribute],
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": true,
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": false,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 987.65
}
}
}
customerDownloadableProducts
Description
Return a list of downloadable products the customer has purchased.
Response
Returns a CustomerDownloadableProducts
Example
Query
query customerDownloadableProducts {
customerDownloadableProducts {
items {
...CustomerDownloadableProductFragment
}
}
}
Response
{
"data": {
"customerDownloadableProducts": {
"items": [CustomerDownloadableProduct]
}
}
}
customerGroup
Description
Provides Customer Group assigned to the Customer or Guest.
Response
Returns a CustomerGroupStorefront!
Example
Query
query customerGroup {
customerGroup {
uid
}
}
Response
{"data": {"customerGroup": {"uid": 4}}}
customerPaymentTokens
Description
Return a list of customer payment tokens stored in the vault.
Response
Returns a CustomerPaymentTokens
Example
Query
query customerPaymentTokens {
customerPaymentTokens {
items {
...PaymentTokenFragment
}
}
}
Response
{
"data": {
"customerPaymentTokens": {"items": [PaymentToken]}
}
}
customerSegments
Description
Customer segments associated with the current customer or guest/visitor.
Response
Returns [CustomerSegmentStorefront]
Arguments
| Name | Description |
|---|---|
cartId - String!
|
The unique ID of the cart to query. |
Example
Query
query customerSegments($cartId: String!) {
customerSegments(cartId: $cartId) {
uid
}
}
Variables
{"cartId": "xyz789"}
Response
{"data": {"customerSegments": [{"uid": 4}]}}
getPaymentConfig
Description
Retrieves the payment configuration for a given location
Response
Returns a PaymentConfigOutput
Arguments
| Name | Description |
|---|---|
location - PaymentLocation!
|
Defines the origin location for that payment request |
Example
Query
query getPaymentConfig($location: PaymentLocation!) {
getPaymentConfig(location: $location) {
apple_pay {
...ApplePayConfigFragment
}
fastlane {
...FastlaneConfigFragment
}
google_pay {
...GooglePayConfigFragment
}
hosted_fields {
...HostedFieldsConfigFragment
}
smart_buttons {
...SmartButtonsConfigFragment
}
}
}
Variables
{"location": "PRODUCT_DETAIL"}
Response
{
"data": {
"getPaymentConfig": {
"apple_pay": ApplePayConfig,
"fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
}
}
}
getPaymentOrder
Description
Retrieves the payment details for the order
Response
Returns a PaymentOrderOutput
Example
Query
query getPaymentOrder(
$cartId: String!,
$id: String!
) {
getPaymentOrder(
cartId: $cartId,
id: $id
) {
id
mp_order_id
payment_source_details {
...PaymentSourceDetailsFragment
}
status
}
}
Variables
{
"cartId": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"getPaymentOrder": {
"id": "abc123",
"mp_order_id": "abc123",
"payment_source_details": PaymentSourceDetails,
"status": "abc123"
}
}
}
getPaymentSDK
Description
Gets the payment SDK urls and values
Response
Returns an GetPaymentSDKOutput
Arguments
| Name | Description |
|---|---|
location - PaymentLocation!
|
Defines the origin location for that payment request |
Example
Query
query getPaymentSDK($location: PaymentLocation!) {
getPaymentSDK(location: $location) {
sdkParams {
...PaymentSDKParamsItemFragment
}
}
}
Variables
{"location": "PRODUCT_DETAIL"}
Response
{
"data": {
"getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
}
}
getVaultConfig
Description
Retrieves the vault configuration
Response
Returns a VaultConfigOutput
Example
Query
query getVaultConfig {
getVaultConfig {
credit_card {
...VaultCreditCardConfigFragment
}
}
}
Response
{
"data": {
"getVaultConfig": {
"credit_card": VaultCreditCardConfig
}
}
}
giftCardAccount
Description
Return details about a specific gift card.
Response
Returns a GiftCardAccount
Arguments
| Name | Description |
|---|---|
input - GiftCardAccountInput!
|
An input object that specifies the gift card code. |
Example
Query
query giftCardAccount($input: GiftCardAccountInput!) {
giftCardAccount(input: $input) {
balance {
...MoneyFragment
}
code
expiration_date
}
}
Variables
{"input": GiftCardAccountInput}
Response
{
"data": {
"giftCardAccount": {
"balance": Money,
"code": "abc123",
"expiration_date": "abc123"
}
}
}
giftRegistry
Description
Return the specified gift registry. Some details will not be available to guests.
Response
Returns a GiftRegistry
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the registry to search for. |
Example
Query
query giftRegistry($giftRegistryUid: ID!) {
giftRegistry(giftRegistryUid: $giftRegistryUid) {
created_at
dynamic_attributes {
...GiftRegistryDynamicAttributeFragment
}
event_name
items {
...GiftRegistryItemInterfaceFragment
}
message
owner_name
privacy_settings
registrants {
...GiftRegistryRegistrantFragment
}
shipping_address {
...CustomerAddressFragment
}
status
type {
...GiftRegistryTypeFragment
}
uid
}
}
Variables
{"giftRegistryUid": 4}
Response
{
"data": {
"giftRegistry": {
"created_at": "abc123",
"dynamic_attributes": [
GiftRegistryDynamicAttribute
],
"event_name": "abc123",
"items": [GiftRegistryItemInterface],
"message": "xyz789",
"owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
"uid": 4
}
}
}
giftRegistryEmailSearch
Description
Search for gift registries by specifying a registrant email address.
Response
Returns [GiftRegistrySearchResult]
Arguments
| Name | Description |
|---|---|
email - String!
|
The registrant's email. |
Example
Query
query giftRegistryEmailSearch($email: String!) {
giftRegistryEmailSearch(email: $email) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{"email": "xyz789"}
Response
{
"data": {
"giftRegistryEmailSearch": [
{
"event_date": "xyz789",
"event_title": "xyz789",
"gift_registry_uid": 4,
"location": "abc123",
"name": "abc123",
"type": "abc123"
}
]
}
}
giftRegistryIdSearch
Description
Search for gift registries by specifying a registry URL key.
Response
Returns [GiftRegistrySearchResult]
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
Example
Query
query giftRegistryIdSearch($giftRegistryUid: ID!) {
giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{"giftRegistryUid": 4}
Response
{
"data": {
"giftRegistryIdSearch": [
{
"event_date": "abc123",
"event_title": "abc123",
"gift_registry_uid": "4",
"location": "xyz789",
"name": "abc123",
"type": "abc123"
}
]
}
}
giftRegistryTypeSearch
Description
Search for gift registries by specifying the registrant name and registry type ID.
Response
Returns [GiftRegistrySearchResult]
Example
Query
query giftRegistryTypeSearch(
$firstName: String!,
$lastName: String!,
$giftRegistryTypeUid: ID
) {
giftRegistryTypeSearch(
firstName: $firstName,
lastName: $lastName,
giftRegistryTypeUid: $giftRegistryTypeUid
) {
event_date
event_title
gift_registry_uid
location
name
type
}
}
Variables
{
"firstName": "xyz789",
"lastName": "abc123",
"giftRegistryTypeUid": 4
}
Response
{
"data": {
"giftRegistryTypeSearch": [
{
"event_date": "xyz789",
"event_title": "xyz789",
"gift_registry_uid": 4,
"location": "abc123",
"name": "xyz789",
"type": "xyz789"
}
]
}
}
giftRegistryTypes
Description
Get a list of available gift registry types.
Response
Returns [GiftRegistryType]
Example
Query
query giftRegistryTypes {
giftRegistryTypes {
dynamic_attributes_metadata {
...GiftRegistryDynamicAttributeMetadataInterfaceFragment
}
label
uid
}
}
Response
{
"data": {
"giftRegistryTypes": [
{
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
"label": "abc123",
"uid": "4"
}
]
}
}
guestOrder
Description
Retrieve guest order details based on number, email and billing last name.
Response
Returns a CustomerOrder!
Arguments
| Name | Description |
|---|---|
input - GuestOrderInformationInput!
|
Example
Query
query guestOrder($input: GuestOrderInformationInput!) {
guestOrder(input: $input) {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...ApplyGiftCardToOrderFragment
}
available_actions
billing_address {
...OrderAddressFragment
}
carrier
comments {
...SalesCommentItemFragment
}
credit_memos {
...CreditMemoFragment
}
custom_attributes {
...CustomAttributeFragment
}
customer_info {
...OrderCustomerInfoFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
invoices {
...InvoiceFragment
}
is_virtual
items {
...OrderItemInterfaceFragment
}
items_eligible_for_return {
...OrderItemInterfaceFragment
}
number
order_date
order_status_change_date
payment_methods {
...OrderPaymentMethodFragment
}
printed_card_included
returns {
...ReturnsFragment
}
shipments {
...OrderShipmentFragment
}
shipping_address {
...OrderAddressFragment
}
shipping_method
status
token
total {
...OrderTotalFragment
}
}
}
Variables
{"input": GuestOrderInformationInput}
Response
{
"data": {
"guestOrder": {
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
"carrier": "xyz789",
"comments": [SalesCommentItem],
"credit_memos": [CreditMemo],
"custom_attributes": [CustomAttribute],
"customer_info": OrderCustomerInfo,
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": "4",
"invoices": [Invoice],
"is_virtual": true,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "abc123",
"order_date": "xyz789",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": false,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "xyz789",
"status": "abc123",
"token": "xyz789",
"total": OrderTotal
}
}
}
guestOrderByToken
Description
Retrieve guest order details based on token.
Response
Returns a CustomerOrder!
Arguments
| Name | Description |
|---|---|
input - OrderTokenInput!
|
Example
Query
query guestOrderByToken($input: OrderTokenInput!) {
guestOrderByToken(input: $input) {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...ApplyGiftCardToOrderFragment
}
available_actions
billing_address {
...OrderAddressFragment
}
carrier
comments {
...SalesCommentItemFragment
}
credit_memos {
...CreditMemoFragment
}
custom_attributes {
...CustomAttributeFragment
}
customer_info {
...OrderCustomerInfoFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
invoices {
...InvoiceFragment
}
is_virtual
items {
...OrderItemInterfaceFragment
}
items_eligible_for_return {
...OrderItemInterfaceFragment
}
number
order_date
order_status_change_date
payment_methods {
...OrderPaymentMethodFragment
}
printed_card_included
returns {
...ReturnsFragment
}
shipments {
...OrderShipmentFragment
}
shipping_address {
...OrderAddressFragment
}
shipping_method
status
token
total {
...OrderTotalFragment
}
}
}
Variables
{"input": OrderTokenInput}
Response
{
"data": {
"guestOrderByToken": {
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
"carrier": "abc123",
"comments": [SalesCommentItem],
"credit_memos": [CreditMemo],
"custom_attributes": [CustomAttribute],
"customer_info": OrderCustomerInfo,
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": "4",
"invoices": [Invoice],
"is_virtual": false,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "xyz789",
"order_date": "abc123",
"order_status_change_date": "xyz789",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "xyz789",
"status": "abc123",
"token": "xyz789",
"total": OrderTotal
}
}
}
isCompanyAdminEmailAvailable
Description
Check whether the specified email can be used to register a company admin.
Response
Returns an IsCompanyAdminEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyAdminEmailAvailable($email: String!) {
isCompanyAdminEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "xyz789"}
Response
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
isCompanyEmailAvailable
Description
Check whether the specified email can be used to register a new company.
Response
Returns an IsCompanyEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyEmailAvailable($email: String!) {
isCompanyEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "xyz789"}
Response
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
isCompanyRoleNameAvailable
Description
Check whether the specified role name is valid for the company.
Response
Returns an IsCompanyRoleNameAvailableOutput
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query isCompanyRoleNameAvailable($name: String!) {
isCompanyRoleNameAvailable(name: $name) {
is_role_name_available
}
}
Variables
{"name": "abc123"}
Response
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
isCompanyUserEmailAvailable
Description
Check whether the specified email can be used to register a company user.
Response
Returns an IsCompanyUserEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query isCompanyUserEmailAvailable($email: String!) {
isCompanyUserEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "abc123"}
Response
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
isEmailAvailable
Description
Check whether the specified email has already been used to create a customer account.
Response
Returns an IsEmailAvailableOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
The email address to check. |
Example
Query
query isEmailAvailable($email: String!) {
isEmailAvailable(email: $email) {
is_email_available
}
}
Variables
{"email": "abc123"}
Response
{"data": {"isEmailAvailable": {"is_email_available": true}}}
negotiableQuote
Description
Retrieve the specified negotiable quote.
Response
Returns a NegotiableQuote
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
query negotiableQuote($uid: ID!) {
negotiableQuote(uid: $uid) {
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...NegotiableQuoteBillingAddressFragment
}
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
created_at
custom_attributes {
...CustomAttributeFragment
}
email
history {
...NegotiableQuoteHistoryEntryFragment
}
is_virtual
items {
...CartItemInterfaceFragment
}
name
prices {
...CartPricesFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
total_quantity
uid
updated_at
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"negotiableQuote": {
"available_payment_methods": [
AvailablePaymentMethod
],
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"created_at": "xyz789",
"custom_attributes": [CustomAttribute],
"email": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_virtual": true,
"items": [CartItemInterface],
"name": "xyz789",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "SUBMITTED",
"total_quantity": 987.65,
"uid": "4",
"updated_at": "abc123"
}
}
}
negotiableQuoteTemplate
Description
Retrieve the specified negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
templateId - ID!
|
Example
Query
query negotiableQuoteTemplate($templateId: ID!) {
negotiableQuoteTemplate(templateId: $templateId) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"templateId": 4}
Response
{
"data": {
"negotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 123,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": "4",
"total_quantity": 987.65
}
}
}
negotiableQuoteTemplates
Description
Return a list of negotiable quote templates that can be viewed by the logged-in customer.
Response
Returns a NegotiableQuoteTemplatesOutput
Arguments
| Name | Description |
|---|---|
filter - NegotiableQuoteTemplateFilterInput
|
The filter to use to determine which negotiable quote templates to return. |
pageSize - Int
|
The maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
The page of results to return. The default value is 1. Default = 1 |
sort - NegotiableQuoteTemplateSortInput
|
The field to use for sorting results. |
Example
Query
query negotiableQuoteTemplates(
$filter: NegotiableQuoteTemplateFilterInput,
$pageSize: Int,
$currentPage: Int,
$sort: NegotiableQuoteTemplateSortInput
) {
negotiableQuoteTemplates(
filter: $filter,
pageSize: $pageSize,
currentPage: $currentPage,
sort: $sort
) {
items {
...NegotiableQuoteTemplateGridItemFragment
}
page_info {
...SearchResultPageInfoFragment
}
sort_fields {
...SortFieldsFragment
}
total_count
}
}
Variables
{
"filter": NegotiableQuoteTemplateFilterInput,
"pageSize": 20,
"currentPage": 1,
"sort": NegotiableQuoteTemplateSortInput
}
Response
{
"data": {
"negotiableQuoteTemplates": {
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"total_count": 987
}
}
}
negotiableQuotes
Description
Return a list of negotiable quotes that can be viewed by the logged-in customer.
Response
Returns a NegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
filter - NegotiableQuoteFilterInput
|
The filter to use to determine which negotiable quotes to return. |
pageSize - Int
|
The maximum number of results to return at once. The default value is 20. Default = 20 |
currentPage - Int
|
The page of results to return. The default value is 1. Default = 1 |
sort - NegotiableQuoteSortInput
|
The field to use for sorting results. |
Example
Query
query negotiableQuotes(
$filter: NegotiableQuoteFilterInput,
$pageSize: Int,
$currentPage: Int,
$sort: NegotiableQuoteSortInput
) {
negotiableQuotes(
filter: $filter,
pageSize: $pageSize,
currentPage: $currentPage,
sort: $sort
) {
items {
...NegotiableQuoteFragment
}
page_info {
...SearchResultPageInfoFragment
}
sort_fields {
...SortFieldsFragment
}
total_count
}
}
Variables
{
"filter": NegotiableQuoteFilterInput,
"pageSize": 20,
"currentPage": 1,
"sort": NegotiableQuoteSortInput
}
Response
{
"data": {
"negotiableQuotes": {
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"total_count": 123
}
}
}
pickupLocations
Description
The pickup locations query searches for locations that match the search request requirements.
Response
Returns a PickupLocations
Arguments
| Name | Description |
|---|---|
area - AreaInput
|
Perform search by location using radius and search term. |
filters - PickupLocationFilterInput
|
Apply filters by attributes. |
sort - PickupLocationSortInput
|
Specifies which attribute to sort on, and whether to return the results in ascending or descending order. |
pageSize - Int
|
The maximum number of pickup locations to return at once. The attribute is optional. Default = 20 |
currentPage - Int
|
Specifies which page of results to return. The default value is 1. Default = 1 |
productsInfo - [ProductInfoInput]
|
Information about products which should be delivered. |
Example
Query
query pickupLocations(
$area: AreaInput,
$filters: PickupLocationFilterInput,
$sort: PickupLocationSortInput,
$pageSize: Int,
$currentPage: Int,
$productsInfo: [ProductInfoInput]
) {
pickupLocations(
area: $area,
filters: $filters,
sort: $sort,
pageSize: $pageSize,
currentPage: $currentPage,
productsInfo: $productsInfo
) {
items {
...PickupLocationFragment
}
page_info {
...SearchResultPageInfoFragment
}
total_count
}
}
Variables
{
"area": AreaInput,
"filters": PickupLocationFilterInput,
"sort": PickupLocationSortInput,
"pageSize": 20,
"currentPage": 1,
"productsInfo": [ProductInfoInput]
}
Response
{
"data": {
"pickupLocations": {
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
"total_count": 987
}
}
}
productSearch
Description
Search products using Live Search
Response
Returns a ProductSearchResponse!
Arguments
| Name | Description |
|---|---|
context - QueryContextInput
|
The query context |
current_page - Int
|
Specifies which page of results to return. The default value is 1. Default = 1 |
filter - [SearchClauseInput!]
|
Identifies product attributes and conditions to filter on |
page_size - Int
|
The maximum number of results to return at once. Default = 20 |
phrase - String!
|
Phrase to search for in product catalog |
sort - [ProductSearchSortInput!]
|
Attributes and direction to sort on |
Example
Query
query productSearch(
$context: QueryContextInput,
$current_page: Int,
$filter: [SearchClauseInput!],
$page_size: Int,
$phrase: String!,
$sort: [ProductSearchSortInput!]
) {
productSearch(
context: $context,
current_page: $current_page,
filter: $filter,
page_size: $page_size,
phrase: $phrase,
sort: $sort
) {
facets {
...AggregationFragment
}
items {
...ProductSearchItemFragment
}
page_info {
...SearchResultPageInfoFragment
}
related_terms
suggestions
total_count
}
}
Variables
{
"context": QueryContextInput,
"current_page": 1,
"filter": [SearchClauseInput],
"page_size": 20,
"phrase": "xyz789",
"sort": [ProductSearchSortInput]
}
Response
{
"data": {
"productSearch": {
"facets": [Aggregation],
"items": [ProductSearchItem],
"page_info": SearchResultPageInfo,
"related_terms": ["abc123"],
"suggestions": ["abc123"],
"total_count": 987
}
}
}
products
Description
Search for products that match the specified SKU values.
Response
Returns [ProductView]
Arguments
| Name | Description |
|---|---|
skus - [String]
|
Example
Query
query products($skus: [String]) {
products(skus: $skus) {
addToCartAllowed
inStock
lowStock
attributes {
...ProductViewAttributeFragment
}
description
id
images {
...ProductViewImageFragment
}
videos {
...ProductViewVideoFragment
}
lastModifiedAt
metaDescription
metaKeyword
metaTitle
name
shortDescription
inputOptions {
...ProductViewInputOptionFragment
}
sku
externalId
url
urlKey
links {
...ProductViewLinkFragment
}
queryType
visibility
}
}
Variables
{"skus": ["xyz789"]}
Response
{
"data": {
"products": [
{
"addToCartAllowed": true,
"inStock": true,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "xyz789",
"id": 4,
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
"metaKeyword": "abc123",
"metaTitle": "xyz789",
"name": "abc123",
"shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
"sku": "abc123",
"externalId": "xyz789",
"url": "abc123",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "abc123",
"visibility": "abc123"
}
]
}
}
recaptchaFormConfig
Response
Returns a ReCaptchaConfigOutput
Arguments
| Name | Description |
|---|---|
formType - ReCaptchaFormEnum!
|
Example
Query
query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
recaptchaFormConfig(formType: $formType) {
configurations {
...ReCaptchaConfigurationFragment
}
is_enabled
}
}
Variables
{"formType": "PLACE_ORDER"}
Response
{
"data": {
"recaptchaFormConfig": {
"configurations": ReCaptchaConfiguration,
"is_enabled": true
}
}
}
recaptchaV3Config
Description
Returns details about Google reCAPTCHA V3-Invisible configuration.
Response
Returns a ReCaptchaConfigurationV3
Example
Query
query recaptchaV3Config {
recaptchaV3Config {
badge_position
failure_message
forms
is_enabled
language_code
minimum_score
theme
website_key
}
}
Response
{
"data": {
"recaptchaV3Config": {
"badge_position": "abc123",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "abc123",
"minimum_score": 987.65,
"theme": "xyz789",
"website_key": "abc123"
}
}
}
recommendations
Description
Get Recommendations
Response
Returns a Recommendations
Arguments
| Name | Description |
|---|---|
cartSkus - [String]
|
SKUs of products in the cart |
category - String
|
Category currently being viewed |
currentSku - String
|
SKU of the product currently being viewed on PDP |
pageType - PageType
|
Type of page on which recommendations are requested |
userPurchaseHistory - [PurchaseHistory]
|
User purchase history with timestamp |
userViewHistory - [ViewHistory]
|
User view history with timestamp |
Example
Query
query recommendations(
$cartSkus: [String],
$category: String,
$currentSku: String,
$pageType: PageType,
$userPurchaseHistory: [PurchaseHistory],
$userViewHistory: [ViewHistory]
) {
recommendations(
cartSkus: $cartSkus,
category: $category,
currentSku: $currentSku,
pageType: $pageType,
userPurchaseHistory: $userPurchaseHistory,
userViewHistory: $userViewHistory
) {
results {
...RecommendationUnitFragment
}
totalResults
}
}
Variables
{
"cartSkus": ["abc123"],
"category": "xyz789",
"currentSku": "xyz789",
"pageType": "CMS",
"userPurchaseHistory": [PurchaseHistory],
"userViewHistory": [ViewHistory]
}
Response
{
"data": {
"recommendations": {
"results": [RecommendationUnit],
"totalResults": 123
}
}
}
recommendationsByUnitIds
Response
Returns a Recommendations
Arguments
| Name | Description |
|---|---|
unitIds - [String!]!
|
List unit IDs of preconfigured units |
currentSku - String
|
SKU of the product currently being viewed on PDP |
userPurchaseHistory - [PurchaseHistory]
|
User purchase history with timestamp |
userViewHistory - [ViewHistory]
|
User view history with timestamp |
cartSkus - [String]
|
SKUs of products in the cart |
Example
Query
query recommendationsByUnitIds(
$unitIds: [String!]!,
$currentSku: String,
$userPurchaseHistory: [PurchaseHistory],
$userViewHistory: [ViewHistory],
$cartSkus: [String]
) {
recommendationsByUnitIds(
unitIds: $unitIds,
currentSku: $currentSku,
userPurchaseHistory: $userPurchaseHistory,
userViewHistory: $userViewHistory,
cartSkus: $cartSkus
) {
results {
...RecommendationUnitFragment
}
totalResults
}
}
Variables
{
"unitIds": ["abc123"],
"currentSku": "xyz789",
"userPurchaseHistory": [PurchaseHistory],
"userViewHistory": [ViewHistory],
"cartSkus": ["abc123"]
}
Response
{
"data": {
"recommendationsByUnitIds": {
"results": [RecommendationUnit],
"totalResults": 987
}
}
}
refineProduct
Response
Returns a ProductView
Arguments
| Name | Description |
|---|---|
optionIds - [String!]!
|
|
sku - String!
|
Example
Query
query refineProduct(
$optionIds: [String!]!,
$sku: String!
) {
refineProduct(
optionIds: $optionIds,
sku: $sku
) {
addToCartAllowed
inStock
lowStock
attributes {
...ProductViewAttributeFragment
}
description
id
images {
...ProductViewImageFragment
}
videos {
...ProductViewVideoFragment
}
lastModifiedAt
metaDescription
metaKeyword
metaTitle
name
shortDescription
inputOptions {
...ProductViewInputOptionFragment
}
sku
externalId
url
urlKey
links {
...ProductViewLinkFragment
}
queryType
visibility
}
}
Variables
{
"optionIds": ["xyz789"],
"sku": "xyz789"
}
Response
{
"data": {
"refineProduct": {
"addToCartAllowed": true,
"inStock": false,
"lowStock": true,
"attributes": [ProductViewAttribute],
"description": "abc123",
"id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
"metaKeyword": "abc123",
"metaTitle": "abc123",
"name": "xyz789",
"shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
"sku": "xyz789",
"externalId": "abc123",
"url": "xyz789",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "abc123",
"visibility": "xyz789"
}
}
}
storeConfig
Description
Return details about the store's configuration.
Response
Returns a StoreConfig
Example
Query
query storeConfig {
storeConfig {
allow_gift_receipt
allow_gift_wrapping_on_order
allow_gift_wrapping_on_order_items
allow_items
allow_order
allow_printed_card
autocomplete_on_storefront
base_currency_code
base_link_url
base_media_url
base_static_url
base_url
cart_expires_in_days
cart_gift_wrapping
cart_merge_preference
cart_printed_card
cart_summary_display_quantity
catalog_default_sort_by
category_fixed_product_tax_display_setting
category_url_suffix
check_money_order_enable_for_specific_countries
check_money_order_enabled
check_money_order_make_check_payable_to
check_money_order_max_order_total
check_money_order_min_order_total
check_money_order_new_order_status
check_money_order_payment_from_specific_countries
check_money_order_send_check_to
check_money_order_sort_order
check_money_order_title
configurable_product_image
configurable_thumbnail_source
contact_enabled
countries_with_required_region
create_account_confirmation
customer_access_token_lifetime
default_country
default_display_currency_code
display_product_prices_in_catalog
display_shipping_prices
display_state_if_optional
enable_multiple_wishlists
fixed_product_taxes_apply_tax_to_fpt
fixed_product_taxes_display_prices_in_emails
fixed_product_taxes_display_prices_in_product_lists
fixed_product_taxes_display_prices_in_sales_modules
fixed_product_taxes_display_prices_on_product_view_page
fixed_product_taxes_enable
fixed_product_taxes_include_fpt_in_subtotal
graphql_share_customer_group
grid_per_page
grid_per_page_values
grouped_product_image
is_checkout_agreements_enabled
is_default_store
is_default_store_group
is_guest_checkout_enabled
is_negotiable_quote_active
is_one_page_checkout_enabled
is_requisition_list_active
list_mode
list_per_page
list_per_page_values
locale
magento_reward_general_is_enabled
magento_reward_general_is_enabled_on_front
magento_reward_general_min_points_balance
magento_reward_general_publish_history
magento_reward_points_invitation_customer
magento_reward_points_invitation_customer_limit
magento_reward_points_invitation_order
magento_reward_points_invitation_order_limit
magento_reward_points_newsletter
magento_reward_points_order
magento_reward_points_register
magento_reward_points_review
magento_reward_points_review_limit
magento_wishlist_general_is_enabled
max_items_in_order_summary
maximum_number_of_wishlists
minicart_display
minicart_max_items
minimum_password_length
newsletter_enabled
optional_zip_countries
order_cancellation_enabled
order_cancellation_reasons {
...CancellationReasonFragment
}
orders_invoices_credit_memos_display_full_summary
orders_invoices_credit_memos_display_grandtotal
orders_invoices_credit_memos_display_price
orders_invoices_credit_memos_display_shipping_amount
orders_invoices_credit_memos_display_subtotal
orders_invoices_credit_memos_display_zero_tax
printed_card_priceV2 {
...MoneyFragment
}
product_fixed_product_tax_display_setting
product_url_suffix
quickorder_active
required_character_classes_number
returns_enabled
root_category_uid
sales_fixed_product_tax_display_setting
sales_gift_wrapping
sales_printed_card
secure_base_link_url
secure_base_media_url
secure_base_static_url
secure_base_url
share_active_segments
share_applied_cart_rule
shopping_cart_display_full_summary
shopping_cart_display_grand_total
shopping_cart_display_price
shopping_cart_display_shipping
shopping_cart_display_subtotal
shopping_cart_display_tax_gift_wrapping
shopping_cart_display_zero_tax
store_code
store_group_code
store_group_name
store_name
store_sort_order
timezone
title_separator
use_store_in_url
website_code
website_name
weight_unit
zero_subtotal_enable_for_specific_countries
zero_subtotal_enabled
zero_subtotal_new_order_status
zero_subtotal_payment_action
zero_subtotal_payment_from_specific_countries
zero_subtotal_sort_order
zero_subtotal_title
}
}
Response
{
"data": {
"storeConfig": {
"allow_gift_receipt": "abc123",
"allow_gift_wrapping_on_order": "xyz789",
"allow_gift_wrapping_on_order_items": "xyz789",
"allow_items": "xyz789",
"allow_order": "abc123",
"allow_printed_card": "abc123",
"autocomplete_on_storefront": true,
"base_currency_code": "abc123",
"base_link_url": "xyz789",
"base_media_url": "abc123",
"base_static_url": "abc123",
"base_url": "xyz789",
"cart_expires_in_days": 987,
"cart_gift_wrapping": "xyz789",
"cart_merge_preference": "xyz789",
"cart_printed_card": "abc123",
"cart_summary_display_quantity": 987,
"catalog_default_sort_by": "abc123",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "abc123",
"check_money_order_enable_for_specific_countries": true,
"check_money_order_enabled": true,
"check_money_order_make_check_payable_to": "xyz789",
"check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "xyz789",
"check_money_order_payment_from_specific_countries": "xyz789",
"check_money_order_send_check_to": "abc123",
"check_money_order_sort_order": 123,
"check_money_order_title": "abc123",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
"contact_enabled": true,
"countries_with_required_region": "abc123",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
"default_display_currency_code": "xyz789",
"display_product_prices_in_catalog": 987,
"display_shipping_prices": 123,
"display_state_if_optional": false,
"enable_multiple_wishlists": "abc123",
"fixed_product_taxes_apply_tax_to_fpt": false,
"fixed_product_taxes_display_prices_in_emails": 123,
"fixed_product_taxes_display_prices_in_product_lists": 123,
"fixed_product_taxes_display_prices_in_sales_modules": 987,
"fixed_product_taxes_display_prices_on_product_view_page": 987,
"fixed_product_taxes_enable": true,
"fixed_product_taxes_include_fpt_in_subtotal": false,
"graphql_share_customer_group": false,
"grid_per_page": 987,
"grid_per_page_values": "xyz789",
"grouped_product_image": "ITSELF",
"is_checkout_agreements_enabled": true,
"is_default_store": false,
"is_default_store_group": false,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
"is_one_page_checkout_enabled": false,
"is_requisition_list_active": "xyz789",
"list_mode": "abc123",
"list_per_page": 987,
"list_per_page_values": "abc123",
"locale": "abc123",
"magento_reward_general_is_enabled": "abc123",
"magento_reward_general_is_enabled_on_front": "xyz789",
"magento_reward_general_min_points_balance": "xyz789",
"magento_reward_general_publish_history": "xyz789",
"magento_reward_points_invitation_customer": "abc123",
"magento_reward_points_invitation_customer_limit": "abc123",
"magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "xyz789",
"magento_reward_points_order": "abc123",
"magento_reward_points_register": "abc123",
"magento_reward_points_review": "xyz789",
"magento_reward_points_review_limit": "xyz789",
"magento_wishlist_general_is_enabled": "xyz789",
"max_items_in_order_summary": 987,
"maximum_number_of_wishlists": "abc123",
"minicart_display": false,
"minicart_max_items": 123,
"minimum_password_length": "abc123",
"newsletter_enabled": true,
"optional_zip_countries": "xyz789",
"order_cancellation_enabled": false,
"order_cancellation_reasons": [CancellationReason],
"orders_invoices_credit_memos_display_full_summary": true,
"orders_invoices_credit_memos_display_grandtotal": false,
"orders_invoices_credit_memos_display_price": 987,
"orders_invoices_credit_memos_display_shipping_amount": 987,
"orders_invoices_credit_memos_display_subtotal": 987,
"orders_invoices_credit_memos_display_zero_tax": false,
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_url_suffix": "xyz789",
"quickorder_active": false,
"required_character_classes_number": "abc123",
"returns_enabled": "abc123",
"root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"sales_gift_wrapping": "abc123",
"sales_printed_card": "abc123",
"secure_base_link_url": "xyz789",
"secure_base_media_url": "abc123",
"secure_base_static_url": "xyz789",
"secure_base_url": "abc123",
"share_active_segments": false,
"share_applied_cart_rule": true,
"shopping_cart_display_full_summary": true,
"shopping_cart_display_grand_total": false,
"shopping_cart_display_price": 123,
"shopping_cart_display_shipping": 123,
"shopping_cart_display_subtotal": 123,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": true,
"store_code": 4,
"store_group_code": 4,
"store_group_name": "abc123",
"store_name": "xyz789",
"store_sort_order": 123,
"timezone": "xyz789",
"title_separator": "abc123",
"use_store_in_url": false,
"website_code": "4",
"website_name": "xyz789",
"weight_unit": "abc123",
"zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": true,
"zero_subtotal_new_order_status": "xyz789",
"zero_subtotal_payment_action": "xyz789",
"zero_subtotal_payment_from_specific_countries": "abc123",
"zero_subtotal_sort_order": 123,
"zero_subtotal_title": "abc123"
}
}
}
variants
Response
Returns a ProductViewVariantResults
Example
Query
query variants(
$sku: String!,
$optionIds: [String!],
$pageSize: Int,
$cursor: String
) {
variants(
sku: $sku,
optionIds: $optionIds,
pageSize: $pageSize,
cursor: $cursor
) {
variants {
...ProductViewVariantFragment
}
cursor
}
}
Variables
{
"sku": "xyz789",
"optionIds": ["xyz789"],
"pageSize": 123,
"cursor": "xyz789"
}
Response
{
"data": {
"variants": {
"variants": [ProductViewVariant],
"cursor": "xyz789"
}
}
}
Mutations
acceptCompanyInvitation
Description
Accept invitation to the company.
Response
Returns a CompanyInvitationOutput
Arguments
| Name | Description |
|---|---|
input - CompanyInvitationInput!
|
Example
Query
mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
acceptCompanyInvitation(input: $input) {
success
}
}
Variables
{"input": CompanyInvitationInput}
Response
{"data": {"acceptCompanyInvitation": {"success": true}}}
acceptNegotiableQuoteTemplate
Description
Update an existing negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - AcceptNegotiableQuoteTemplateInput!
|
An input object that contains the data to update a negotiable quote template. |
Example
Query
mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
acceptNegotiableQuoteTemplate(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": AcceptNegotiableQuoteTemplateInput}
Response
{
"data": {
"acceptNegotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": 4,
"total_quantity": 123.45
}
}
}
addDownloadableProductsToCart
Description
Add one or more downloadable products to the specified cart. We recommend using addProductsToCart instead.
Response
Returns an AddDownloadableProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddDownloadableProductsToCartInput
|
An input object that defines which downloadable products to add to the cart. |
Example
Query
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
addDownloadableProductsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": AddDownloadableProductsToCartInput}
Response
{
"data": {
"addDownloadableProductsToCart": {"cart": Cart}
}
}
addGiftRegistryRegistrants
Description
Add registrants to the specified gift registry.
Response
Returns an AddGiftRegistryRegistrantsOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
registrants - [AddGiftRegistryRegistrantInput!]!
|
An array registrants to add. |
Example
Query
mutation addGiftRegistryRegistrants(
$giftRegistryUid: ID!,
$registrants: [AddGiftRegistryRegistrantInput!]!
) {
addGiftRegistryRegistrants(
giftRegistryUid: $giftRegistryUid,
registrants: $registrants
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": "4",
"registrants": [AddGiftRegistryRegistrantInput]
}
Response
{
"data": {
"addGiftRegistryRegistrants": {
"gift_registry": GiftRegistry
}
}
}
addProductsToCart
Description
Add any type of product to the cart.
Response
Returns an AddProductsToCartOutput
Arguments
| Name | Description |
|---|---|
cartId - String!
|
The cart ID of the shopper. |
cartItems - [CartItemInput!]!
|
An array that defines the products to add to the cart. |
Example
Query
mutation addProductsToCart(
$cartId: String!,
$cartItems: [CartItemInput!]!
) {
addProductsToCart(
cartId: $cartId,
cartItems: $cartItems
) {
cart {
...CartFragment
}
user_errors {
...ErrorFragment
}
}
}
Variables
{
"cartId": "xyz789",
"cartItems": [CartItemInput]
}
Response
{
"data": {
"addProductsToCart": {
"cart": Cart,
"user_errors": [Error]
}
}
}
addProductsToCompareList
Description
Add products to the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - AddProductsToCompareListInput
|
An input object that defines which products to add to an existing compare list. |
Example
Query
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
addProductsToCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": AddProductsToCompareListInput}
Response
{
"data": {
"addProductsToCompareList": {
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
"uid": "4"
}
}
}
addProductsToNewCart
Description
Creates a new cart and add any type of product to it
Response
Returns an AddProductsToNewCartOutput
Arguments
| Name | Description |
|---|---|
cartItems - [CartItemInput!]!
|
An array that defines the products to add to the new cart |
Example
Query
mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
addProductsToNewCart(cartItems: $cartItems) {
cart {
...CartFragment
}
user_errors {
...CartUserInputErrorFragment
}
}
}
Variables
{"cartItems": [CartItemInput]}
Response
{
"data": {
"addProductsToNewCart": {
"cart": Cart,
"user_errors": [CartUserInputError]
}
}
}
addProductsToRequisitionList
Description
Add items to the specified requisition list.
Response
Returns an AddProductsToRequisitionListOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
requisitionListItems - [RequisitionListItemsInput!]!
|
An array of products to be added to the requisition list. |
Example
Query
mutation addProductsToRequisitionList(
$requisitionListUid: ID!,
$requisitionListItems: [RequisitionListItemsInput!]!
) {
addProductsToRequisitionList(
requisitionListUid: $requisitionListUid,
requisitionListItems: $requisitionListItems
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"requisitionListUid": 4,
"requisitionListItems": [RequisitionListItemsInput]
}
Response
{
"data": {
"addProductsToRequisitionList": {
"requisition_list": RequisitionList
}
}
}
addProductsToWishlist
Description
Add one or more products to the specified wish list. This mutation supports all product types.
Response
Returns an AddProductsToWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of a wish list. |
wishlistItems - [WishlistItemInput!]!
|
An array of products to add to the wish list. |
Example
Query
mutation addProductsToWishlist(
$wishlistId: ID!,
$wishlistItems: [WishlistItemInput!]!
) {
addProductsToWishlist(
wishlistId: $wishlistId,
wishlistItems: $wishlistItems
) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{
"wishlistId": "4",
"wishlistItems": [WishlistItemInput]
}
Response
{
"data": {
"addProductsToWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
addPurchaseOrderComment
Description
Add a comment to an existing purchase order.
Response
Returns an AddPurchaseOrderCommentOutput
Arguments
| Name | Description |
|---|---|
input - AddPurchaseOrderCommentInput!
|
Example
Query
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
addPurchaseOrderComment(input: $input) {
comment {
...PurchaseOrderCommentFragment
}
}
}
Variables
{"input": AddPurchaseOrderCommentInput}
Response
{
"data": {
"addPurchaseOrderComment": {
"comment": PurchaseOrderComment
}
}
}
addPurchaseOrderItemsToCart
Description
Add purchase order items to the shopping cart.
Response
Returns an AddProductsToCartOutput
Arguments
| Name | Description |
|---|---|
input - AddPurchaseOrderItemsToCartInput!
|
Example
Query
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
addPurchaseOrderItemsToCart(input: $input) {
cart {
...CartFragment
}
user_errors {
...ErrorFragment
}
}
}
Variables
{"input": AddPurchaseOrderItemsToCartInput}
Response
{
"data": {
"addPurchaseOrderItemsToCart": {
"cart": Cart,
"user_errors": [Error]
}
}
}
addRequisitionListItemsToCart
Description
Add items in the requisition list to the customer's cart.
Response
Returns an AddRequisitionListItemsToCartOutput
Example
Query
mutation addRequisitionListItemsToCart(
$requisitionListUid: ID!,
$requisitionListItemUids: [ID!]
) {
addRequisitionListItemsToCart(
requisitionListUid: $requisitionListUid,
requisitionListItemUids: $requisitionListItemUids
) {
add_requisition_list_items_to_cart_user_errors {
...AddRequisitionListItemToCartUserErrorFragment
}
cart {
...CartFragment
}
status
}
}
Variables
{
"requisitionListUid": "4",
"requisitionListItemUids": [4]
}
Response
{
"data": {
"addRequisitionListItemsToCart": {
"add_requisition_list_items_to_cart_user_errors": [
AddRequisitionListItemToCartUserError
],
"cart": Cart,
"status": true
}
}
}
addReturnComment
Description
Add a comment to an existing return.
Response
Returns an AddReturnCommentOutput
Arguments
| Name | Description |
|---|---|
input - AddReturnCommentInput!
|
An input object that defines a return comment. |
Example
Query
mutation addReturnComment($input: AddReturnCommentInput!) {
addReturnComment(input: $input) {
return {
...ReturnFragment
}
}
}
Variables
{"input": AddReturnCommentInput}
Response
{"data": {"addReturnComment": {"return": Return}}}
addReturnTracking
Description
Add tracking information to the return.
Response
Returns an AddReturnTrackingOutput
Arguments
| Name | Description |
|---|---|
input - AddReturnTrackingInput!
|
An input object that defines tracking information. |
Example
Query
mutation addReturnTracking($input: AddReturnTrackingInput!) {
addReturnTracking(input: $input) {
return {
...ReturnFragment
}
return_shipping_tracking {
...ReturnShippingTrackingFragment
}
}
}
Variables
{"input": AddReturnTrackingInput}
Response
{
"data": {
"addReturnTracking": {
"return": Return,
"return_shipping_tracking": ReturnShippingTracking
}
}
}
addWishlistItemsToCart
Description
Add items in the specified wishlist to the customer's cart.
Response
Returns an AddWishlistItemsToCartOutput
Example
Query
mutation addWishlistItemsToCart(
$wishlistId: ID!,
$wishlistItemIds: [ID!]
) {
addWishlistItemsToCart(
wishlistId: $wishlistId,
wishlistItemIds: $wishlistItemIds
) {
add_wishlist_items_to_cart_user_errors {
...WishlistCartUserInputErrorFragment
}
status
wishlist {
...WishlistFragment
}
}
}
Variables
{"wishlistId": 4, "wishlistItemIds": ["4"]}
Response
{
"data": {
"addWishlistItemsToCart": {
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
"status": true,
"wishlist": Wishlist
}
}
}
applyCouponToCart
Description
Apply a pre-defined coupon code to the specified cart.
Response
Returns an ApplyCouponToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyCouponToCartInput
|
An input object that defines the coupon code to apply to the cart. |
Example
Query
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
applyCouponToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyCouponToCartInput}
Response
{"data": {"applyCouponToCart": {"cart": Cart}}}
applyCouponsToCart
Description
Apply a pre-defined coupon code to the specified cart.
Response
Returns an ApplyCouponToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyCouponsToCartInput
|
An input object that defines the coupon code to apply to the cart. |
Example
Query
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
applyCouponsToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyCouponsToCartInput}
Response
{"data": {"applyCouponsToCart": {"cart": Cart}}}
applyGiftCardToCart
Description
Apply a pre-defined gift card code to the specified cart.
Response
Returns an ApplyGiftCardToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyGiftCardToCartInput
|
An input object that specifies the gift card code and cart. |
Example
Query
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
applyGiftCardToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyGiftCardToCartInput}
Response
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
applyRewardPointsToCart
Description
Apply all available points, up to the cart total. Partial redemption is not available.
Response
Returns an ApplyRewardPointsToCartOutput
Arguments
| Name | Description |
|---|---|
cartId - ID!
|
Example
Query
mutation applyRewardPointsToCart($cartId: ID!) {
applyRewardPointsToCart(cartId: $cartId) {
cart {
...CartFragment
}
}
}
Variables
{"cartId": 4}
Response
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
applyStoreCreditToCart
Description
Apply store credit to the specified cart.
Response
Returns an ApplyStoreCreditToCartOutput
Arguments
| Name | Description |
|---|---|
input - ApplyStoreCreditToCartInput!
|
An input object that specifies the cart ID. |
Example
Query
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
applyStoreCreditToCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": ApplyStoreCreditToCartInput}
Response
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
approvePurchaseOrders
Description
Approve purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
approvePurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"approvePurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
assignCompareListToCustomer
Description
Assign the specified compare list to the logged in customer.
Response
Returns an AssignCompareListToCustomerOutput
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be assigned. |
Example
Query
mutation assignCompareListToCustomer($uid: ID!) {
assignCompareListToCustomer(uid: $uid) {
compare_list {
...CompareListFragment
}
result
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"assignCompareListToCustomer": {
"compare_list": CompareList,
"result": false
}
}
}
assignCustomerToGuestCart
Description
Assign a logged-in customer to the specified guest shopping cart.
Example
Query
mutation assignCustomerToGuestCart($cart_id: String!) {
assignCustomerToGuestCart(cart_id: $cart_id) {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
custom_attributes {
...CustomAttributeFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
rules {
...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{"cart_id": "abc123"}
Response
{
"data": {
"assignCustomerToGuestCart": {
"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,
"custom_attributes": [CustomAttribute],
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": true,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": false,
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
}
}
}
cancelNegotiableQuoteTemplate
Description
Cancel a negotiable quote template
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - CancelNegotiableQuoteTemplateInput!
|
An input object that cancels a negotiable quote template. |
Example
Query
mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
cancelNegotiableQuoteTemplate(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": CancelNegotiableQuoteTemplateInput}
Response
{
"data": {
"cancelNegotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 987,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "xyz789",
"template_id": 4,
"total_quantity": 123.45
}
}
}
cancelOrder
Description
Cancel the specified customer order.
Response
Returns a CancelOrderOutput
Arguments
| Name | Description |
|---|---|
input - CancelOrderInput!
|
Example
Query
mutation cancelOrder($input: CancelOrderInput!) {
cancelOrder(input: $input) {
error
errorV2 {
...CancelOrderErrorFragment
}
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": CancelOrderInput}
Response
{
"data": {
"cancelOrder": {
"error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
}
}
cancelPurchaseOrders
Description
Cancel purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
cancelPurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"cancelPurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
changeCustomerPassword
Description
Change the password for the logged-in customer.
Response
Returns a Customer
Example
Query
mutation changeCustomerPassword(
$currentPassword: String!,
$newPassword: String!
) {
changeCustomerPassword(
currentPassword: $currentPassword,
newPassword: $newPassword
) {
addresses {
...CustomerAddressFragment
}
addressesV2 {
...CustomerAddressesFragment
}
allow_remote_shopping_assistance
companies {
...UserCompaniesOutputFragment
}
compare_list {
...CompareListFragment
}
confirmation_status
created_at
custom_attributes {
...AttributeValueInterfaceFragment
}
date_of_birth
default_billing
default_shipping
email
firstname
gender
gift_registries {
...GiftRegistryFragment
}
gift_registry {
...GiftRegistryFragment
}
group {
...CustomerGroupStorefrontFragment
}
is_subscribed
job_title
lastname
middlename
orders {
...CustomerOrdersFragment
}
prefix
purchase_order {
...PurchaseOrderFragment
}
purchase_order_approval_rule {
...PurchaseOrderApprovalRuleFragment
}
purchase_order_approval_rule_metadata {
...PurchaseOrderApprovalRuleMetadataFragment
}
purchase_order_approval_rules {
...PurchaseOrderApprovalRulesFragment
}
purchase_orders {
...PurchaseOrdersFragment
}
purchase_orders_enabled
requisition_lists {
...RequisitionListsFragment
}
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
reward_points {
...RewardPointsFragment
}
role {
...CompanyRoleFragment
}
segments {
...CustomerSegmentStorefrontFragment
}
status
store_credit {
...CustomerStoreCreditFragment
}
structure_id
suffix
taxvat
team {
...CompanyTeamFragment
}
telephone
wishlist_v2 {
...WishlistFragment
}
wishlists {
...WishlistFragment
}
}
}
Variables
{
"currentPassword": "xyz789",
"newPassword": "abc123"
}
Response
{
"data": {
"changeCustomerPassword": {
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
"allow_remote_shopping_assistance": false,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "xyz789",
"default_billing": "abc123",
"default_shipping": "xyz789",
"email": "xyz789",
"firstname": "abc123",
"gender": 123,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group": CustomerGroupStorefront,
"is_subscribed": true,
"job_title": "xyz789",
"lastname": "abc123",
"middlename": "abc123",
"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,
"reward_points": RewardPoints,
"role": CompanyRole,
"segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
"suffix": "abc123",
"taxvat": "abc123",
"team": CompanyTeam,
"telephone": "xyz789",
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
}
}
clearCustomerCart
Description
Remove all items from the specified cart.
Response
Returns a ClearCustomerCartOutput
Arguments
| Name | Description |
|---|---|
cartUid - String!
|
The masked ID of the cart. |
Example
Query
mutation clearCustomerCart($cartUid: String!) {
clearCustomerCart(cartUid: $cartUid) {
cart {
...CartFragment
}
status
}
}
Variables
{"cartUid": "abc123"}
Response
{
"data": {
"clearCustomerCart": {"cart": Cart, "status": false}
}
}
clearWishlist
Description
Remove all the products from the specified wish list.
Response
Returns a RemoveProductsFromWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of a wish list. |
Example
Query
mutation clearWishlist($wishlistId: ID!) {
clearWishlist(wishlistId: $wishlistId) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{"wishlistId": "4"}
Response
{
"data": {
"clearWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
closeNegotiableQuotes
Description
Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.
Response
Returns a CloseNegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
input - CloseNegotiableQuotesInput!
|
An input object that closes a negotiable quote. |
Example
Query
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
closeNegotiableQuotes(input: $input) {
negotiable_quotes {
...NegotiableQuotesOutputFragment
}
operation_results {
... on NegotiableQuoteUidOperationSuccess {
...NegotiableQuoteUidOperationSuccessFragment
}
... on CloseNegotiableQuoteOperationFailure {
...CloseNegotiableQuoteOperationFailureFragment
}
}
result_status
}
}
Variables
{"input": CloseNegotiableQuotesInput}
Response
{
"data": {
"closeNegotiableQuotes": {
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
}
}
completeOrder
Description
Synchronizes order details and place the order
Response
Returns a PlaceOrderOutput
Arguments
| Name | Description |
|---|---|
input - CompleteOrderInput
|
Describes the variables needed to complete or place the order |
Example
Query
mutation completeOrder($input: CompleteOrderInput) {
completeOrder(input: $input) {
errors {
...PlaceOrderErrorFragment
}
orderV2 {
...CustomerOrderFragment
}
}
}
Variables
{"input": CompleteOrderInput}
Response
{
"data": {
"completeOrder": {
"errors": [PlaceOrderError],
"orderV2": CustomerOrder
}
}
}
confirmCancelOrder
Description
Cancel the specified guest customer order.
Response
Returns a CancelOrderOutput
Arguments
| Name | Description |
|---|---|
input - ConfirmCancelOrderInput!
|
Example
Query
mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
confirmCancelOrder(input: $input) {
error
errorV2 {
...CancelOrderErrorFragment
}
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": ConfirmCancelOrderInput}
Response
{
"data": {
"confirmCancelOrder": {
"error": "xyz789",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
}
}
confirmEmail
Description
Confirms the email address for a customer.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - ConfirmEmailInput!
|
An input object to identify the customer to confirm the email. |
Example
Query
mutation confirmEmail($input: ConfirmEmailInput!) {
confirmEmail(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": ConfirmEmailInput}
Response
{"data": {"confirmEmail": {"customer": Customer}}}
confirmReturn
Description
Confirm the return.
Response
Returns a RequestReturnOutput
Arguments
| Name | Description |
|---|---|
input - ConfirmReturnInput!
|
Example
Query
mutation confirmReturn($input: ConfirmReturnInput!) {
confirmReturn(input: $input) {
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
}
}
Variables
{"input": ConfirmReturnInput}
Response
{
"data": {
"confirmReturn": {
"return": Return,
"returns": Returns
}
}
}
contactUs
Description
Send a 'Contact Us' email to the merchant.
Response
Returns a ContactUsOutput
Arguments
| Name | Description |
|---|---|
input - ContactUsInput!
|
An input object that defines shopper information. |
Example
Query
mutation contactUs($input: ContactUsInput!) {
contactUs(input: $input) {
status
}
}
Variables
{"input": ContactUsInput}
Response
{"data": {"contactUs": {"status": false}}}
copyItemsBetweenRequisitionLists
Description
Copy items from one requisition list to another.
Response
Returns a CopyItemsFromRequisitionListsOutput
Arguments
| Name | Description |
|---|---|
sourceRequisitionListUid - ID!
|
The unique ID of the source requisition list. |
destinationRequisitionListUid - ID
|
The unique ID of the destination requisition list. If null, a new requisition list will be created. |
requisitionListItem - CopyItemsBetweenRequisitionListsInput
|
The list of products to copy. |
Example
Query
mutation copyItemsBetweenRequisitionLists(
$sourceRequisitionListUid: ID!,
$destinationRequisitionListUid: ID,
$requisitionListItem: CopyItemsBetweenRequisitionListsInput
) {
copyItemsBetweenRequisitionLists(
sourceRequisitionListUid: $sourceRequisitionListUid,
destinationRequisitionListUid: $destinationRequisitionListUid,
requisitionListItem: $requisitionListItem
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"sourceRequisitionListUid": 4,
"destinationRequisitionListUid": 4,
"requisitionListItem": CopyItemsBetweenRequisitionListsInput
}
Response
{
"data": {
"copyItemsBetweenRequisitionLists": {
"requisition_list": RequisitionList
}
}
}
copyProductsBetweenWishlists
Description
Copy products from one wish list to another. The original wish list is unchanged.
Response
Returns a CopyProductsBetweenWishlistsOutput
Arguments
| Name | Description |
|---|---|
sourceWishlistUid - ID!
|
The ID of the original wish list. |
destinationWishlistUid - ID!
|
The ID of the target wish list. |
wishlistItems - [WishlistItemCopyInput!]!
|
An array of items to copy. |
Example
Query
mutation copyProductsBetweenWishlists(
$sourceWishlistUid: ID!,
$destinationWishlistUid: ID!,
$wishlistItems: [WishlistItemCopyInput!]!
) {
copyProductsBetweenWishlists(
sourceWishlistUid: $sourceWishlistUid,
destinationWishlistUid: $destinationWishlistUid,
wishlistItems: $wishlistItems
) {
destination_wishlist {
...WishlistFragment
}
source_wishlist {
...WishlistFragment
}
user_errors {
...WishListUserInputErrorFragment
}
}
}
Variables
{
"sourceWishlistUid": 4,
"destinationWishlistUid": "4",
"wishlistItems": [WishlistItemCopyInput]
}
Response
{
"data": {
"copyProductsBetweenWishlists": {
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
}
}
createCompany
Description
Create a company at the request of either a customer or a guest.
Response
Returns a CreateCompanyOutput
Arguments
| Name | Description |
|---|---|
input - CompanyCreateInput!
|
Example
Query
mutation createCompany($input: CompanyCreateInput!) {
createCompany(input: $input) {
company {
...CompanyFragment
}
}
}
Variables
{"input": CompanyCreateInput}
Response
{"data": {"createCompany": {"company": Company}}}
createCompanyRole
Description
Create a new company role.
Response
Returns a CreateCompanyRoleOutput
Arguments
| Name | Description |
|---|---|
input - CompanyRoleCreateInput!
|
Example
Query
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
createCompanyRole(input: $input) {
role {
...CompanyRoleFragment
}
}
}
Variables
{"input": CompanyRoleCreateInput}
Response
{"data": {"createCompanyRole": {"role": CompanyRole}}}
createCompanyTeam
Description
Create a new team for the customer's company within the current company context.
Response
Returns a CreateCompanyTeamOutput
Arguments
| Name | Description |
|---|---|
input - CompanyTeamCreateInput!
|
Example
Query
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
createCompanyTeam(input: $input) {
team {
...CompanyTeamFragment
}
}
}
Variables
{"input": CompanyTeamCreateInput}
Response
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
createCompanyUser
Description
Create a new company user at the request of an existing customer.
Response
Returns a CreateCompanyUserOutput
Arguments
| Name | Description |
|---|---|
input - CompanyUserCreateInput!
|
Example
Query
mutation createCompanyUser($input: CompanyUserCreateInput!) {
createCompanyUser(input: $input) {
user {
...CustomerFragment
}
}
}
Variables
{"input": CompanyUserCreateInput}
Response
{"data": {"createCompanyUser": {"user": Customer}}}
createCompareList
Description
Create a new compare list. The compare list is saved for logged in customers.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - CreateCompareListInput
|
Example
Query
mutation createCompareList($input: CreateCompareListInput) {
createCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": CreateCompareListInput}
Response
{
"data": {
"createCompareList": {
"attributes": [ComparableAttribute],
"item_count": 123,
"items": [ComparableItem],
"uid": 4
}
}
}
createCustomerAddress
Description
Create a billing or shipping address for a customer or guest.
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
input - CustomerAddressInput!
|
Example
Query
mutation createCustomerAddress($input: CustomerAddressInput!) {
createCustomerAddress(input: $input) {
city
company
country_code
custom_attributesV2 {
...AttributeValueInterfaceFragment
}
default_billing
default_shipping
extension_attributes {
...CustomerAddressAttributeFragment
}
fax
firstname
id
lastname
middlename
postcode
prefix
region {
...CustomerAddressRegionFragment
}
region_id
street
suffix
telephone
uid
vat_id
}
}
Variables
{"input": CustomerAddressInput}
Response
{
"data": {
"createCustomerAddress": {
"city": "xyz789",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": false,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
"fax": "xyz789",
"firstname": "xyz789",
"id": 123,
"lastname": "abc123",
"middlename": "abc123",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 987,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "abc123",
"uid": "4",
"vat_id": "abc123"
}
}
}
createCustomerV2
Description
Create a customer account.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - CustomerCreateInput!
|
An input object that defines the customer to be created. |
Example
Query
mutation createCustomerV2($input: CustomerCreateInput!) {
createCustomerV2(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": CustomerCreateInput}
Response
{"data": {"createCustomerV2": {"customer": Customer}}}
createGiftRegistry
Description
Create a gift registry on behalf of the customer.
Response
Returns a CreateGiftRegistryOutput
Arguments
| Name | Description |
|---|---|
giftRegistry - CreateGiftRegistryInput!
|
An input object that defines a new gift registry. |
Example
Query
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
createGiftRegistry(giftRegistry: $giftRegistry) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{"giftRegistry": CreateGiftRegistryInput}
Response
{
"data": {
"createGiftRegistry": {"gift_registry": GiftRegistry}
}
}
createGuestCart
Description
Create a new shopping cart
Response
Returns a CreateGuestCartOutput
Arguments
| Name | Description |
|---|---|
input - CreateGuestCartInput
|
Example
Query
mutation createGuestCart($input: CreateGuestCartInput) {
createGuestCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": CreateGuestCartInput}
Response
{"data": {"createGuestCart": {"cart": Cart}}}
createPaymentOrder
Description
Creates a payment order for further payment processing
Response
Returns a CreatePaymentOrderOutput
Arguments
| Name | Description |
|---|---|
input - CreatePaymentOrderInput!
|
Contains payment order details that are used while processing the payment order |
Example
Query
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
createPaymentOrder(input: $input) {
amount
currency_code
id
mp_order_id
status
}
}
Variables
{"input": CreatePaymentOrderInput}
Response
{
"data": {
"createPaymentOrder": {
"amount": 987.65,
"currency_code": "xyz789",
"id": "xyz789",
"mp_order_id": "abc123",
"status": "abc123"
}
}
}
createPurchaseOrderApprovalRule
Description
Create a purchase order approval rule.
Response
Returns a PurchaseOrderApprovalRule
Arguments
| Name | Description |
|---|---|
input - PurchaseOrderApprovalRuleInput!
|
Example
Query
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
createPurchaseOrderApprovalRule(input: $input) {
applies_to_roles {
...CompanyRoleFragment
}
approver_roles {
...CompanyRoleFragment
}
condition {
...PurchaseOrderApprovalRuleConditionInterfaceFragment
}
created_at
created_by
description
name
status
uid
updated_at
}
}
Variables
{"input": PurchaseOrderApprovalRuleInput}
Response
{
"data": {
"createPurchaseOrderApprovalRule": {
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "xyz789",
"created_by": "abc123",
"description": "abc123",
"name": "xyz789",
"status": "ENABLED",
"uid": 4,
"updated_at": "xyz789"
}
}
}
createRequisitionList
Description
Create an empty requisition list.
Response
Returns a CreateRequisitionListOutput
Arguments
| Name | Description |
|---|---|
input - CreateRequisitionListInput
|
Example
Query
mutation createRequisitionList($input: CreateRequisitionListInput) {
createRequisitionList(input: $input) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{"input": CreateRequisitionListInput}
Response
{
"data": {
"createRequisitionList": {
"requisition_list": RequisitionList
}
}
}
createVaultCardPaymentToken
Description
Creates a vault payment token
Response
Returns a CreateVaultCardPaymentTokenOutput
Arguments
| Name | Description |
|---|---|
input - CreateVaultCardPaymentTokenInput!
|
Describe the variables needed to create a vault card payment token |
Example
Query
mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
createVaultCardPaymentToken(input: $input) {
payment_source {
...PaymentSourceOutputFragment
}
vault_token_id
}
}
Variables
{"input": CreateVaultCardPaymentTokenInput}
Response
{
"data": {
"createVaultCardPaymentToken": {
"payment_source": PaymentSourceOutput,
"vault_token_id": "xyz789"
}
}
}
createVaultCardSetupToken
Description
Creates a vault card setup token
Response
Returns a CreateVaultCardSetupTokenOutput
Arguments
| Name | Description |
|---|---|
input - CreateVaultCardSetupTokenInput!
|
Describe the variables needed to create a vault card setup token |
Example
Query
mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
createVaultCardSetupToken(input: $input) {
setup_token
}
}
Variables
{"input": CreateVaultCardSetupTokenInput}
Response
{
"data": {
"createVaultCardSetupToken": {
"setup_token": "abc123"
}
}
}
createWishlist
Description
Create a new wish list.
Response
Returns a CreateWishlistOutput
Arguments
| Name | Description |
|---|---|
input - CreateWishlistInput!
|
An input object that defines a new wish list. |
Example
Query
mutation createWishlist($input: CreateWishlistInput!) {
createWishlist(input: $input) {
wishlist {
...WishlistFragment
}
}
}
Variables
{"input": CreateWishlistInput}
Response
{"data": {"createWishlist": {"wishlist": Wishlist}}}
deleteCompanyRole
Description
Delete the specified company role.
Response
Returns a DeleteCompanyRoleOutput
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteCompanyRole($id: ID!) {
deleteCompanyRole(id: $id) {
success
}
}
Variables
{"id": 4}
Response
{"data": {"deleteCompanyRole": {"success": false}}}
deleteCompanyTeam
Description
Delete the specified company team.
Response
Returns a DeleteCompanyTeamOutput
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteCompanyTeam($id: ID!) {
deleteCompanyTeam(id: $id) {
success
}
}
Variables
{"id": 4}
Response
{"data": {"deleteCompanyTeam": {"success": true}}}
deleteCompanyUserV2
Description
Delete the specified company user.
Response
Returns a DeleteCompanyUserOutput
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteCompanyUserV2($id: ID!) {
deleteCompanyUserV2(id: $id) {
success
}
}
Variables
{"id": "4"}
Response
{"data": {"deleteCompanyUserV2": {"success": false}}}
deleteCompareList
Description
Delete the specified compare list.
Response
Returns a DeleteCompareListOutput
Arguments
| Name | Description |
|---|---|
uid - ID!
|
The unique ID of the compare list to be deleted. |
Example
Query
mutation deleteCompareList($uid: ID!) {
deleteCompareList(uid: $uid) {
result
}
}
Variables
{"uid": "4"}
Response
{"data": {"deleteCompareList": {"result": true}}}
deleteCustomer
Description
Delete customer account
Response
Returns a Boolean
Example
Query
mutation deleteCustomer {
deleteCustomer
}
Response
{"data": {"deleteCustomer": false}}
deleteCustomerAddress
Description
Delete the billing or shipping address of a customer.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int!
|
The ID of the customer address to be deleted. |
Example
Query
mutation deleteCustomerAddress($id: Int!) {
deleteCustomerAddress(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"deleteCustomerAddress": false}}
deleteNegotiableQuoteTemplate
Description
Delete a negotiable quote template
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - DeleteNegotiableQuoteTemplateInput!
|
An input object that cancels a negotiable quote template. |
Example
Query
mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
deleteNegotiableQuoteTemplate(input: $input)
}
Variables
{"input": DeleteNegotiableQuoteTemplateInput}
Response
{"data": {"deleteNegotiableQuoteTemplate": false}}
deleteNegotiableQuotes
Description
Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.
Response
Returns a DeleteNegotiableQuotesOutput
Arguments
| Name | Description |
|---|---|
input - DeleteNegotiableQuotesInput!
|
An input object that deletes a negotiable quote. |
Example
Query
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
deleteNegotiableQuotes(input: $input) {
negotiable_quotes {
...NegotiableQuotesOutputFragment
}
operation_results {
... on NegotiableQuoteUidOperationSuccess {
...NegotiableQuoteUidOperationSuccessFragment
}
... on DeleteNegotiableQuoteOperationFailure {
...DeleteNegotiableQuoteOperationFailureFragment
}
}
result_status
}
}
Variables
{"input": DeleteNegotiableQuotesInput}
Response
{
"data": {
"deleteNegotiableQuotes": {
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
}
}
deletePaymentToken
Description
Delete a customer's payment token.
Response
Returns a DeletePaymentTokenOutput
Arguments
| Name | Description |
|---|---|
public_hash - String!
|
The reusable payment token securely stored in the vault. |
Example
Query
mutation deletePaymentToken($public_hash: String!) {
deletePaymentToken(public_hash: $public_hash) {
customerPaymentTokens {
...CustomerPaymentTokensFragment
}
result
}
}
Variables
{"public_hash": "xyz789"}
Response
{
"data": {
"deletePaymentToken": {
"customerPaymentTokens": CustomerPaymentTokens,
"result": false
}
}
}
deletePurchaseOrderApprovalRule
Description
Delete existing purchase order approval rules.
Response
Returns a DeletePurchaseOrderApprovalRuleOutput
Arguments
| Name | Description |
|---|---|
input - DeletePurchaseOrderApprovalRuleInput!
|
Example
Query
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
deletePurchaseOrderApprovalRule(input: $input) {
errors {
...DeletePurchaseOrderApprovalRuleErrorFragment
}
}
}
Variables
{"input": DeletePurchaseOrderApprovalRuleInput}
Response
{
"data": {
"deletePurchaseOrderApprovalRule": {
"errors": [DeletePurchaseOrderApprovalRuleError]
}
}
}
deleteRequisitionList
Description
Delete a requisition list.
Response
Returns a DeleteRequisitionListOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
Example
Query
mutation deleteRequisitionList($requisitionListUid: ID!) {
deleteRequisitionList(requisitionListUid: $requisitionListUid) {
requisition_lists {
...RequisitionListsFragment
}
status
}
}
Variables
{"requisitionListUid": "4"}
Response
{
"data": {
"deleteRequisitionList": {
"requisition_lists": RequisitionLists,
"status": false
}
}
}
deleteRequisitionListItems
Description
Delete items from a requisition list.
Response
Returns a DeleteRequisitionListItemsOutput
Example
Query
mutation deleteRequisitionListItems(
$requisitionListUid: ID!,
$requisitionListItemUids: [ID!]!
) {
deleteRequisitionListItems(
requisitionListUid: $requisitionListUid,
requisitionListItemUids: $requisitionListItemUids
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
Response
{
"data": {
"deleteRequisitionListItems": {
"requisition_list": RequisitionList
}
}
}
deleteWishlist
Description
Delete the specified wish list. You cannot delete the customer's default (first) wish list.
Response
Returns a DeleteWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of the wish list to delete. |
Example
Query
mutation deleteWishlist($wishlistId: ID!) {
deleteWishlist(wishlistId: $wishlistId) {
status
wishlists {
...WishlistFragment
}
}
}
Variables
{"wishlistId": "4"}
Response
{
"data": {
"deleteWishlist": {
"status": false,
"wishlists": [Wishlist]
}
}
}
duplicateNegotiableQuote
Description
Negotiable Quote resulting from duplication operation.
Response
Returns a DuplicateNegotiableQuoteOutput
Arguments
| Name | Description |
|---|---|
input - DuplicateNegotiableQuoteInput!
|
An input object that defines ID of the quote to be duplicated. |
Example
Query
mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
duplicateNegotiableQuote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": DuplicateNegotiableQuoteInput}
Response
{
"data": {
"duplicateNegotiableQuote": {"quote": NegotiableQuote}
}
}
estimateShippingMethods
Description
Estimate shipping method(s) for cart based on address
Response
Returns [AvailableShippingMethod]
Arguments
| Name | Description |
|---|---|
input - EstimateTotalsInput!
|
An input object that specifies details for estimation of available shipping methods |
Example
Query
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
estimateShippingMethods(input: $input) {
additional_data {
...ShippingAdditionalDataFragment
}
amount {
...MoneyFragment
}
available
carrier_code
carrier_title
error_message
method_code
method_title
price_excl_tax {
...MoneyFragment
}
price_incl_tax {
...MoneyFragment
}
}
}
Variables
{"input": EstimateTotalsInput}
Response
{
"data": {
"estimateShippingMethods": [
{
"additional_data": [ShippingAdditionalData],
"amount": Money,
"available": true,
"carrier_code": "xyz789",
"carrier_title": "abc123",
"error_message": "abc123",
"method_code": "xyz789",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
]
}
}
estimateTotals
Description
Estimate totals for cart based on the address
Response
Returns an EstimateTotalsOutput!
Arguments
| Name | Description |
|---|---|
input - EstimateTotalsInput!
|
An input object that specifies details for cart totals estimation |
Example
Query
mutation estimateTotals($input: EstimateTotalsInput!) {
estimateTotals(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": EstimateTotalsInput}
Response
{"data": {"estimateTotals": {"cart": Cart}}}
exchangeExternalCustomerToken
Description
Generate a token for specified customer.
Response
Returns an ExchangeExternalCustomerTokenOutput
Arguments
| Name | Description |
|---|---|
input - ExchangeExternalCustomerTokenInput
|
Contains details about external customer. |
Example
Query
mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
exchangeExternalCustomerToken(input: $input) {
customer {
...CustomerFragment
}
token
}
}
Variables
{"input": ExchangeExternalCustomerTokenInput}
Response
{
"data": {
"exchangeExternalCustomerToken": {
"customer": Customer,
"token": "xyz789"
}
}
}
finishUpload
Response
Returns a finishUploadOutput
Arguments
| Name | Description |
|---|---|
input - finishUploadInput!
|
Example
Query
mutation finishUpload($input: finishUploadInput!) {
finishUpload(input: $input) {
key
message
success
}
}
Variables
{"input": finishUploadInput}
Response
{
"data": {
"finishUpload": {
"key": "abc123",
"message": "xyz789",
"success": true
}
}
}
generateCustomerToken
Description
Generate a token for specified customer.
Response
Returns a CustomerToken
Example
Query
mutation generateCustomerToken(
$email: String!,
$password: String!
) {
generateCustomerToken(
email: $email,
password: $password
) {
token
}
}
Variables
{
"email": "abc123",
"password": "abc123"
}
Response
{
"data": {
"generateCustomerToken": {
"token": "xyz789"
}
}
}
generateCustomerTokenAsAdmin
Description
Request a customer token so that an administrator can perform remote shopping assistance.
Response
Returns a GenerateCustomerTokenAsAdminOutput
Arguments
| Name | Description |
|---|---|
input - GenerateCustomerTokenAsAdminInput!
|
An input object that defines the customer email address. |
Example
Query
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
generateCustomerTokenAsAdmin(input: $input) {
customer_token
}
}
Variables
{"input": GenerateCustomerTokenAsAdminInput}
Response
{
"data": {
"generateCustomerTokenAsAdmin": {
"customer_token": "xyz789"
}
}
}
generateNegotiableQuoteFromTemplate
Description
Generate a negotiable quote from an accept quote template.
Response
Arguments
| Name | Description |
|---|---|
input - GenerateNegotiableQuoteFromTemplateInput!
|
An input object that contains the data to generate a negotiable quote from quote template. |
Example
Query
mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
generateNegotiableQuoteFromTemplate(input: $input) {
negotiable_quote_uid
}
}
Variables
{"input": GenerateNegotiableQuoteFromTemplateInput}
Response
{
"data": {
"generateNegotiableQuoteFromTemplate": {
"negotiable_quote_uid": "4"
}
}
}
initiateUpload
Response
Returns an initiateUploadOutput
Arguments
| Name | Description |
|---|---|
input - initiateUploadInput!
|
Example
Query
mutation initiateUpload($input: initiateUploadInput!) {
initiateUpload(input: $input) {
expires_at
key
upload_url
}
}
Variables
{"input": initiateUploadInput}
Response
{
"data": {
"initiateUpload": {
"expires_at": "xyz789",
"key": "abc123",
"upload_url": "abc123"
}
}
}
mergeCarts
Description
Transfer the contents of a guest cart into the cart of a logged-in customer.
Response
Returns a Cart!
Example
Query
mutation mergeCarts(
$source_cart_id: String!,
$destination_cart_id: String
) {
mergeCarts(
source_cart_id: $source_cart_id,
destination_cart_id: $destination_cart_id
) {
applied_coupons {
...AppliedCouponFragment
}
applied_gift_cards {
...AppliedGiftCardFragment
}
applied_reward_points {
...RewardPointsAmountFragment
}
applied_store_credit {
...AppliedStoreCreditFragment
}
available_gift_wrappings {
...GiftWrappingFragment
}
available_payment_methods {
...AvailablePaymentMethodFragment
}
billing_address {
...BillingCartAddressFragment
}
custom_attributes {
...CustomAttributeFragment
}
email
gift_message {
...GiftMessageFragment
}
gift_receipt_included
gift_wrapping {
...GiftWrappingFragment
}
id
is_virtual
itemsV2 {
...CartItemsFragment
}
prices {
...CartPricesFragment
}
printed_card_included
rules {
...CartRuleStorefrontFragment
}
selected_payment_method {
...SelectedPaymentMethodFragment
}
shipping_addresses {
...ShippingCartAddressFragment
}
total_quantity
}
}
Variables
{
"source_cart_id": "abc123",
"destination_cart_id": "xyz789"
}
Response
{
"data": {
"mergeCarts": {
"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,
"custom_attributes": [CustomAttribute],
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": "4",
"is_virtual": true,
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
}
}
}
moveCartItemsToGiftRegistry
Description
Move all items from the cart to a gift registry.
Response
Returns a MoveCartItemsToGiftRegistryOutput
Example
Query
mutation moveCartItemsToGiftRegistry(
$cartUid: ID!,
$giftRegistryUid: ID!
) {
moveCartItemsToGiftRegistry(
cartUid: $cartUid,
giftRegistryUid: $giftRegistryUid
) {
gift_registry {
...GiftRegistryFragment
}
status
user_errors {
...GiftRegistryItemsUserErrorFragment
}
}
}
Variables
{"cartUid": 4, "giftRegistryUid": "4"}
Response
{
"data": {
"moveCartItemsToGiftRegistry": {
"gift_registry": GiftRegistry,
"status": false,
"user_errors": [GiftRegistryItemsUserError]
}
}
}
moveItemsBetweenRequisitionLists
Description
Move Items from one requisition list to another.
Response
Returns a MoveItemsBetweenRequisitionListsOutput
Arguments
| Name | Description |
|---|---|
sourceRequisitionListUid - ID!
|
The unique ID of the source requisition list. |
destinationRequisitionListUid - ID
|
The unique ID of the destination requisition list. If null, a new requisition list will be created. |
requisitionListItem - MoveItemsBetweenRequisitionListsInput
|
The list of products to move. |
Example
Query
mutation moveItemsBetweenRequisitionLists(
$sourceRequisitionListUid: ID!,
$destinationRequisitionListUid: ID,
$requisitionListItem: MoveItemsBetweenRequisitionListsInput
) {
moveItemsBetweenRequisitionLists(
sourceRequisitionListUid: $sourceRequisitionListUid,
destinationRequisitionListUid: $destinationRequisitionListUid,
requisitionListItem: $requisitionListItem
) {
destination_requisition_list {
...RequisitionListFragment
}
source_requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"sourceRequisitionListUid": "4",
"destinationRequisitionListUid": 4,
"requisitionListItem": MoveItemsBetweenRequisitionListsInput
}
Response
{
"data": {
"moveItemsBetweenRequisitionLists": {
"destination_requisition_list": RequisitionList,
"source_requisition_list": RequisitionList
}
}
}
moveLineItemToRequisitionList
Description
Move negotiable quote item to requisition list.
Response
Returns a MoveLineItemToRequisitionListOutput
Arguments
| Name | Description |
|---|---|
input - MoveLineItemToRequisitionListInput!
|
An input object that defines the quote item and requisition list moved to. |
Example
Query
mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
moveLineItemToRequisitionList(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": MoveLineItemToRequisitionListInput}
Response
{
"data": {
"moveLineItemToRequisitionList": {
"quote": NegotiableQuote
}
}
}
moveProductsBetweenWishlists
Description
Move products from one wish list to another.
Response
Returns a MoveProductsBetweenWishlistsOutput
Arguments
| Name | Description |
|---|---|
sourceWishlistUid - ID!
|
The ID of the original wish list. |
destinationWishlistUid - ID!
|
The ID of the target wish list. |
wishlistItems - [WishlistItemMoveInput!]!
|
An array of items to move. |
Example
Query
mutation moveProductsBetweenWishlists(
$sourceWishlistUid: ID!,
$destinationWishlistUid: ID!,
$wishlistItems: [WishlistItemMoveInput!]!
) {
moveProductsBetweenWishlists(
sourceWishlistUid: $sourceWishlistUid,
destinationWishlistUid: $destinationWishlistUid,
wishlistItems: $wishlistItems
) {
destination_wishlist {
...WishlistFragment
}
source_wishlist {
...WishlistFragment
}
user_errors {
...WishListUserInputErrorFragment
}
}
}
Variables
{
"sourceWishlistUid": "4",
"destinationWishlistUid": 4,
"wishlistItems": [WishlistItemMoveInput]
}
Response
{
"data": {
"moveProductsBetweenWishlists": {
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
}
}
openNegotiableQuoteTemplate
Description
Open an existing negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - OpenNegotiableQuoteTemplateInput!
|
An input object that contains the data to open a negotiable quote template. |
Example
Query
mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
openNegotiableQuoteTemplate(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": OpenNegotiableQuoteTemplateInput}
Response
{
"data": {
"openNegotiableQuoteTemplate": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "xyz789",
"template_id": "4",
"total_quantity": 123.45
}
}
}
placeNegotiableQuoteOrder
Description
Convert a negotiable quote into an order.
Response
Returns a PlaceNegotiableQuoteOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceNegotiableQuoteOrderInput!
|
An input object that specifies the negotiable quote. |
Example
Query
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
placeNegotiableQuoteOrder(input: $input) {
order {
...OrderFragment
}
orderV2 {
...CustomerOrderFragment
}
}
}
Variables
{"input": PlaceNegotiableQuoteOrderInput}
Response
{
"data": {
"placeNegotiableQuoteOrder": {
"order": Order,
"orderV2": CustomerOrder
}
}
}
placeOrder
Description
Convert the quote into an order.
Response
Returns a PlaceOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceOrderInput
|
An input object that defines the shopper's cart ID. |
Example
Query
mutation placeOrder($input: PlaceOrderInput) {
placeOrder(input: $input) {
errors {
...PlaceOrderErrorFragment
}
orderV2 {
...CustomerOrderFragment
}
}
}
Variables
{"input": PlaceOrderInput}
Response
{
"data": {
"placeOrder": {
"errors": [PlaceOrderError],
"orderV2": CustomerOrder
}
}
}
placeOrderForPurchaseOrder
Description
Convert the purchase order into an order.
Response
Returns a PlaceOrderForPurchaseOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlaceOrderForPurchaseOrderInput!
|
Example
Query
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
placeOrderForPurchaseOrder(input: $input) {
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": PlaceOrderForPurchaseOrderInput}
Response
{
"data": {
"placeOrderForPurchaseOrder": {"order": CustomerOrder}
}
}
placePurchaseOrder
Description
Place a purchase order.
Response
Returns a PlacePurchaseOrderOutput
Arguments
| Name | Description |
|---|---|
input - PlacePurchaseOrderInput!
|
Example
Query
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
placePurchaseOrder(input: $input) {
purchase_order {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PlacePurchaseOrderInput}
Response
{
"data": {
"placePurchaseOrder": {
"purchase_order": PurchaseOrder
}
}
}
redeemGiftCardBalanceAsStoreCredit
Description
Redeem a gift card for store credit.
Response
Returns a GiftCardAccount
Arguments
| Name | Description |
|---|---|
input - GiftCardAccountInput!
|
An input object that specifies the gift card code to redeem. |
Example
Query
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
redeemGiftCardBalanceAsStoreCredit(input: $input) {
balance {
...MoneyFragment
}
code
expiration_date
}
}
Variables
{"input": GiftCardAccountInput}
Response
{
"data": {
"redeemGiftCardBalanceAsStoreCredit": {
"balance": Money,
"code": "xyz789",
"expiration_date": "abc123"
}
}
}
rejectPurchaseOrders
Description
Reject purchase orders.
Response
Returns a PurchaseOrdersActionOutput
Arguments
| Name | Description |
|---|---|
input - PurchaseOrdersActionInput!
|
Example
Query
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
rejectPurchaseOrders(input: $input) {
errors {
...PurchaseOrderActionErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": PurchaseOrdersActionInput}
Response
{
"data": {
"rejectPurchaseOrders": {
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
}
}
removeCouponFromCart
Description
Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.
Response
Returns a RemoveCouponFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveCouponFromCartInput
|
An input object that defines which coupon code to remove from the cart. |
Example
Query
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
removeCouponFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveCouponFromCartInput}
Response
{"data": {"removeCouponFromCart": {"cart": Cart}}}
removeCouponsFromCart
Description
Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.
Response
Returns a RemoveCouponFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveCouponsFromCartInput
|
An input object that defines which coupon code to remove from the cart. |
Example
Query
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
removeCouponsFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveCouponsFromCartInput}
Response
{"data": {"removeCouponsFromCart": {"cart": Cart}}}
removeGiftCardFromCart
Description
Removes a gift card from the cart.
Response
Returns a RemoveGiftCardFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveGiftCardFromCartInput
|
An input object that specifies which gift card code to remove from the cart. |
Example
Query
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
removeGiftCardFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveGiftCardFromCartInput}
Response
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
removeGiftRegistry
Description
Delete the specified gift registry.
Response
Returns a RemoveGiftRegistryOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry to delete. |
Example
Query
mutation removeGiftRegistry($giftRegistryUid: ID!) {
removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
success
}
}
Variables
{"giftRegistryUid": 4}
Response
{"data": {"removeGiftRegistry": {"success": false}}}
removeGiftRegistryItems
Description
Delete the specified items from a gift registry.
Response
Returns a RemoveGiftRegistryItemsOutput
Example
Query
mutation removeGiftRegistryItems(
$giftRegistryUid: ID!,
$itemsUid: [ID!]!
) {
removeGiftRegistryItems(
giftRegistryUid: $giftRegistryUid,
itemsUid: $itemsUid
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{"giftRegistryUid": "4", "itemsUid": [4]}
Response
{
"data": {
"removeGiftRegistryItems": {
"gift_registry": GiftRegistry
}
}
}
removeGiftRegistryRegistrants
Description
Removes registrants from a gift registry.
Response
Returns a RemoveGiftRegistryRegistrantsOutput
Example
Query
mutation removeGiftRegistryRegistrants(
$giftRegistryUid: ID!,
$registrantsUid: [ID!]!
) {
removeGiftRegistryRegistrants(
giftRegistryUid: $giftRegistryUid,
registrantsUid: $registrantsUid
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": "4",
"registrantsUid": [4]
}
Response
{
"data": {
"removeGiftRegistryRegistrants": {
"gift_registry": GiftRegistry
}
}
}
removeItemFromCart
Description
Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.
Response
Returns a RemoveItemFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveItemFromCartInput
|
An input object that defines which products to remove from the cart. |
Example
Query
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
removeItemFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveItemFromCartInput}
Response
{"data": {"removeItemFromCart": {"cart": Cart}}}
removeNegotiableQuoteItems
Description
Remove one or more products from a negotiable quote.
Response
Returns a RemoveNegotiableQuoteItemsOutput
Arguments
| Name | Description |
|---|---|
input - RemoveNegotiableQuoteItemsInput!
|
An input object that removes one or more items from a negotiable quote. |
Example
Query
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
removeNegotiableQuoteItems(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": RemoveNegotiableQuoteItemsInput}
Response
{
"data": {
"removeNegotiableQuoteItems": {
"quote": NegotiableQuote
}
}
}
removeNegotiableQuoteTemplateItems
Description
Remove one or more products from a negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - RemoveNegotiableQuoteTemplateItemsInput!
|
An input object that removes one or more items from a negotiable quote template. |
Example
Query
mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
removeNegotiableQuoteTemplateItems(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": RemoveNegotiableQuoteTemplateItemsInput}
Response
{
"data": {
"removeNegotiableQuoteTemplateItems": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": "4",
"total_quantity": 123.45
}
}
}
removeProductsFromCompareList
Description
Remove products from the specified compare list.
Response
Returns a CompareList
Arguments
| Name | Description |
|---|---|
input - RemoveProductsFromCompareListInput
|
An input object that defines which products to remove from a compare list. |
Example
Query
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
removeProductsFromCompareList(input: $input) {
attributes {
...ComparableAttributeFragment
}
item_count
items {
...ComparableItemFragment
}
uid
}
}
Variables
{"input": RemoveProductsFromCompareListInput}
Response
{
"data": {
"removeProductsFromCompareList": {
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
"uid": 4
}
}
}
removeProductsFromWishlist
Description
Remove one or more products from the specified wish list.
Response
Returns a RemoveProductsFromWishlistOutput
Example
Query
mutation removeProductsFromWishlist(
$wishlistId: ID!,
$wishlistItemsIds: [ID!]!
) {
removeProductsFromWishlist(
wishlistId: $wishlistId,
wishlistItemsIds: $wishlistItemsIds
) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{"wishlistId": 4, "wishlistItemsIds": ["4"]}
Response
{
"data": {
"removeProductsFromWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
removeReturnTracking
Description
Remove a tracked shipment from a return.
Response
Returns a RemoveReturnTrackingOutput
Arguments
| Name | Description |
|---|---|
input - RemoveReturnTrackingInput!
|
An input object that removes tracking information. |
Example
Query
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
removeReturnTracking(input: $input) {
return {
...ReturnFragment
}
}
}
Variables
{"input": RemoveReturnTrackingInput}
Response
{"data": {"removeReturnTracking": {"return": Return}}}
removeRewardPointsFromCart
Description
Cancel the application of reward points to the cart.
Response
Returns a RemoveRewardPointsFromCartOutput
Arguments
| Name | Description |
|---|---|
cartId - ID!
|
Example
Query
mutation removeRewardPointsFromCart($cartId: ID!) {
removeRewardPointsFromCart(cartId: $cartId) {
cart {
...CartFragment
}
}
}
Variables
{"cartId": 4}
Response
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
removeStoreCreditFromCart
Description
Remove store credit that has been applied to the specified cart.
Response
Returns a RemoveStoreCreditFromCartOutput
Arguments
| Name | Description |
|---|---|
input - RemoveStoreCreditFromCartInput!
|
An input object that specifies the cart ID. |
Example
Query
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
removeStoreCreditFromCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": RemoveStoreCreditFromCartInput}
Response
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
renameNegotiableQuote
Description
Rename negotiable quote.
Response
Returns a RenameNegotiableQuoteOutput
Arguments
| Name | Description |
|---|---|
input - RenameNegotiableQuoteInput!
|
An input object that defines the quote item name and comment. |
Example
Query
mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
renameNegotiableQuote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": RenameNegotiableQuoteInput}
Response
{
"data": {
"renameNegotiableQuote": {"quote": NegotiableQuote}
}
}
reorderItems
Description
Add all products from a customer's previous order to the cart.
Response
Returns a ReorderItemsOutput
Arguments
| Name | Description |
|---|---|
orderNumber - String!
|
Example
Query
mutation reorderItems($orderNumber: String!) {
reorderItems(orderNumber: $orderNumber) {
cart {
...CartFragment
}
userInputErrors {
...CheckoutUserInputErrorFragment
}
}
}
Variables
{"orderNumber": "xyz789"}
Response
{
"data": {
"reorderItems": {
"cart": Cart,
"userInputErrors": [CheckoutUserInputError]
}
}
}
requestGuestOrderCancel
Description
Request to cancel specified guest order.
Response
Returns a CancelOrderOutput
Arguments
| Name | Description |
|---|---|
input - GuestOrderCancelInput!
|
Example
Query
mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
requestGuestOrderCancel(input: $input) {
error
errorV2 {
...CancelOrderErrorFragment
}
order {
...CustomerOrderFragment
}
}
}
Variables
{"input": GuestOrderCancelInput}
Response
{
"data": {
"requestGuestOrderCancel": {
"error": "xyz789",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
}
}
requestGuestReturn
Response
Returns a RequestReturnOutput
Arguments
| Name | Description |
|---|---|
input - RequestGuestReturnInput!
|
An input object that contains the fields needed to start a return request for guest. |
Example
Query
mutation requestGuestReturn($input: RequestGuestReturnInput!) {
requestGuestReturn(input: $input) {
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
}
}
Variables
{"input": RequestGuestReturnInput}
Response
{
"data": {
"requestGuestReturn": {
"return": Return,
"returns": Returns
}
}
}
requestNegotiableQuote
Description
Request a new negotiable quote on behalf of the buyer.
Response
Returns a RequestNegotiableQuoteOutput
Arguments
| Name | Description |
|---|---|
input - RequestNegotiableQuoteInput!
|
An input object that contains a request to initiate a negotiable quote. |
Example
Query
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
requestNegotiableQuote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": RequestNegotiableQuoteInput}
Response
{
"data": {
"requestNegotiableQuote": {"quote": NegotiableQuote}
}
}
requestNegotiableQuoteTemplateFromQuote
Description
Request a new negotiable quote on behalf of the buyer.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - RequestNegotiableQuoteTemplateInput!
|
An input object that contains a request to initiate a negotiable quote template. |
Example
Query
mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
requestNegotiableQuoteTemplateFromQuote(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": RequestNegotiableQuoteTemplateInput}
Response
{
"data": {
"requestNegotiableQuoteTemplateFromQuote": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 123,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "xyz789",
"template_id": 4,
"total_quantity": 987.65
}
}
}
requestPasswordResetEmail
Description
Request an email with a reset password token for the registered customer identified by the specified email.
Example
Query
mutation requestPasswordResetEmail($email: String!) {
requestPasswordResetEmail(email: $email)
}
Variables
{"email": "abc123"}
Response
{"data": {"requestPasswordResetEmail": false}}
requestReturn
Description
Initiates a buyer's request to return items for replacement or refund.
Response
Returns a RequestReturnOutput
Arguments
| Name | Description |
|---|---|
input - RequestReturnInput!
|
An input object that contains the fields needed to start a return request. |
Example
Query
mutation requestReturn($input: RequestReturnInput!) {
requestReturn(input: $input) {
return {
...ReturnFragment
}
returns {
...ReturnsFragment
}
}
}
Variables
{"input": RequestReturnInput}
Response
{
"data": {
"requestReturn": {
"return": Return,
"returns": Returns
}
}
}
resendConfirmationEmail
Description
Resends the confirmation email to a customer.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
email - String!
|
The email address to send the confirmation email to. |
Example
Query
mutation resendConfirmationEmail($email: String!) {
resendConfirmationEmail(email: $email)
}
Variables
{"email": "abc123"}
Response
{"data": {"resendConfirmationEmail": true}}
resetPassword
Description
Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.
Response
Returns a Boolean
Example
Query
mutation resetPassword(
$email: String!,
$resetPasswordToken: String!,
$newPassword: String!
) {
resetPassword(
email: $email,
resetPasswordToken: $resetPasswordToken,
newPassword: $newPassword
)
}
Variables
{
"email": "xyz789",
"resetPasswordToken": "abc123",
"newPassword": "xyz789"
}
Response
{"data": {"resetPassword": false}}
revokeCustomerToken
Description
Revoke the customer token.
Response
Returns a RevokeCustomerTokenOutput
Example
Query
mutation revokeCustomerToken {
revokeCustomerToken {
result
}
}
Response
{"data": {"revokeCustomerToken": {"result": true}}}
sendNegotiableQuoteForReview
Description
Send the negotiable quote to the seller for review.
Response
Returns a SendNegotiableQuoteForReviewOutput
Arguments
| Name | Description |
|---|---|
input - SendNegotiableQuoteForReviewInput!
|
An input object that sends a request for the merchant to review a negotiable quote. |
Example
Query
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
sendNegotiableQuoteForReview(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SendNegotiableQuoteForReviewInput}
Response
{
"data": {
"sendNegotiableQuoteForReview": {
"quote": NegotiableQuote
}
}
}
setBillingAddressOnCart
Description
Set the billing address on a specific cart.
Response
Returns a SetBillingAddressOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetBillingAddressOnCartInput
|
An input object that defines the billing address to be assigned to the cart. |
Example
Query
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
setBillingAddressOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetBillingAddressOnCartInput}
Response
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
setCartAsInactive
Description
Sets the cart as inactive
Response
Returns a SetCartAsInactiveOutput
Arguments
| Name | Description |
|---|---|
cartId - String!
|
The customer cart ID |
Example
Query
mutation setCartAsInactive($cartId: String!) {
setCartAsInactive(cartId: $cartId) {
error
success
}
}
Variables
{"cartId": "abc123"}
Response
{
"data": {
"setCartAsInactive": {
"error": "abc123",
"success": false
}
}
}
setCustomAttributesOnCart
Description
Add custom attributes to the cart.
Response
Returns an AddCustomAttributesToCartItemOutput
Arguments
| Name | Description |
|---|---|
input - CartCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnCart($input: CartCustomAttributesInput) {
setCustomAttributesOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": CartCustomAttributesInput}
Response
{"data": {"setCustomAttributesOnCart": {"cart": Cart}}}
setCustomAttributesOnCartItem
Description
Add custom attributes to item in the cart.
Response
Returns an AddCustomAttributesToCartItemOutput
Arguments
| Name | Description |
|---|---|
input - CartItemCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnCartItem($input: CartItemCustomAttributesInput) {
setCustomAttributesOnCartItem(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": CartItemCustomAttributesInput}
Response
{
"data": {
"setCustomAttributesOnCartItem": {"cart": Cart}
}
}
setCustomAttributesOnCompany
Description
Add custom attributes to company.
Response
Returns a SetCustomAttributesOnCompanyOutput
Arguments
| Name | Description |
|---|---|
input - SetCustomAttributesOnCompanyInput!
|
An input object that defines the custom attributes to be assigned to a company. |
Example
Query
mutation setCustomAttributesOnCompany($input: SetCustomAttributesOnCompanyInput!) {
setCustomAttributesOnCompany(input: $input) {
company {
...CompanyFragment
}
}
}
Variables
{"input": SetCustomAttributesOnCompanyInput}
Response
{
"data": {
"setCustomAttributesOnCompany": {"company": Company}
}
}
setCustomAttributesOnCreditMemo
Description
Add custom attributes to the credit memo.
Response
Returns a CreditMemoOutput
Arguments
| Name | Description |
|---|---|
input - CreditMemoCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnCreditMemo($input: CreditMemoCustomAttributesInput) {
setCustomAttributesOnCreditMemo(input: $input) {
credit_memo {
...CreditMemoFragment
}
}
}
Variables
{"input": CreditMemoCustomAttributesInput}
Response
{
"data": {
"setCustomAttributesOnCreditMemo": {
"credit_memo": CreditMemo
}
}
}
setCustomAttributesOnCreditMemoItem
Description
Add custom attributes to the credit memo item.
Response
Returns a CreditMemoOutput
Arguments
| Name | Description |
|---|---|
input - CreditMemoItemCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnCreditMemoItem($input: CreditMemoItemCustomAttributesInput) {
setCustomAttributesOnCreditMemoItem(input: $input) {
credit_memo {
...CreditMemoFragment
}
}
}
Variables
{"input": CreditMemoItemCustomAttributesInput}
Response
{
"data": {
"setCustomAttributesOnCreditMemoItem": {
"credit_memo": CreditMemo
}
}
}
setCustomAttributesOnInvoice
Description
Add custom attributes to the invoice.
Response
Returns an InvoiceOutput
Arguments
| Name | Description |
|---|---|
input - InvoiceCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnInvoice($input: InvoiceCustomAttributesInput) {
setCustomAttributesOnInvoice(input: $input) {
invoice {
...InvoiceFragment
}
}
}
Variables
{"input": InvoiceCustomAttributesInput}
Response
{
"data": {
"setCustomAttributesOnInvoice": {"invoice": Invoice}
}
}
setCustomAttributesOnInvoiceItem
Description
Add custom attributes to the invoice item.
Response
Returns an InvoiceOutput
Arguments
| Name | Description |
|---|---|
input - InvoiceItemCustomAttributesInput
|
Example
Query
mutation setCustomAttributesOnInvoiceItem($input: InvoiceItemCustomAttributesInput) {
setCustomAttributesOnInvoiceItem(input: $input) {
invoice {
...InvoiceFragment
}
}
}
Variables
{"input": InvoiceItemCustomAttributesInput}
Response
{
"data": {
"setCustomAttributesOnInvoiceItem": {
"invoice": Invoice
}
}
}
setCustomAttributesOnNegotiableQuote
Description
Add custom attributes to a negotiable quote.
Response
Arguments
| Name | Description |
|---|---|
input - SetCustomAttributesOnNegotiableQuoteInput!
|
An input object that defines the custom attributes to be assigned to a negotiable quote. |
Example
Query
mutation setCustomAttributesOnNegotiableQuote($input: SetCustomAttributesOnNegotiableQuoteInput!) {
setCustomAttributesOnNegotiableQuote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetCustomAttributesOnNegotiableQuoteInput}
Response
{
"data": {
"setCustomAttributesOnNegotiableQuote": {
"quote": NegotiableQuote
}
}
}
setGiftOptionsOnCart
Description
Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.
Response
Returns a SetGiftOptionsOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetGiftOptionsOnCartInput
|
An input object that defines the selected gift options. |
Example
Query
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
setGiftOptionsOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetGiftOptionsOnCartInput}
Response
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
setGuestEmailOnCart
Description
Assign the email address of a guest to the cart.
Response
Returns a SetGuestEmailOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetGuestEmailOnCartInput
|
An input object that defines a guest email address. |
Example
Query
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
setGuestEmailOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetGuestEmailOnCartInput}
Response
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
setLineItemNote
Description
Add buyer's note to a negotiable quote item.
Response
Returns a SetLineItemNoteOutput
Arguments
| Name | Description |
|---|---|
input - LineItemNoteInput!
|
An input object that defines the quote item note. |
Example
Query
mutation setLineItemNote($input: LineItemNoteInput!) {
setLineItemNote(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": LineItemNoteInput}
Response
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
setNegotiableQuoteBillingAddress
Description
Assign a billing address to a negotiable quote.
Response
Returns a SetNegotiableQuoteBillingAddressOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteBillingAddressInput!
|
An input object that defines the billing address to be assigned to a negotiable quote. |
Example
Query
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
setNegotiableQuoteBillingAddress(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuoteBillingAddressInput}
Response
{
"data": {
"setNegotiableQuoteBillingAddress": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuotePaymentMethod
Description
Set the payment method on a negotiable quote.
Response
Returns a SetNegotiableQuotePaymentMethodOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuotePaymentMethodInput!
|
An input object that defines the payment method for the specified negotiable quote. |
Example
Query
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
setNegotiableQuotePaymentMethod(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuotePaymentMethodInput}
Response
{
"data": {
"setNegotiableQuotePaymentMethod": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuoteShippingAddress
Description
Assign a previously-defined address as the shipping address for a negotiable quote.
Response
Returns a SetNegotiableQuoteShippingAddressOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteShippingAddressInput!
|
An input object that defines the shipping address to be assigned to a negotiable quote. |
Example
Query
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
setNegotiableQuoteShippingAddress(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuoteShippingAddressInput}
Response
{
"data": {
"setNegotiableQuoteShippingAddress": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuoteShippingMethods
Description
Assign the shipping methods on the negotiable quote.
Response
Returns a SetNegotiableQuoteShippingMethodsOutput
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteShippingMethodsInput!
|
An input object that defines the shipping methods to be assigned to a negotiable quote. |
Example
Query
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
setNegotiableQuoteShippingMethods(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": SetNegotiableQuoteShippingMethodsInput}
Response
{
"data": {
"setNegotiableQuoteShippingMethods": {
"quote": NegotiableQuote
}
}
}
setNegotiableQuoteTemplateShippingAddress
Description
Assign a previously-defined address as the shipping address for a negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - SetNegotiableQuoteTemplateShippingAddressInput!
|
An input object that defines the shipping address to be assigned to a negotiable quote template. |
Example
Query
mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
setNegotiableQuoteTemplateShippingAddress(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": SetNegotiableQuoteTemplateShippingAddressInput}
Response
{
"data": {
"setNegotiableQuoteTemplateShippingAddress": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": false,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 123,
"name": "abc123",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": 4,
"total_quantity": 987.65
}
}
}
setPaymentMethodOnCart
Description
Apply a payment method to the cart.
Response
Returns a SetPaymentMethodOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetPaymentMethodOnCartInput
|
An input object that defines which payment method to apply to the cart. |
Example
Query
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
setPaymentMethodOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetPaymentMethodOnCartInput}
Response
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
setQuoteTemplateLineItemNote
Description
Add buyer's note to a negotiable quote template item.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - QuoteTemplateLineItemNoteInput!
|
An input object that defines the quote template item note. |
Example
Query
mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
setQuoteTemplateLineItemNote(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": QuoteTemplateLineItemNoteInput}
Response
{
"data": {
"setQuoteTemplateLineItemNote": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": 4,
"total_quantity": 987.65
}
}
}
setShippingAddressesOnCart
Description
Set one or more shipping addresses on a specific cart.
Response
Returns a SetShippingAddressesOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetShippingAddressesOnCartInput
|
An input object that defines one or more shipping addresses to be assigned to the cart. |
Example
Query
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
setShippingAddressesOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetShippingAddressesOnCartInput}
Response
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
setShippingMethodsOnCart
Description
Set one or more delivery methods on a cart.
Response
Returns a SetShippingMethodsOnCartOutput
Arguments
| Name | Description |
|---|---|
input - SetShippingMethodsOnCartInput
|
An input object that applies one or more shipping methods to the cart. |
Example
Query
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
setShippingMethodsOnCart(input: $input) {
cart {
...CartFragment
}
}
}
Variables
{"input": SetShippingMethodsOnCartInput}
Response
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
submitNegotiableQuoteTemplateForReview
Description
Accept an existing negotiable quote template.
Response
Returns a NegotiableQuoteTemplate
Arguments
| Name | Description |
|---|---|
input - SubmitNegotiableQuoteTemplateForReviewInput!
|
An input object that contains the data to update a negotiable quote template. |
Example
Query
mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
submitNegotiableQuoteTemplateForReview(input: $input) {
buyer {
...NegotiableQuoteUserFragment
}
comments {
...NegotiableQuoteCommentFragment
}
expiration_date
history {
...NegotiableQuoteHistoryEntryFragment
}
is_min_max_qty_used
is_virtual
items {
...CartItemInterfaceFragment
}
max_order_commitment
min_order_commitment
name
notifications {
...QuoteTemplateNotificationMessageFragment
}
prices {
...CartPricesFragment
}
reference_document_links {
...NegotiableQuoteReferenceDocumentLinkFragment
}
shipping_addresses {
...NegotiableQuoteShippingAddressFragment
}
status
template_id
total_quantity
}
}
Variables
{"input": SubmitNegotiableQuoteTemplateForReviewInput}
Response
{
"data": {
"submitNegotiableQuoteTemplateForReview": {
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": false,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 987,
"min_order_commitment": 123,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [
NegotiableQuoteShippingAddress
],
"status": "abc123",
"template_id": "4",
"total_quantity": 123.45
}
}
}
subscribeEmailToNewsletter
Description
Subscribe the specified email to the store's newsletter.
Response
Returns a SubscribeEmailToNewsletterOutput
Arguments
| Name | Description |
|---|---|
email - String!
|
The email address that will receive the store's newsletter. |
Example
Query
mutation subscribeEmailToNewsletter($email: String!) {
subscribeEmailToNewsletter(email: $email) {
status
}
}
Variables
{"email": "abc123"}
Response
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
syncPaymentOrder
Description
Synchronizes the payment order details for further payment processing
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - SyncPaymentOrderInput
|
Describes the variables needed to synchronize the payment order details |
Example
Query
mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
syncPaymentOrder(input: $input)
}
Variables
{"input": SyncPaymentOrderInput}
Response
{"data": {"syncPaymentOrder": true}}
updateCartItems
Description
Modify items in the cart.
Response
Returns an UpdateCartItemsOutput
Arguments
| Name | Description |
|---|---|
input - UpdateCartItemsInput
|
An input object that defines products to be updated. |
Example
Query
mutation updateCartItems($input: UpdateCartItemsInput) {
updateCartItems(input: $input) {
cart {
...CartFragment
}
errors {
...CartUserInputErrorFragment
}
}
}
Variables
{"input": UpdateCartItemsInput}
Response
{
"data": {
"updateCartItems": {
"cart": Cart,
"errors": [CartUserInputError]
}
}
}
updateCompany
Description
Update company information.
Response
Returns an UpdateCompanyOutput
Arguments
| Name | Description |
|---|---|
input - CompanyUpdateInput!
|
Example
Query
mutation updateCompany($input: CompanyUpdateInput!) {
updateCompany(input: $input) {
company {
...CompanyFragment
}
}
}
Variables
{"input": CompanyUpdateInput}
Response
{"data": {"updateCompany": {"company": Company}}}
updateCompanyRole
Description
Update company role information.
Response
Returns an UpdateCompanyRoleOutput
Arguments
| Name | Description |
|---|---|
input - CompanyRoleUpdateInput!
|
Example
Query
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
updateCompanyRole(input: $input) {
role {
...CompanyRoleFragment
}
}
}
Variables
{"input": CompanyRoleUpdateInput}
Response
{"data": {"updateCompanyRole": {"role": CompanyRole}}}
updateCompanyStructure
Description
Change the parent node of a company team within the current company context.
Response
Returns an UpdateCompanyStructureOutput
Arguments
| Name | Description |
|---|---|
input - CompanyStructureUpdateInput!
|
Example
Query
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
updateCompanyStructure(input: $input) {
company {
...CompanyFragment
}
}
}
Variables
{"input": CompanyStructureUpdateInput}
Response
{"data": {"updateCompanyStructure": {"company": Company}}}
updateCompanyTeam
Description
Update company team data.
Response
Returns an UpdateCompanyTeamOutput
Arguments
| Name | Description |
|---|---|
input - CompanyTeamUpdateInput!
|
Example
Query
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
updateCompanyTeam(input: $input) {
team {
...CompanyTeamFragment
}
}
}
Variables
{"input": CompanyTeamUpdateInput}
Response
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
updateCompanyUser
Description
Update an existing company user.
Response
Returns an UpdateCompanyUserOutput
Arguments
| Name | Description |
|---|---|
input - CompanyUserUpdateInput!
|
Example
Query
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
updateCompanyUser(input: $input) {
user {
...CustomerFragment
}
}
}
Variables
{"input": CompanyUserUpdateInput}
Response
{"data": {"updateCompanyUser": {"user": Customer}}}
updateCustomerAddress
Description
Update the billing or shipping address of a customer or guest.
Response
Returns a CustomerAddress
Arguments
| Name | Description |
|---|---|
id - Int!
|
The ID assigned to the customer address. |
input - CustomerAddressInput
|
An input object that contains changes to the customer address. |
Example
Query
mutation updateCustomerAddress(
$id: Int!,
$input: CustomerAddressInput
) {
updateCustomerAddress(
id: $id,
input: $input
) {
city
company
country_code
custom_attributesV2 {
...AttributeValueInterfaceFragment
}
default_billing
default_shipping
extension_attributes {
...CustomerAddressAttributeFragment
}
fax
firstname
id
lastname
middlename
postcode
prefix
region {
...CustomerAddressRegionFragment
}
region_id
street
suffix
telephone
uid
vat_id
}
}
Variables
{"id": 987, "input": CustomerAddressInput}
Response
{
"data": {
"updateCustomerAddress": {
"city": "xyz789",
"company": "xyz789",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": true,
"default_shipping": true,
"extension_attributes": [CustomerAddressAttribute],
"fax": "abc123",
"firstname": "xyz789",
"id": 987,
"lastname": "xyz789",
"middlename": "xyz789",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegion,
"region_id": 987,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "abc123",
"uid": 4,
"vat_id": "xyz789"
}
}
}
updateCustomerEmail
Description
Change the email address for the logged-in customer.
Response
Returns a CustomerOutput
Example
Query
mutation updateCustomerEmail(
$email: String!,
$password: String!
) {
updateCustomerEmail(
email: $email,
password: $password
) {
customer {
...CustomerFragment
}
}
}
Variables
{
"email": "xyz789",
"password": "abc123"
}
Response
{"data": {"updateCustomerEmail": {"customer": Customer}}}
updateCustomerV2
Description
Update the customer's personal information.
Response
Returns a CustomerOutput
Arguments
| Name | Description |
|---|---|
input - CustomerUpdateInput!
|
An input object that defines the customer characteristics to update. |
Example
Query
mutation updateCustomerV2($input: CustomerUpdateInput!) {
updateCustomerV2(input: $input) {
customer {
...CustomerFragment
}
}
}
Variables
{"input": CustomerUpdateInput}
Response
{"data": {"updateCustomerV2": {"customer": Customer}}}
updateGiftRegistry
Description
Update the specified gift registry.
Response
Returns an UpdateGiftRegistryOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of an existing gift registry. |
giftRegistry - UpdateGiftRegistryInput!
|
An input object that defines which fields to update. |
Example
Query
mutation updateGiftRegistry(
$giftRegistryUid: ID!,
$giftRegistry: UpdateGiftRegistryInput!
) {
updateGiftRegistry(
giftRegistryUid: $giftRegistryUid,
giftRegistry: $giftRegistry
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": "4",
"giftRegistry": UpdateGiftRegistryInput
}
Response
{
"data": {
"updateGiftRegistry": {"gift_registry": GiftRegistry}
}
}
updateGiftRegistryItems
Description
Update the specified items in the gift registry.
Response
Returns an UpdateGiftRegistryItemsOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
items - [UpdateGiftRegistryItemInput!]!
|
An array of items to be updated. |
Example
Query
mutation updateGiftRegistryItems(
$giftRegistryUid: ID!,
$items: [UpdateGiftRegistryItemInput!]!
) {
updateGiftRegistryItems(
giftRegistryUid: $giftRegistryUid,
items: $items
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": 4,
"items": [UpdateGiftRegistryItemInput]
}
Response
{
"data": {
"updateGiftRegistryItems": {
"gift_registry": GiftRegistry
}
}
}
updateGiftRegistryRegistrants
Description
Modify the properties of one or more gift registry registrants.
Response
Returns an UpdateGiftRegistryRegistrantsOutput
Arguments
| Name | Description |
|---|---|
giftRegistryUid - ID!
|
The unique ID of the gift registry. |
registrants - [UpdateGiftRegistryRegistrantInput!]!
|
An array of registrants to update. |
Example
Query
mutation updateGiftRegistryRegistrants(
$giftRegistryUid: ID!,
$registrants: [UpdateGiftRegistryRegistrantInput!]!
) {
updateGiftRegistryRegistrants(
giftRegistryUid: $giftRegistryUid,
registrants: $registrants
) {
gift_registry {
...GiftRegistryFragment
}
}
}
Variables
{
"giftRegistryUid": "4",
"registrants": [UpdateGiftRegistryRegistrantInput]
}
Response
{
"data": {
"updateGiftRegistryRegistrants": {
"gift_registry": GiftRegistry
}
}
}
updateNegotiableQuoteQuantities
Description
Change the quantity of one or more items in an existing negotiable quote.
Response
Returns an UpdateNegotiableQuoteItemsQuantityOutput
Arguments
| Name | Description |
|---|---|
input - UpdateNegotiableQuoteQuantitiesInput!
|
An input object that changes the quantity of one or more items in a negotiable quote. |
Example
Query
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
updateNegotiableQuoteQuantities(input: $input) {
quote {
...NegotiableQuoteFragment
}
}
}
Variables
{"input": UpdateNegotiableQuoteQuantitiesInput}
Response
{
"data": {
"updateNegotiableQuoteQuantities": {
"quote": NegotiableQuote
}
}
}
updateNegotiableQuoteTemplateQuantities
Description
Change the quantity of one or more items in an existing negotiable quote template.
Response
Arguments
| Name | Description |
|---|---|
input - UpdateNegotiableQuoteTemplateQuantitiesInput!
|
An input object that changes the quantity of one or more items in a negotiable quote template. |
Example
Query
mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
updateNegotiableQuoteTemplateQuantities(input: $input) {
quote_template {
...NegotiableQuoteTemplateFragment
}
}
}
Variables
{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
Response
{
"data": {
"updateNegotiableQuoteTemplateQuantities": {
"quote_template": NegotiableQuoteTemplate
}
}
}
updateProductsInWishlist
Description
Update one or more products in the specified wish list.
Response
Returns an UpdateProductsInWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of a wish list. |
wishlistItems - [WishlistItemUpdateInput!]!
|
An array of items to be updated. |
Example
Query
mutation updateProductsInWishlist(
$wishlistId: ID!,
$wishlistItems: [WishlistItemUpdateInput!]!
) {
updateProductsInWishlist(
wishlistId: $wishlistId,
wishlistItems: $wishlistItems
) {
user_errors {
...WishListUserInputErrorFragment
}
wishlist {
...WishlistFragment
}
}
}
Variables
{
"wishlistId": 4,
"wishlistItems": [WishlistItemUpdateInput]
}
Response
{
"data": {
"updateProductsInWishlist": {
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
}
}
updatePurchaseOrderApprovalRule
Description
Update existing purchase order approval rules.
Response
Returns a PurchaseOrderApprovalRule
Arguments
| Name | Description |
|---|---|
input - UpdatePurchaseOrderApprovalRuleInput!
|
Example
Query
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
updatePurchaseOrderApprovalRule(input: $input) {
applies_to_roles {
...CompanyRoleFragment
}
approver_roles {
...CompanyRoleFragment
}
condition {
...PurchaseOrderApprovalRuleConditionInterfaceFragment
}
created_at
created_by
description
name
status
uid
updated_at
}
}
Variables
{"input": UpdatePurchaseOrderApprovalRuleInput}
Response
{
"data": {
"updatePurchaseOrderApprovalRule": {
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "abc123",
"created_by": "xyz789",
"description": "xyz789",
"name": "abc123",
"status": "ENABLED",
"uid": 4,
"updated_at": "xyz789"
}
}
}
updateRequisitionList
Description
Rename a requisition list and change its description.
Response
Returns an UpdateRequisitionListOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
input - UpdateRequisitionListInput
|
Example
Query
mutation updateRequisitionList(
$requisitionListUid: ID!,
$input: UpdateRequisitionListInput
) {
updateRequisitionList(
requisitionListUid: $requisitionListUid,
input: $input
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"requisitionListUid": "4",
"input": UpdateRequisitionListInput
}
Response
{
"data": {
"updateRequisitionList": {
"requisition_list": RequisitionList
}
}
}
updateRequisitionListItems
Description
Update items in a requisition list.
Response
Returns an UpdateRequisitionListItemsOutput
Arguments
| Name | Description |
|---|---|
requisitionListUid - ID!
|
The unique ID of the requisition list. |
requisitionListItems - [UpdateRequisitionListItemsInput!]!
|
Items to be updated in the requisition list. |
Example
Query
mutation updateRequisitionListItems(
$requisitionListUid: ID!,
$requisitionListItems: [UpdateRequisitionListItemsInput!]!
) {
updateRequisitionListItems(
requisitionListUid: $requisitionListUid,
requisitionListItems: $requisitionListItems
) {
requisition_list {
...RequisitionListFragment
}
}
}
Variables
{
"requisitionListUid": "4",
"requisitionListItems": [
UpdateRequisitionListItemsInput
]
}
Response
{
"data": {
"updateRequisitionListItems": {
"requisition_list": RequisitionList
}
}
}
updateWishlist
Description
Change the name and visibility of the specified wish list.
Response
Returns an UpdateWishlistOutput
Arguments
| Name | Description |
|---|---|
wishlistId - ID!
|
The ID of the wish list to update. |
name - String
|
The name assigned to the wish list. |
visibility - WishlistVisibilityEnum
|
Indicates the visibility of the wish list. |
Example
Query
mutation updateWishlist(
$wishlistId: ID!,
$name: String,
$visibility: WishlistVisibilityEnum
) {
updateWishlist(
wishlistId: $wishlistId,
name: $name,
visibility: $visibility
) {
name
uid
visibility
}
}
Variables
{
"wishlistId": 4,
"name": "xyz789",
"visibility": "PUBLIC"
}
Response
{
"data": {
"updateWishlist": {
"name": "abc123",
"uid": 4,
"visibility": "PUBLIC"
}
}
}
validatePurchaseOrders
Description
Validate purchase orders.
Response
Returns a ValidatePurchaseOrdersOutput
Arguments
| Name | Description |
|---|---|
input - ValidatePurchaseOrdersInput!
|
Example
Query
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
validatePurchaseOrders(input: $input) {
errors {
...ValidatePurchaseOrderErrorFragment
}
purchase_orders {
...PurchaseOrderFragment
}
}
}
Variables
{"input": ValidatePurchaseOrdersInput}
Response
{
"data": {
"validatePurchaseOrders": {
"errors": [ValidatePurchaseOrderError],
"purchase_orders": [PurchaseOrder]
}
}
}
Types
AcceptNegotiableQuoteTemplateInput
Description
Specifies the quote template id to accept quote template.
Fields
| Input Field | Description |
|---|---|
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{"template_id": "4"}
AddCustomAttributesToCartItemOutput
Description
Contains details about the cart after adding custom attributes to it items.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The custom attributes to cart item have been added. |
Example
{"cart": Cart}
AddDownloadableProductsToCartInput
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The ID of the cart. |
cart_items - [DownloadableProductCartItemInput]!
|
An array of downloadable products to add. |
Example
{
"cart_id": "abc123",
"cart_items": [DownloadableProductCartItemInput]
}
AddDownloadableProductsToCartOutput
Description
Contains details about the cart after adding downloadable products.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after adding products. |
Example
{"cart": Cart}
AddGiftRegistryRegistrantInput
Description
Defines a new registrant.
Fields
| Input Field | Description |
|---|---|
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
|
Additional attributes specified as a code-value pair. |
email - String!
|
The email address of the registrant. |
firstname - String!
|
The first name of the registrant. |
lastname - String!
|
The last name of the registrant. |
Example
{
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
"email": "xyz789",
"firstname": "xyz789",
"lastname": "xyz789"
}
AddGiftRegistryRegistrantsOutput
Description
Contains the results of a request to add registrants.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry after adding registrants. |
Example
{"gift_registry": GiftRegistry}
AddProductsToCartOutput
Description
Contains details about the cart after adding products to it.
Example
{
"cart": Cart,
"user_errors": [Error]
}
AddProductsToCompareListInput
Description
Contains products to add to an existing compare list.
Example
{"products": ["4"], "uid": 4}
AddProductsToNewCartOutput
Description
Contains details about the cart after adding products to it.
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The cart after products have been added. |
user_errors - [CartUserInputError]
|
Contains errors encountered while adding an item to the cart. |
Example
{
"cart": Cart,
"user_errors": [CartUserInputError]
}
AddProductsToRequisitionListOutput
Description
Output of the request to add products to a requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The requisition list after adding products. |
Example
{"requisition_list": RequisitionList}
AddProductsToWishlistOutput
Description
Contains the customer's wish list and any errors encountered.
Fields
| Field Name | Description |
|---|---|
user_errors - [WishListUserInputError]!
|
An array of errors encountered while adding products to a wish list. |
wishlist - Wishlist!
|
Contains the wish list with all items that were successfully added. |
Example
{
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
AddPurchaseOrderCommentInput
Description
Contains the comment to be added to a purchase order.
Example
{
"comment": "abc123",
"purchase_order_uid": 4
}
AddPurchaseOrderCommentOutput
Description
Contains the successfully added comment.
Fields
| Field Name | Description |
|---|---|
comment - PurchaseOrderComment!
|
The purchase order comment. |
Example
{"comment": PurchaseOrderComment}
AddPurchaseOrderItemsToCartInput
Description
Defines the purchase order and cart to act on.
Example
{
"cart_id": "xyz789",
"purchase_order_uid": 4,
"replace_existing_cart_items": true
}
AddRequisitionListItemToCartUserError
Description
Contains details about why an attempt to add items to the requistion list failed.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error. |
type - AddRequisitionListItemToCartUserErrorType!
|
The type of error that occurred. |
Example
{
"message": "abc123",
"type": "OUT_OF_STOCK"
}
AddRequisitionListItemToCartUserErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"OUT_OF_STOCK"
AddRequisitionListItemsToCartOutput
Description
Output of the request to add items in a requisition list to the cart.
Fields
| Field Name | Description |
|---|---|
add_requisition_list_items_to_cart_user_errors - [AddRequisitionListItemToCartUserError]!
|
Details about why the attempt to add items to the requistion list was not successful. |
cart - Cart
|
The cart after adding requisition list items. |
status - Boolean!
|
Indicates whether the attempt to add items to the requisition list was successful. |
Example
{
"add_requisition_list_items_to_cart_user_errors": [
AddRequisitionListItemToCartUserError
],
"cart": Cart,
"status": false
}
AddReturnCommentInput
Description
Defines a return comment.
Example
{
"comment_text": "xyz789",
"return_uid": "4"
}
AddReturnCommentOutput
Description
Contains details about the return request.
Fields
| Field Name | Description |
|---|---|
return - Return
|
The modified return. |
Example
{"return": Return}
AddReturnTrackingInput
Description
Defines tracking information to be added to the return.
Example
{
"carrier_uid": "4",
"return_uid": 4,
"tracking_number": "abc123"
}
AddReturnTrackingOutput
Description
Contains the response after adding tracking information.
Fields
| Field Name | Description |
|---|---|
return - Return
|
Details about the modified return. |
return_shipping_tracking - ReturnShippingTracking
|
Details about shipping for a return. |
Example
{
"return": Return,
"return_shipping_tracking": ReturnShippingTracking
}
AddWishlistItemsToCartOutput
Description
Contains the resultant wish list and any error information.
Fields
| Field Name | Description |
|---|---|
add_wishlist_items_to_cart_user_errors - [WishlistCartUserInputError]!
|
An array of errors encountered while adding products to the customer's cart. |
status - Boolean!
|
Indicates whether the attempt to add items to the customer's cart was successful. |
wishlist - Wishlist!
|
Contains the wish list with all items that were successfully added. |
Example
{
"add_wishlist_items_to_cart_user_errors": [
WishlistCartUserInputError
],
"status": false,
"wishlist": Wishlist
}
Aggregation
Description
A bucket that contains information for each filterable option
Fields
| Field Name | Description |
|---|---|
attribute - String!
|
The attribute code of the filter item |
buckets - [Bucket]!
|
A container that divides the data into manageable groups. For example, attributes that can have numeric values might have buckets that define price ranges |
title - String!
|
The filter name displayed in layered navigation |
type - AggregationType
|
Identifies the data type of the aggregation |
Example
{
"attribute": "abc123",
"buckets": [Bucket],
"title": "abc123",
"type": "INTELLIGENT"
}
AggregationType
Description
Identifies the data type of the aggregation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INTELLIGENT"
ApplePayConfig
Fields
| Field Name | Description |
|---|---|
button_styles - ButtonStyles
|
The styles for the ApplePay Smart Button configuration |
code - String
|
The payment method code as defined in the payment gateway |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
payment_source - String
|
The payment source for the payment method |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
title - String
|
The name displayed for the payment method |
Example
{
"button_styles": ButtonStyles,
"code": "abc123",
"is_visible": true,
"payment_intent": "abc123",
"payment_source": "xyz789",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
"title": "abc123"
}
ApplePayMethodInput
Description
Apple Pay inputs
Example
{
"payment_source": "abc123",
"payments_order_id": "xyz789",
"paypal_order_id": "abc123"
}
AppliedCoupon
Description
Contains the applied coupon code.
Fields
| Field Name | Description |
|---|---|
code - String!
|
The coupon code the shopper applied to the card. |
Example
{"code": "xyz789"}
AppliedGiftCard
Description
Contains an applied gift card with applied and remaining balance.
Example
{
"applied_balance": Money,
"code": "xyz789",
"current_balance": Money,
"expiration_date": "abc123"
}
AppliedQueryRule
Description
The rule that was applied to this product
Fields
| Field Name | Description |
|---|---|
action_type - AppliedQueryRuleActionType
|
An enum that defines the type of rule that was applied |
rule_id - String
|
The ID assigned to the rule |
rule_name - String
|
The name of the applied rule |
Example
{
"action_type": "BOOST",
"rule_id": "xyz789",
"rule_name": "abc123"
}
AppliedQueryRuleActionType
Description
The type of rule that was applied to a product during search (optional)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BOOST"
AppliedStoreCredit
Description
Contains the applied and current balances.
Fields
| Field Name | Description |
|---|---|
applied_balance - Money
|
The applied store credit balance to the current cart. |
current_balance - Money
|
The current balance remaining on store credit. |
enabled - Boolean
|
Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. |
Example
{
"applied_balance": Money,
"current_balance": Money,
"enabled": true
}
ApplyCouponToCartInput
Description
Specifies the coupon code to apply to the cart.
Example
{
"cart_id": "abc123",
"coupon_code": "xyz789"
}
ApplyCouponToCartOutput
Description
Contains details about the cart after applying a coupon.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after applying a coupon. |
Example
{"cart": Cart}
ApplyCouponsStrategy
Description
The strategy to apply coupons to the cart.
Values
| Enum Value | Description |
|---|---|
|
|
Append new coupons keeping the coupons that have been applied before. |
|
|
Remove all the coupons from the cart and apply only new provided coupons. |
Example
"APPEND"
ApplyCouponsToCartInput
Description
Apply coupons to the cart.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
coupon_codes - [String]!
|
An array of valid coupon codes. |
type - ApplyCouponsStrategy
|
replace to replace the existing coupon(s) or append to add the coupon to the coupon(s) list.
|
Example
{
"cart_id": "abc123",
"coupon_codes": ["xyz789"],
"type": "APPEND"
}
ApplyGiftCardToCartInput
Description
Defines the input required to run the applyGiftCardToCart mutation.
Example
{
"cart_id": "xyz789",
"gift_card_code": "abc123"
}
ApplyGiftCardToCartOutput
Description
Defines the possible output for the applyGiftCardToCart mutation.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
Describes the contents of the specified shopping cart. |
Example
{"cart": Cart}
ApplyGiftCardToOrder
Description
Contains applied gift cards with gift card code and amount.
Example
{
"applied_balance": Money,
"code": "xyz789"
}
ApplyRewardPointsToCartOutput
Description
Contains the customer cart.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The customer cart after reward points are applied. |
Example
{"cart": Cart}
ApplyStoreCreditToCartInput
Description
Defines the input required to run the applyStoreCreditToCart mutation.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID that identifies the customer's cart. |
Example
{"cart_id": "xyz789"}
ApplyStoreCreditToCartOutput
Description
Defines the possible output for the applyStoreCreditToCart mutation.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The contents of the specified shopping cart. |
Example
{"cart": Cart}
AreaInput
Description
AreaInput defines the parameters which will be used for filter by specified location.
Example
{"radius": 123, "search_term": "abc123"}
AssetImage
Description
Contains information about an asset image.
Fields
| Field Name | Description |
|---|---|
asset_image - ProductMediaGalleryEntriesAssetImage
|
Contains a ProductMediaGalleryEntriesAssetImage object. |
disabled - Boolean
|
Indicates whether the image is hidden from view. |
label - String
|
The label of the product image or video. |
position - Int
|
The media item's position after it has been sorted. |
url - String
|
The URL of the product image or video. |
Example
{
"asset_image": ProductMediaGalleryEntriesAssetImage,
"disabled": true,
"label": "abc123",
"position": 987,
"url": "abc123"
}
AssetVideo
Description
Contains information about an asset video.
Fields
| Field Name | Description |
|---|---|
asset_video - ProductMediaGalleryEntriesAssetVideo
|
Contains a ProductMediaGalleryEntriesAssetVideo object. |
disabled - Boolean
|
Indicates whether the image is hidden from view. |
label - String
|
The label of the product image or video. |
position - Int
|
The media item's position after it has been sorted. |
url - String
|
The URL of the product image or video. |
Example
{
"asset_video": ProductMediaGalleryEntriesAssetVideo,
"disabled": true,
"label": "abc123",
"position": 123,
"url": "abc123"
}
AssignCompareListToCustomerOutput
Description
Contains the results of the request to assign a compare list.
Fields
| Field Name | Description |
|---|---|
compare_list - CompareList
|
The contents of the customer's compare list. |
result - Boolean!
|
Indicates whether the compare list was successfully assigned to the customer. |
Example
{"compare_list": CompareList, "result": true}
AttributeEntityTypeEnum
Description
List of all entity types. Populated by the modules introducing EAV entities.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CATALOG_PRODUCT"
AttributeFile
AttributeFilterInput
Description
An input object that specifies the filters used for attributes.
Fields
| Input Field | Description |
|---|---|
is_comparable - Boolean
|
Whether a product or category attribute can be compared against another or not. |
is_filterable - Boolean
|
Whether a product or category attribute can be filtered or not. |
is_filterable_in_search - Boolean
|
Whether a product or category attribute can be filtered in search or not. |
is_html_allowed_on_front - Boolean
|
Whether a product or category attribute can use HTML on front or not. |
is_searchable - Boolean
|
Whether a product or category attribute can be searched or not. |
is_used_for_customer_segment - Boolean
|
Whether a customer or customer address attribute is used for customer segment or not. |
is_used_for_price_rules - Boolean
|
Whether a product or category attribute can be used for price rules or not. |
is_used_for_promo_rules - Boolean
|
Whether a product or category attribute is used for promo rules or not. |
is_visible_in_advanced_search - Boolean
|
Whether a product or category attribute is visible in advanced search or not. |
is_visible_on_front - Boolean
|
Whether a product or category attribute is visible on front or not. |
is_wysiwyg_enabled - Boolean
|
Whether a product or category attribute has WYSIWYG enabled or not. |
used_in_product_listing - Boolean
|
Whether a product or category attribute is used in product listing or not. |
Example
{
"is_comparable": false,
"is_filterable": false,
"is_filterable_in_search": true,
"is_html_allowed_on_front": false,
"is_searchable": false,
"is_used_for_customer_segment": false,
"is_used_for_price_rules": false,
"is_used_for_promo_rules": false,
"is_visible_in_advanced_search": false,
"is_visible_on_front": true,
"is_wysiwyg_enabled": false,
"used_in_product_listing": false
}
AttributeFrontendInputEnum
Description
EAV attribute frontend input types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
AttributeInput
Description
Defines the attribute characteristics to search for the attribute_code and entity_type to search.
Example
{
"attribute_code": "abc123",
"entity_type": "abc123"
}
AttributeInputSelectedOption
Description
Specifies selected option for a select or multiselect attribute value.
Fields
| Input Field | Description |
|---|---|
value - String!
|
The attribute option value. |
Example
{"value": "abc123"}
AttributeMetadata
Description
Base EAV implementation of CustomAttributeMetadataInterface.
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The unique identifier for an attribute code. This value should be in lowercase letters without spaces. |
default_value - String
|
Default attribute value. |
entity_type - AttributeEntityTypeEnum!
|
The type of entity that defines the attribute. |
frontend_class - String
|
The frontend class of the attribute. |
frontend_input - AttributeFrontendInputEnum
|
The frontend input type of the attribute. |
is_required - Boolean!
|
Whether the attribute value is required. |
is_unique - Boolean!
|
Whether the attribute value must be unique. |
label - String
|
The label assigned to the attribute. |
options - [CustomAttributeOptionInterface]!
|
Attribute options. |
Example
{
"code": 4,
"default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": false,
"is_unique": false,
"label": "abc123",
"options": [CustomAttributeOptionInterface]
}
AttributeMetadataError
Description
Attribute metadata retrieval error.
Fields
| Field Name | Description |
|---|---|
message - String!
|
Attribute metadata retrieval error message. |
type - AttributeMetadataErrorType!
|
Attribute metadata retrieval error type. |
Example
{
"message": "abc123",
"type": "ENTITY_NOT_FOUND"
}
AttributeMetadataErrorType
Description
Attribute metadata retrieval error types.
Values
| Enum Value | Description |
|---|---|
|
|
The requested entity was not found. |
|
|
The requested attribute was not found. |
|
|
The filter cannot be applied as it does not belong to the entity |
|
|
Not categorized error, see the error message. |
Example
"ENTITY_NOT_FOUND"
AttributeMetadataResponse
Description
Contains the output of the attributeMetadata query
Fields
| Field Name | Description |
|---|---|
filterableInSearch - [FilterableInSearchAttribute!]
|
An array of product attributes that can be used for filtering in a productSearch query |
sortable - [SortableAttribute!]
|
An array of product attributes that can be used for sorting in a productSearch query |
Example
{
"filterableInSearch": [FilterableInSearchAttribute],
"sortable": [SortableAttribute]
}
AttributeOptionMetadata
Description
Base EAV implementation of CustomAttributeOptionInterface.
Example
{
"is_default": false,
"label": "xyz789",
"value": "xyz789"
}
AttributeSelectedOption
AttributeSelectedOptionInterface
Fields
| Field Name | Description |
|---|---|
label - String!
|
The attribute selected option label. |
value - String!
|
The attribute selected option value. |
Possible Types
| AttributeSelectedOptionInterface Types |
|---|
Example
{
"label": "xyz789",
"value": "abc123"
}
AttributeSelectedOptions
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The attribute code. |
selected_options - [AttributeSelectedOptionInterface]!
|
Example
{
"code": "4",
"selected_options": [AttributeSelectedOptionInterface]
}
AttributeValue
Example
{
"code": "4",
"value": "abc123"
}
AttributeValueInput
Description
Specifies the value for attribute.
Fields
| Input Field | Description |
|---|---|
attribute_code - String!
|
The code of the attribute. |
selected_options - [AttributeInputSelectedOption]
|
An array containing selected options for a select or multiselect attribute. |
value - String
|
The value assigned to the attribute. |
Example
{
"attribute_code": "abc123",
"selected_options": [AttributeInputSelectedOption],
"value": "xyz789"
}
AttributeValueInterface
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The attribute code. |
Possible Types
| AttributeValueInterface Types |
|---|
Example
{"code": 4}
AttributesFormOutput
Description
Metadata of EAV attributes associated to form
Fields
| Field Name | Description |
|---|---|
errors - [AttributeMetadataError]!
|
Errors of retrieving certain attributes metadata. |
items - [CustomAttributeMetadataInterface]!
|
Requested attributes metadata. |
Example
{
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
AttributesMetadataOutput
Description
Metadata of EAV attributes.
Fields
| Field Name | Description |
|---|---|
errors - [AttributeMetadataError]!
|
Errors of retrieving certain attributes metadata. |
items - [CustomAttributeMetadataInterface]!
|
Requested attributes metadata. |
Example
{
"errors": [AttributeMetadataError],
"items": [CustomAttributeMetadataInterface]
}
AvailableCurrency
Description
Defines the code and symbol of a currency that can be used for purchase orders.
Fields
| Field Name | Description |
|---|---|
code - CurrencyEnum!
|
3-letter currency code, for example USD. |
symbol - String!
|
Currency symbol, for example $. |
Example
{"code": "AFN", "symbol": "abc123"}
AvailablePaymentMethod
Description
Describes a payment method that the shopper can use to pay for the order.
Fields
| Field Name | Description |
|---|---|
code - String!
|
The payment method code. |
is_deferred - Boolean!
|
If the payment method is an online integration |
oope_payment_method_config - OopePaymentMethodConfig
|
Configuration for out of process payment methods |
title - String!
|
The payment method title. |
Example
{
"code": "abc123",
"is_deferred": true,
"oope_payment_method_config": OopePaymentMethodConfig,
"title": "abc123"
}
AvailableShippingMethod
Description
Contains details about the possible shipping methods and carriers.
Fields
| Field Name | Description |
|---|---|
additional_data - [ShippingAdditionalData]
|
Additional data related to the shipping method. |
amount - Money!
|
The cost of shipping using this shipping method. |
available - Boolean!
|
Indicates whether this shipping method can be applied to the cart. |
carrier_code - String!
|
A string that identifies a commercial carrier or an offline shipping method. |
carrier_title - String!
|
The label for the carrier code. |
error_message - String
|
Describes an error condition. |
method_code - String
|
A shipping method code associated with a carrier. The value could be null if no method is available. |
method_title - String
|
The label for the shipping method code. The value could be null if no method is available. |
price_excl_tax - Money!
|
The cost of shipping using this shipping method, excluding tax. |
price_incl_tax - Money!
|
The cost of shipping using this shipping method, including tax. |
Example
{
"additional_data": [ShippingAdditionalData],
"amount": Money,
"available": false,
"carrier_code": "xyz789",
"carrier_title": "abc123",
"error_message": "xyz789",
"method_code": "xyz789",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
BatchMutationStatus
BillingAddressInput
Description
Defines the billing address.
Fields
| Input Field | Description |
|---|---|
address - CartAddressInput
|
Defines a billing address. |
customer_address_id - Int
|
An ID from the customer's address book that uniquely identifies the address to be used for billing. |
same_as_shipping - Boolean
|
Indicates whether to set the billing address to be the same as the existing shipping address on the cart. |
use_for_shipping - Boolean
|
Indicates whether to set the shipping address to be the same as this billing address. |
Example
{
"address": CartAddressInput,
"customer_address_id": 123,
"same_as_shipping": true,
"use_for_shipping": false
}
BillingAddressPaymentSourceInput
Description
The billing address information
Fields
| Input Field | Description |
|---|---|
address_line_1 - String
|
The first line of the address |
address_line_2 - String
|
The second line of the address |
city - String
|
The city of the address |
country_code - String!
|
The country of the address |
postal_code - String
|
The postal code of the address |
region - String
|
The region of the address |
Example
{
"address_line_1": "xyz789",
"address_line_2": "abc123",
"city": "abc123",
"country_code": "abc123",
"postal_code": "abc123",
"region": "xyz789"
}
BillingCartAddress
Description
Contains details about the billing address.
Fields
| Field Name | Description |
|---|---|
city - String!
|
The city specified for the billing or shipping address. |
company - String
|
The company specified for the billing or shipping address. |
country - CartAddressCountry!
|
An object containing the country label and code. |
custom_attributes - [AttributeValueInterface]!
|
The custom attribute values of the billing or shipping address. |
fax - String
|
The customer's fax number. |
firstname - String!
|
The first name of the customer or guest. |
id - Int
|
Id of the customer address. |
lastname - String!
|
The last name of the customer or guest. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The ZIP or postal code of the billing or shipping address. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - CartAddressRegion
|
An object containing the region label and code. |
street - [String]!
|
An array containing the street for the billing or shipping address. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number for the billing or shipping address. |
uid - String!
|
The unique id of the customer address. |
vat_id - String
|
The VAT company number for billing or shipping address. |
Example
{
"city": "abc123",
"company": "abc123",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "abc123",
"firstname": "abc123",
"id": 123,
"lastname": "xyz789",
"middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
"region": CartAddressRegion,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "xyz789",
"uid": "abc123",
"vat_id": "xyz789"
}
Boolean
Breadcrumb
Description
Contains details about an individual category that comprises a breadcrumb.
Example
{
"category_level": 987,
"category_name": "xyz789",
"category_uid": "4",
"category_url_key": "abc123",
"category_url_path": "xyz789"
}
Bucket
Description
An interface for bucket contents
Fields
| Field Name | Description |
|---|---|
title - String!
|
A human-readable name of a bucket |
Possible Types
| Bucket Types |
|---|
Example
{"title": "abc123"}
BundleCartItem
Description
An implementation for bundle product cart items.
Fields
| Field Name | Description |
|---|---|
available_gift_wrapping - [GiftWrapping]!
|
The list of available gift wrapping options for the cart item. |
bundle_options - [SelectedBundleOption]!
|
An array containing the bundle options the shopper selected. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array containing the customizable options the shopper selected. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
gift_message - GiftMessage
|
The entered gift message for the cart item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the cart item. |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"available_gift_wrapping": [GiftWrapping],
"bundle_options": [SelectedBundleOption],
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"is_available": false,
"max_qty": 123.45,
"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"
}
BundleCreditMemoItem
Description
Defines bundle product options for CreditMemoItemInterface.
Fields
| Field Name | Description |
|---|---|
bundle_options - [ItemSelectedBundleOption]
|
A list of bundle options that are assigned to a bundle product that is part of a credit memo. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo item |
discounts - [Discount]
|
Details about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for a CreditMemoItemInterface object. |
order_item - OrderItemInterface
|
The order item the credit memo is applied to. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_refunded - Float
|
The number of refunded items. |
Example
{
"bundle_options": [ItemSelectedBundleOption],
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 123.45
}
BundleInvoiceItem
Description
Defines bundle product options for InvoiceItemInterface.
Fields
| Field Name | Description |
|---|---|
bundle_options - [ItemSelectedBundleOption]
|
A list of bundle options that are assigned to an invoiced bundle product. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice item |
discounts - [Discount]
|
Information about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for an InvoiceItemInterface object. |
order_item - OrderItemInterface
|
Details about an individual order item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_invoiced - Float
|
The number of invoiced items. |
Example
{
"bundle_options": [ItemSelectedBundleOption],
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_invoiced": 987.65
}
BundleItem
Description
Defines an individual item within a bundle product.
Fields
| Field Name | Description |
|---|---|
options - [BundleItemOption]
|
An array of additional options for this bundle item. |
position - Int
|
A number indicating the sequence order of this item compared to the other bundle items. |
price_range - PriceRange!
|
The range of prices for the product |
required - Boolean
|
Indicates whether the item must be included in the bundle. |
sku - String
|
The SKU of the bundle product. |
title - String
|
The display name of the item. |
type - String
|
The input type that the customer uses to select the item. Examples include radio button and checkbox. |
uid - ID
|
The unique ID for a BundleItem object. |
Example
{
"options": [BundleItemOption],
"position": 123,
"price_range": PriceRange,
"required": false,
"sku": "abc123",
"title": "xyz789",
"type": "xyz789",
"uid": 4
}
BundleItemOption
Description
Defines the characteristics that comprise a specific bundle item and its options.
Fields
| Field Name | Description |
|---|---|
can_change_quantity - Boolean
|
Indicates whether the customer can change the number of items for this option. |
is_default - Boolean
|
Indicates whether this option is the default option. |
label - String
|
The text that identifies the bundled item option. |
position - Int
|
When a bundle item contains multiple options, the relative position of this option compared to the other options. |
price - Float
|
The price of the selected option. |
price_type - PriceTypeEnum
|
One of FIXED, PERCENT, or DYNAMIC. |
product - ProductInterface
|
Contains details about this product option. |
quantity - Float
|
The quantity of this specific bundle item. |
uid - ID!
|
The unique ID for a BundleItemOption object. |
Example
{
"can_change_quantity": true,
"is_default": false,
"label": "abc123",
"position": 987,
"price": 123.45,
"price_type": "FIXED",
"product": ProductInterface,
"quantity": 123.45,
"uid": 4
}
BundleOrderItem
Description
Defines bundle product options for OrderItemInterface.
Fields
| Field Name | Description |
|---|---|
bundle_options - [ItemSelectedBundleOption]
|
A list of bundle options that are assigned to the bundle product. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
parent_sku - String
|
The SKU of parent product. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Example
{
"bundle_options": [ItemSelectedBundleOption],
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": 4,
"parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
"product_type": "xyz789",
"product_url_key": "abc123",
"quantity_canceled": 987.65,
"quantity_invoiced": 987.65,
"quantity_ordered": 987.65,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
"quantity_returned": 987.65,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
}
BundleProduct
Description
Defines basic features of a bundle product and contains multiple BundleItems.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
dynamic_price - Boolean
|
Indicates whether the bundle product has a dynamic price. |
dynamic_sku - Boolean
|
Indicates whether the bundle product has a dynamic SKU. |
dynamic_weight - Boolean
|
Indicates whether the bundle product has a dynamically calculated weight. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
items - [BundleItem]
|
An array containing information about individual bundle items. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_details - PriceDetails
|
The price details of the main product |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
price_view - PriceViewEnum
|
One of PRICE_RANGE or AS_LOW_AS. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
ship_bundle_items - ShipBundleItemsEnum
|
Indicates whether to ship bundle items together or individually. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
weight - Float
|
The weight of the item, in units defined by the store. |
Example
{
"canonical_url": "abc123",
"categories": [CategoryInterface],
"country_of_manufacture": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"dynamic_price": true,
"dynamic_sku": false,
"dynamic_weight": false,
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "abc123",
"items": [BundleItem],
"manufacturer": 987,
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "abc123",
"new_from_date": "abc123",
"new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_details": PriceDetails,
"price_range": PriceRange,
"price_tiers": [TierPrice],
"price_view": "PRICE_RANGE",
"product_links": [ProductLinksInterface],
"quantity": 123.45,
"related_products": [ProductInterface],
"ship_bundle_items": "TOGETHER",
"short_description": ComplexTextValue,
"sku": "abc123",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "abc123",
"weight": 123.45
}
BundleRequisitionListItem
Description
Contains details about bundle products added to a requisition list.
Fields
| Field Name | Description |
|---|---|
bundle_options - [SelectedBundleOption]!
|
An array of selected options for a bundle product. |
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. |
quantity - Float!
|
The quantity of the product added to the requisition list. |
uid - ID!
|
The unique ID of an item in a requisition list. |
Example
{
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 987.65,
"uid": 4
}
BundleShipmentItem
Description
Defines bundle product options for ShipmentItemInterface.
Fields
| Field Name | Description |
|---|---|
bundle_options - [ItemSelectedBundleOption]
|
A list of bundle options that are assigned to a shipped product. |
id - ID!
|
The unique ID for a ShipmentItemInterface object. |
order_item - OrderItemInterface
|
The order item associated with the shipment item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product. |
product_sku - String!
|
The SKU of the base product. |
quantity_shipped - Float!
|
The number of shipped items. |
Example
{
"bundle_options": [ItemSelectedBundleOption],
"id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_shipped": 123.45
}
BundleWishlistItem
Description
Defines bundle product options for WishlistItemInterface.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
bundle_options - [SelectedBundleOption]
|
An array containing information about the selected bundle items. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "xyz789",
"bundle_options": [SelectedBundleOption],
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 123.45
}
ButtonStyles
Fields
| Field Name | Description |
|---|---|
color - String
|
The button color |
height - Int
|
The button height in pixels |
label - String
|
The button label |
layout - String
|
The button layout |
shape - String
|
The button shape |
tagline - Boolean
|
Indicates whether the tagline is displayed |
use_default_height - Boolean
|
Defines if the button uses default height. If the value is false, the value of height is used |
Example
{
"color": "xyz789",
"height": 987,
"label": "xyz789",
"layout": "xyz789",
"shape": "xyz789",
"tagline": true,
"use_default_height": true
}
CancelNegotiableQuoteTemplateInput
Description
Specifies the quote template id of the quote template to cancel
Example
{
"cancellation_comment": "xyz789",
"template_id": "4"
}
CancelOrderError
Fields
| Field Name | Description |
|---|---|
code - CancelOrderErrorCode!
|
An error code that is specific to cancel order. |
message - String!
|
A localized error message. |
Example
{
"code": "ORDER_CANCELLATION_DISABLED",
"message": "abc123"
}
CancelOrderErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDER_CANCELLATION_DISABLED"
CancelOrderInput
CancelOrderOutput
Description
Contains the updated customer order and error message if any.
Fields
| Field Name | Description |
|---|---|
error - String
|
Error encountered while cancelling the order. |
errorV2 - CancelOrderError
|
|
order - CustomerOrder
|
Updated customer order. |
Example
{
"error": "abc123",
"errorV2": CancelOrderError,
"order": CustomerOrder
}
CancellationReason
Card
Example
{
"bin_details": CardBin,
"card_expiry_month": "abc123",
"card_expiry_year": "xyz789",
"last_digits": "xyz789",
"name": "xyz789"
}
CardBin
CardPaymentSourceInput
Description
The card payment source information
Fields
| Input Field | Description |
|---|---|
billing_address - BillingAddressPaymentSourceInput!
|
The billing address of the card |
name - String
|
The name on the cardholder |
Example
{
"billing_address": BillingAddressPaymentSourceInput,
"name": "xyz789"
}
CardPaymentSourceOutput
Description
The card payment source information
Example
{
"brand": "xyz789",
"expiry": "xyz789",
"last_digits": "abc123"
}
Cart
Description
Contains the contents and other details about a guest or customer cart.
Fields
| Field Name | Description |
|---|---|
applied_coupons - [AppliedCoupon]
|
An array of AppliedCoupon objects. Each object contains the code text attribute, which specifies the coupon code. |
applied_gift_cards - [AppliedGiftCard]
|
An array of gift card items applied to the cart. |
applied_reward_points - RewardPointsAmount
|
The amount of reward points applied to the cart. |
applied_store_credit - AppliedStoreCredit
|
Store credit information applied to the cart. |
available_gift_wrappings - [GiftWrapping]!
|
The list of available gift wrapping options for the cart. |
available_payment_methods - [AvailablePaymentMethod]
|
An array of available payment methods. |
billing_address - BillingCartAddress
|
The billing address assigned to the cart. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart |
email - String
|
The email address of the guest or customer. |
gift_message - GiftMessage
|
The entered gift message for the cart |
gift_receipt_included - Boolean!
|
Indicates whether the shopper requested gift receipt for the cart. |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the cart. |
id - ID!
|
The unique ID for a Cart object. |
is_virtual - Boolean!
|
Indicates whether the cart contains only virtual products. |
itemsV2 - CartItems
|
|
Arguments |
|
prices - CartPrices
|
Pricing details for the quote. |
printed_card_included - Boolean!
|
Indicates whether the shopper requested a printed card for the cart. |
rules - [CartRuleStorefront]
|
Provides applied cart rules in the current active cart |
selected_payment_method - SelectedPaymentMethod
|
Indicates which payment method was applied to the cart. |
shipping_addresses - [ShippingCartAddress]!
|
An array of shipping addresses assigned to the cart. |
total_quantity - Float!
|
The total number of items in the cart. |
Example
{
"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,
"custom_attributes": [CustomAttribute],
"email": "abc123",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": 4,
"is_virtual": false,
"itemsV2": CartItems,
"prices": CartPrices,
"printed_card_included": true,
"rules": [CartRuleStorefront],
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [ShippingCartAddress],
"total_quantity": 123.45
}
CartAddressCountry
Description
Contains details the country in a billing or shipping address.
Example
{
"code": "xyz789",
"label": "abc123"
}
CartAddressInput
Description
Defines the billing or shipping address to be applied to the cart.
Fields
| Input Field | Description |
|---|---|
city - String!
|
The city specified for the billing or shipping address. |
company - String
|
The company specified for the billing or shipping address. |
country_code - String!
|
The country code and label for the billing or shipping address. |
custom_attributes - [AttributeValueInput]
|
The custom attribute values of the billing or shipping address. |
fax - String
|
The customer's fax number. |
firstname - String!
|
The first name of the customer or guest. |
lastname - String!
|
The last name of the customer or guest. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The ZIP or postal code of the billing or shipping address. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - String
|
A string that defines the state or province of the billing or shipping address. |
region_id - Int
|
An integer that defines the state or province of the billing or shipping address. |
save_in_address_book - Boolean
|
Determines whether to save the address in the customer's address book. The default value is true. |
street - [String]!
|
An array containing the street for the billing or shipping address. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number for the billing or shipping address. |
vat_id - String
|
The VAT company number for billing or shipping address. |
Example
{
"city": "abc123",
"company": "abc123",
"country_code": "abc123",
"custom_attributes": [AttributeValueInput],
"fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
"middlename": "abc123",
"postcode": "abc123",
"prefix": "abc123",
"region": "abc123",
"region_id": 123,
"save_in_address_book": false,
"street": ["xyz789"],
"suffix": "xyz789",
"telephone": "abc123",
"vat_id": "abc123"
}
CartAddressInterface
Fields
| Field Name | Description |
|---|---|
city - String!
|
The city specified for the billing or shipping address. |
company - String
|
The company specified for the billing or shipping address. |
country - CartAddressCountry!
|
An object containing the country label and code. |
custom_attributes - [AttributeValueInterface]!
|
The custom attribute values of the billing or shipping address. |
fax - String
|
The customer's fax number. |
firstname - String!
|
The first name of the customer or guest. |
id - Int
|
Id of the customer address. |
lastname - String!
|
The last name of the customer or guest. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The ZIP or postal code of the billing or shipping address. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - CartAddressRegion
|
An object containing the region label and code. |
street - [String]!
|
An array containing the street for the billing or shipping address. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number for the billing or shipping address. |
uid - String!
|
The unique id of the customer address. |
vat_id - String
|
The VAT company number for billing or shipping address. |
Possible Types
| CartAddressInterface Types |
|---|
Example
{
"city": "abc123",
"company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "xyz789",
"firstname": "xyz789",
"id": 123,
"lastname": "xyz789",
"middlename": "xyz789",
"postcode": "abc123",
"prefix": "xyz789",
"region": CartAddressRegion,
"street": ["xyz789"],
"suffix": "xyz789",
"telephone": "xyz789",
"uid": "xyz789",
"vat_id": "abc123"
}
CartAddressRegion
Description
Contains details about the region in a billing or shipping address.
Example
{
"code": "xyz789",
"label": "abc123",
"region_id": 987
}
CartCustomAttributesInput
Description
Defines a cart custom attributes.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The cart ID. |
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for cart. |
Example
{
"cart_id": "abc123",
"custom_attributes": [CustomAttributeInput]
}
CartDiscountType
CartItemCustomAttributesInput
Description
Defines a cart item custom attributes.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The cart ID. |
cart_item_id - String!
|
The cart item ID. |
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for cart item. |
Example
{
"cart_id": "xyz789",
"cart_item_id": "abc123",
"custom_attributes": [CustomAttributeInput]
}
CartItemError
Fields
| Field Name | Description |
|---|---|
code - CartItemErrorType!
|
An error code that describes the error encountered |
message - String!
|
A localized error message |
Example
{"code": "UNDEFINED", "message": "abc123"}
CartItemErrorType
CartItemInput
Description
Defines an item to be added to the cart.
Fields
| Input Field | Description |
|---|---|
entered_options - [EnteredOptionInput]
|
An array of entered options for the base product, such as personalization text. |
parent_sku - String
|
For a child product, the SKU of its parent product. |
quantity - Float!
|
The amount or number of an item to add. |
selected_options - [ID]
|
The selected options for the base product, such as color or size, using the unique ID for an object such as CustomizableRadioOption, CustomizableDropDownOption, or ConfigurableProductOptionsValues. |
sku - String!
|
The SKU of the product. |
Example
{
"entered_options": [EnteredOptionInput],
"parent_sku": "xyz789",
"quantity": 123.45,
"selected_options": ["4"],
"sku": "abc123"
}
CartItemInterface
Description
An interface for products in a cart.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Possible Types
| CartItemInterface Types |
|---|
Example
{
"custom_attributes": [CustomAttribute],
"discount": [Discount],
"errors": [CartItemError],
"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": 987.65,
"uid": 4
}
CartItemPrices
Description
Contains details about the price of the item, including taxes and discounts.
Fields
| Field Name | Description |
|---|---|
catalog_discount - ProductDiscount
|
The price discount for the unit price of the item represents the difference between its regular price and final price. |
discounts - [Discount]
|
An array of discounts to be applied to the cart item. |
fixed_product_taxes - [FixedProductTax]
|
An array of FPTs applied to the cart item. |
original_item_price - Money!
|
The value of the original unit price for the item, including discounts. |
original_row_total - Money!
|
The value of the original price multiplied by the quantity of the item. |
price - Money!
|
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart. |
price_including_tax - Money!
|
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart. |
row_catalog_discount - ProductDiscount
|
The price discount multiplied by the item quantity represents the total difference between the regular price and the final price for the entire quote item. |
row_total - Money!
|
The value of the price multiplied by the quantity of the item. |
row_total_including_tax - Money!
|
The value of row_total plus the tax applied to the item. |
total_item_discount - Money
|
The total of all discounts applied to the item. |
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
}
CartItemSelectedOptionValuePrice
Description
Contains details about the price of a selected customizable value.
Fields
| Field Name | Description |
|---|---|
type - PriceTypeEnum!
|
Indicates whether the price type is fixed, percent, or dynamic. |
units - String!
|
A string that describes the unit of the value. |
value - Float!
|
A price value. |
Example
{
"type": "FIXED",
"units": "xyz789",
"value": 987.65
}
CartItemUpdateInput
Description
A single item to be updated.
Fields
| Input Field | Description |
|---|---|
cart_item_uid - ID
|
The unique ID for a CartItemInterface object. |
customizable_options - [CustomizableOptionInput]
|
An array that defines customizable options for the product. |
gift_message - GiftMessageInput
|
Gift message details for the cart item |
gift_wrapping_id - ID
|
The unique ID for a GiftWrapping object to be used for the cart item. |
quantity - Float
|
The new quantity of the item. |
Example
{
"cart_item_uid": "4",
"customizable_options": [CustomizableOptionInput],
"gift_message": GiftMessageInput,
"gift_wrapping_id": 4,
"quantity": 123.45
}
CartItems
Fields
| Field Name | Description |
|---|---|
items - [CartItemInterface]!
|
An array of products that have been added to the cart. |
page_info - SearchResultPageInfo
|
Metadata for pagination rendering. |
total_count - Int!
|
The number of returned cart items. |
Example
{
"items": [CartItemInterface],
"page_info": SearchResultPageInfo,
"total_count": 123
}
CartPrices
Description
Contains details about the final price of items in the cart, including discount and tax information.
Fields
| Field Name | Description |
|---|---|
applied_taxes - [CartTaxItem]
|
An array containing the names and amounts of taxes applied to each item in the cart. |
discounts - [Discount]
|
An array containing cart rule discounts, store credit and gift cards applied to the cart. |
gift_options - GiftOptionsPrices
|
The list of prices for the selected gift options. |
grand_total - Money
|
The total, including discounts, taxes, shipping, and other fees. |
grand_total_excluding_tax - Money
|
The total of the cart, including discounts, shipping, and other fees without tax. |
subtotal_excluding_tax - Money
|
The subtotal without any applied taxes. |
subtotal_including_tax - Money
|
The subtotal including any applied taxes. |
subtotal_with_discount_excluding_tax - Money
|
The subtotal with any discounts applied, but not taxes. |
Example
{
"applied_taxes": [CartTaxItem],
"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
}
CartRuleStorefront
Fields
| Field Name | Description |
|---|---|
uid - ID!
|
The unique ID for a CartRule object. |
Example
{"uid": "4"}
CartTaxItem
Description
Contains tax information about an item in the cart.
Example
{
"amount": Money,
"label": "abc123"
}
CartUserInputError
Fields
| Field Name | Description |
|---|---|
code - CartUserInputErrorType!
|
A cart-specific error code. |
message - String!
|
A localized error message. |
Example
{
"code": "PRODUCT_NOT_FOUND",
"message": "abc123"
}
CartUserInputErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRODUCT_NOT_FOUND"
CatalogAttributeApplyToEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SIMPLE"
CatalogAttributeMetadata
Description
Swatch attribute metadata.
Fields
| Field Name | Description |
|---|---|
apply_to - [CatalogAttributeApplyToEnum]
|
To which catalog types an attribute can be applied. |
code - ID!
|
The unique identifier for an attribute code. This value should be in lowercase letters without spaces. |
default_value - String
|
Default attribute value. |
entity_type - AttributeEntityTypeEnum!
|
The type of entity that defines the attribute. |
frontend_class - String
|
The frontend class of the attribute. |
frontend_input - AttributeFrontendInputEnum
|
The frontend input type of the attribute. |
is_comparable - Boolean
|
Whether a product or category attribute can be compared against another or not. |
is_filterable - Boolean
|
Whether a product or category attribute can be filtered or not. |
is_filterable_in_search - Boolean
|
Whether a product or category attribute can be filtered in search or not. |
is_html_allowed_on_front - Boolean
|
Whether a product or category attribute can use HTML on front or not. |
is_required - Boolean!
|
Whether the attribute value is required. |
is_searchable - Boolean
|
Whether a product or category attribute can be searched or not. |
is_unique - Boolean!
|
Whether the attribute value must be unique. |
is_used_for_price_rules - Boolean
|
Whether a product or category attribute can be used for price rules or not. |
is_used_for_promo_rules - Boolean
|
Whether a product or category attribute is used for promo rules or not. |
is_visible_in_advanced_search - Boolean
|
Whether a product or category attribute is visible in advanced search or not. |
is_visible_on_front - Boolean
|
Whether a product or category attribute is visible on front or not. |
is_wysiwyg_enabled - Boolean
|
Whether a product or category attribute has WYSIWYG enabled or not. |
label - String
|
The label assigned to the attribute. |
options - [CustomAttributeOptionInterface]!
|
Attribute options. |
swatch_input_type - SwatchInputTypeEnum
|
Input type of the swatch attribute option. |
update_product_preview_image - Boolean
|
Whether update product preview image or not. |
use_product_image_for_swatch - Boolean
|
Whether use product image for swatch or not. |
used_in_product_listing - Boolean
|
Whether a product or category attribute is used in product listing or not. |
Example
{
"apply_to": ["SIMPLE"],
"code": "4",
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_comparable": false,
"is_filterable": true,
"is_filterable_in_search": true,
"is_html_allowed_on_front": false,
"is_required": false,
"is_searchable": false,
"is_unique": true,
"is_used_for_price_rules": false,
"is_used_for_promo_rules": true,
"is_visible_in_advanced_search": false,
"is_visible_on_front": true,
"is_wysiwyg_enabled": true,
"label": "xyz789",
"options": [CustomAttributeOptionInterface],
"swatch_input_type": "BOOLEAN",
"update_product_preview_image": true,
"use_product_image_for_swatch": true,
"used_in_product_listing": false
}
CategoryBucket
Description
New category bucket for federation
Example
{
"count": 987,
"id": "4",
"path": "xyz789",
"title": "xyz789"
}
CategoryBucketInterface
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Possible Types
| CategoryBucketInterface Types |
|---|
Example
{"id": 4}
CategoryInterface
Description
Contains the full set of attributes that can be returned in a category search.
Fields
| Field Name | Description |
|---|---|
available_sort_by - [String]
|
|
breadcrumbs - [Breadcrumb]
|
An array of breadcrumb items. |
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. |
children_count - String
|
|
custom_layout_update_file - String
|
|
default_sort_by - String
|
The attribute to use for sorting. |
description - String
|
An optional description of the category. |
display_mode - String
|
|
filter_price_range - Float
|
|
image - String
|
|
include_in_menu - Int
|
|
is_anchor - Int
|
|
landing_page - Int
|
|
level - Int
|
The depth of the category within the tree. |
meta_description - String
|
|
meta_keywords - String
|
|
meta_title - String
|
|
name - String
|
The display name of the category. |
path - String
|
The full category path. |
path_in_store - String
|
The category path within the store. |
position - Int
|
The position of the category relative to other categories at the same level in tree. |
product_count - Int
|
The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not. |
uid - ID!
|
The unique ID for a CategoryInterface object. |
url_key - String
|
The URL key assigned to the category. |
url_path - String
|
The URL path assigned to the category. |
Possible Types
| CategoryInterface Types |
|---|
Example
{
"available_sort_by": ["abc123"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children_count": "xyz789",
"custom_layout_update_file": "abc123",
"default_sort_by": "abc123",
"description": "abc123",
"display_mode": "xyz789",
"filter_price_range": 987.65,
"image": "abc123",
"include_in_menu": 123,
"is_anchor": 987,
"landing_page": 123,
"level": 123,
"meta_description": "abc123",
"meta_keywords": "xyz789",
"meta_title": "abc123",
"name": "xyz789",
"path": "abc123",
"path_in_store": "xyz789",
"position": 987,
"product_count": 123,
"uid": "4",
"url_key": "xyz789",
"url_path": "xyz789"
}
CategoryTree
Description
Contains the hierarchy of categories.
Fields
| Field Name | Description |
|---|---|
available_sort_by - [String]
|
|
breadcrumbs - [Breadcrumb]
|
An array of breadcrumb items. |
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled. |
children_count - String
|
|
custom_layout_update_file - String
|
|
default_sort_by - String
|
The attribute to use for sorting. |
description - String
|
An optional description of the category. |
display_mode - String
|
|
filter_price_range - Float
|
|
image - String
|
|
include_in_menu - Int
|
|
is_anchor - Int
|
|
landing_page - Int
|
|
level - Int
|
The depth of the category within the tree. |
meta_description - String
|
|
meta_keywords - String
|
|
meta_title - String
|
|
name - String
|
The display name of the category. |
path - String
|
The full category path. |
path_in_store - String
|
The category path within the store. |
position - Int
|
The position of the category relative to other categories at the same level in tree. |
product_count - Int
|
The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not. |
uid - ID!
|
The unique ID for a CategoryInterface object. |
url_key - String
|
The URL key assigned to the category. |
url_path - String
|
The URL path assigned to the category. |
Example
{
"available_sort_by": ["xyz789"],
"breadcrumbs": [Breadcrumb],
"canonical_url": "xyz789",
"children_count": "abc123",
"custom_layout_update_file": "abc123",
"default_sort_by": "abc123",
"description": "xyz789",
"display_mode": "xyz789",
"filter_price_range": 123.45,
"image": "abc123",
"include_in_menu": 987,
"is_anchor": 123,
"landing_page": 123,
"level": 123,
"meta_description": "abc123",
"meta_keywords": "xyz789",
"meta_title": "abc123",
"name": "xyz789",
"path": "xyz789",
"path_in_store": "abc123",
"position": 123,
"product_count": 987,
"uid": "4",
"url_key": "abc123",
"url_path": "abc123"
}
CategoryView
Description
Old category bucket for federation
Fields
| Field Name | Description |
|---|---|
availableSortBy - [String]
|
|
children - [String!]
|
|
defaultSortBy - String
|
|
id - ID!
|
'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead. |
level - Int
|
|
name - String
|
|
parentId - String!
|
|
path - String
|
'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead. |
roles - [String!]!
|
|
urlKey - String
|
|
urlPath - String
|
|
count - Int!
|
'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead. |
title - String!
|
'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead. |
Example
{
"availableSortBy": ["abc123"],
"children": ["abc123"],
"defaultSortBy": "xyz789",
"id": "4",
"level": 123,
"name": "xyz789",
"parentId": "xyz789",
"path": "xyz789",
"roles": ["xyz789"],
"urlKey": "xyz789",
"urlPath": "abc123",
"count": 123,
"title": "abc123"
}
CategoryViewInterface
Fields
| Field Name | Description |
|---|---|
availableSortBy - [String]
|
|
defaultSortBy - String
|
|
id - ID!
|
'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead. |
level - Int
|
|
name - String
|
|
path - String
|
|
roles - [String]
|
|
urlKey - String
|
|
urlPath - String
|
Possible Types
| CategoryViewInterface Types |
|---|
Example
{
"availableSortBy": ["abc123"],
"defaultSortBy": "abc123",
"id": "4",
"level": 987,
"name": "xyz789",
"path": "abc123",
"roles": ["xyz789"],
"urlKey": "abc123",
"urlPath": "abc123"
}
CheckoutAgreement
Description
Defines details about an individual checkout agreement.
Fields
| Field Name | Description |
|---|---|
agreement_id - Int!
|
The ID for a checkout agreement. |
checkbox_text - String!
|
The checkbox text for the checkout agreement. |
content - String!
|
Required. The text of the agreement. |
content_height - String
|
The height of the text box where the Terms and Conditions statement appears during checkout. |
is_html - Boolean!
|
Indicates whether the content text is in HTML format. |
mode - CheckoutAgreementMode!
|
Indicates whether agreements are accepted automatically or manually. |
name - String!
|
The name given to the condition. |
Example
{
"agreement_id": 987,
"checkbox_text": "xyz789",
"content": "xyz789",
"content_height": "xyz789",
"is_html": true,
"mode": "AUTO",
"name": "abc123"
}
CheckoutAgreementMode
Description
Indicates how agreements are accepted.
Values
| Enum Value | Description |
|---|---|
|
|
Conditions are automatically accepted upon checkout. |
|
|
Shoppers must manually accept the conditions to place an order. |
Example
"AUTO"
CheckoutUserInputError
Description
An error encountered while adding an item to the cart.
Fields
| Field Name | Description |
|---|---|
code - CheckoutUserInputErrorCodes!
|
An error code that is specific to Checkout. |
message - String!
|
A localized error message. |
path - [String]!
|
The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors |
Example
{
"code": "REORDER_NOT_AVAILABLE",
"message": "abc123",
"path": ["xyz789"]
}
CheckoutUserInputErrorCodes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REORDER_NOT_AVAILABLE"
ClearCustomerCartOutput
Description
Output of the request to clear the customer cart.
Example
{"cart": Cart, "status": false}
CloseNegotiableQuoteError
CloseNegotiableQuoteOperationFailure
Description
Contains details about a failed close operation on a negotiable quote.
Fields
| Field Name | Description |
|---|---|
errors - [CloseNegotiableQuoteError]!
|
An array of errors encountered while attempting close the negotiable quote. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"errors": [NegotiableQuoteInvalidStateError],
"quote_uid": 4
}
CloseNegotiableQuoteOperationResult
CloseNegotiableQuotesInput
Description
Defines the negotiable quotes to mark as closed.
Fields
| Input Field | Description |
|---|---|
quote_uids - [ID]!
|
A list of unique IDs from NegotiableQuote objects. |
Example
{"quote_uids": [4]}
CloseNegotiableQuotesOutput
Description
Contains the closed negotiable quotes and other negotiable quotes the company user can view.
Fields
| Field Name | Description |
|---|---|
negotiable_quotes - NegotiableQuotesOutput
|
A list of negotiable quotes that can be viewed by the logged-in customer |
Arguments
|
|
operation_results - [CloseNegotiableQuoteOperationResult]!
|
An array of closed negotiable quote UIDs and details about any errors. |
result_status - BatchMutationStatus!
|
The status of the request to close one or more negotiable quotes. |
Example
{
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
ColorSwatchData
Fields
| Field Name | Description |
|---|---|
value - String
|
The value can be represented as color (HEX code), image link, or text. |
Example
{"value": "abc123"}
CompaniesSortFieldEnum
Description
The fields available for sorting the customer companies.
Values
| Enum Value | Description |
|---|---|
|
|
The name of the company. |
Example
"NAME"
CompaniesSortInput
Description
Specifies which field to sort on, and whether to return the results in ascending or descending order.
Fields
| Input Field | Description |
|---|---|
field - CompaniesSortFieldEnum!
|
The field for sorting the results. |
order - SortEnum!
|
Indicates whether to return results in ascending or descending order. |
Example
{"field": "NAME", "order": "ASC"}
Company
Description
Contains the output schema for a company.
Fields
| Field Name | Description |
|---|---|
acl_resources - [CompanyAclResource]
|
The list of all resources defined within the company. |
available_payment_methods - [AvailablePaymentMethod]
|
Available payment methods for the company with proper B2B configuration and company-specific filtering. |
available_shipping_methods - [CompanyAvailableShippingMethod]
|
Available shipping carriers for the company with proper B2B configuration and company-specific filtering. |
company_admin - Customer
|
An object containing information about the company administrator. |
credit - CompanyCredit!
|
Company credit balances and limits. |
credit_history - CompanyCreditHistory!
|
Details about the history of company credit operations. |
Arguments |
|
custom_attributes - [CustomAttribute]
|
The custom attributes for the company |
email - String
|
The email address of the company contact. |
id - ID!
|
The unique ID of a Company object. |
legal_address - CompanyLegalAddress
|
The address where the company is registered to conduct business. |
legal_name - String
|
The full legal name of the company. |
name - String
|
The name of the company. |
payment_methods - [String]
|
The list of payment methods available to a company. |
reseller_id - String
|
The resale number that is assigned to the company for tax reporting purposes. |
role - CompanyRole
|
A company role filtered by the unique ID of a CompanyRole object. |
Arguments
|
|
roles - CompanyRoles!
|
An object that contains a list of company roles. |
sales_representative - CompanySalesRepresentative
|
An object containing information about the company sales representative. |
structure - CompanyStructure
|
The company structure of teams and customers in depth-first order. |
team - CompanyTeam
|
The company team data filtered by the unique ID for a CompanyTeam object. |
Arguments
|
|
user - Customer
|
A company user filtered by the unique ID of a Customer object. |
Arguments
|
|
users - CompanyUsers
|
An object that contains a list of company users based on activity status. |
Arguments
|
|
vat_tax_id - String
|
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. |
Example
{
"acl_resources": [CompanyAclResource],
"available_payment_methods": [AvailablePaymentMethod],
"available_shipping_methods": [
CompanyAvailableShippingMethod
],
"company_admin": Customer,
"credit": CompanyCredit,
"credit_history": CompanyCreditHistory,
"custom_attributes": [CustomAttribute],
"email": "abc123",
"id": "4",
"legal_address": CompanyLegalAddress,
"legal_name": "abc123",
"name": "abc123",
"payment_methods": ["abc123"],
"reseller_id": "abc123",
"role": CompanyRole,
"roles": CompanyRoles,
"sales_representative": CompanySalesRepresentative,
"structure": CompanyStructure,
"team": CompanyTeam,
"user": Customer,
"users": CompanyUsers,
"vat_tax_id": "abc123"
}
CompanyAclResource
Description
Contains details about the access control list settings of a resource.
Fields
| Field Name | Description |
|---|---|
children - [CompanyAclResource]
|
An array of sub-resources. |
id - ID!
|
The unique ID for a CompanyAclResource object. |
sort_order - Int
|
The sort order of an ACL resource. |
text - String
|
The label assigned to the ACL resource. |
Example
{
"children": [CompanyAclResource],
"id": "4",
"sort_order": 987,
"text": "abc123"
}
CompanyAdminInput
Description
Defines the input schema for creating a company administrator.
Fields
| Input Field | Description |
|---|---|
custom_attributes - [AttributeValueInput]
|
The company administrator's custom attributes. |
email - String!
|
The email address of the company administrator. |
firstname - String!
|
The company administrator's first name. |
gender - Int
|
The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). |
job_title - String
|
The job title of the company administrator. |
lastname - String!
|
The company administrator's last name. |
telephone - String
|
The phone number of the company administrator. |
Example
{
"custom_attributes": [AttributeValueInput],
"email": "abc123",
"firstname": "abc123",
"gender": 987,
"job_title": "abc123",
"lastname": "abc123",
"telephone": "abc123"
}
CompanyAvailableShippingMethod
Description
Describes a carrier-level shipping option available to the company.
Example
{
"code": "abc123",
"title": "abc123"
}
CompanyBasicInfo
Description
The minimal required information to identify and display the company.
Example
{
"id": 4,
"legal_name": "xyz789",
"name": "xyz789"
}
CompanyCreateInput
Description
Defines the input schema for creating a new company.
Fields
| Input Field | Description |
|---|---|
company_admin - CompanyAdminInput!
|
Defines the company administrator. |
company_email - String!
|
The email address of the company contact. |
company_name - String!
|
The name of the company to create. |
legal_address - CompanyLegalAddressCreateInput!
|
Defines legal address data of the company. |
legal_name - String
|
The full legal name of the company. |
reseller_id - String
|
The resale number that is assigned to the company for tax reporting purposes. |
vat_tax_id - String
|
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. |
Example
{
"company_admin": CompanyAdminInput,
"company_email": "xyz789",
"company_name": "xyz789",
"legal_address": CompanyLegalAddressCreateInput,
"legal_name": "abc123",
"reseller_id": "xyz789",
"vat_tax_id": "abc123"
}
CompanyCredit
Description
Contains company credit balances and limits.
Fields
| Field Name | Description |
|---|---|
available_credit - Money!
|
The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value. |
credit_limit - Money!
|
The amount of credit extended to the company. |
outstanding_balance - Money!
|
The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value. |
Example
{
"available_credit": Money,
"credit_limit": Money,
"outstanding_balance": Money
}
CompanyCreditHistory
Description
Contains details about prior company credit operations.
Fields
| Field Name | Description |
|---|---|
items - [CompanyCreditOperation]!
|
An array of company credit operations. |
page_info - SearchResultPageInfo!
|
Metadata for pagination rendering. |
total_count - Int
|
The number of the company credit operations matching the specified filter. |
Example
{
"items": [CompanyCreditOperation],
"page_info": SearchResultPageInfo,
"total_count": 123
}
CompanyCreditHistoryFilterInput
Description
Defines a filter for narrowing the results of a credit history search.
Fields
| Input Field | Description |
|---|---|
custom_reference_number - String
|
The purchase order number associated with the company credit operation. |
operation_type - CompanyCreditOperationType
|
The type of the company credit operation. |
updated_by - String
|
The name of the person submitting the company credit operation. |
Example
{
"custom_reference_number": "abc123",
"operation_type": "ALLOCATION",
"updated_by": "xyz789"
}
CompanyCreditOperation
Description
Contains details about a single company credit operation.
Fields
| Field Name | Description |
|---|---|
amount - Money
|
The amount of the company credit operation. |
balance - CompanyCredit!
|
The credit balance as a result of the operation. |
custom_reference_number - String
|
The purchase order number associated with the company credit operation. |
date - String!
|
The date the operation occurred. |
type - CompanyCreditOperationType!
|
The type of the company credit operation. |
updated_by - CompanyCreditOperationUser!
|
The company user that submitted the company credit operation. |
Example
{
"amount": Money,
"balance": CompanyCredit,
"custom_reference_number": "abc123",
"date": "xyz789",
"type": "ALLOCATION",
"updated_by": CompanyCreditOperationUser
}
CompanyCreditOperationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALLOCATION"
CompanyCreditOperationUser
Description
Defines the administrator or company user that submitted a company credit operation.
Fields
| Field Name | Description |
|---|---|
name - String!
|
The name of the company user submitting the company credit operation. |
type - CompanyCreditOperationUserType!
|
The type of the company user submitting the company credit operation. |
Example
{"name": "abc123", "type": "CUSTOMER"}
CompanyCreditOperationUserType
CompanyInvitationInput
Description
Defines the input schema for accepting the company invitation.
Fields
| Input Field | Description |
|---|---|
code - String!
|
The invitation code. |
role_id - ID
|
The company role id. |
user - CompanyInvitationUserInput!
|
Company user attributes in the invitation. |
Example
{
"code": "xyz789",
"role_id": "4",
"user": CompanyInvitationUserInput
}
CompanyInvitationOutput
Description
The result of accepting the company invitation.
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Indicates whether the customer was added to the company successfully. |
Example
{"success": false}
CompanyInvitationUserInput
Description
Company user attributes in the invitation.
Fields
| Input Field | Description |
|---|---|
company_id - ID!
|
The company unique identifier. |
customer_id - ID!
|
The customer unique identifier. |
job_title - String
|
The job title of a company user. |
status - CompanyUserStatusEnum
|
Indicates whether the company user is ACTIVE or INACTIVE. |
telephone - String
|
The phone number of the company user. |
Example
{
"company_id": 4,
"customer_id": "4",
"job_title": "xyz789",
"status": "ACTIVE",
"telephone": "xyz789"
}
CompanyLegalAddress
Description
Contains details about the address where the company is registered to conduct business.
Fields
| Field Name | Description |
|---|---|
city - String
|
The city where the company is registered to conduct business. |
country_code - CountryCodeEnum
|
The country code of the company's legal address. |
postcode - String
|
The company's postal code. |
region - CustomerAddressRegion
|
An object containing region data for the company. |
street - [String]
|
An array of strings that define the company's street address. |
telephone - String
|
The company's phone number. |
Example
{
"city": "abc123",
"country_code": "AF",
"postcode": "abc123",
"region": CustomerAddressRegion,
"street": ["abc123"],
"telephone": "abc123"
}
CompanyLegalAddressCreateInput
Description
Defines the input schema for defining a company's legal address.
Fields
| Input Field | Description |
|---|---|
city - String!
|
The city where the company is registered to conduct business. |
country_id - CountryCodeEnum!
|
The company's country ID. Use the countries query to get this value. |
postcode - String!
|
The postal code of the company. |
region - CustomerAddressRegionInput!
|
An object containing the region name and/or region ID where the company is registered to conduct business. |
street - [String]!
|
An array of strings that define the street address where the company is registered to conduct business. |
telephone - String!
|
The primary phone number of the company. |
Example
{
"city": "abc123",
"country_id": "AF",
"postcode": "abc123",
"region": CustomerAddressRegionInput,
"street": ["xyz789"],
"telephone": "abc123"
}
CompanyLegalAddressUpdateInput
Description
Defines the input schema for updating a company's legal address.
Fields
| Input Field | Description |
|---|---|
city - String
|
The city where the company is registered to conduct business. |
country_id - CountryCodeEnum
|
The unique ID for a Country object. |
postcode - String
|
The postal code of the company. |
region - CustomerAddressRegionInput
|
An object containing the region name and/or region ID where the company is registered to conduct business. |
street - [String]
|
An array of strings that define the street address where the company is registered to conduct business. |
telephone - String
|
The primary phone number of the company. |
Example
{
"city": "xyz789",
"country_id": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput,
"street": ["abc123"],
"telephone": "xyz789"
}
CompanyRole
Description
Contails details about a single role.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID for a CompanyRole object. |
name - String
|
The name assigned to the role. |
permissions - [CompanyAclResource]
|
A list of permission resources defined for a role. |
users_count - Int
|
The total number of users assigned the specified role. |
Example
{
"id": 4,
"name": "abc123",
"permissions": [CompanyAclResource],
"users_count": 987
}
CompanyRoleCreateInput
Description
Defines the input schema for creating a company role.
Example
{
"name": "abc123",
"permissions": ["xyz789"]
}
CompanyRoleUpdateInput
Description
Defines the input schema for updating a company role.
Example
{
"id": 4,
"name": "xyz789",
"permissions": ["abc123"]
}
CompanyRoles
Description
Contains an array of roles.
Fields
| Field Name | Description |
|---|---|
items - [CompanyRole]!
|
A list of company roles that match the specified filter criteria. |
page_info - SearchResultPageInfo
|
Pagination metadata. |
total_count - Int!
|
The total number of objects matching the specified filter. |
Example
{
"items": [CompanyRole],
"page_info": SearchResultPageInfo,
"total_count": 123
}
CompanySalesRepresentative
Description
Contains details about a company sales representative.
Example
{
"email": "abc123",
"firstname": "xyz789",
"lastname": "xyz789"
}
CompanyStructure
Description
Contains an array of the individual nodes that comprise the company structure.
Fields
| Field Name | Description |
|---|---|
items - [CompanyStructureItem]
|
An array of elements in a company structure. |
Example
{"items": [CompanyStructureItem]}
CompanyStructureEntity
CompanyStructureItem
Description
Defines an individual node in the company structure.
Fields
| Field Name | Description |
|---|---|
entity - CompanyStructureEntity
|
A union of CompanyTeam and Customer objects. |
id - ID!
|
The unique ID for a CompanyStructureItem object. |
parent_id - ID
|
The ID of the parent item in the company hierarchy. |
Example
{
"entity": CompanyTeam,
"id": "4",
"parent_id": "4"
}
CompanyStructureUpdateInput
Description
Defines the input schema for updating the company structure.
Example
{
"parent_tree_id": "4",
"tree_id": "4"
}
CompanyTeam
Description
Describes a company team.
Example
{
"description": "xyz789",
"id": "4",
"name": "xyz789",
"structure_id": "4"
}
CompanyTeamCreateInput
Description
Defines the input schema for creating a company team.
Example
{
"description": "xyz789",
"name": "xyz789",
"target_id": "4"
}
CompanyTeamUpdateInput
Description
Defines the input schema for updating a company team.
Example
{
"description": "abc123",
"id": "4",
"name": "abc123"
}
CompanyUpdateInput
Description
Defines the input schema for updating a company.
Fields
| Input Field | Description |
|---|---|
company_email - String
|
The email address of the company contact. |
company_name - String
|
The name of the company to update. |
legal_address - CompanyLegalAddressUpdateInput
|
The legal address data of the company. |
legal_name - String
|
The full legal name of the company. |
reseller_id - String
|
The resale number that is assigned to the company for tax reporting purposes. |
vat_tax_id - String
|
The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. |
Example
{
"company_email": "xyz789",
"company_name": "abc123",
"legal_address": CompanyLegalAddressUpdateInput,
"legal_name": "xyz789",
"reseller_id": "abc123",
"vat_tax_id": "xyz789"
}
CompanyUserCreateInput
Description
Defines the input schema for creating a company user.
Fields
| Input Field | Description |
|---|---|
email - String!
|
The company user's email address |
firstname - String!
|
The company user's first name. |
job_title - String!
|
The company user's job title or function. |
lastname - String!
|
The company user's last name. |
role_id - ID!
|
The unique ID for a CompanyRole object. |
status - CompanyUserStatusEnum!
|
Indicates whether the company user is ACTIVE or INACTIVE. |
target_id - ID
|
The ID of a node within a company's structure. This ID will be the parent of the created company user. |
telephone - String!
|
The company user's phone number. |
Example
{
"email": "xyz789",
"firstname": "abc123",
"job_title": "abc123",
"lastname": "xyz789",
"role_id": 4,
"status": "ACTIVE",
"target_id": 4,
"telephone": "xyz789"
}
CompanyUserStatusEnum
Description
Defines the list of company user status values.
Values
| Enum Value | Description |
|---|---|
|
|
Only active users. |
|
|
Only inactive users. |
Example
"ACTIVE"
CompanyUserUpdateInput
Description
Defines the input schema for updating a company user.
Fields
| Input Field | Description |
|---|---|
email - String
|
The company user's email address. |
firstname - String
|
The company user's first name. |
id - ID!
|
The unique ID of a Customer object. |
job_title - String
|
The company user's job title or function. |
lastname - String
|
The company user's last name. |
role_id - ID
|
The unique ID for a CompanyRole object. |
status - CompanyUserStatusEnum
|
Indicates whether the company user is ACTIVE or INACTIVE. |
telephone - String
|
The company user's phone number. |
Example
{
"email": "xyz789",
"firstname": "xyz789",
"id": "4",
"job_title": "abc123",
"lastname": "xyz789",
"role_id": 4,
"status": "ACTIVE",
"telephone": "abc123"
}
CompanyUsers
Description
Contains details about company users.
Fields
| Field Name | Description |
|---|---|
items - [Customer]!
|
An array of CompanyUser objects that match the specified filter criteria. |
page_info - SearchResultPageInfo
|
Pagination metadata. |
total_count - Int!
|
The number of objects returned. |
Example
{
"items": [Customer],
"page_info": SearchResultPageInfo,
"total_count": 123
}
CompanyUsersFilterInput
Description
Defines the filter for returning a list of company users.
Fields
| Input Field | Description |
|---|---|
status - CompanyUserStatusEnum
|
The activity status to filter on. |
Example
{"status": "ACTIVE"}
ComparableAttribute
Description
Contains an attribute code that is used for product comparisons.
Example
{
"code": "abc123",
"label": "abc123"
}
ComparableItem
Description
Defines an object used to iterate through items for product comparisons.
Fields
| Field Name | Description |
|---|---|
attributes - [ProductAttribute]!
|
An array of product attributes that can be used to compare products. |
product - ProductInterface!
|
Details about a product in a compare list. Product information is part of a composable Catalog Service. |
uid - ID!
|
The unique ID of an item in a compare list. |
Example
{
"attributes": [ProductAttribute],
"product": ProductInterface,
"uid": "4"
}
CompareList
Description
Contains iterable information such as the array of items, the count, and attributes that represent the compare list.
Fields
| Field Name | Description |
|---|---|
attributes - [ComparableAttribute]
|
An array of attributes that can be used for comparing products. |
item_count - Int!
|
The number of items in the compare list. |
items - [ComparableItem]
|
An array of products to compare. |
uid - ID!
|
The unique ID assigned to the compare list. |
Example
{
"attributes": [ComparableAttribute],
"item_count": 987,
"items": [ComparableItem],
"uid": 4
}
CompleteOrderInput
Description
Update the quote and complete the order
Example
{
"cartId": "abc123",
"id": "xyz789"
}
ComplexProductView
Description
Represents all product types, except simple products. Complex product prices are returned as a price range, because price values can vary based on selected options.
Fields
| Field Name | Description |
|---|---|
addToCartAllowed - Boolean
|
A flag stating if the product can be added to cart This field is deprecated and will be removed. |
inStock - Boolean
|
A flag stating if the product is in stock This field is deprecated and will be removed. |
lowStock - Boolean
|
A flag stating if the product stock is low This field is deprecated and will be removed. |
attributes - [ProductViewAttribute]
|
A list of merchant-defined attributes designated for the storefront. |
Arguments
|
|
description - String
|
The detailed description of the product. |
id - ID!
|
The product ID, generated as a composite key, unique per locale. |
images - [ProductViewImage]
|
A list of images defined for the product. |
Arguments
|
|
videos - [ProductViewVideo]
|
A list of videos defined for the product. |
lastModifiedAt - DateTime
|
Date and time when the product was last updated. |
metaDescription - String
|
A brief overview of the product for search results listings. |
metaKeyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
metaTitle - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
name - String
|
Product name. |
inputOptions - [ProductViewInputOption]
|
A list of input options. This field is deprecated and will be removed. |
options - [ProductViewOption]
|
A list of selectable options. |
priceRange - ProductViewPriceRange
|
A range of possible prices for a complex product. |
shortDescription - String
|
A summary of the product. |
sku - String
|
Product SKU. |
externalId - String
|
External Id This field is deprecated and will be removed. |
url - String
|
Canonical URL of the product. This field is deprecated and will be removed. |
urlKey - String
|
The URL key of the product. |
links - [ProductViewLink]
|
A list of product links |
Arguments
|
|
queryType - String
|
Indicates if the product was retrieved from the primary or the backup query |
visibility - String
|
Visibility setting of the product |
Example
{
"addToCartAllowed": true,
"inStock": false,
"lowStock": true,
"attributes": [ProductViewAttribute],
"description": "abc123",
"id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
"metaKeyword": "abc123",
"metaTitle": "abc123",
"name": "xyz789",
"inputOptions": [ProductViewInputOption],
"options": [ProductViewOption],
"priceRange": ProductViewPriceRange,
"shortDescription": "abc123",
"sku": "xyz789",
"externalId": "abc123",
"url": "abc123",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "xyz789",
"visibility": "abc123"
}
ComplexTextValue
Fields
| Field Name | Description |
|---|---|
html - String!
|
Text that can contain HTML tags. |
Example
{"html": "abc123"}
ConfigurableAttributeOption
Description
Contains details about a configurable product attribute option.
Fields
| Field Name | Description |
|---|---|
code - String
|
The ID assigned to the attribute. |
label - String
|
A string that describes the configurable attribute option. |
uid - ID!
|
The unique ID for a ConfigurableAttributeOption object. |
value_index - Int
|
A unique index number assigned to the configurable product option. |
Example
{
"code": "abc123",
"label": "xyz789",
"uid": "4",
"value_index": 123
}
ConfigurableCartItem
Description
An implementation for configurable product cart items.
Fields
| Field Name | Description |
|---|---|
available_gift_wrapping - [GiftWrapping]!
|
The list of available gift wrapping options for the cart item. |
configurable_options - [SelectedConfigurableOption]!
|
An array containing the configuranle options the shopper selected. |
configured_variant - ProductInterface!
|
Product details of the cart item. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array containing the customizable options the shopper selected. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
gift_message - GiftMessage
|
The entered gift message for the cart item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the cart item. |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"available_gift_wrapping": [GiftWrapping],
"configurable_options": [SelectedConfigurableOption],
"configured_variant": ProductInterface,
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"is_available": true,
"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": 123.45,
"uid": "4"
}
ConfigurableOptionAvailableForSelection
Description
Describes configurable options that have been selected and can be selected as a result of the previous selections.
Example
{
"attribute_code": "xyz789",
"option_value_uids": ["4"]
}
ConfigurableOrderItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
parent_sku - String
|
The SKU of parent product. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": "4",
"parent_sku": "abc123",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"product_type": "abc123",
"product_url_key": "xyz789",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
"quantity_ordered": 123.45,
"quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "xyz789"
}
ConfigurableProduct
Description
Defines basic features of a configurable product and its simple product variants.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
configurable_options - [ConfigurableProductOptions]
|
An array of options for the configurable product. |
configurable_product_options_selection - ConfigurableProductOptionsSelection
|
An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. |
Arguments
|
|
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
variants - [ConfigurableVariant]
|
An array of simple product variants. |
weight - Float
|
The weight of the item, in units defined by the store. |
Example
{
"canonical_url": "xyz789",
"categories": [CategoryInterface],
"configurable_options": [ConfigurableProductOptions],
"configurable_product_options_selection": ConfigurableProductOptionsSelection,
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_message_available": false,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"manufacturer": 987,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "abc123",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 987.65,
"name": "abc123",
"new_from_date": "abc123",
"new_to_date": "abc123",
"only_x_left_in_stock": 123.45,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 123.45,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 123.45,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "abc123",
"variants": [ConfigurableVariant],
"weight": 987.65
}
ConfigurableProductOption
Description
Contains details about configurable product options.
Fields
| Field Name | Description |
|---|---|
attribute_code - String!
|
An attribute code that uniquely identifies a configurable option. |
label - String!
|
The display name of the option. |
uid - ID!
|
The unique ID of the configurable option. |
values - [ConfigurableProductOptionValue]
|
An array of values that are applicable for this option. |
Example
{
"attribute_code": "abc123",
"label": "xyz789",
"uid": "4",
"values": [ConfigurableProductOptionValue]
}
ConfigurableProductOptionValue
Description
Defines a value for a configurable product option.
Fields
| Field Name | Description |
|---|---|
is_available - Boolean!
|
Indicates whether the product is available with this selected option. |
is_use_default - Boolean!
|
Indicates whether the value is the default. |
label - String!
|
The display name of the value. |
swatch - SwatchDataInterface
|
The URL assigned to the thumbnail of the swatch image. |
uid - ID!
|
The unique ID of the value. |
Example
{
"is_available": false,
"is_use_default": true,
"label": "abc123",
"swatch": SwatchDataInterface,
"uid": 4
}
ConfigurableProductOptions
Description
Defines configurable attributes for the specified product.
Fields
| Field Name | Description |
|---|---|
attribute_code - String
|
A string that identifies the attribute. |
attribute_uid - ID!
|
The unique ID for an Attribute object. |
label - String
|
A displayed string that describes the configurable product option. |
position - Int
|
A number that indicates the order in which the attribute is displayed. |
uid - ID!
|
The unique ID for a ConfigurableProductOptions object. |
use_default - Boolean
|
Indicates whether the option is the default. |
values - [ConfigurableProductOptionsValues]
|
An array that defines the value_index codes assigned to the configurable product. |
Example
{
"attribute_code": "xyz789",
"attribute_uid": 4,
"label": "abc123",
"position": 123,
"uid": 4,
"use_default": true,
"values": [ConfigurableProductOptionsValues]
}
ConfigurableProductOptionsSelection
Description
Contains metadata corresponding to the selected configurable options.
Fields
| Field Name | Description |
|---|---|
configurable_options - [ConfigurableProductOption]
|
An array of all possible configurable options. |
media_gallery - [MediaGalleryInterface]
|
Product images and videos corresponding to the specified configurable options selection. |
options_available_for_selection - [ConfigurableOptionAvailableForSelection]
|
The configurable options available for further selection based on the current selection. |
variant - SimpleProduct
|
A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option. |
Example
{
"configurable_options": [ConfigurableProductOption],
"media_gallery": [MediaGalleryInterface],
"options_available_for_selection": [
ConfigurableOptionAvailableForSelection
],
"variant": SimpleProduct
}
ConfigurableProductOptionsValues
Description
Contains the index number assigned to a configurable product option.
Fields
| Field Name | Description |
|---|---|
default_label - String
|
The label of the product on the default store. |
label - String
|
The label of the product. |
store_label - String
|
The label of the product on the current store. |
swatch_data - SwatchDataInterface
|
Swatch data for a configurable product option. |
uid - ID
|
The unique ID for a ConfigurableProductOptionsValues object. |
use_default_value - Boolean
|
Indicates whether to use the default_label. |
Example
{
"default_label": "abc123",
"label": "xyz789",
"store_label": "xyz789",
"swatch_data": SwatchDataInterface,
"uid": 4,
"use_default_value": true
}
ConfigurableRequisitionListItem
Description
Contains details about configurable products added to a requisition list.
Fields
| Field Name | Description |
|---|---|
configurable_options - [SelectedConfigurableOption]
|
Selected configurable options for an item in the requisition list. |
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. |
quantity - Float!
|
The quantity of the product added to the requisition list. |
uid - ID!
|
The unique ID of an item in a requisition list. |
Example
{
"configurable_options": [SelectedConfigurableOption],
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 123.45,
"uid": 4
}
ConfigurableVariant
Description
Contains all the simple product variants of a configurable product.
Fields
| Field Name | Description |
|---|---|
attributes - [ConfigurableAttributeOption]
|
An array of configurable attribute options. |
product - SimpleProduct
|
An array of linked simple products. |
Example
{
"attributes": [ConfigurableAttributeOption],
"product": SimpleProduct
}
ConfigurableWishlistItem
Description
A configurable product wish list item.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
configurable_options - [SelectedConfigurableOption]
|
An array of selected configurable options. |
configured_variant - ProductInterface
|
Product details of the selected variant. The value is null if some options are not configured. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "xyz789",
"configurable_options": [SelectedConfigurableOption],
"configured_variant": ProductInterface,
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": "4",
"product": ProductInterface,
"quantity": 123.45
}
ConfirmCancelOrderInput
ConfirmEmailInput
Description
Contains details about a customer email address to confirm.
Example
{
"confirmation_key": "xyz789",
"email": "abc123"
}
ConfirmReturnInput
ConfirmationStatusEnum
Description
List of account confirmation statuses.
Values
| Enum Value | Description |
|---|---|
|
|
Account confirmed |
|
|
Account confirmation not required |
Example
"ACCOUNT_CONFIRMED"
ContactUsInput
Example
{
"comment": "abc123",
"email": "xyz789",
"name": "xyz789",
"telephone": "xyz789"
}
ContactUsOutput
Description
Contains the status of the request.
Fields
| Field Name | Description |
|---|---|
status - Boolean!
|
Indicates whether the request was successful. |
Example
{"status": false}
CopyItemsBetweenRequisitionListsInput
Description
An input object that defines the items in a requisition list to be copied.
Fields
| Input Field | Description |
|---|---|
requisitionListItemUids - [ID]!
|
An array of IDs representing products copied from one requisition list to another. |
Example
{"requisitionListItemUids": ["4"]}
CopyItemsFromRequisitionListsOutput
Description
Output of the request to copy items to the destination requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The destination requisition list after the items were copied. |
Example
{"requisition_list": RequisitionList}
CopyProductsBetweenWishlistsOutput
Description
Contains the source and target wish lists after copying products.
Fields
| Field Name | Description |
|---|---|
destination_wishlist - Wishlist!
|
The destination wish list containing the copied products. |
source_wishlist - Wishlist!
|
The wish list that the products were copied from. |
user_errors - [WishListUserInputError]!
|
An array of errors encountered while copying products in a wish list. |
Example
{
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
Country
Fields
| Field Name | Description |
|---|---|
available_regions - [Region]
|
An array of regions within a particular country. |
full_name_english - String
|
The name of the country in English. |
full_name_locale - String
|
The name of the country in the current locale. |
id - String
|
The unique ID for a Country object. |
three_letter_abbreviation - String
|
The three-letter abbreviation of the country, such as USA. |
two_letter_abbreviation - String
|
The two-letter abbreviation of the country, such as US. |
Example
{
"available_regions": [Region],
"full_name_english": "abc123",
"full_name_locale": "xyz789",
"id": "abc123",
"three_letter_abbreviation": "xyz789",
"two_letter_abbreviation": "abc123"
}
CountryCodeEnum
Description
The list of country codes.
Values
| Enum Value | Description |
|---|---|
|
|
Afghanistan |
|
|
Åland Islands |
|
|
Albania |
|
|
Algeria |
|
|
American Samoa |
|
|
Andorra |
|
|
Angola |
|
|
Anguilla |
|
|
Antarctica |
|
|
Antigua & Barbuda |
|
|
Argentina |
|
|
Armenia |
|
|
Aruba |
|
|
Australia |
|
|
Austria |
|
|
Azerbaijan |
|
|
Bahamas |
|
|
Bahrain |
|
|
Bangladesh |
|
|
Barbados |
|
|
Belarus |
|
|
Belgium |
|
|
Belize |
|
|
Benin |
|
|
Bermuda |
|
|
Bhutan |
|
|
Bolivia |
|
|
Bosnia & Herzegovina |
|
|
Botswana |
|
|
Bouvet Island |
|
|
Brazil |
|
|
British Indian Ocean Territory |
|
|
British Virgin Islands |
|
|
Brunei |
|
|
Bulgaria |
|
|
Burkina Faso |
|
|
Burundi |
|
|
Cambodia |
|
|
Cameroon |
|
|
Canada |
|
|
Cape Verde |
|
|
Cayman Islands |
|
|
Central African Republic |
|
|
Chad |
|
|
Chile |
|
|
China |
|
|
Christmas Island |
|
|
Cocos (Keeling) Islands |
|
|
Colombia |
|
|
Comoros |
|
|
Congo-Brazzaville |
|
|
Congo-Kinshasa |
|
|
Cook Islands |
|
|
Costa Rica |
|
|
Côte d’Ivoire |
|
|
Croatia |
|
|
Cuba |
|
|
Cyprus |
|
|
Czech Republic |
|
|
Denmark |
|
|
Djibouti |
|
|
Dominica |
|
|
Dominican Republic |
|
|
Ecuador |
|
|
Egypt |
|
|
El Salvador |
|
|
Equatorial Guinea |
|
|
Eritrea |
|
|
Estonia |
|
|
Eswatini |
|
|
Ethiopia |
|
|
Falkland Islands |
|
|
Faroe Islands |
|
|
Fiji |
|
|
Finland |
|
|
France |
|
|
French Guiana |
|
|
French Polynesia |
|
|
French Southern Territories |
|
|
Gabon |
|
|
Gambia |
|
|
Georgia |
|
|
Germany |
|
|
Ghana |
|
|
Gibraltar |
|
|
Greece |
|
|
Greenland |
|
|
Grenada |
|
|
Guadeloupe |
|
|
Guam |
|
|
Guatemala |
|
|
Guernsey |
|
|
Guinea |
|
|
Guinea-Bissau |
|
|
Guyana |
|
|
Haiti |
|
|
Heard & McDonald Islands |
|
|
Honduras |
|
|
Hong Kong SAR China |
|
|
Hungary |
|
|
Iceland |
|
|
India |
|
|
Indonesia |
|
|
Iran |
|
|
Iraq |
|
|
Ireland |
|
|
Isle of Man |
|
|
Israel |
|
|
Italy |
|
|
Jamaica |
|
|
Japan |
|
|
Jersey |
|
|
Jordan |
|
|
Kazakhstan |
|
|
Kenya |
|
|
Kiribati |
|
|
Kuwait |
|
|
Kyrgyzstan |
|
|
Laos |
|
|
Latvia |
|
|
Lebanon |
|
|
Lesotho |
|
|
Liberia |
|
|
Libya |
|
|
Liechtenstein |
|
|
Lithuania |
|
|
Luxembourg |
|
|
Macau SAR China |
|
|
Macedonia |
|
|
Madagascar |
|
|
Malawi |
|
|
Malaysia |
|
|
Maldives |
|
|
Mali |
|
|
Malta |
|
|
Marshall Islands |
|
|
Martinique |
|
|
Mauritania |
|
|
Mauritius |
|
|
Mayotte |
|
|
Mexico |
|
|
Micronesia |
|
|
Moldova |
|
|
Monaco |
|
|
Mongolia |
|
|
Montenegro |
|
|
Montserrat |
|
|
Morocco |
|
|
Mozambique |
|
|
Myanmar (Burma) |
|
|
Namibia |
|
|
Nauru |
|
|
Nepal |
|
|
Netherlands |
|
|
Netherlands Antilles |
|
|
New Caledonia |
|
|
New Zealand |
|
|
Nicaragua |
|
|
Niger |
|
|
Nigeria |
|
|
Niue |
|
|
Norfolk Island |
|
|
Northern Mariana Islands |
|
|
North Korea |
|
|
Norway |
|
|
Oman |
|
|
Pakistan |
|
|
Palau |
|
|
Palestinian Territories |
|
|
Panama |
|
|
Papua New Guinea |
|
|
Paraguay |
|
|
Peru |
|
|
Philippines |
|
|
Pitcairn Islands |
|
|
Poland |
|
|
Portugal |
|
|
Qatar |
|
|
Réunion |
|
|
Romania |
|
|
Russia |
|
|
Rwanda |
|
|
Samoa |
|
|
San Marino |
|
|
São Tomé & Príncipe |
|
|
Saudi Arabia |
|
|
Senegal |
|
|
Serbia |
|
|
Seychelles |
|
|
Sierra Leone |
|
|
Singapore |
|
|
Slovakia |
|
|
Slovenia |
|
|
Solomon Islands |
|
|
Somalia |
|
|
South Africa |
|
|
South Georgia & South Sandwich Islands |
|
|
South Korea |
|
|
Spain |
|
|
Sri Lanka |
|
|
St. Barthélemy |
|
|
St. Helena |
|
|
St. Kitts & Nevis |
|
|
St. Lucia |
|
|
St. Martin |
|
|
St. Pierre & Miquelon |
|
|
St. Vincent & Grenadines |
|
|
Sudan |
|
|
Suriname |
|
|
Svalbard & Jan Mayen |
|
|
Sweden |
|
|
Switzerland |
|
|
Syria |
|
|
Taiwan |
|
|
Tajikistan |
|
|
Tanzania |
|
|
Thailand |
|
|
Timor-Leste |
|
|
Togo |
|
|
Tokelau |
|
|
Tonga |
|
|
Trinidad & Tobago |
|
|
Tunisia |
|
|
Turkey |
|
|
Turkmenistan |
|
|
Turks & Caicos Islands |
|
|
Tuvalu |
|
|
Uganda |
|
|
Ukraine |
|
|
United Arab Emirates |
|
|
United Kingdom |
|
|
United States |
|
|
Uruguay |
|
|
U.S. Outlying Islands |
|
|
U.S. Virgin Islands |
|
|
Uzbekistan |
|
|
Vanuatu |
|
|
Vatican City |
|
|
Venezuela |
|
|
Vietnam |
|
|
Wallis & Futuna |
|
|
Western Sahara |
|
|
Yemen |
|
|
Zambia |
|
|
Zimbabwe |
Example
"AF"
CreateCompanyOutput
Description
Contains the response to the request to create a company.
Fields
| Field Name | Description |
|---|---|
company - Company!
|
The new company instance. |
Example
{"company": Company}
CreateCompanyRoleOutput
Description
Contains the response to the request to create a company role.
Fields
| Field Name | Description |
|---|---|
role - CompanyRole!
|
The new company role instance. |
Example
{"role": CompanyRole}
CreateCompanyTeamOutput
Description
Contains the response to the request to create a company team.
Fields
| Field Name | Description |
|---|---|
team - CompanyTeam!
|
The new company team instance. |
Example
{"team": CompanyTeam}
CreateCompanyUserOutput
Description
Contains the response to the request to create a company user.
Fields
| Field Name | Description |
|---|---|
user - Customer!
|
The new company user instance. |
Example
{"user": Customer}
CreateCompareListInput
Description
Contains an array of product IDs to use for creating a compare list.
Fields
| Input Field | Description |
|---|---|
products - [ID]
|
An array of product IDs to add to the compare list. |
Example
{"products": [4]}
CreateGiftRegistryInput
Description
Defines a new gift registry.
Fields
| Input Field | Description |
|---|---|
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
|
Additional attributes specified as a code-value pair. |
event_name - String!
|
The name of the event. |
gift_registry_type_uid - ID!
|
The ID of the selected event type. |
message - String!
|
A message describing the event. |
privacy_settings - GiftRegistryPrivacySettings!
|
Indicates whether the registry is PRIVATE or PUBLIC. |
registrants - [AddGiftRegistryRegistrantInput]!
|
The list of people who receive notifications about the registry. |
shipping_address - GiftRegistryShippingAddressInput
|
The shipping address for all gift registry items. |
status - GiftRegistryStatus!
|
Indicates whether the registry is ACTIVE or INACTIVE. |
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
Description
Contains the results of a request to create a gift registry.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The newly-created gift registry. |
Example
{"gift_registry": GiftRegistry}
CreateGuestCartInput
Fields
| Input Field | Description |
|---|---|
cart_uid - ID
|
Optional client-generated ID |
Example
{"cart_uid": 4}
CreateGuestCartOutput
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The newly created cart. |
Example
{"cart": Cart}
CreatePaymentOrderInput
Description
Contains payment order details that are used while processing the payment order
Fields
| Input Field | Description |
|---|---|
cartId - String!
|
The customer cart ID |
location - PaymentLocation!
|
Defines the origin location for that payment request |
methodCode - String!
|
The code for the payment method used in the order |
paymentSource - String!
|
The identifiable payment source for the payment method |
vaultIntent - Boolean
|
Indicates whether the payment information should be vaulted |
Example
{
"cartId": "abc123",
"location": "PRODUCT_DETAIL",
"methodCode": "abc123",
"paymentSource": "abc123",
"vaultIntent": false
}
CreatePaymentOrderOutput
Description
Contains payment order details that are used while processing the payment order
Example
{
"amount": 987.65,
"currency_code": "xyz789",
"id": "abc123",
"mp_order_id": "xyz789",
"status": "xyz789"
}
CreatePurchaseOrderApprovalRuleConditionAmountInput
Description
Specifies the amount and currency to evaluate.
Fields
| Input Field | Description |
|---|---|
currency - CurrencyEnum!
|
Purchase order approval rule condition amount currency. |
value - Float!
|
Purchase order approval rule condition amount value. |
Example
{"currency": "AFN", "value": 987.65}
CreatePurchaseOrderApprovalRuleConditionInput
Description
Defines a set of conditions that apply to a rule.
Fields
| Input Field | Description |
|---|---|
amount - CreatePurchaseOrderApprovalRuleConditionAmountInput
|
The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. |
attribute - PurchaseOrderApprovalRuleType!
|
The type of approval rule. |
operator - PurchaseOrderApprovalRuleConditionOperator!
|
Defines how to evaluate an amount or quantity in a purchase order. |
quantity - Int
|
The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. |
Example
{
"amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
"attribute": "GRAND_TOTAL",
"operator": "MORE_THAN",
"quantity": 123
}
CreateRequisitionListInput
Description
An input object that identifies and describes a new requisition list.
Example
{
"description": "xyz789",
"name": "xyz789"
}
CreateRequisitionListOutput
Description
Output of the request to create a requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The created requisition list. |
Example
{"requisition_list": RequisitionList}
CreateVaultCardPaymentTokenInput
Description
Describe the variables needed to create a vault payment token
Example
{
"card_description": "abc123",
"setup_token_id": "abc123"
}
CreateVaultCardPaymentTokenOutput
Description
The vault token id and information about the payment source
Fields
| Field Name | Description |
|---|---|
payment_source - PaymentSourceOutput!
|
The payment source information |
vault_token_id - String!
|
The vault payment token information |
Example
{
"payment_source": PaymentSourceOutput,
"vault_token_id": "abc123"
}
CreateVaultCardSetupTokenInput
Description
Describe the variables needed to create a vault card setup token
Fields
| Input Field | Description |
|---|---|
setup_token - VaultSetupTokenInput!
|
The setup token information |
three_ds_mode - ThreeDSMode
|
The 3DS mode |
Example
{
"setup_token": VaultSetupTokenInput,
"three_ds_mode": "OFF"
}
CreateVaultCardSetupTokenOutput
Description
The setup token id information
Fields
| Field Name | Description |
|---|---|
setup_token - String!
|
The setup token id |
Example
{"setup_token": "abc123"}
CreateWishlistInput
Description
Defines the name and visibility of a new wish list.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the new wish list. |
visibility - WishlistVisibilityEnum!
|
Indicates whether the wish list is public or private. |
Example
{"name": "abc123", "visibility": "PUBLIC"}
CreateWishlistOutput
Description
Contains the wish list.
Fields
| Field Name | Description |
|---|---|
wishlist - Wishlist!
|
The newly-created wish list |
Example
{"wishlist": Wishlist}
CreditMemo
Description
Contains credit memo details.
Fields
| Field Name | Description |
|---|---|
comments - [SalesCommentItem]
|
Comments on the credit memo. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo |
id - ID!
|
The unique ID for a CreditMemo object. |
items - [CreditMemoItemInterface]
|
An array containing details about refunded items. |
number - String!
|
The sequential credit memo number. |
total - CreditMemoTotal
|
Details about the total refunded amount. |
Example
{
"comments": [SalesCommentItem],
"custom_attributes": [CustomAttribute],
"id": 4,
"items": [CreditMemoItemInterface],
"number": "xyz789",
"total": CreditMemoTotal
}
CreditMemoCustomAttributesInput
Description
Defines a credit memo item's custom attributes.
Fields
| Input Field | Description |
|---|---|
credit_memo_id - String!
|
The credit memo ID. |
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for the credit memo. |
Example
{
"credit_memo_id": "xyz789",
"custom_attributes": [CustomAttributeInput]
}
CreditMemoItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo item |
discounts - [Discount]
|
Details about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for a CreditMemoItemInterface object. |
order_item - OrderItemInterface
|
The order item the credit memo is applied to. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_refunded - Float
|
The number of refunded items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 123.45
}
CreditMemoItemCustomAttributesInput
Description
Defines a credit memo's custom attributes.
Fields
| Input Field | Description |
|---|---|
credit_memo_id - String!
|
The credit memo ID. |
credit_memo_item_id - String!
|
The credit memo item ID. |
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for the credit memo item. |
Example
{
"credit_memo_id": "abc123",
"credit_memo_item_id": "xyz789",
"custom_attributes": [CustomAttributeInput]
}
CreditMemoItemInterface
Description
Credit memo item details.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo item |
discounts - [Discount]
|
Details about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for a CreditMemoItemInterface object. |
order_item - OrderItemInterface
|
The order item the credit memo is applied to. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_refunded - Float
|
The number of refunded items. |
Possible Types
| CreditMemoItemInterface Types |
|---|
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": 4,
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_refunded": 123.45
}
CreditMemoOutput
Description
Contains details about the credit memo after adding custom attributes to it.
Fields
| Field Name | Description |
|---|---|
credit_memo - CreditMemo!
|
The custom attributes to credit memo have been added. |
Example
{"credit_memo": CreditMemo}
CreditMemoTotal
Description
Contains credit memo price details.
Fields
| Field Name | Description |
|---|---|
adjustment - Money!
|
An adjustment manually applied to the order. |
base_grand_total - Money!
|
The final base grand total amount in the base currency. |
discounts - [Discount]
|
The applied discounts to the credit memo. |
grand_total - Money!
|
The final total amount, including shipping, discounts, and taxes. |
shipping_handling - ShippingHandling
|
Details about the shipping and handling costs for the credit memo. |
subtotal - Money!
|
The subtotal of the invoice, excluding shipping, discounts, and taxes. |
taxes - [TaxItem]
|
The credit memo tax details. |
total_shipping - Money!
|
The shipping amount for the credit memo. |
total_tax - Money!
|
The amount of tax applied to the credit memo. |
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
| Field Name | Description |
|---|---|
available_currency_codes - [String]
|
An array of three-letter currency codes accepted by the store, such as USD and EUR. |
base_currency_code - String
|
The base currency set for the store, such as USD. |
base_currency_symbol - String
|
The symbol for the specified base currency, such as $. |
default_display_currency_code - String
|
The currency that is displayed by default, such as USD. |
default_display_currency_symbol - String
|
The currency symbol that is displayed by default, such as $. |
exchange_rates - [ExchangeRate]
|
An array of exchange rates for currencies defined in the store. |
Example
{
"available_currency_codes": ["abc123"],
"base_currency_code": "xyz789",
"base_currency_symbol": "xyz789",
"default_display_currency_code": "abc123",
"default_display_currency_symbol": "abc123",
"exchange_rates": [ExchangeRate]
}
CurrencyEnum
Description
The list of available currency codes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFN"
CustomAttribute
Description
Specifies the custom attribute code and value.
Example
{
"attribute_code": "abc123",
"value": "abc123"
}
CustomAttributeInput
Description
Defines a custom attribute.
Example
{
"attribute_code": "abc123",
"value": "xyz789"
}
CustomAttributeMetadataInterface
Description
An interface containing fields that define the EAV attribute.
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The unique identifier for an attribute code. This value should be in lowercase letters without spaces. |
default_value - String
|
Default attribute value. |
entity_type - AttributeEntityTypeEnum!
|
The type of entity that defines the attribute. |
frontend_class - String
|
The frontend class of the attribute. |
frontend_input - AttributeFrontendInputEnum
|
The frontend input type of the attribute. |
is_required - Boolean!
|
Whether the attribute value is required. |
is_unique - Boolean!
|
Whether the attribute value must be unique. |
label - String
|
The label assigned to the attribute. |
options - [CustomAttributeOptionInterface]!
|
Attribute options. |
Possible Types
| CustomAttributeMetadataInterface Types |
|---|
Example
{
"code": "4",
"default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"is_required": false,
"is_unique": false,
"label": "xyz789",
"options": [CustomAttributeOptionInterface]
}
CustomAttributeOptionInterface
Fields
| Field Name | Description |
|---|---|
is_default - Boolean!
|
Is the option value default. |
label - String!
|
The label assigned to the attribute option. |
value - String!
|
The attribute option value. |
Possible Types
| CustomAttributeOptionInterface Types |
|---|
Example
{
"is_default": false,
"label": "xyz789",
"value": "abc123"
}
CustomConfigKeyValue
Example
{
"key": "xyz789",
"value": "xyz789"
}
Customer
Description
Defines the customer name, addresses, and other details.
Fields
| Field Name | Description |
|---|---|
addresses - [CustomerAddress]
|
An array containing the customer's shipping and billing addresses. |
addressesV2 - CustomerAddresses
|
An array containing the customer's shipping and billing addresses. |
allow_remote_shopping_assistance - Boolean!
|
Indicates whether the customer has enabled remote shopping assistance. |
companies - UserCompaniesOutput!
|
An object that contains a list of companies user is assigned to. |
Arguments
|
|
compare_list - CompareList
|
The contents of the customer's compare list. |
confirmation_status - ConfirmationStatusEnum!
|
The customer's confirmation status. |
created_at - String
|
Timestamp indicating when the account was created. |
custom_attributes - [AttributeValueInterface]
|
Customer's custom attributes. |
Arguments
|
|
date_of_birth - String
|
The customer's date of birth. |
default_billing - String
|
The ID assigned to the billing address. |
default_shipping - String
|
The ID assigned to the shipping address. |
email - String
|
The customer's email address. Required. |
firstname - String
|
The customer's first name. |
gender - Int
|
The customer's gender (Male - 1, Female - 2). |
gift_registries - [GiftRegistry]
|
Details about all of the customer's gift registries. |
gift_registry - GiftRegistry
|
Details about a specific gift registry. |
Arguments
|
|
group - CustomerGroupStorefront
|
Customer group assigned to the customer |
is_subscribed - Boolean
|
Indicates whether the customer is subscribed to the company's newsletter. |
job_title - String
|
The job title of a company user. |
lastname - String
|
The customer's family name. |
middlename - String
|
The customer's middle name. |
orders - CustomerOrders
|
|
Arguments
|
|
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
purchase_order - PurchaseOrder
|
Purchase order details. |
Arguments
|
|
purchase_order_approval_rule - PurchaseOrderApprovalRule
|
Details about a single purchase order approval rule. |
Arguments
|
|
purchase_order_approval_rule_metadata - PurchaseOrderApprovalRuleMetadata
|
Purchase order approval rule metadata that can be used for rule edit form rendering. |
purchase_order_approval_rules - PurchaseOrderApprovalRules
|
A list of purchase order approval rules visible to the customer. |
purchase_orders - PurchaseOrders
|
A list of purchase orders visible to the customer. |
Arguments |
|
purchase_orders_enabled - Boolean!
|
Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result. |
requisition_lists - RequisitionLists
|
An object that contains the customer's requisition lists. |
Arguments
|
|
return - Return
|
Details about the specified return request from the unique ID for a Return object. |
Arguments
|
|
returns - Returns
|
Information about the customer's return requests. |
reward_points - RewardPoints
|
Customer reward points details. |
role - CompanyRole
|
The role name and permissions assigned to the company user. |
segments - [CustomerSegmentStorefront]
|
Customer segments associated with the current customer |
status - CompanyUserStatusEnum
|
Indicates whether the company user is ACTIVE or INACTIVE. |
store_credit - CustomerStoreCredit
|
Store credit information applied for the logged in customer. |
structure_id - ID!
|
ID of the company structure |
suffix - String
|
A value such as Sr., Jr., or III. |
taxvat - String
|
The customer's Value-added tax (VAT) number (for corporate customers). |
team - CompanyTeam
|
The team the company user is assigned to. |
telephone - String
|
The phone number of the company user. |
wishlist_v2 - Wishlist
|
Retrieve the wish list identified by the unique ID for a Wishlist object. |
Arguments
|
|
wishlists - [Wishlist]!
|
An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce. |
Example
{
"addresses": [CustomerAddress],
"addressesV2": CustomerAddresses,
"allow_remote_shopping_assistance": true,
"companies": UserCompaniesOutput,
"compare_list": CompareList,
"confirmation_status": "ACCOUNT_CONFIRMED",
"created_at": "abc123",
"custom_attributes": [AttributeValueInterface],
"date_of_birth": "abc123",
"default_billing": "xyz789",
"default_shipping": "xyz789",
"email": "xyz789",
"firstname": "abc123",
"gender": 987,
"gift_registries": [GiftRegistry],
"gift_registry": GiftRegistry,
"group": CustomerGroupStorefront,
"is_subscribed": false,
"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": true,
"requisition_lists": RequisitionLists,
"return": Return,
"returns": Returns,
"reward_points": RewardPoints,
"role": CompanyRole,
"segments": [CustomerSegmentStorefront],
"status": "ACTIVE",
"store_credit": CustomerStoreCredit,
"structure_id": "4",
"suffix": "abc123",
"taxvat": "abc123",
"team": CompanyTeam,
"telephone": "abc123",
"wishlist_v2": Wishlist,
"wishlists": [Wishlist]
}
CustomerAddress
Description
Contains detailed information about a customer's billing or shipping address.
Fields
| Field Name | Description |
|---|---|
city - String
|
The customer's city or town. |
company - String
|
The customer's company. |
country_code - CountryCodeEnum
|
The customer's country. |
custom_attributesV2 - [AttributeValueInterface]!
|
Custom attributes assigned to the customer address. |
Arguments
|
|
default_billing - Boolean
|
Indicates whether the address is the customer's default billing address. |
default_shipping - Boolean
|
Indicates whether the address is the customer's default shipping address. |
extension_attributes - [CustomerAddressAttribute]
|
Contains any extension attributes for the address. |
fax - String
|
The customer's fax number. |
firstname - String
|
The first name of the person associated with the shipping/billing address. |
id - Int
|
The ID of a CustomerAddress object. |
lastname - String
|
The family name of the person associated with the shipping/billing address. |
middlename - String
|
The middle name of the person associated with the shipping/billing address. |
postcode - String
|
The customer's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - CustomerAddressRegion
|
An object containing the region name, region code, and region ID. |
region_id - Int
|
The unique ID for a pre-defined region. |
street - [String]
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The customer's telephone number. |
uid - ID!
|
The unique ID for a CustomerAddress object. |
vat_id - String
|
The customer's Value-added tax (VAT) number (for corporate customers). |
Example
{
"city": "abc123",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"default_billing": true,
"default_shipping": false,
"extension_attributes": [CustomerAddressAttribute],
"fax": "abc123",
"firstname": "xyz789",
"id": 123,
"lastname": "xyz789",
"middlename": "xyz789",
"postcode": "abc123",
"prefix": "xyz789",
"region": CustomerAddressRegion,
"region_id": 987,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "abc123",
"uid": "4",
"vat_id": "abc123"
}
CustomerAddressAttribute
Description
Specifies the attribute code and value of a customer address attribute.
Example
{
"attribute_code": "xyz789",
"value": "abc123"
}
CustomerAddressInput
Description
Contains details about a billing or shipping address.
Fields
| Input Field | Description |
|---|---|
city - String
|
The customer's city or town. |
company - String
|
The customer's company. |
country_code - CountryCodeEnum
|
The two-letter code representing the customer's country. |
custom_attributesV2 - [AttributeValueInput]
|
Custom attributes assigned to the customer address. |
default_billing - Boolean
|
Indicates whether the address is the default billing address. |
default_shipping - Boolean
|
Indicates whether the address is the default shipping address. |
fax - String
|
The customer's fax number. |
firstname - String
|
The first name of the person associated with the billing/shipping address. |
lastname - String
|
The family name of the person associated with the billing/shipping address. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The customer's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - CustomerAddressRegionInput
|
An object containing the region name, region code, and region ID. |
street - [String]
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The customer's telephone number. |
vat_id - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"city": "abc123",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInput],
"default_billing": false,
"default_shipping": true,
"fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
"middlename": "xyz789",
"postcode": "xyz789",
"prefix": "abc123",
"region": CustomerAddressRegionInput,
"street": ["abc123"],
"suffix": "abc123",
"telephone": "xyz789",
"vat_id": "xyz789"
}
CustomerAddressRegion
Description
Defines the customer's state or province.
Example
{
"region": "abc123",
"region_code": "xyz789",
"region_id": 123
}
CustomerAddressRegionInput
Description
Defines the customer's state or province.
Example
{
"region": "xyz789",
"region_code": "abc123",
"region_id": 123
}
CustomerAddresses
Fields
| Field Name | Description |
|---|---|
items - [CustomerAddress]
|
An array containing the customer's shipping and billing addresses. |
page_info - SearchResultPageInfo
|
Contains pagination metadata. |
total_count - Int
|
The total count of customer addresses. |
Example
{
"items": [CustomerAddress],
"page_info": SearchResultPageInfo,
"total_count": 987
}
CustomerAttributeMetadata
Description
Customer attribute metadata.
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The unique identifier for an attribute code. This value should be in lowercase letters without spaces. |
default_value - String
|
Default attribute value. |
entity_type - AttributeEntityTypeEnum!
|
The type of entity that defines the attribute. |
frontend_class - String
|
The frontend class of the attribute. |
frontend_input - AttributeFrontendInputEnum
|
The frontend input type of the attribute. |
input_filter - InputFilterEnum
|
The template used for the input of the attribute (e.g., 'date'). |
is_required - Boolean!
|
Whether the attribute value is required. |
is_unique - Boolean!
|
Whether the attribute value must be unique. |
label - String
|
The label assigned to the attribute. |
multiline_count - Int
|
The number of lines of the attribute value. |
options - [CustomAttributeOptionInterface]!
|
Attribute options. |
sort_order - Int
|
The position of the attribute in the form. |
validate_rules - [ValidationRule]
|
The validation rules of the attribute value. |
Example
{
"code": 4,
"default_value": "xyz789",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
"is_unique": false,
"label": "xyz789",
"multiline_count": 123,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
}
CustomerCreateInput
Description
An input object for creating a customer.
Fields
| Input Field | Description |
|---|---|
allow_remote_shopping_assistance - Boolean
|
Indicates whether the customer has enabled remote shopping assistance. |
custom_attributes - [AttributeValueInput]
|
The customer's custom attributes. |
date_of_birth - String
|
The customer's date of birth. |
email - String!
|
The customer's email address. |
firstname - String!
|
The customer's first name. |
gender - Int
|
The customer's gender (Male - 1, Female - 2). |
is_subscribed - Boolean
|
Indicates whether the customer is subscribed to the company's newsletter. |
lastname - String!
|
The customer's family name. |
middlename - String
|
The customer's middle name. |
password - String
|
The customer's password. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
suffix - String
|
A value such as Sr., Jr., or III. |
taxvat - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"allow_remote_shopping_assistance": false,
"custom_attributes": [AttributeValueInput],
"date_of_birth": "abc123",
"email": "xyz789",
"firstname": "xyz789",
"gender": 123,
"is_subscribed": true,
"lastname": "abc123",
"middlename": "abc123",
"password": "xyz789",
"prefix": "abc123",
"suffix": "xyz789",
"taxvat": "abc123"
}
CustomerDownloadableProduct
Description
Contains details about a single downloadable product.
Fields
| Field Name | Description |
|---|---|
date - String
|
The date and time the purchase was made. |
download_url - String
|
The fully qualified URL to the download file. |
order_increment_id - String
|
The unique ID assigned to the item. |
remaining_downloads - String
|
The remaining number of times the customer can download the product. |
status - String
|
Indicates when the product becomes available for download. Options are Pending and Invoiced. |
Example
{
"date": "abc123",
"download_url": "abc123",
"order_increment_id": "xyz789",
"remaining_downloads": "xyz789",
"status": "abc123"
}
CustomerDownloadableProducts
Description
Contains a list of downloadable products.
Fields
| Field Name | Description |
|---|---|
items - [CustomerDownloadableProduct]
|
An array of purchased downloadable items. |
Example
{"items": [CustomerDownloadableProduct]}
CustomerGroupStorefront
Description
Data of customer group.
Fields
| Field Name | Description |
|---|---|
uid - ID!
|
The unique ID for a CustomerGroup object. |
Example
{"uid": 4}
CustomerOrder
Description
Contains details about each of the customer's orders.
Fields
| Field Name | Description |
|---|---|
applied_coupons - [AppliedCoupon]!
|
Coupons applied to the order. |
applied_gift_cards - [ApplyGiftCardToOrder]
|
An array of gift cards applied to the order. |
available_actions - [OrderActionType]!
|
List of available order actions. |
billing_address - OrderAddress
|
The billing address for the order. |
carrier - String
|
The shipping carrier for the order delivery. |
comments - [SalesCommentItem]
|
Comments about the order. |
credit_memos - [CreditMemo]
|
A list of credit memos. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the order |
customer_info - OrderCustomerInfo!
|
Returns customer information from order. |
email - String
|
Order customer email. |
gift_message - GiftMessage
|
The entered gift message for the order |
gift_receipt_included - Boolean!
|
Indicates whether the customer requested a gift receipt for the order. |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order. |
id - ID!
|
The unique ID for a CustomerOrder object. |
invoices - [Invoice]!
|
A list of invoices for the order. |
is_virtual - Boolean!
|
TRUE if the order is virtual
|
items - [OrderItemInterface]
|
An array containing the items purchased in this order. |
items_eligible_for_return - [OrderItemInterface]
|
A list of order items eligible to be in a return request. |
number - String!
|
The order number. |
order_date - String!
|
The date the order was placed. |
order_status_change_date - String!
|
The date the order status was last updated. |
payment_methods - [OrderPaymentMethod]
|
Payment details for the order. |
printed_card_included - Boolean!
|
Indicates whether the customer requested a printed card for the order. |
returns - Returns
|
Return requests associated with this order. |
shipments - [OrderShipment]
|
A list of shipments for the order. |
shipping_address - OrderAddress
|
The shipping address for the order. |
shipping_method - String
|
The delivery method for the order. |
status - String!
|
The current status of the order. |
token - String!
|
The token that can be used to retrieve the order using order query. |
total - OrderTotal
|
Details about the calculated totals for this order. |
Example
{
"applied_coupons": [AppliedCoupon],
"applied_gift_cards": [ApplyGiftCardToOrder],
"available_actions": ["REORDER"],
"billing_address": OrderAddress,
"carrier": "xyz789",
"comments": [SalesCommentItem],
"credit_memos": [CreditMemo],
"custom_attributes": [CustomAttribute],
"customer_info": OrderCustomerInfo,
"email": "xyz789",
"gift_message": GiftMessage,
"gift_receipt_included": false,
"gift_wrapping": GiftWrapping,
"id": 4,
"invoices": [Invoice],
"is_virtual": true,
"items": [OrderItemInterface],
"items_eligible_for_return": [OrderItemInterface],
"number": "abc123",
"order_date": "xyz789",
"order_status_change_date": "abc123",
"payment_methods": [OrderPaymentMethod],
"printed_card_included": true,
"returns": Returns,
"shipments": [OrderShipment],
"shipping_address": OrderAddress,
"shipping_method": "xyz789",
"status": "xyz789",
"token": "xyz789",
"total": OrderTotal
}
CustomerOrderSortInput
Description
CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.
Fields
| Input Field | Description |
|---|---|
sort_direction - SortEnum!
|
This enumeration indicates whether to return results in ascending or descending order |
sort_field - CustomerOrderSortableField!
|
Specifies the field to use for sorting |
Example
{"sort_direction": "ASC", "sort_field": "NUMBER"}
CustomerOrderSortableField
Description
Specifies the field to use for sorting
Values
| Enum Value | Description |
|---|---|
|
|
Sorts customer orders by number |
|
|
Sorts customer orders by created_at field |
Example
"NUMBER"
CustomerOrders
Description
The collection of orders that match the conditions defined in the filter.
Fields
| Field Name | Description |
|---|---|
date_of_first_order - String
|
Date of the first order placed in the store |
items - [CustomerOrder]!
|
An array of customer orders. |
page_info - SearchResultPageInfo
|
Contains pagination metadata. |
total_count - Int
|
The total count of customer orders. |
Example
{
"date_of_first_order": "xyz789",
"items": [CustomerOrder],
"page_info": SearchResultPageInfo,
"total_count": 123
}
CustomerOrdersFilterInput
Description
Identifies the filter to use for filtering orders.
Fields
| Input Field | Description |
|---|---|
grand_total - FilterRangeTypeInput
|
Filters by order base grand total value. |
number - FilterStringTypeInput
|
Filters by order number. |
order_date - FilterRangeTypeInput
|
Filters by order created_at time. |
status - FilterEqualTypeInput
|
Filters by order status. |
Example
{
"grand_total": FilterRangeTypeInput,
"number": FilterStringTypeInput,
"order_date": FilterRangeTypeInput,
"status": FilterEqualTypeInput
}
CustomerOutput
Description
Contains details about a newly-created or updated customer.
Fields
| Field Name | Description |
|---|---|
customer - Customer!
|
Customer details after creating or updating a customer. |
Example
{"customer": Customer}
CustomerPaymentTokens
Description
Contains payment tokens stored in the customer's vault.
Fields
| Field Name | Description |
|---|---|
items - [PaymentToken]!
|
An array of payment tokens. |
Example
{"items": [PaymentToken]}
CustomerSegmentStorefront
Description
Customer segment details
Fields
| Field Name | Description |
|---|---|
uid - ID!
|
The unique ID for a CustomerSegment object. |
Example
{"uid": 4}
CustomerStoreCredit
Description
Contains store credit information with balance and history.
Fields
| Field Name | Description |
|---|---|
balance_history - CustomerStoreCreditHistory
|
Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned. |
current_balance - Money
|
The current balance of store credit. |
enabled - Boolean
|
Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. |
Example
{
"balance_history": CustomerStoreCreditHistory,
"current_balance": Money,
"enabled": false
}
CustomerStoreCreditHistory
Description
Lists changes to the amount of store credit available to the customer.
Fields
| Field Name | Description |
|---|---|
items - [CustomerStoreCreditHistoryItem]
|
An array containing information about changes to the store credit available to the customer. |
page_info - SearchResultPageInfo
|
Metadata for pagination rendering. |
total_count - Int
|
The number of items returned. |
Example
{
"items": [CustomerStoreCreditHistoryItem],
"page_info": SearchResultPageInfo,
"total_count": 987
}
CustomerStoreCreditHistoryItem
Description
Contains store credit history information.
Fields
| Field Name | Description |
|---|---|
action - String
|
The action that was made on the store credit. |
actual_balance - Money
|
The store credit available to the customer as a result of this action. |
balance_change - Money
|
The amount added to or subtracted from the store credit as a result of this action. |
date_time_changed - String
|
The date and time when the store credit change was made. |
Example
{
"action": "xyz789",
"actual_balance": Money,
"balance_change": Money,
"date_time_changed": "abc123"
}
CustomerToken
Description
Contains a customer authorization token.
Fields
| Field Name | Description |
|---|---|
token - String
|
The customer authorization token. |
Example
{"token": "xyz789"}
CustomerUpdateInput
Description
An input object for updating a customer.
Fields
| Input Field | Description |
|---|---|
allow_remote_shopping_assistance - Boolean
|
Indicates whether the customer has enabled remote shopping assistance. |
custom_attributes - [AttributeValueInput]
|
The customer's custom attributes. |
date_of_birth - String
|
The customer's date of birth. |
firstname - String
|
The customer's first name. |
gender - Int
|
The customer's gender (Male - 1, Female - 2). |
is_subscribed - Boolean
|
Indicates whether the customer is subscribed to the company's newsletter. |
lastname - String
|
The customer's family name. |
middlename - String
|
The customer's middle name. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
suffix - String
|
A value such as Sr., Jr., or III. |
taxvat - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"allow_remote_shopping_assistance": true,
"custom_attributes": [AttributeValueInput],
"date_of_birth": "xyz789",
"firstname": "xyz789",
"gender": 987,
"is_subscribed": true,
"lastname": "abc123",
"middlename": "abc123",
"prefix": "abc123",
"suffix": "xyz789",
"taxvat": "abc123"
}
CustomizableAreaOption
Description
Contains information about a text area that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
product_sku - String
|
The Stock Keeping Unit of the base product. |
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - CustomizableAreaValue
|
An object that defines a text area. |
Example
{
"product_sku": "abc123",
"required": false,
"sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": CustomizableAreaValue
}
CustomizableAreaValue
Description
Defines the price and sku of a product whose page contains a customized text area.
Fields
| Field Name | Description |
|---|---|
max_characters - Int
|
The maximum number of characters that can be entered for this customizable option. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
uid - ID!
|
The unique ID for a CustomizableAreaValue object. |
Example
{
"max_characters": 123,
"price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
"uid": 4
}
CustomizableCheckboxOption
Description
Contains information about a set of checkbox values that are defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - [CustomizableCheckboxValue]
|
An array that defines a set of checkbox values. |
Example
{
"required": true,
"sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": [CustomizableCheckboxValue]
}
CustomizableCheckboxValue
Description
Defines the price and sku of a product whose page contains a customized set of checkbox values.
Fields
| Field Name | Description |
|---|---|
option_type_id - Int
|
The ID assigned to the value. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
sort_order - Int
|
The order in which the checkbox value is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableCheckboxValue object. |
Example
{
"option_type_id": 123,
"price": 123.45,
"price_type": "FIXED",
"sku": "xyz789",
"sort_order": 987,
"title": "abc123",
"uid": "4"
}
CustomizableDateOption
Description
Contains information about a date picker that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
product_sku - String
|
The Stock Keeping Unit of the base product. |
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - CustomizableDateValue
|
An object that defines a date field in a customizable option. |
Example
{
"product_sku": "abc123",
"required": false,
"sort_order": 987,
"title": "abc123",
"uid": 4,
"value": CustomizableDateValue
}
CustomizableDateTypeEnum
Description
Defines the customizable date type.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DATE"
CustomizableDateValue
Description
Defines the price and sku of a product whose page contains a customized date picker.
Fields
| Field Name | Description |
|---|---|
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
type - CustomizableDateTypeEnum
|
DATE, DATE_TIME or TIME |
uid - ID!
|
The unique ID for a CustomizableDateValue object. |
Example
{
"price": 987.65,
"price_type": "FIXED",
"sku": "abc123",
"type": "DATE",
"uid": 4
}
CustomizableDropDownOption
Description
Contains information about a drop down menu that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - [CustomizableDropDownValue]
|
An array that defines the set of options for a drop down menu. |
Example
{
"required": false,
"sort_order": 123,
"title": "abc123",
"uid": "4",
"value": [CustomizableDropDownValue]
}
CustomizableDropDownValue
Description
Defines the price and sku of a product whose page contains a customized drop down menu.
Fields
| Field Name | Description |
|---|---|
option_type_id - Int
|
The ID assigned to the value. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableDropDownValue object. |
Example
{
"option_type_id": 123,
"price": 123.45,
"price_type": "FIXED",
"sku": "abc123",
"sort_order": 123,
"title": "abc123",
"uid": 4
}
CustomizableFieldOption
Description
Contains information about a text field that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
product_sku - String
|
The Stock Keeping Unit of the base product. |
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - CustomizableFieldValue
|
An object that defines a text field. |
Example
{
"product_sku": "abc123",
"required": false,
"sort_order": 987,
"title": "xyz789",
"uid": 4,
"value": CustomizableFieldValue
}
CustomizableFieldValue
Description
Defines the price and sku of a product whose page contains a customized text field.
Fields
| Field Name | Description |
|---|---|
max_characters - Int
|
The maximum number of characters that can be entered for this customizable option. |
price - Float
|
The price of the custom value. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
uid - ID!
|
The unique ID for a CustomizableFieldValue object. |
Example
{
"max_characters": 987,
"price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
"uid": 4
}
CustomizableFileOption
Description
Contains information about a file picker that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
product_sku - String
|
The Stock Keeping Unit of the base product. |
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - CustomizableFileValue
|
An object that defines a file value. |
Example
{
"product_sku": "xyz789",
"required": true,
"sort_order": 987,
"title": "abc123",
"uid": 4,
"value": CustomizableFileValue
}
CustomizableFileValue
Description
Defines the price and sku of a product whose page contains a customized file picker.
Fields
| Field Name | Description |
|---|---|
file_extension - String
|
The file extension to accept. |
image_size_x - Int
|
The maximum width of an image. |
image_size_y - Int
|
The maximum height of an image. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
uid - ID!
|
The unique ID for a CustomizableFileValue object. |
Example
{
"file_extension": "xyz789",
"image_size_x": 123,
"image_size_y": 987,
"price": 987.65,
"price_type": "FIXED",
"sku": "xyz789",
"uid": "4"
}
CustomizableMultipleOption
Description
Contains information about a multiselect that is defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - [CustomizableMultipleValue]
|
An array that defines the set of options for a multiselect. |
Example
{
"required": false,
"sort_order": 987,
"title": "abc123",
"uid": 4,
"value": [CustomizableMultipleValue]
}
CustomizableMultipleValue
Description
Defines the price and sku of a product whose page contains a customized multiselect.
Fields
| Field Name | Description |
|---|---|
option_type_id - Int
|
The ID assigned to the value. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableMultipleValue object. |
Example
{
"option_type_id": 123,
"price": 123.45,
"price_type": "FIXED",
"sku": "xyz789",
"sort_order": 123,
"title": "xyz789",
"uid": "4"
}
CustomizableOptionInput
CustomizableOptionInterface
Description
Contains basic information about a customizable option. It can be implemented by several types of configurable options.
Fields
| Field Name | Description |
|---|---|
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
Possible Types
| CustomizableOptionInterface Types |
|---|
Example
{
"required": false,
"sort_order": 123,
"title": "abc123",
"uid": "4"
}
CustomizableProductInterface
Description
Contains information about customizable product options.
Fields
| Field Name | Description |
|---|---|
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
Possible Types
| CustomizableProductInterface Types |
|---|
Example
{"options": [CustomizableOptionInterface]}
CustomizableRadioOption
Description
Contains information about a set of radio buttons that are defined as part of a customizable option.
Fields
| Field Name | Description |
|---|---|
required - Boolean
|
Indicates whether the option is required. |
sort_order - Int
|
The order in which the option is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableOptionInterface object. |
value - [CustomizableRadioValue]
|
An array that defines a set of radio buttons. |
Example
{
"required": true,
"sort_order": 123,
"title": "xyz789",
"uid": 4,
"value": [CustomizableRadioValue]
}
CustomizableRadioValue
Description
Defines the price and sku of a product whose page contains a customized set of radio buttons.
Fields
| Field Name | Description |
|---|---|
option_type_id - Int
|
The ID assigned to the value. |
price - Float
|
The price assigned to this option. |
price_type - PriceTypeEnum
|
FIXED, PERCENT, or DYNAMIC. |
sku - String
|
The Stock Keeping Unit for this option. |
sort_order - Int
|
The order in which the radio button is displayed. |
title - String
|
The display name for this option. |
uid - ID!
|
The unique ID for a CustomizableRadioValue object. |
Example
{
"option_type_id": 987,
"price": 123.45,
"price_type": "FIXED",
"sku": "xyz789",
"sort_order": 123,
"title": "abc123",
"uid": 4
}
DateTime
DeleteCompanyRoleOutput
Description
Contains the response to the request to delete the company role.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
SIndicates whether the company role has been deleted successfully. |
Example
{"success": true}
DeleteCompanyTeamOutput
Description
Contains the status of the request to delete a company team.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Indicates whether the delete operation succeeded. |
Example
{"success": true}
DeleteCompanyUserOutput
Description
Contains the response to the request to delete the company user.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Indicates whether the company user has been deactivated successfully. |
Example
{"success": false}
DeleteCompareListOutput
Description
Contains the results of the request to delete a compare list.
Fields
| Field Name | Description |
|---|---|
result - Boolean!
|
Indicates whether the compare list was successfully deleted. |
Example
{"result": true}
DeleteNegotiableQuoteError
DeleteNegotiableQuoteOperationFailure
Description
Contains details about a failed delete operation on a negotiable quote.
Fields
| Field Name | Description |
|---|---|
errors - [DeleteNegotiableQuoteError]!
|
|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"errors": [NegotiableQuoteInvalidStateError],
"quote_uid": "4"
}
DeleteNegotiableQuoteOperationResult
DeleteNegotiableQuoteTemplateInput
Description
Specifies the quote template id of the quote template to delete
Fields
| Input Field | Description |
|---|---|
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{"template_id": "4"}
DeleteNegotiableQuotesInput
Fields
| Input Field | Description |
|---|---|
quote_uids - [ID]!
|
A list of unique IDs for NegotiableQuote objects to delete. |
Example
{"quote_uids": [4]}
DeleteNegotiableQuotesOutput
Description
Contains a list of undeleted negotiable quotes the company user can view.
Fields
| Field Name | Description |
|---|---|
negotiable_quotes - NegotiableQuotesOutput
|
A list of negotiable quotes that the customer can view |
Arguments
|
|
operation_results - [DeleteNegotiableQuoteOperationResult]!
|
An array of deleted negotiable quote UIDs and details about any errors. |
result_status - BatchMutationStatus!
|
The status of the request to delete one or more negotiable quotes. |
Example
{
"negotiable_quotes": NegotiableQuotesOutput,
"operation_results": [
NegotiableQuoteUidOperationSuccess
],
"result_status": "SUCCESS"
}
DeletePaymentTokenOutput
Description
Indicates whether the request succeeded and returns the remaining customer payment tokens.
Fields
| Field Name | Description |
|---|---|
customerPaymentTokens - CustomerPaymentTokens
|
A container for the customer's remaining payment tokens. |
result - Boolean!
|
Indicates whether the request succeeded. |
Example
{
"customerPaymentTokens": CustomerPaymentTokens,
"result": true
}
DeletePurchaseOrderApprovalRuleError
Description
Contains details about an error that occurred when deleting an approval rule .
Fields
| Field Name | Description |
|---|---|
message - String
|
The text of the error message. |
type - DeletePurchaseOrderApprovalRuleErrorType
|
The error type. |
Example
{"message": "abc123", "type": "UNDEFINED"}
DeletePurchaseOrderApprovalRuleErrorType
DeletePurchaseOrderApprovalRuleInput
Description
Specifies the IDs of the approval rules to delete.
Fields
| Input Field | Description |
|---|---|
approval_rule_uids - [ID]!
|
An array of purchase order approval rule IDs. |
Example
{"approval_rule_uids": ["4"]}
DeletePurchaseOrderApprovalRuleOutput
Description
Contains any errors encountered while attempting to delete approval rules.
Fields
| Field Name | Description |
|---|---|
errors - [DeletePurchaseOrderApprovalRuleError]!
|
An array of error messages encountered while performing the operation. |
Example
{"errors": [DeletePurchaseOrderApprovalRuleError]}
DeleteRequisitionListItemsOutput
Description
Output of the request to remove items from the requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The requisition list after removing items. |
Example
{"requisition_list": RequisitionList}
DeleteRequisitionListOutput
Description
Indicates whether the request to delete the requisition list was successful.
Fields
| Field Name | Description |
|---|---|
requisition_lists - RequisitionLists
|
The customer's requisition lists after deleting a requisition list. |
status - Boolean!
|
Indicates whether the request to delete the requisition list was successful. |
Example
{"requisition_lists": RequisitionLists, "status": true}
DeleteWishlistOutput
Description
Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.
Fields
| Field Name | Description |
|---|---|
status - Boolean!
|
Indicates whether the wish list was deleted. |
wishlists - [Wishlist]!
|
A list of undeleted wish lists. |
Example
{"status": false, "wishlists": [Wishlist]}
Discount
Description
Specifies the discount type and value for quote line item.
Fields
| Field Name | Description |
|---|---|
amount - Money!
|
The amount of the discount. |
applied_to - CartDiscountType!
|
The type of the entity the discount is applied to. |
coupon - AppliedCoupon
|
The coupon related to the discount. |
is_discounting_locked - Boolean
|
Is quote discounting locked for line item. |
label - String!
|
A description of the discount. |
type - String
|
Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. |
value - Float
|
Quote line item discount value. |
Example
{
"amount": Money,
"applied_to": "ITEM",
"coupon": AppliedCoupon,
"is_discounting_locked": true,
"label": "abc123",
"type": "abc123",
"value": 123.45
}
DownloadableCartItem
Description
An implementation for downloadable product cart items.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array containing the customizable options the shopper selected. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
links - [DownloadableProductLinks]
|
An array containing information about the links for the downloadable product added to the cart. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
samples - [DownloadableProductSamples]
|
An array containing information about samples of the selected downloadable product. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"is_available": true,
"links": [DownloadableProductLinks],
"max_qty": 123.45,
"min_qty": 987.65,
"not_available_message": "abc123",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
"samples": [DownloadableProductSamples],
"uid": "4"
}
DownloadableCreditMemoItem
Description
Defines downloadable product options for CreditMemoItemInterface.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo item |
discounts - [Discount]
|
Details about the final discount amount for the base product, including discounts on options. |
downloadable_links - [DownloadableItemsLinks]
|
A list of downloadable links that are refunded from the downloadable product. |
id - ID!
|
The unique ID for a CreditMemoItemInterface object. |
order_item - OrderItemInterface
|
The order item the credit memo is applied to. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_refunded - Float
|
The number of refunded items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
"id": 4,
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_refunded": 987.65
}
DownloadableInvoiceItem
Description
Defines downloadable product options for InvoiceItemInterface.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice item |
discounts - [Discount]
|
Information about the final discount amount for the base product, including discounts on options. |
downloadable_links - [DownloadableItemsLinks]
|
A list of downloadable links that are invoiced from the downloadable product. |
id - ID!
|
The unique ID for an InvoiceItemInterface object. |
order_item - OrderItemInterface
|
Details about an individual order item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_invoiced - Float
|
The number of invoiced items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"downloadable_links": [DownloadableItemsLinks],
"id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_invoiced": 987.65
}
DownloadableItemsLinks
Description
Defines characteristics of the links for downloadable product.
Example
{
"sort_order": 987,
"title": "abc123",
"uid": 4
}
DownloadableOrderItem
Description
Defines downloadable product options for OrderItemInterface.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
downloadable_links - [DownloadableItemsLinks]
|
A list of downloadable links that are ordered from the downloadable product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Example
{
"custom_attributes": [CustomAttribute],
"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": "abc123",
"product_type": "xyz789",
"product_url_key": "abc123",
"quantity_canceled": 123.45,
"quantity_invoiced": 987.65,
"quantity_ordered": 987.65,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
}
DownloadableProduct
Description
Defines a product that the shopper downloads.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
downloadable_product_links - [DownloadableProductLinks]
|
An array containing information about the links for this downloadable product. |
downloadable_product_samples - [DownloadableProductSamples]
|
An array containing information about samples of this downloadable product. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
links_purchased_separately - Int
|
A value of 1 indicates that each link in the array must be purchased separately. |
links_title - String
|
The heading above the list of downloadable products. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
Example
{
"canonical_url": "abc123",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"downloadable_product_links": [
DownloadableProductLinks
],
"downloadable_product_samples": [
DownloadableProductSamples
],
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "abc123",
"links_purchased_separately": 123,
"links_title": "abc123",
"manufacturer": 123,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "abc123",
"new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "abc123"
}
DownloadableProductCartItemInput
Description
Defines a single downloadable product.
Fields
| Input Field | Description |
|---|---|
customizable_options - [CustomizableOptionInput]
|
The ID and value of the option. |
data - CartItemInput!
|
The quantity and SKU of the downloadable product. |
downloadable_product_links - [DownloadableProductLinksInput]
|
An array of objects containing the link_id of the downloadable product link. |
Example
{
"customizable_options": [CustomizableOptionInput],
"data": CartItemInput,
"downloadable_product_links": [
DownloadableProductLinksInput
]
}
DownloadableProductLinks
Description
Defines characteristics of a downloadable product.
Fields
| Field Name | Description |
|---|---|
price - Float
|
The price of the downloadable product. |
sample_url - String
|
The full URL to the downloadable sample. |
sort_order - Int
|
A number indicating the sort order. |
title - String
|
The display name of the link. |
uid - ID!
|
The unique ID for a DownloadableProductLinks object. |
Example
{
"price": 123.45,
"sample_url": "abc123",
"sort_order": 987,
"title": "abc123",
"uid": "4"
}
DownloadableProductLinksInput
Description
Contains the link ID for the downloadable product.
Fields
| Input Field | Description |
|---|---|
link_id - Int!
|
The unique ID of the downloadable product link. |
Example
{"link_id": 987}
DownloadableProductSamples
Description
Defines characteristics of a downloadable product.
Example
{
"sample_url": "xyz789",
"sort_order": 123,
"title": "xyz789"
}
DownloadableRequisitionListItem
Description
Contains details about downloadable products added to a requisition list.
Fields
| Field Name | Description |
|---|---|
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
links - [DownloadableProductLinks]
|
An array of links for downloadable products in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. |
quantity - Float!
|
The quantity of the product added to the requisition list. |
samples - [DownloadableProductSamples]
|
An array of links to downloadable product samples. |
uid - ID!
|
The unique ID of an item in a requisition list. |
Example
{
"customizable_options": [SelectedCustomizableOption],
"links": [DownloadableProductLinks],
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples],
"uid": 4
}
DownloadableWishlistItem
Description
A downloadable product wish list item.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
links_v2 - [DownloadableProductLinks]
|
An array containing information about the selected links. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
samples - [DownloadableProductSamples]
|
An array containing information about the selected samples. |
Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
"links_v2": [DownloadableProductLinks],
"product": ProductInterface,
"quantity": 987.65,
"samples": [DownloadableProductSamples]
}
DuplicateNegotiableQuoteInput
Description
Identifies a quote to be duplicated
Example
{
"duplicated_quote_uid": "4",
"quote_uid": 4
}
DuplicateNegotiableQuoteOutput
Description
Contains the newly created negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
Negotiable Quote resulting from duplication operation. |
Example
{"quote": NegotiableQuote}
EnteredCustomAttributeInput
Description
Contains details about a custom text attribute that the buyer entered.
Example
{
"attribute_code": "xyz789",
"value": "xyz789"
}
EnteredOptionInput
Description
Defines a customer-entered option.
Example
{
"uid": "4",
"value": "xyz789"
}
Error
Description
An error encountered while adding an item to the the cart.
Fields
| Field Name | Description |
|---|---|
code - CartUserInputErrorType!
|
A cart-specific error code. |
message - String!
|
A localized error message. |
Possible Types
| Error Types |
|---|
Example
{
"code": "PRODUCT_NOT_FOUND",
"message": "xyz789"
}
ErrorInterface
Fields
| Field Name | Description |
|---|---|
message - String!
|
The returned error message. |
Possible Types
| ErrorInterface Types |
|---|
Example
{"message": "abc123"}
EstimateAddressInput
Description
Contains details about an address.
Fields
| Input Field | Description |
|---|---|
country_code - CountryCodeEnum!
|
The two-letter code representing the customer's country. |
postcode - String
|
The customer's ZIP or postal code. |
region - CustomerAddressRegionInput
|
An object containing the region name, region code, and region ID. |
Example
{
"country_code": "AF",
"postcode": "xyz789",
"region": CustomerAddressRegionInput
}
EstimateTotalsInput
Fields
| Input Field | Description |
|---|---|
address - EstimateAddressInput!
|
Customer's address to estimate totals. |
cart_id - String!
|
The unique ID of the cart to query. |
shipping_method - ShippingMethodInput
|
Selected shipping method to estimate totals. |
Example
{
"address": EstimateAddressInput,
"cart_id": "xyz789",
"shipping_method": ShippingMethodInput
}
EstimateTotalsOutput
Description
Estimate totals output.
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
Cart after totals estimation |
Example
{"cart": Cart}
ExchangeExternalCustomerTokenInput
Description
Contains details about external customer.
Fields
| Input Field | Description |
|---|---|
customer - CustomerCreateInput!
|
An input object that defines the customer characteristics to update. |
Example
{"customer": CustomerCreateInput}
ExchangeExternalCustomerTokenOutput
Description
Contains customer token for external customer.
Example
{
"customer": Customer,
"token": "abc123"
}
ExchangeRate
FastlaneConfig
Fields
| Field Name | Description |
|---|---|
code - String
|
The payment method code as defined in the payment gateway |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
payment_source - String
|
The payment source for the payment method |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
title - String
|
The name displayed for the payment method |
Example
{
"code": "xyz789",
"is_visible": false,
"payment_intent": "xyz789",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
}
FastlaneMethodInput
Description
Fastlane Payment inputs
Example
{
"payment_source": "abc123",
"paypal_fastlane_token": "abc123"
}
FilterEqualTypeInput
Description
Defines a filter that matches the input exactly.
Fields
| Input Field | Description |
|---|---|
eq - String
|
Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as 5. |
in - [String]
|
Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of ["4", "5", "6"]. |
Example
{
"eq": "abc123",
"in": ["xyz789"]
}
FilterMatchTypeEnum
FilterMatchTypeInput
Description
Defines a filter that performs a fuzzy search.
Fields
| Input Field | Description |
|---|---|
match - String
|
Use this attribute to fuzzy match the specified string. For example, to filter on a specific SKU, specify a value such as 24-MB01. |
match_type - FilterMatchTypeEnum
|
Filter match type for fine-tuned results. Possible values FULL or PARTIAL. If match_type is not provided, returned results will default to FULL match. |
Example
{"match": "xyz789", "match_type": "FULL"}
FilterRangeTypeInput
Description
Defines a filter that matches a range of values, such as prices or dates.
Example
{
"from": "abc123",
"to": "xyz789"
}
FilterStringTypeInput
Description
Defines a filter for an input string.
Example
{
"eq": "abc123",
"in": ["abc123"],
"match": "abc123"
}
FilterTypeInput
Description
Defines the comparison operators that can be used in a filter.
Fields
| Input Field | Description |
|---|---|
eq - String
|
Equals. |
from - String
|
From. Must be used with the to field. |
gt - String
|
Greater than. |
gteq - String
|
Greater than or equal to. |
in - [String]
|
In. The value can contain a set of comma-separated values. |
like - String
|
Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. |
lt - String
|
Less than. |
lteq - String
|
Less than or equal to. |
moreq - String
|
More than or equal to. |
neq - String
|
Not equal to. |
nin - [String]
|
Not in. The value can contain a set of comma-separated values. |
notnull - String
|
Not null. |
null - String
|
Is null. |
to - String
|
To. Must be used with the from field. |
Example
{
"eq": "xyz789",
"from": "abc123",
"gt": "xyz789",
"gteq": "abc123",
"in": ["xyz789"],
"like": "abc123",
"lt": "abc123",
"lteq": "abc123",
"moreq": "abc123",
"neq": "xyz789",
"nin": ["xyz789"],
"notnull": "xyz789",
"null": "xyz789",
"to": "xyz789"
}
FilterableInSearchAttribute
Description
Contains product attributes that can be used for filtering in a productSearch query
Fields
| Field Name | Description |
|---|---|
attribute - String!
|
The unique identifier for an attribute code. This value should be in lowercase letters and without spaces |
frontendInput - String
|
Indicates how field rendered on storefront |
label - String
|
The display name assigned to the attribute |
numeric - Boolean
|
Indicates whether this attribute has a numeric value, such as a price or integer |
Example
{
"attribute": "xyz789",
"frontendInput": "xyz789",
"label": "xyz789",
"numeric": false
}
FixedProductTax
Description
A single FPT that can be applied to a product price.
Example
{
"amount": Money,
"label": "abc123"
}
FixedProductTaxDisplaySettings
Description
Lists display settings for the Fixed Product Tax.
Values
| Enum Value | Description |
|---|---|
|
|
The displayed price includes the FPT amount without displaying the ProductPrice.fixed_product_taxes values. This value corresponds to 'Including FPT only'. |
|
|
The displayed price includes the FPT amount while displaying the values of ProductPrice.fixed_product_taxes separately. This value corresponds to 'Including FPT and FPT description'. |
|
|
The displayed price does not include the FPT amount. The values of ProductPrice.fixed_product_taxes and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.' |
|
|
The displayed price does not include the FPT amount. The values from ProductPrice.fixed_product_taxes are not displayed. This value corresponds to 'Excluding FPT'. |
|
|
The FPT feature is not enabled. You can omit ProductPrice.fixed_product_taxes from your query. |
Example
"INCLUDE_FPT_WITHOUT_DETAILS"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GenerateCustomerTokenAsAdminInput
Description
Identifies which customer requires remote shopping assistance.
Fields
| Input Field | Description |
|---|---|
customer_email - String!
|
The email address of the customer requesting remote shopping assistance. |
Example
{"customer_email": "xyz789"}
GenerateCustomerTokenAsAdminOutput
Description
Contains the generated customer token.
Fields
| Field Name | Description |
|---|---|
customer_token - String!
|
The generated customer token. |
Example
{"customer_token": "abc123"}
GenerateNegotiableQuoteFromTemplateInput
Description
Specifies the template id, from which to generate quote from.
Fields
| Input Field | Description |
|---|---|
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{"template_id": 4}
GenerateNegotiableQuoteFromTemplateOutput
Description
Contains the generated negotiable quote id.
Fields
| Field Name | Description |
|---|---|
negotiable_quote_uid - ID!
|
The unique ID of a generated NegotiableQuote object. |
Example
{"negotiable_quote_uid": 4}
GetPaymentSDKOutput
Description
Gets the payment SDK URLs and values
Fields
| Field Name | Description |
|---|---|
sdkParams - [PaymentSDKParamsItem]
|
The payment SDK parameters |
Example
{"sdkParams": [PaymentSDKParamsItem]}
GiftCardAccount
Description
Contains details about the gift card account.
Example
{
"balance": Money,
"code": "xyz789",
"expiration_date": "abc123"
}
GiftCardAccountInput
Description
Contains the gift card code.
Fields
| Input Field | Description |
|---|---|
gift_card_code - String!
|
The applied gift card code. |
Example
{"gift_card_code": "abc123"}
GiftCardAmounts
Description
Contains the value of a gift card, the website that generated the card, and related information.
Example
{
"attribute_id": 987,
"uid": "4",
"value": 987.65,
"website_id": 987,
"website_value": 987.65
}
GiftCardCartItem
Description
Contains details about a gift card that has been added to a cart.
Fields
| Field Name | Description |
|---|---|
amount - Money!
|
The amount and currency of the gift card. |
available_gift_wrapping - [GiftWrapping]!
|
The list of available gift wrapping options for the cart item. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array of customizations applied to the gift card. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
gift_message - GiftMessage
|
The entered gift message data for the gift card cart item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping option for the cart item. |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
message - String
|
The message from the sender to the recipient. |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
recipient_email - String
|
The email address of the person receiving the gift card. |
recipient_name - String!
|
The name of the person receiving the gift card. |
sender_email - String
|
The email address of the sender. |
sender_name - String!
|
The name of the sender. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"amount": Money,
"available_gift_wrapping": [GiftWrapping],
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"is_available": false,
"max_qty": 123.45,
"message": "abc123",
"min_qty": 987.65,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
"recipient_email": "abc123",
"recipient_name": "xyz789",
"sender_email": "abc123",
"sender_name": "xyz789",
"uid": 4
}
GiftCardCreditMemoItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the credit memo item |
discounts - [Discount]
|
Details about the final discount amount for the base product, including discounts on options. |
gift_card - GiftCardItem
|
Selected gift card properties for a credit memo item. |
id - ID!
|
The unique ID for a CreditMemoItemInterface object. |
order_item - OrderItemInterface
|
The order item the credit memo is applied to. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_refunded - Float
|
The number of refunded items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"gift_card": GiftCardItem,
"id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_refunded": 123.45
}
GiftCardInvoiceItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice item |
discounts - [Discount]
|
Information about the final discount amount for the base product, including discounts on options. |
gift_card - GiftCardItem
|
Selected gift card properties for an invoice item. |
id - ID!
|
The unique ID for an InvoiceItemInterface object. |
order_item - OrderItemInterface
|
Details about an individual order item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_invoiced - Float
|
The number of invoiced items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"gift_card": GiftCardItem,
"id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_invoiced": 123.45
}
GiftCardItem
Description
Contains details about a gift card.
Fields
| Field Name | Description |
|---|---|
message - String
|
The message from the sender to the recipient. |
recipient_email - String
|
The email address of the receiver of a virtual gift card. |
recipient_name - String
|
The name of the receiver of a physical or virtual gift card. |
sender_email - String
|
The email address of the sender of a virtual gift card. |
sender_name - String
|
The name of the sender of a physical or virtual gift card. |
Example
{
"message": "abc123",
"recipient_email": "abc123",
"recipient_name": "xyz789",
"sender_email": "xyz789",
"sender_name": "xyz789"
}
GiftCardOptions
Description
Contains details about the sender, recipient, and amount of a gift card.
Fields
| Field Name | Description |
|---|---|
amount - Money
|
The amount and currency of the gift card. |
custom_giftcard_amount - Money
|
The custom amount and currency of the gift card. |
message - String
|
A message to the recipient. |
recipient_email - String
|
The email address of the person receiving the gift card. |
recipient_name - String
|
The name of the person receiving the gift card. |
sender_email - String
|
The email address of the person sending the gift card. |
sender_name - String
|
The name of the person sending the gift card. |
Example
{
"amount": Money,
"custom_giftcard_amount": Money,
"message": "abc123",
"recipient_email": "xyz789",
"recipient_name": "xyz789",
"sender_email": "abc123",
"sender_name": "xyz789"
}
GiftCardOrderItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_card - GiftCardItem
|
Selected gift card properties for an order item. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"eligible_for_return": true,
"entered_options": [OrderItemOption],
"gift_card": GiftCardItem,
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"product_type": "abc123",
"product_url_key": "xyz789",
"quantity_canceled": 987.65,
"quantity_invoiced": 123.45,
"quantity_ordered": 987.65,
"quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
"status": "abc123"
}
GiftCardProduct
Description
Defines properties of a gift card.
Fields
| Field Name | Description |
|---|---|
allow_message - Boolean
|
Indicates whether the customer can provide a message to accompany the gift card. |
allow_open_amount - Boolean
|
Indicates whether shoppers have the ability to set the value of the gift card. |
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_card_options - [CustomizableOptionInterface]!
|
An array of customizable gift card options. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
giftcard_amounts - [GiftCardAmounts]
|
An array that contains information about the values and ID of a gift card. |
giftcard_type - GiftCardTypeEnum
|
An enumeration that specifies the type of gift card. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_redeemable - Boolean
|
Indicates whether the customer can redeem the value on the card for cash. |
is_returnable - String
|
Indicates whether the product can be returned. |
lifetime - Int
|
The number of days after purchase until the gift card expires. A null value means there is no limit. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
message_max_length - Int
|
The maximum number of characters the gift message can contain. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
open_amount_max - Float
|
The maximum acceptable value of an open amount gift card. |
open_amount_min - Float
|
The minimum acceptable value of an open amount gift card. |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
weight - Float
|
The weight of the item, in units defined by the store. |
Example
{
"allow_message": false,
"allow_open_amount": true,
"canonical_url": "abc123",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_card_options": [CustomizableOptionInterface],
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"giftcard_amounts": [GiftCardAmounts],
"giftcard_type": "VIRTUAL",
"image": ProductImage,
"is_redeemable": true,
"is_returnable": "xyz789",
"lifetime": 123,
"manufacturer": 987,
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"message_max_length": 123,
"meta_description": "xyz789",
"meta_keyword": "abc123",
"meta_title": "xyz789",
"min_sale_qty": 987.65,
"name": "xyz789",
"new_from_date": "abc123",
"new_to_date": "abc123",
"only_x_left_in_stock": 123.45,
"open_amount_max": 123.45,
"open_amount_min": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": "4",
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"weight": 987.65
}
GiftCardRequisitionListItem
Description
Contains details about gift cards added to a requisition list.
Fields
| Field Name | Description |
|---|---|
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
gift_card_options - GiftCardOptions!
|
An array that defines gift card properties. |
product - ProductInterface!
|
Details about a requisition list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The amount added. |
uid - ID!
|
The unique ID for the requisition list item. |
Example
{
"customizable_options": [SelectedCustomizableOption],
"gift_card_options": GiftCardOptions,
"product": ProductInterface,
"quantity": 123.45,
"uid": "4"
}
GiftCardShipmentItem
Fields
| Field Name | Description |
|---|---|
gift_card - GiftCardItem
|
Selected gift card properties for a shipment item. |
id - ID!
|
The unique ID for a ShipmentItemInterface object. |
order_item - OrderItemInterface
|
The order item associated with the shipment item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product. |
product_sku - String!
|
The SKU of the base product. |
quantity_shipped - Float!
|
The number of shipped items. |
Example
{
"gift_card": GiftCardItem,
"id": "4",
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_shipped": 123.45
}
GiftCardTypeEnum
Description
Specifies the gift card type.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"VIRTUAL"
GiftCardWishlistItem
Description
A single gift card added to a wish list.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
gift_card_options - GiftCardOptions!
|
Details about a gift card. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "abc123",
"gift_card_options": GiftCardOptions,
"id": 4,
"product": ProductInterface,
"quantity": 123.45
}
GiftMessage
Description
Contains the text of a gift message, its sender, and recipient
Example
{
"from": "xyz789",
"message": "abc123",
"to": "xyz789"
}
GiftMessageInput
Description
Defines a gift message.
Example
{
"from": "xyz789",
"message": "abc123",
"to": "xyz789"
}
GiftOptionsPrices
Description
Contains prices for gift wrapping options.
Fields
| Field Name | Description |
|---|---|
gift_wrapping_for_items - Money
|
Price of the gift wrapping for all individual order items. |
gift_wrapping_for_items_incl_tax - Money
|
Price of the gift wrapping for all individual order items including tax. |
gift_wrapping_for_order - Money
|
Price of the gift wrapping for the whole order. |
gift_wrapping_for_order_incl_tax - Money
|
Price of the gift wrapping for the whole order including tax. |
printed_card - Money
|
Price for the printed card. |
printed_card_incl_tax - Money
|
Price for the printed card including tax. |
Example
{
"gift_wrapping_for_items": Money,
"gift_wrapping_for_items_incl_tax": Money,
"gift_wrapping_for_order": Money,
"gift_wrapping_for_order_incl_tax": Money,
"printed_card": Money,
"printed_card_incl_tax": Money
}
GiftRegistry
Description
Contains details about a gift registry.
Fields
| Field Name | Description |
|---|---|
created_at - String!
|
The date on which the gift registry was created. Only the registry owner can access this attribute. |
dynamic_attributes - [GiftRegistryDynamicAttribute]
|
An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. |
event_name - String!
|
The name of the event. |
items - [GiftRegistryItemInterface]
|
An array of products added to the gift registry. |
message - String!
|
The message text the customer entered to describe the event. |
owner_name - String!
|
The customer who created the gift registry. |
privacy_settings - GiftRegistryPrivacySettings!
|
An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. |
registrants - [GiftRegistryRegistrant]
|
Contains details about each registrant for the event. |
shipping_address - CustomerAddress
|
Contains the customer's shipping address. Only the registry owner can access this attribute. |
status - GiftRegistryStatus!
|
An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. |
type - GiftRegistryType
|
The type of gift registry. |
uid - ID!
|
The unique ID assigned to the gift registry. |
Example
{
"created_at": "abc123",
"dynamic_attributes": [GiftRegistryDynamicAttribute],
"event_name": "xyz789",
"items": [GiftRegistryItemInterface],
"message": "abc123",
"owner_name": "abc123",
"privacy_settings": "PRIVATE",
"registrants": [GiftRegistryRegistrant],
"shipping_address": CustomerAddress,
"status": "ACTIVE",
"type": GiftRegistryType,
"uid": "4"
}
GiftRegistryDynamicAttribute
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The internal ID of the dynamic attribute. |
group - GiftRegistryDynamicAttributeGroup!
|
Indicates which group the dynamic attribute is a member of. |
label - String!
|
The display name of the dynamic attribute. |
value - String!
|
A corresponding value for the code. |
Example
{
"code": 4,
"group": "EVENT_INFORMATION",
"label": "abc123",
"value": "abc123"
}
GiftRegistryDynamicAttributeGroup
Description
Defines the group type of a gift registry dynamic attribute.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EVENT_INFORMATION"
GiftRegistryDynamicAttributeInput
GiftRegistryDynamicAttributeInterface
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The internal ID of the dynamic attribute. |
label - String!
|
The display name of the dynamic attribute. |
value - String!
|
A corresponding value for the code. |
Possible Types
| GiftRegistryDynamicAttributeInterface Types |
|---|
Example
{
"code": "4",
"label": "xyz789",
"value": "xyz789"
}
GiftRegistryDynamicAttributeMetadata
Fields
| Field Name | Description |
|---|---|
attribute_group - String!
|
Indicates which group the dynamic attribute a member of. |
code - ID!
|
The internal ID of the dynamic attribute. |
input_type - String!
|
The selected input type for this dynamic attribute. The value can be one of several static or custom types. |
is_required - Boolean!
|
Indicates whether the dynamic attribute is required. |
label - String!
|
The display name of the dynamic attribute. |
sort_order - Int
|
The order in which to display the dynamic attribute. |
Example
{
"attribute_group": "xyz789",
"code": "4",
"input_type": "xyz789",
"is_required": true,
"label": "abc123",
"sort_order": 987
}
GiftRegistryDynamicAttributeMetadataInterface
Fields
| Field Name | Description |
|---|---|
attribute_group - String!
|
Indicates which group the dynamic attribute a member of. |
code - ID!
|
The internal ID of the dynamic attribute. |
input_type - String!
|
The selected input type for this dynamic attribute. The value can be one of several static or custom types. |
is_required - Boolean!
|
Indicates whether the dynamic attribute is required. |
label - String!
|
The display name of the dynamic attribute. |
sort_order - Int
|
The order in which to display the dynamic attribute. |
Possible Types
| GiftRegistryDynamicAttributeMetadataInterface Types |
|---|
Example
{
"attribute_group": "abc123",
"code": "4",
"input_type": "xyz789",
"is_required": false,
"label": "xyz789",
"sort_order": 987
}
GiftRegistryItem
Fields
| Field Name | Description |
|---|---|
created_at - String!
|
The date the product was added to the gift registry. |
note - String
|
A brief message about the gift registry item. |
product - ProductInterface!
|
Details about the gift registry item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The requested quantity of the product. |
quantity_fulfilled - Float!
|
The fulfilled quantity of the product. |
uid - ID!
|
The unique ID of a gift registry item. |
Example
{
"created_at": "xyz789",
"note": "xyz789",
"product": ProductInterface,
"quantity": 123.45,
"quantity_fulfilled": 123.45,
"uid": 4
}
GiftRegistryItemInterface
Fields
| Field Name | Description |
|---|---|
created_at - String!
|
The date the product was added to the gift registry. |
note - String
|
A brief message about the gift registry item. |
product - ProductInterface!
|
Details about the gift registry item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The requested quantity of the product. |
quantity_fulfilled - Float!
|
The fulfilled quantity of the product. |
uid - ID!
|
The unique ID of a gift registry item. |
Possible Types
| GiftRegistryItemInterface Types |
|---|
Example
{
"created_at": "xyz789",
"note": "abc123",
"product": ProductInterface,
"quantity": 123.45,
"quantity_fulfilled": 123.45,
"uid": "4"
}
GiftRegistryItemUserErrorInterface
Description
Contains the status and any errors that encountered with the customer's gift register item.
Fields
| Field Name | Description |
|---|---|
status - Boolean!
|
Indicates whether the attempt to move the cart items to the gift registry was successful. |
user_errors - [GiftRegistryItemsUserError]!
|
An array of errors encountered while moving items from the cart to the gift registry. |
Possible Types
| GiftRegistryItemUserErrorInterface Types |
|---|
Example
{
"status": false,
"user_errors": [GiftRegistryItemsUserError]
}
GiftRegistryItemsUserError
Description
Contains details about an error that occurred when processing a gift registry item.
Fields
| Field Name | Description |
|---|---|
code - GiftRegistryItemsUserErrorType!
|
An error code that describes the error encountered. |
gift_registry_item_uid - ID
|
The unique ID of the gift registry item containing an error. |
gift_registry_uid - ID
|
The unique ID of the GiftRegistry object containing an error. |
message - String!
|
A localized error message. |
product_uid - ID
|
The unique ID of the product containing an error. |
Example
{
"code": "OUT_OF_STOCK",
"gift_registry_item_uid": 4,
"gift_registry_uid": 4,
"message": "abc123",
"product_uid": 4
}
GiftRegistryItemsUserErrorType
Description
Defines the error type.
Values
| Enum Value | Description |
|---|---|
|
|
Used for handling out of stock products. |
|
|
Used for exceptions like EntityNotFound. |
|
|
Used for other exceptions, such as database connection failures. |
Example
"OUT_OF_STOCK"
GiftRegistryOutputInterface
Description
Contains the customer's gift registry.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry. |
Possible Types
| GiftRegistryOutputInterface Types |
|---|
Example
{"gift_registry": GiftRegistry}
GiftRegistryPrivacySettings
Description
Defines the privacy setting of the gift registry.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIVATE"
GiftRegistryRegistrant
Description
Contains details about a registrant.
Fields
| Field Name | Description |
|---|---|
dynamic_attributes - [GiftRegistryRegistrantDynamicAttribute]
|
An array of dynamic attributes assigned to the registrant. |
email - String!
|
The email address of the registrant. Only the registry owner can access this attribute. |
firstname - String!
|
The first name of the registrant. |
lastname - String!
|
The last name of the registrant. |
uid - ID!
|
The unique ID assigned to the registrant. |
Example
{
"dynamic_attributes": [
GiftRegistryRegistrantDynamicAttribute
],
"email": "abc123",
"firstname": "abc123",
"lastname": "abc123",
"uid": "4"
}
GiftRegistryRegistrantDynamicAttribute
GiftRegistrySearchResult
Description
Contains the results of a gift registry search.
Fields
| Field Name | Description |
|---|---|
event_date - String
|
The date of the event. |
event_title - String!
|
The title given to the event. |
gift_registry_uid - ID!
|
The URL key of the gift registry. |
location - String
|
The location of the event. |
name - String!
|
The name of the gift registry owner. |
type - String
|
The type of event being held. |
Example
{
"event_date": "abc123",
"event_title": "xyz789",
"gift_registry_uid": 4,
"location": "abc123",
"name": "abc123",
"type": "xyz789"
}
GiftRegistryShippingAddressInput
Description
Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.
Fields
| Input Field | Description |
|---|---|
address_data - CustomerAddressInput
|
Defines the shipping address for this gift registry. |
address_id - ID
|
The ID assigned to this customer address. |
Example
{
"address_data": CustomerAddressInput,
"address_id": "4"
}
GiftRegistryStatus
Description
Defines the status of the gift registry.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
GiftRegistryType
Description
Contains details about a gift registry type.
Fields
| Field Name | Description |
|---|---|
dynamic_attributes_metadata - [GiftRegistryDynamicAttributeMetadataInterface]
|
An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. |
label - String!
|
The label assigned to the gift registry type on the Admin. |
uid - ID!
|
The unique ID assigned to the gift registry type. |
Example
{
"dynamic_attributes_metadata": [
GiftRegistryDynamicAttributeMetadataInterface
],
"label": "abc123",
"uid": "4"
}
GiftWrapping
Description
Contains details about the selected or available gift wrapping options.
Fields
| Field Name | Description |
|---|---|
design - String!
|
The name of the gift wrapping design. |
image - GiftWrappingImage
|
The preview image for a gift wrapping option. |
price - Money!
|
The gift wrapping price. |
uid - ID!
|
The unique ID for a GiftWrapping object. |
Example
{
"design": "xyz789",
"image": GiftWrappingImage,
"price": Money,
"uid": "4"
}
GiftWrappingImage
Description
Points to an image associated with a gift wrapping option.
Example
{
"label": "abc123",
"url": "abc123"
}
GooglePayButtonStyles
GooglePayConfig
Fields
| Field Name | Description |
|---|---|
button_styles - GooglePayButtonStyles
|
The styles for the GooglePay Button configuration |
code - String
|
The payment method code as defined in the payment gateway |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
payment_source - String
|
The payment source for the payment method |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
three_ds_mode - ThreeDSMode
|
3DS mode |
title - String
|
The name displayed for the payment method |
Example
{
"button_styles": GooglePayButtonStyles,
"code": "abc123",
"is_visible": false,
"payment_intent": "abc123",
"payment_source": "abc123",
"sdk_params": [SDKParams],
"sort_order": "xyz789",
"three_ds_mode": "OFF",
"title": "abc123"
}
GooglePayMethodInput
Description
Google Pay inputs
Example
{
"payment_source": "xyz789",
"payments_order_id": "abc123",
"paypal_order_id": "abc123"
}
GroupedProduct
Description
Defines a grouped product, which consists of simple standalone products that are presented as a group.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
items - [GroupedProductItem]
|
An array containing grouped product items. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
weight - Float
|
The weight of the item, in units defined by the store. |
Example
{
"canonical_url": "xyz789",
"categories": [CategoryInterface],
"country_of_manufacture": "xyz789",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_message_available": false,
"gift_wrapping_available": true,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"items": [GroupedProductItem],
"manufacturer": 987,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "abc123",
"meta_keyword": "abc123",
"meta_title": "abc123",
"min_sale_qty": 123.45,
"name": "abc123",
"new_from_date": "abc123",
"new_to_date": "xyz789",
"only_x_left_in_stock": 123.45,
"options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 123.45,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 123.45,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "abc123",
"weight": 987.65
}
GroupedProductItem
Description
Contains information about an individual grouped product item.
Fields
| Field Name | Description |
|---|---|
position - Int
|
The relative position of this item compared to the other group items. |
product - ProductInterface!
|
Details about this product option. Product information is part of a composable Catalog Service. |
qty - Float
|
The quantity of this grouped product item. |
Example
{
"position": 987,
"product": ProductInterface,
"qty": 123.45
}
GroupedProductWishlistItem
Description
A grouped product wish list item.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
"product": ProductInterface,
"quantity": 123.45
}
GuestOrderCancelInput
Description
Input to retrieve a guest order based on token.
Example
{
"reason": "abc123",
"token": "xyz789"
}
GuestOrderInformationInput
Description
Input to retrieve an order based on details.
Example
{
"email": "abc123",
"lastname": "xyz789",
"number": "abc123"
}
Highlight
Description
An object that provides highlighted text for matched words
Example
{
"attribute": "abc123",
"matched_words": ["xyz789"],
"value": "abc123"
}
HostedFieldsConfig
Fields
| Field Name | Description |
|---|---|
cc_vault_code - String
|
Vault payment method code |
code - String
|
The payment method code as defined in the payment gateway |
is_vault_enabled - Boolean
|
Card vault enabled |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
payment_source - String
|
The payment source for the payment method |
requires_card_details - Boolean
|
Card and bin details required |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
three_ds_mode - ThreeDSMode
|
3DS mode |
title - String
|
The name displayed for the payment method |
Example
{
"cc_vault_code": "xyz789",
"code": "xyz789",
"is_vault_enabled": true,
"is_visible": true,
"payment_intent": "abc123",
"payment_source": "xyz789",
"requires_card_details": false,
"sdk_params": [SDKParams],
"sort_order": "abc123",
"three_ds_mode": "OFF",
"title": "xyz789"
}
HostedFieldsInput
Description
Hosted Fields payment inputs
Fields
| Input Field | Description |
|---|---|
cardBin - String
|
Card bin number |
cardExpiryMonth - String
|
Expiration month of the card |
cardExpiryYear - String
|
Expiration year of the card |
cardLast4 - String
|
Last four digits of the card |
holderName - String
|
Name on the card |
is_active_payment_token_enabler - Boolean
|
Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the Payment Services payment integration. |
payment_source - String
|
The payment source for the payment method |
payments_order_id - String
|
The payment services order ID |
paypal_order_id - String
|
PayPal order ID |
Example
{
"cardBin": "xyz789",
"cardExpiryMonth": "xyz789",
"cardExpiryYear": "abc123",
"cardLast4": "abc123",
"holderName": "xyz789",
"is_active_payment_token_enabler": false,
"payment_source": "abc123",
"payments_order_id": "xyz789",
"paypal_order_id": "abc123"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ImageSwatchData
InputFilterEnum
Description
List of templates/filters applied to customer attribute input.
Values
| Enum Value | Description |
|---|---|
|
|
There are no templates or filters to be applied. |
|
|
Forces attribute input to follow the date format. |
|
|
Strip whitespace (or other characters) from the beginning and end of the input. |
|
|
Strip HTML Tags. |
|
|
Escape HTML Entities. |
Example
"NONE"
InsufficientStockError
Fields
| Field Name | Description |
|---|---|
code - CartUserInputErrorType!
|
A cart-specific error code. |
message - String!
|
A localized error message. |
quantity - Float
|
Amount of available stock |
Example
{
"code": "PRODUCT_NOT_FOUND",
"message": "abc123",
"quantity": 123.45
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InternalError
Description
Contains an error message when an internal error occurred.
Fields
| Field Name | Description |
|---|---|
message - String!
|
The returned error message. |
Example
{"message": "abc123"}
Invoice
Description
Contains invoice details.
Fields
| Field Name | Description |
|---|---|
comments - [SalesCommentItem]
|
Comments on the invoice. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice |
id - ID!
|
The unique ID for a Invoice object. |
items - [InvoiceItemInterface]
|
Invoiced product details. |
number - String!
|
Sequential invoice number. |
total - InvoiceTotal
|
Invoice total amount details. |
Example
{
"comments": [SalesCommentItem],
"custom_attributes": [CustomAttribute],
"id": 4,
"items": [InvoiceItemInterface],
"number": "abc123",
"total": InvoiceTotal
}
InvoiceCustomAttributesInput
Description
Defines an invoice custom attributes.
Fields
| Input Field | Description |
|---|---|
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for invoice. |
invoice_id - String!
|
The invoice ID. |
Example
{
"custom_attributes": [CustomAttributeInput],
"invoice_id": "abc123"
}
InvoiceItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice item |
discounts - [Discount]
|
Information about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for an InvoiceItemInterface object. |
order_item - OrderItemInterface
|
Details about an individual order item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_invoiced - Float
|
The number of invoiced items. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": "4",
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "xyz789",
"quantity_invoiced": 123.45
}
InvoiceItemCustomAttributesInput
Description
Defines an invoice item custom attributes.
Fields
| Input Field | Description |
|---|---|
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for invoice item. |
invoice_id - String!
|
The invoice ID. |
invoice_item_id - String!
|
The invoice item ID. |
Example
{
"custom_attributes": [CustomAttributeInput],
"invoice_id": "abc123",
"invoice_item_id": "abc123"
}
InvoiceItemInterface
Description
Contains detailes about invoiced items.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the invoice item |
discounts - [Discount]
|
Information about the final discount amount for the base product, including discounts on options. |
id - ID!
|
The unique ID for an InvoiceItemInterface object. |
order_item - OrderItemInterface
|
Details about an individual order item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product including selected options. |
product_sku - String!
|
The SKU of the base product. |
quantity_invoiced - Float
|
The number of invoiced items. |
Possible Types
| InvoiceItemInterface Types |
|---|
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_invoiced": 987.65
}
InvoiceOutput
Description
Contains details about the invoice after adding custom attributes to it.
Fields
| Field Name | Description |
|---|---|
invoice - Invoice!
|
The custom attributes to invoice have been added. |
Example
{"invoice": Invoice}
InvoiceTotal
Description
Contains price details from an invoice.
Fields
| Field Name | Description |
|---|---|
base_grand_total - Money!
|
The final base grand total amount in the base currency. |
discounts - [Discount]
|
The applied discounts to the invoice. |
grand_total - Money!
|
The final total amount, including shipping, discounts, and taxes. |
shipping_handling - ShippingHandling
|
Details about the shipping and handling costs for the invoice. |
subtotal - Money!
|
The subtotal of the invoice, excluding shipping, discounts, and taxes. |
taxes - [TaxItem]
|
The invoice tax details. |
total_shipping - Money!
|
The shipping amount for the invoice. |
total_tax - Money!
|
The amount of tax applied to the invoice. |
Example
{
"base_grand_total": Money,
"discounts": [Discount],
"grand_total": Money,
"shipping_handling": ShippingHandling,
"subtotal": Money,
"taxes": [TaxItem],
"total_shipping": Money,
"total_tax": Money
}
IsCompanyAdminEmailAvailableOutput
Description
Contains the response of a company admin email validation query.
Fields
| Field Name | Description |
|---|---|
is_email_available - Boolean!
|
Indicates whether the specified email address can be used to create a company administrator. |
Example
{"is_email_available": false}
IsCompanyEmailAvailableOutput
Description
Contains the response of a company email validation query.
Fields
| Field Name | Description |
|---|---|
is_email_available - Boolean!
|
Indicates whether the specified email address can be used to create a company. |
Example
{"is_email_available": false}
IsCompanyRoleNameAvailableOutput
Description
Contains the response of a role name validation query.
Fields
| Field Name | Description |
|---|---|
is_role_name_available - Boolean!
|
Indicates whether the specified company role name is available. |
Example
{"is_role_name_available": false}
IsCompanyUserEmailAvailableOutput
Description
Contains the response of a company user email validation query.
Fields
| Field Name | Description |
|---|---|
is_email_available - Boolean!
|
Indicates whether the specified email address can be used to create a company user. |
Example
{"is_email_available": true}
IsEmailAvailableOutput
Description
Contains the result of the isEmailAvailable query.
Fields
| Field Name | Description |
|---|---|
is_email_available - Boolean
|
Indicates whether the specified email address can be used to create a customer. |
Example
{"is_email_available": true}
ItemNote
Description
The note object for quote line item.
Fields
| Field Name | Description |
|---|---|
created_at - String
|
Timestamp that reflects note creation date. |
creator_id - Int
|
ID of the user who submitted a note. |
creator_type - Int
|
Type of teh user who submitted a note. |
negotiable_quote_item_uid - ID
|
The unique ID of a CartItemInterface object. |
note - String
|
Note text. |
note_uid - ID
|
The unique ID of a ItemNote object. |
Example
{
"created_at": "abc123",
"creator_id": 123,
"creator_type": 987,
"negotiable_quote_item_uid": 4,
"note": "xyz789",
"note_uid": 4
}
ItemSelectedBundleOption
Description
A list of options of the selected bundle product.
Fields
| Field Name | Description |
|---|---|
label - String!
|
The label of the option. |
uid - ID!
|
The unique ID for a ItemSelectedBundleOption object. |
values - [ItemSelectedBundleOptionValue]
|
A list of products that represent the values of the parent option. |
Example
{
"label": "abc123",
"uid": 4,
"values": [ItemSelectedBundleOptionValue]
}
ItemSelectedBundleOptionValue
Description
A list of values for the selected bundle product.
Fields
| Field Name | Description |
|---|---|
price - Money!
|
The price of the child bundle product. |
product_name - String!
|
The name of the child bundle product. |
product_sku - String!
|
The SKU of the child bundle product. |
quantity - Float!
|
The number of this bundle product that were ordered. |
uid - ID!
|
The unique ID for a ItemSelectedBundleOptionValue object. |
Example
{
"price": Money,
"product_name": "abc123",
"product_sku": "xyz789",
"quantity": 123.45,
"uid": 4
}
JSON
KeyValue
LineItemNoteInput
Description
Sets quote item note.
Example
{
"note": "xyz789",
"quote_item_uid": 4,
"quote_uid": "4"
}
MediaGalleryInterface
Description
Contains basic information about a product image or video.
Fields
| Field Name | Description |
|---|---|
disabled - Boolean
|
Indicates whether the image is hidden from view. |
label - String
|
The label of the product image or video. |
position - Int
|
The media item's position after it has been sorted. |
url - String
|
The URL of the product image or video. |
Possible Types
| MediaGalleryInterface Types |
|---|
Example
{
"disabled": false,
"label": "abc123",
"position": 123,
"url": "abc123"
}
MediaResourceType
Description
Enumeration of media resource types
Values
| Enum Value | Description |
|---|---|
|
|
Customer file resource type |
Example
"CUSTOMER_ATTRIBUTE_FILE"
MessageStyleLogo
Fields
| Field Name | Description |
|---|---|
type - String
|
The type of logo for the PayPal Pay Later messaging |
Example
{"type": "abc123"}
MessageStyles
Fields
| Field Name | Description |
|---|---|
layout - String
|
The message layout |
logo - MessageStyleLogo
|
The message logo |
Example
{
"layout": "abc123",
"logo": MessageStyleLogo
}
Money
Description
Defines a monetary value, including a numeric value and a currency code.
Fields
| Field Name | Description |
|---|---|
currency - CurrencyEnum
|
A three-letter currency code, such as USD or EUR. |
value - Float
|
A number expressing a monetary value. |
Example
{"currency": "AFN", "value": 123.45}
MoveCartItemsToGiftRegistryOutput
Description
Contains the customer's gift registry and any errors encountered.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry. |
status - Boolean!
|
Indicates whether the attempt to move the cart items to the gift registry was successful. |
user_errors - [GiftRegistryItemsUserError]!
|
An array of errors encountered while moving items from the cart to the gift registry. |
Example
{
"gift_registry": GiftRegistry,
"status": true,
"user_errors": [GiftRegistryItemsUserError]
}
MoveItemsBetweenRequisitionListsInput
Description
An input object that defines the items in a requisition list to be moved.
Fields
| Input Field | Description |
|---|---|
requisitionListItemUids - [ID]!
|
An array of IDs representing products moved from one requisition list to another. |
Example
{"requisitionListItemUids": [4]}
MoveItemsBetweenRequisitionListsOutput
Description
Output of the request to move items to another requisition list.
Fields
| Field Name | Description |
|---|---|
destination_requisition_list - RequisitionList
|
The destination requisition list after moving items. |
source_requisition_list - RequisitionList
|
The source requisition list after moving items. |
Example
{
"destination_requisition_list": RequisitionList,
"source_requisition_list": RequisitionList
}
MoveLineItemToRequisitionListInput
Description
Move Line Item to Requisition List.
Example
{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
MoveLineItemToRequisitionListOutput
Description
Contains the updated negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after moving item to requisition list. |
Example
{"quote": NegotiableQuote}
MoveProductsBetweenWishlistsOutput
Description
Contains the source and target wish lists after moving products.
Fields
| Field Name | Description |
|---|---|
destination_wishlist - Wishlist!
|
The destination wish list after receiving products moved from the source wish list. |
source_wishlist - Wishlist!
|
The source wish list after moving products from it. |
user_errors - [WishListUserInputError]!
|
An array of errors encountered while moving products to a wish list. |
Example
{
"destination_wishlist": Wishlist,
"source_wishlist": Wishlist,
"user_errors": [WishListUserInputError]
}
NegotiableQuote
Description
Contains details about a negotiable quote.
Fields
| Field Name | Description |
|---|---|
available_payment_methods - [AvailablePaymentMethod]
|
An array of payment methods that can be applied to the negotiable quote. |
billing_address - NegotiableQuoteBillingAddress
|
The billing address applied to the negotiable quote. |
buyer - NegotiableQuoteUser!
|
The first and last name of the buyer. |
comments - [NegotiableQuoteComment]
|
A list of comments made by the buyer and seller. |
created_at - String
|
Timestamp indicating when the negotiable quote was created. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the negotiable quote |
email - String
|
The email address of the company user. |
history - [NegotiableQuoteHistoryEntry]
|
A list of status and price changes for the negotiable quote. |
is_virtual - Boolean!
|
Indicates whether the negotiable quote contains only virtual products. |
items - [CartItemInterface]
|
The list of items in the negotiable quote. |
name - String!
|
The title assigned to the negotiable quote. |
prices - CartPrices
|
A set of subtotals and totals applied to the negotiable quote. |
selected_payment_method - SelectedPaymentMethod
|
The payment method that was applied to the negotiable quote. |
shipping_addresses - [NegotiableQuoteShippingAddress]!
|
A list of shipping addresses applied to the negotiable quote. |
status - NegotiableQuoteStatus!
|
The status of the negotiable quote. |
total_quantity - Float!
|
The total number of items in the negotiable quote. |
uid - ID!
|
The unique ID of a NegotiableQuote object. |
updated_at - String
|
Timestamp indicating when the negotiable quote was updated. |
Example
{
"available_payment_methods": [AvailablePaymentMethod],
"billing_address": NegotiableQuoteBillingAddress,
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"created_at": "xyz789",
"custom_attributes": [CustomAttribute],
"email": "abc123",
"history": [NegotiableQuoteHistoryEntry],
"is_virtual": false,
"items": [CartItemInterface],
"name": "xyz789",
"prices": CartPrices,
"selected_payment_method": SelectedPaymentMethod,
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "SUBMITTED",
"total_quantity": 123.45,
"uid": 4,
"updated_at": "xyz789"
}
NegotiableQuoteAddressCountry
Description
Defines the company's country.
Example
{
"code": "abc123",
"label": "abc123"
}
NegotiableQuoteAddressInput
Description
Defines the billing or shipping address to be applied to the cart.
Fields
| Input Field | Description |
|---|---|
city - String!
|
The city specified for the billing or shipping address. |
company - String
|
The company name. |
country_code - String!
|
The country code and label for the billing or shipping address. |
custom_attributes - [AttributeValueInput]
|
The custom attribute values of the billing or shipping negotiable quote address. |
fax - String
|
The fax number of the customer. |
firstname - String!
|
The first name of the company user. |
lastname - String!
|
The last name of the company user. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The ZIP or postal code of the billing or shipping address. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - String
|
A string that defines the state or province of the billing or shipping address. |
region_id - Int
|
An integer that defines the state or province of the billing or shipping address. |
save_in_address_book - Boolean
|
Determines whether to save the address in the customer's address book. The default value is true. |
street - [String]!
|
An array containing the street for the billing or shipping address. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number for the billing or shipping address. |
vat_id - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"city": "xyz789",
"company": "xyz789",
"country_code": "xyz789",
"custom_attributes": [AttributeValueInput],
"fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
"middlename": "xyz789",
"postcode": "xyz789",
"prefix": "xyz789",
"region": "xyz789",
"region_id": 123,
"save_in_address_book": true,
"street": ["xyz789"],
"suffix": "abc123",
"telephone": "abc123",
"vat_id": "abc123"
}
NegotiableQuoteAddressInterface
Fields
| Field Name | Description |
|---|---|
city - String!
|
The company's city or town. |
company - String
|
The company name associated with the shipping/billing address. |
country - NegotiableQuoteAddressCountry!
|
The company's country. |
custom_attributes - [AttributeValueInterface]
|
The custom attribute values of the billing or shipping negotiable quote address. |
fax - String
|
The fax number of the customer. |
firstname - String!
|
The first name of the company user. |
lastname - String!
|
The last name of the company user. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The company's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - NegotiableQuoteAddressRegion
|
An object containing the region name, region code, and region ID. |
street - [String]!
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The customer's telephone number. |
uid - ID!
|
The unique identifier of the address. |
vat_id - String
|
The customer's Tax/VAT number (for corporate customers). |
Possible Types
| NegotiableQuoteAddressInterface Types |
|---|
Example
{
"city": "abc123",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "abc123",
"firstname": "xyz789",
"lastname": "xyz789",
"middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
"region": NegotiableQuoteAddressRegion,
"street": ["xyz789"],
"suffix": "xyz789",
"telephone": "abc123",
"uid": 4,
"vat_id": "abc123"
}
NegotiableQuoteAddressRegion
Description
Defines the company's state or province.
Example
{
"code": "xyz789",
"label": "abc123",
"region_id": 987
}
NegotiableQuoteBillingAddress
Fields
| Field Name | Description |
|---|---|
city - String!
|
The company's city or town. |
company - String
|
The company name associated with the shipping/billing address. |
country - NegotiableQuoteAddressCountry!
|
The company's country. |
custom_attributes - [AttributeValueInterface]
|
The custom attribute values of the billing or shipping negotiable quote address. |
fax - String
|
The fax number of the customer. |
firstname - String!
|
The first name of the company user. |
lastname - String!
|
The last name of the company user. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The company's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - NegotiableQuoteAddressRegion
|
An object containing the region name, region code, and region ID. |
street - [String]!
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The customer's telephone number. |
uid - ID!
|
The unique identifier of the address. |
vat_id - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"city": "abc123",
"company": "abc123",
"country": NegotiableQuoteAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "abc123",
"firstname": "abc123",
"lastname": "xyz789",
"middlename": "xyz789",
"postcode": "xyz789",
"prefix": "abc123",
"region": NegotiableQuoteAddressRegion,
"street": ["abc123"],
"suffix": "xyz789",
"telephone": "xyz789",
"uid": "4",
"vat_id": "xyz789"
}
NegotiableQuoteBillingAddressInput
Description
Defines the billing address.
Fields
| Input Field | Description |
|---|---|
address - NegotiableQuoteAddressInput
|
Defines a billing address. |
customer_address_uid - ID
|
The unique ID of a CustomerAddress object. |
same_as_shipping - Boolean
|
Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote. |
use_for_shipping - Boolean
|
Indicates whether to set the shipping address to be the same as this billing address. |
Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"same_as_shipping": false,
"use_for_shipping": false
}
NegotiableQuoteComment
Description
Contains a single plain text comment from either the buyer or seller.
Fields
| Field Name | Description |
|---|---|
author - NegotiableQuoteUser!
|
The first and last name of the commenter. |
created_at - String!
|
Timestamp indicating when the comment was created. |
creator_type - NegotiableQuoteCommentCreatorType!
|
Indicates whether a buyer or seller commented. |
text - String!
|
The plain text comment. |
uid - ID!
|
The unique ID of a NegotiableQuoteComment object. |
Example
{
"author": NegotiableQuoteUser,
"created_at": "abc123",
"creator_type": "BUYER",
"text": "xyz789",
"uid": "4"
}
NegotiableQuoteCommentCreatorType
NegotiableQuoteCommentInput
Description
Contains the commend provided by the buyer.
Fields
| Input Field | Description |
|---|---|
comment - String!
|
The comment provided by the buyer. |
Example
{"comment": "abc123"}
NegotiableQuoteCustomLogChange
Description
Contains custom log entries added by third-party extensions.
Example
{
"new_value": "abc123",
"old_value": "xyz789",
"title": "xyz789"
}
NegotiableQuoteFilterInput
Description
Defines a filter to limit the negotiable quotes to return.
Fields
| Input Field | Description |
|---|---|
ids - FilterEqualTypeInput
|
Filter by the ID of one or more negotiable quotes. |
name - FilterMatchTypeInput
|
Filter by the negotiable quote name. |
Example
{
"ids": FilterEqualTypeInput,
"name": FilterMatchTypeInput
}
NegotiableQuoteHistoryChanges
Description
Contains a list of changes to a negotiable quote.
Fields
| Field Name | Description |
|---|---|
comment_added - NegotiableQuoteHistoryCommentChange
|
The comment provided with a change in the negotiable quote history. |
custom_changes - NegotiableQuoteCustomLogChange
|
Lists log entries added by third-party extensions. |
expiration - NegotiableQuoteHistoryExpirationChange
|
The expiration date of the negotiable quote before and after a change in the quote history. |
products_removed - NegotiableQuoteHistoryProductsRemovedChange
|
Lists products that were removed as a result of a change in the quote history. |
statuses - NegotiableQuoteHistoryStatusesChange
|
The status before and after a change in the negotiable quote history. |
total - NegotiableQuoteHistoryTotalChange
|
The total amount of the negotiable quote before and after a change in the quote history. |
Example
{
"comment_added": NegotiableQuoteHistoryCommentChange,
"custom_changes": NegotiableQuoteCustomLogChange,
"expiration": NegotiableQuoteHistoryExpirationChange,
"products_removed": NegotiableQuoteHistoryProductsRemovedChange,
"statuses": NegotiableQuoteHistoryStatusesChange,
"total": NegotiableQuoteHistoryTotalChange
}
NegotiableQuoteHistoryCommentChange
Description
Contains a comment submitted by a seller or buyer.
Fields
| Field Name | Description |
|---|---|
comment - String!
|
A plain text comment submitted by a seller or buyer. |
Example
{"comment": "xyz789"}
NegotiableQuoteHistoryEntry
Description
Contains details about a change for a negotiable quote.
Fields
| Field Name | Description |
|---|---|
author - NegotiableQuoteUser!
|
The person who made a change in the status of the negotiable quote. |
change_type - NegotiableQuoteHistoryEntryChangeType!
|
An enum that describes the why the entry in the negotiable quote history changed status. |
changes - NegotiableQuoteHistoryChanges
|
The set of changes in the negotiable quote. |
created_at - String
|
Timestamp indicating when the negotiable quote entry was created. |
uid - ID!
|
The unique ID of a NegotiableQuoteHistoryEntry object. |
Example
{
"author": NegotiableQuoteUser,
"change_type": "CREATED",
"changes": NegotiableQuoteHistoryChanges,
"created_at": "abc123",
"uid": "4"
}
NegotiableQuoteHistoryEntryChangeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
NegotiableQuoteHistoryExpirationChange
Description
Contains a new expiration date and the previous date.
Example
{
"new_expiration": "xyz789",
"old_expiration": "abc123"
}
NegotiableQuoteHistoryProductsRemovedChange
Description
Contains lists of products that have been removed from the catalog and negotiable quote.
Fields
| Field Name | Description |
|---|---|
products_removed_from_catalog - [ID]
|
A list of product IDs the seller removed from the catalog. |
products_removed_from_quote - [ProductInterface]
|
A list of products removed from the negotiable quote by either the buyer or the seller. Product information is part of a composable Catalog Service. |
Example
{
"products_removed_from_catalog": ["4"],
"products_removed_from_quote": [ProductInterface]
}
NegotiableQuoteHistoryStatusChange
Description
Lists a new status change applied to a negotiable quote and the previous status.
Fields
| Field Name | Description |
|---|---|
new_status - NegotiableQuoteStatus!
|
The updated status. |
old_status - NegotiableQuoteStatus
|
The previous status. The value will be null for the first history entry in a negotiable quote. |
Example
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
NegotiableQuoteHistoryStatusesChange
Description
Contains a list of status changes that occurred for the negotiable quote.
Fields
| Field Name | Description |
|---|---|
changes - [NegotiableQuoteHistoryStatusChange]!
|
A list of status changes. |
Example
{"changes": [NegotiableQuoteHistoryStatusChange]}
NegotiableQuoteHistoryTotalChange
Description
Contains a new price and the previous price.
Example
{
"new_price": Money,
"old_price": Money
}
NegotiableQuoteInvalidStateError
Description
An error indicating that an operation was attempted on a negotiable quote in an invalid state.
Fields
| Field Name | Description |
|---|---|
message - String!
|
The returned error message. |
Example
{"message": "abc123"}
NegotiableQuoteItemQuantityInput
Description
Specifies the updated quantity of an item.
Example
{"quantity": 123.45, "quote_item_uid": 4}
NegotiableQuotePaymentMethodInput
Description
Defines the payment method to be applied to the negotiable quote.
Example
{
"code": "xyz789",
"purchase_order_number": "abc123"
}
NegotiableQuoteReferenceDocumentLink
Description
Contains a reference document link for a negotiable quote template.
Example
{
"document_identifier": "abc123",
"document_name": "abc123",
"link_id": "4",
"reference_document_url": "abc123"
}
NegotiableQuoteShippingAddress
Fields
| Field Name | Description |
|---|---|
available_shipping_methods - [AvailableShippingMethod]
|
An array of shipping methods available to the buyer. |
city - String!
|
The company's city or town. |
company - String
|
The company name associated with the shipping/billing address. |
country - NegotiableQuoteAddressCountry!
|
The company's country. |
custom_attributes - [AttributeValueInterface]
|
The custom attribute values of the billing or shipping negotiable quote address. |
fax - String
|
The fax number of the customer. |
firstname - String!
|
The first name of the company user. |
lastname - String!
|
The last name of the company user. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
postcode - String
|
The company's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - NegotiableQuoteAddressRegion
|
An object containing the region name, region code, and region ID. |
selected_shipping_method - SelectedShippingMethod
|
The selected shipping method. |
street - [String]!
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The customer's telephone number. |
uid - ID!
|
The unique identifier of the address. |
vat_id - String
|
The customer's Tax/VAT number (for corporate customers). |
Example
{
"available_shipping_methods": [AvailableShippingMethod],
"city": "abc123",
"company": "xyz789",
"country": NegotiableQuoteAddressCountry,
"custom_attributes": [AttributeValueInterface],
"fax": "abc123",
"firstname": "abc123",
"lastname": "xyz789",
"middlename": "xyz789",
"postcode": "abc123",
"prefix": "xyz789",
"region": NegotiableQuoteAddressRegion,
"selected_shipping_method": SelectedShippingMethod,
"street": ["xyz789"],
"suffix": "xyz789",
"telephone": "abc123",
"uid": 4,
"vat_id": "abc123"
}
NegotiableQuoteShippingAddressInput
Description
Defines shipping addresses for the negotiable quote.
Fields
| Input Field | Description |
|---|---|
address - NegotiableQuoteAddressInput
|
A shipping address. |
customer_address_uid - ID
|
An ID from the company user's address book that uniquely identifies the address to be used for shipping. |
customer_notes - String
|
Text provided by the company user. |
Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"customer_notes": "xyz789"
}
NegotiableQuoteSortInput
Description
Defines the field to use to sort a list of negotiable quotes.
Fields
| Input Field | Description |
|---|---|
sort_direction - SortEnum!
|
Whether to return results in ascending or descending order. |
sort_field - NegotiableQuoteSortableField!
|
The specified sort field. |
Example
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
NegotiableQuoteSortableField
Values
| Enum Value | Description |
|---|---|
|
|
Sorts negotiable quotes by name. |
|
|
Sorts negotiable quotes by the dates they were created. |
|
|
Sorts negotiable quotes by the dates they were last modified. |
Example
"QUOTE_NAME"
NegotiableQuoteStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUBMITTED"
NegotiableQuoteTemplate
Description
Contains details about a negotiable quote template.
Fields
| Field Name | Description |
|---|---|
buyer - NegotiableQuoteUser!
|
The first and last name of the buyer. |
comments - [NegotiableQuoteComment]
|
A list of comments made by the buyer and seller. |
expiration_date - String!
|
The expiration period of the negotiable quote template. |
history - [NegotiableQuoteHistoryEntry]
|
A list of status and price changes for the negotiable quote template. |
is_min_max_qty_used - Boolean!
|
Indicates whether the minimum and maximum quantity settings are used. |
is_virtual - Boolean!
|
Indicates whether the negotiable quote template contains only virtual products. |
items - [CartItemInterface]
|
The list of items in the negotiable quote template. |
max_order_commitment - Int!
|
Commitment for maximum orders |
min_order_commitment - Int!
|
Commitment for minimum orders |
name - String!
|
The title assigned to the negotiable quote template. |
notifications - [QuoteTemplateNotificationMessage]
|
A list of notifications for the negotiable quote template. |
prices - CartPrices
|
A set of subtotals and totals applied to the negotiable quote template. |
reference_document_links - [NegotiableQuoteReferenceDocumentLink]
|
A list of reference document links for the negotiable quote template. |
shipping_addresses - [NegotiableQuoteShippingAddress]!
|
A list of shipping addresses applied to the negotiable quote template. |
status - String!
|
The status of the negotiable quote template. |
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
total_quantity - Float!
|
The total number of items in the negotiable quote template. |
Example
{
"buyer": NegotiableQuoteUser,
"comments": [NegotiableQuoteComment],
"expiration_date": "xyz789",
"history": [NegotiableQuoteHistoryEntry],
"is_min_max_qty_used": true,
"is_virtual": true,
"items": [CartItemInterface],
"max_order_commitment": 123,
"min_order_commitment": 987,
"name": "xyz789",
"notifications": [QuoteTemplateNotificationMessage],
"prices": CartPrices,
"reference_document_links": [
NegotiableQuoteReferenceDocumentLink
],
"shipping_addresses": [NegotiableQuoteShippingAddress],
"status": "xyz789",
"template_id": 4,
"total_quantity": 123.45
}
NegotiableQuoteTemplateFilterInput
Description
Defines a filter to limit the negotiable quotes to return.
Fields
| Input Field | Description |
|---|---|
state - FilterEqualTypeInput
|
Filter by state of one or more negotiable quote templates. |
status - FilterEqualTypeInput
|
Filter by status of one or more negotiable quote templates. |
Example
{
"state": FilterEqualTypeInput,
"status": FilterEqualTypeInput
}
NegotiableQuoteTemplateGridItem
Description
Contains data for a negotiable quote template in a grid.
Fields
| Field Name | Description |
|---|---|
activated_at - String!
|
The date and time the negotiable quote template was activated. |
company_name - String!
|
Company name the quote template is assigned to |
expiration_date - String!
|
The expiration period of the negotiable quote template. |
is_min_max_qty_used - Boolean!
|
Indicates whether the minimum and maximum quantity settings are used. |
last_shared_at - String!
|
The date and time the negotiable quote template was last shared. |
max_order_commitment - Int!
|
Commitment for maximum orders |
min_negotiated_grand_total - Float!
|
The minimum negotiated grand total of the negotiable quote template. |
min_order_commitment - Int!
|
Commitment for minimum orders |
name - String!
|
The title assigned to the negotiable quote template. |
orders_placed - Int!
|
The number of orders placed for the negotiable quote template. |
sales_rep_name - String!
|
The first and last name of the sales representative. |
state - String!
|
State of the negotiable quote template. |
status - String!
|
The status of the negotiable quote template. |
submitted_by - String!
|
The first and last name of the buyer. |
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{
"activated_at": "xyz789",
"company_name": "abc123",
"expiration_date": "xyz789",
"is_min_max_qty_used": false,
"last_shared_at": "abc123",
"max_order_commitment": 123,
"min_negotiated_grand_total": 987.65,
"min_order_commitment": 987,
"name": "xyz789",
"orders_placed": 987,
"sales_rep_name": "xyz789",
"state": "xyz789",
"status": "abc123",
"submitted_by": "xyz789",
"template_id": 4
}
NegotiableQuoteTemplateItemQuantityInput
Description
Specifies the updated quantity of an item.
Fields
| Input Field | Description |
|---|---|
item_id - ID!
|
The unique ID of a CartItemInterface object. |
max_qty - Float
|
The new max quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template. |
min_qty - Float
|
The new min quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template. |
quantity - Float!
|
The new quantity of the negotiable quote item. |
Example
{
"item_id": "4",
"max_qty": 987.65,
"min_qty": 123.45,
"quantity": 123.45
}
NegotiableQuoteTemplateReferenceDocumentLinkInput
Description
Defines the reference document link to add to a negotiable quote template.
Fields
| Input Field | Description |
|---|---|
document_identifier - String
|
The identifier of the reference document. |
document_name - String!
|
The title of the reference document. |
link_id - ID
|
The unique ID of a NegotiableQuoteReferenceDocumentLink object. |
reference_document_url - String!
|
The URL of the reference document. |
Example
{
"document_identifier": "xyz789",
"document_name": "xyz789",
"link_id": "4",
"reference_document_url": "xyz789"
}
NegotiableQuoteTemplateShippingAddressInput
Description
Defines shipping addresses for the negotiable quote template.
Fields
| Input Field | Description |
|---|---|
address - NegotiableQuoteAddressInput
|
A shipping address. |
customer_address_uid - ID
|
An ID from the company user's address book that uniquely identifies the address to be used for shipping. |
customer_notes - String
|
Text provided by the company user. |
Example
{
"address": NegotiableQuoteAddressInput,
"customer_address_uid": 4,
"customer_notes": "xyz789"
}
NegotiableQuoteTemplateSortInput
Description
Defines the field to use to sort a list of negotiable quotes.
Fields
| Input Field | Description |
|---|---|
sort_direction - SortEnum!
|
Whether to return results in ascending or descending order. |
sort_field - NegotiableQuoteTemplateSortableField!
|
The specified sort field. |
Example
{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
NegotiableQuoteTemplateSortableField
Values
| Enum Value | Description |
|---|---|
|
|
Sorts negotiable quote templates by template id. |
|
|
Sorts negotiable quote templates by the date they were last shared. |
Example
"TEMPLATE_ID"
NegotiableQuoteTemplatesOutput
Description
Contains a list of negotiable templates that match the specified filter.
Fields
| Field Name | Description |
|---|---|
items - [NegotiableQuoteTemplateGridItem]!
|
A list of negotiable quote templates |
page_info - SearchResultPageInfo!
|
Contains pagination metadata |
sort_fields - SortFields
|
Contains the default sort field and all available sort fields. |
total_count - Int!
|
The number of negotiable quote templates returned |
Example
{
"items": [NegotiableQuoteTemplateGridItem],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"total_count": 987
}
NegotiableQuoteUidNonFatalResultInterface
Fields
| Field Name | Description |
|---|---|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Possible Types
| NegotiableQuoteUidNonFatalResultInterface Types |
|---|
Example
{"quote_uid": 4}
NegotiableQuoteUidOperationSuccess
Description
Contains details about a successful operation on a negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{"quote_uid": 4}
NegotiableQuoteUser
Description
A limited view of a Buyer or Seller in the negotiable quote process.
Example
{
"firstname": "abc123",
"lastname": "abc123"
}
NegotiableQuotesOutput
Description
Contains a list of negotiable that match the specified filter.
Fields
| Field Name | Description |
|---|---|
items - [NegotiableQuote]!
|
A list of negotiable quotes |
page_info - SearchResultPageInfo!
|
Contains pagination metadata |
sort_fields - SortFields
|
Contains the default sort field and all available sort fields. |
total_count - Int!
|
The number of negotiable quotes returned |
Example
{
"items": [NegotiableQuote],
"page_info": SearchResultPageInfo,
"sort_fields": SortFields,
"total_count": 123
}
NoSuchEntityUidError
Description
Contains an error message when an invalid UID was specified.
Example
{"message": "xyz789", "uid": 4}
OopePaymentMethodConfig
Fields
| Field Name | Description |
|---|---|
backend_integration_url - String!
|
The backend URL to dispatch requests related to the payment method. |
custom_config - [CustomConfigKeyValue]!
|
Custom config key values. |
Example
{
"backend_integration_url": "xyz789",
"custom_config": [CustomConfigKeyValue]
}
OpenNegotiableQuoteTemplateInput
Description
Specifies the quote template id to open quote template.
Fields
| Input Field | Description |
|---|---|
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{"template_id": 4}
Order
Description
Contains the order ID.
Fields
| Field Name | Description |
|---|---|
order_number - String!
|
The unique ID for an Order object. |
Example
{"order_number": "abc123"}
OrderActionType
Description
The list of available order actions.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REORDER"
OrderAddress
Description
Contains detailed information about an order's billing and shipping addresses.
Fields
| Field Name | Description |
|---|---|
city - String!
|
The city or town. |
company - String
|
The customer's company. |
country_code - CountryCodeEnum
|
The customer's country. |
custom_attributesV2 - [AttributeValueInterface]!
|
Custom attributes assigned to the customer address. |
Arguments
|
|
fax - String
|
The fax number. |
firstname - String!
|
The first name of the person associated with the shipping/billing address. |
lastname - String!
|
The family name of the person associated with the shipping/billing address. |
middlename - String
|
The middle name of the person associated with the shipping/billing address. |
postcode - String
|
The customer's ZIP or postal code. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - String
|
The state or province name. |
region_id - ID
|
The unique ID for a Region object of a pre-defined region. |
street - [String]!
|
An array of strings that define the street number and name. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number. |
vat_id - String
|
The customer's Value-added tax (VAT) number (for corporate customers). |
Example
{
"city": "abc123",
"company": "abc123",
"country_code": "AF",
"custom_attributesV2": [AttributeValueInterface],
"fax": "abc123",
"firstname": "abc123",
"lastname": "abc123",
"middlename": "abc123",
"postcode": "xyz789",
"prefix": "xyz789",
"region": "abc123",
"region_id": 4,
"street": ["xyz789"],
"suffix": "abc123",
"telephone": "abc123",
"vat_id": "xyz789"
}
OrderCustomerInfo
Example
{
"firstname": "xyz789",
"lastname": "xyz789",
"middlename": "abc123",
"prefix": "xyz789",
"suffix": "abc123"
}
OrderItem
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"eligible_for_return": false,
"entered_options": [OrderItemOption],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"id": "4",
"prices": OrderItemPrices,
"product": ProductInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"product_type": "abc123",
"product_url_key": "abc123",
"quantity_canceled": 123.45,
"quantity_invoiced": 123.45,
"quantity_ordered": 987.65,
"quantity_refunded": 123.45,
"quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 987.65,
"selected_options": [OrderItemOption],
"status": "abc123"
}
OrderItemInterface
Description
Order item details.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the order item |
discounts - [Discount]
|
The final discount information for the product. |
eligible_for_return - Boolean
|
Indicates whether the order item is eligible to be in a return request. |
entered_options - [OrderItemOption]
|
The entered option for the base product, such as a logo or image. |
gift_message - GiftMessage
|
The selected gift message for the order item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the order item. |
id - ID!
|
The unique ID for an OrderItemInterface object. |
prices - OrderItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface
|
The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price of the base product, including selected options. |
product_sku - String!
|
The SKU of the base product. |
product_type - String
|
The type of product, such as simple, configurable, etc. |
product_url_key - String
|
URL key of the base product. |
quantity_canceled - Float
|
The number of canceled items. |
quantity_invoiced - Float
|
The number of invoiced items. |
quantity_ordered - Float
|
The number of units ordered for this item. |
quantity_refunded - Float
|
The number of refunded items. |
quantity_return_requested - Float
|
The requested return quantity of the item. |
quantity_returned - Float
|
The number of returned items. |
quantity_shipped - Float
|
The number of shipped items. |
selected_options - [OrderItemOption]
|
The selected options for the base product, such as color or size. |
status - String
|
The status of the order item. |
Possible Types
| OrderItemInterface Types |
|---|
Example
{
"custom_attributes": [CustomAttribute],
"discounts": [Discount],
"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": "abc123",
"product_type": "abc123",
"product_url_key": "xyz789",
"quantity_canceled": 987.65,
"quantity_invoiced": 123.45,
"quantity_ordered": 987.65,
"quantity_refunded": 987.65,
"quantity_return_requested": 987.65,
"quantity_returned": 123.45,
"quantity_shipped": 123.45,
"selected_options": [OrderItemOption],
"status": "abc123"
}
OrderItemOption
Description
Represents order item options like selected or entered.
Example
{
"label": "abc123",
"value": "abc123"
}
OrderItemPrices
Fields
| Field Name | Description |
|---|---|
discounts - [Discount]
|
An array of discounts to be applied to the cart item. |
fixed_product_taxes - [FixedProductTax]!
|
|
original_price - Money
|
The original price of the item. |
original_price_including_tax - Money
|
The original price of the item including tax. |
original_row_total - Money!
|
The value of the original price multiplied by the quantity of the item. |
original_row_total_including_tax - Money!
|
The value of the original price multiplied by the quantity of the item including tax. |
price - Money!
|
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart. |
price_including_tax - Money!
|
The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart. |
row_total - Money!
|
The value of the price multiplied by the quantity of the item. |
row_total_including_tax - Money!
|
The value of row_total plus the tax applied to the item. |
total_item_discount - Money!
|
The total of all discounts applied to the item. |
Example
{
"discounts": [Discount],
"fixed_product_taxes": [FixedProductTax],
"original_price": Money,
"original_price_including_tax": Money,
"original_row_total": Money,
"original_row_total_including_tax": Money,
"price": Money,
"price_including_tax": Money,
"row_total": Money,
"row_total_including_tax": Money,
"total_item_discount": Money
}
OrderPaymentMethod
Description
Contains details about the payment method used to pay for the order.
Fields
| Field Name | Description |
|---|---|
additional_data - [KeyValue]
|
Additional data per payment method type. |
name - String!
|
The label that describes the payment method. |
type - String!
|
The payment method code that indicates how the order was paid for. |
Example
{
"additional_data": [KeyValue],
"name": "abc123",
"type": "xyz789"
}
OrderShipment
Description
Contains order shipment details.
Fields
| Field Name | Description |
|---|---|
comments - [SalesCommentItem]
|
Comments added to the shipment. |
id - ID!
|
The unique ID for a OrderShipment object. |
items - [ShipmentItemInterface]
|
An array of items included in the shipment. |
number - String!
|
The sequential credit shipment number. |
tracking - [ShipmentTracking]
|
An array of shipment tracking details. |
Example
{
"comments": [SalesCommentItem],
"id": 4,
"items": [ShipmentItemInterface],
"number": "abc123",
"tracking": [ShipmentTracking]
}
OrderTokenInput
Description
Input to retrieve an order based on token.
Fields
| Input Field | Description |
|---|---|
token - String!
|
Order token. |
Example
{"token": "xyz789"}
OrderTotal
Description
Contains details about the sales total amounts used to calculate the final price.
Fields
| Field Name | Description |
|---|---|
base_grand_total - Money!
|
The final base grand total amount in the base currency. |
discounts - [Discount]
|
The applied discounts to the order. |
gift_options - GiftOptionsPrices
|
|
grand_total - Money!
|
The final total amount, including shipping, discounts, and taxes. |
grand_total_excl_tax - Money!
|
The grand total of the order, excluding taxes. |
shipping_handling - ShippingHandling
|
Details about the shipping and handling costs for the order. |
subtotal_excl_tax - Money!
|
The subtotal of the order, excluding taxes. |
subtotal_incl_tax - Money!
|
The subtotal of the order, including taxes. |
taxes - [TaxItem]
|
The order tax details. |
total_giftcard - Money
|
The gift card balance applied to the order. |
total_reward_points - Money
|
The total reward points applied to the order. |
total_shipping - Money!
|
The shipping amount for the order. |
total_store_credit - Money
|
The total store credit applied to the order. |
total_tax - Money!
|
The amount of tax applied to the order. |
Example
{
"base_grand_total": Money,
"discounts": [Discount],
"gift_options": GiftOptionsPrices,
"grand_total": Money,
"grand_total_excl_tax": Money,
"shipping_handling": ShippingHandling,
"subtotal_excl_tax": Money,
"subtotal_incl_tax": Money,
"taxes": [TaxItem],
"total_giftcard": Money,
"total_reward_points": Money,
"total_shipping": Money,
"total_store_credit": Money,
"total_tax": Money
}
PageType
Description
Type of page on which recommendations are requested
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
This field is deprecated and will be removed. |
|
|
|
|
|
|
|
|
Example
"CMS"
PaymentAttributeInput
Description
Defines the payment attribute.
Example
{
"key": "xyz789",
"value": "xyz789"
}
PaymentConfigItem
Description
Contains payment fields that are common to all types of payment methods.
Fields
| Field Name | Description |
|---|---|
code - String
|
The payment method code as defined in the payment gateway |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
title - String
|
The name displayed for the payment method |
Possible Types
| PaymentConfigItem Types |
|---|
Example
{
"code": "xyz789",
"is_visible": true,
"payment_intent": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "abc123"
}
PaymentConfigOutput
Description
Retrieves the payment configuration for a given location
Fields
| Field Name | Description |
|---|---|
apple_pay - ApplePayConfig
|
ApplePay payment method configuration |
fastlane - FastlaneConfig
|
Fastlane payment method configuration |
google_pay - GooglePayConfig
|
GooglePay payment method configuration |
hosted_fields - HostedFieldsConfig
|
Hosted fields payment method configuration |
smart_buttons - SmartButtonsConfig
|
Smart Buttons payment method configuration |
Example
{
"apple_pay": ApplePayConfig,
"fastlane": FastlaneConfig,
"google_pay": GooglePayConfig,
"hosted_fields": HostedFieldsConfig,
"smart_buttons": SmartButtonsConfig
}
PaymentLocation
Description
Defines the origin location for that payment request
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRODUCT_DETAIL"
PaymentMethodInput
Description
Defines the payment method.
Fields
| Input Field | Description |
|---|---|
additional_data - [PaymentAttributeInput]
|
Additional data related to the payment method. |
code - String!
|
The internal name for the payment method. |
payment_services_paypal_apple_pay - ApplePayMethodInput
|
Required input for Apple Pay button |
payment_services_paypal_fastlane - FastlaneMethodInput
|
Required input for fastlane |
payment_services_paypal_google_pay - GooglePayMethodInput
|
Required input for Google Pay button |
payment_services_paypal_hosted_fields - HostedFieldsInput
|
Required input for Hosted Fields |
payment_services_paypal_smart_buttons - SmartButtonMethodInput
|
Required input for Smart buttons |
payment_services_paypal_vault - VaultMethodInput
|
Required input for vault |
purchase_order_number - String
|
The purchase order number. Optional for most payment methods. |
Example
{
"additional_data": [PaymentAttributeInput],
"code": "abc123",
"payment_services_paypal_apple_pay": ApplePayMethodInput,
"payment_services_paypal_fastlane": FastlaneMethodInput,
"payment_services_paypal_google_pay": GooglePayMethodInput,
"payment_services_paypal_hosted_fields": HostedFieldsInput,
"payment_services_paypal_smart_buttons": SmartButtonMethodInput,
"payment_services_paypal_vault": VaultMethodInput,
"purchase_order_number": "xyz789"
}
PaymentOrderOutput
Description
Contains the payment order details
Fields
| Field Name | Description |
|---|---|
id - String
|
PayPal order ID |
mp_order_id - String
|
The order ID generated by Payment Services |
payment_source_details - PaymentSourceDetails
|
Details about the card used on the order |
status - String
|
The status of the payment order |
Example
{
"id": "abc123",
"mp_order_id": "xyz789",
"payment_source_details": PaymentSourceDetails,
"status": "xyz789"
}
PaymentSDKParamsItem
Fields
| Field Name | Description |
|---|---|
code - String
|
The payment method code used in the order |
params - [SDKParams]
|
The payment SDK parameters |
Example
{
"code": "xyz789",
"params": [SDKParams]
}
PaymentSourceDetails
Fields
| Field Name | Description |
|---|---|
card - Card
|
Details about the card used on the order |
Example
{"card": Card}
PaymentSourceInput
Description
The payment source information
Fields
| Input Field | Description |
|---|---|
card - CardPaymentSourceInput!
|
The card payment source information |
Example
{"card": CardPaymentSourceInput}
PaymentSourceOutput
Description
The payment source information
Fields
| Field Name | Description |
|---|---|
card - CardPaymentSourceOutput!
|
The card payment source information |
Example
{"card": CardPaymentSourceOutput}
PaymentToken
Description
The stored payment method available to the customer.
Fields
| Field Name | Description |
|---|---|
details - String
|
A description of the stored account details. |
payment_method_code - String!
|
The payment method code associated with the token. |
public_hash - String!
|
The public hash of the token. |
type - PaymentTokenTypeEnum!
|
Specifies the payment token type. |
Example
{
"details": "xyz789",
"payment_method_code": "xyz789",
"public_hash": "xyz789",
"type": "card"
}
PaymentTokenTypeEnum
Description
The list of available payment token types.
Values
| Enum Value | Description |
|---|---|
|
|
phpcs:ignore Magento2.GraphQL.ValidArgumentName |
|
|
phpcs:ignore Magento2.GraphQL.ValidArgumentName |
Example
"card"
PhysicalProductInterface
Description
Contains attributes specific to tangible products.
Fields
| Field Name | Description |
|---|---|
weight - Float
|
The weight of the item, in units defined by the store. |
Possible Types
| PhysicalProductInterface Types |
|---|
Example
{"weight": 123.45}
PickupLocation
Description
Defines Pickup Location information.
Example
{
"city": "xyz789",
"contact_name": "abc123",
"country_id": "xyz789",
"description": "xyz789",
"email": "abc123",
"fax": "abc123",
"latitude": 123.45,
"longitude": 123.45,
"name": "xyz789",
"phone": "abc123",
"pickup_location_code": "xyz789",
"postcode": "xyz789",
"region": "abc123",
"region_id": 123,
"street": "xyz789"
}
PickupLocationFilterInput
Description
PickupLocationFilterInput defines the list of attributes and filters for the search.
Fields
| Input Field | Description |
|---|---|
city - FilterTypeInput
|
Filter by city. |
country_id - FilterTypeInput
|
Filter by country. |
name - FilterTypeInput
|
Filter by pickup location name. |
pickup_location_code - FilterTypeInput
|
Filter by pickup location code. |
postcode - FilterTypeInput
|
Filter by postcode. |
region - FilterTypeInput
|
Filter by region. |
region_id - FilterTypeInput
|
Filter by region id. |
street - FilterTypeInput
|
Filter by street. |
Example
{
"city": FilterTypeInput,
"country_id": FilterTypeInput,
"name": FilterTypeInput,
"pickup_location_code": FilterTypeInput,
"postcode": FilterTypeInput,
"region": FilterTypeInput,
"region_id": FilterTypeInput,
"street": FilterTypeInput
}
PickupLocationSortInput
Description
PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.
Fields
| Input Field | Description |
|---|---|
city - SortEnum
|
City where pickup location is placed. |
contact_name - SortEnum
|
Name of the contact person. |
country_id - SortEnum
|
Id of the country in two letters. |
description - SortEnum
|
Description of the pickup location. |
distance - SortEnum
|
Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored. |
email - SortEnum
|
Contact email of the pickup location. |
fax - SortEnum
|
Contact fax of the pickup location. |
latitude - SortEnum
|
Geographic latitude where pickup location is placed. |
longitude - SortEnum
|
Geographic longitude where pickup location is placed. |
name - SortEnum
|
The pickup location name. Customer use this to identify the pickup location. |
phone - SortEnum
|
Contact phone number of the pickup location. |
pickup_location_code - SortEnum
|
A code assigned to pickup location to identify the source. |
postcode - SortEnum
|
Postcode where pickup location is placed. |
region - SortEnum
|
Name of the region. |
region_id - SortEnum
|
Id of the region. |
street - SortEnum
|
Street where pickup location is placed. |
Example
{
"city": "ASC",
"contact_name": "ASC",
"country_id": "ASC",
"description": "ASC",
"distance": "ASC",
"email": "ASC",
"fax": "ASC",
"latitude": "ASC",
"longitude": "ASC",
"name": "ASC",
"phone": "ASC",
"pickup_location_code": "ASC",
"postcode": "ASC",
"region": "ASC",
"region_id": "ASC",
"street": "ASC"
}
PickupLocations
Description
Top level object returned in a pickup locations search.
Fields
| Field Name | Description |
|---|---|
items - [PickupLocation]
|
An array of pickup locations that match the specific search request. |
page_info - SearchResultPageInfo
|
An object that includes the page_info and currentPage values specified in the query. |
total_count - Int
|
The number of products returned. |
Example
{
"items": [PickupLocation],
"page_info": SearchResultPageInfo,
"total_count": 123
}
PlaceNegotiableQuoteOrderInput
Description
Specifies the negotiable quote to convert to an order.
Fields
| Input Field | Description |
|---|---|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{"quote_uid": 4}
PlaceNegotiableQuoteOrderOutput
Description
An output object that returns the generated order.
Fields
| Field Name | Description |
|---|---|
order - Order!
|
Contains the generated order number. |
orderV2 - CustomerOrder
|
Full order information. |
Example
{
"order": Order,
"orderV2": CustomerOrder
}
PlaceOrderError
Description
An error encountered while placing an order.
Fields
| Field Name | Description |
|---|---|
code - PlaceOrderErrorCodes!
|
An error code that is specific to place order. |
message - String!
|
A localized error message. |
Example
{
"code": "CART_NOT_FOUND",
"message": "xyz789"
}
PlaceOrderErrorCodes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CART_NOT_FOUND"
PlaceOrderForPurchaseOrderInput
Description
Specifies the purchase order to convert to an order.
Fields
| Input Field | Description |
|---|---|
purchase_order_uid - ID!
|
The unique ID of a purchase order. |
Example
{"purchase_order_uid": "4"}
PlaceOrderForPurchaseOrderOutput
Description
Contains the results of the request to place an order.
Fields
| Field Name | Description |
|---|---|
order - CustomerOrder!
|
Placed order. |
Example
{"order": CustomerOrder}
PlaceOrderInput
Description
Specifies the quote to be converted to an order.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
Example
{"cart_id": "abc123"}
PlaceOrderOutput
Description
Contains the results of the request to place an order.
Fields
| Field Name | Description |
|---|---|
errors - [PlaceOrderError]!
|
An array of place order errors. |
orderV2 - CustomerOrder
|
Full order information. |
Example
{
"errors": [PlaceOrderError],
"orderV2": CustomerOrder
}
PlacePurchaseOrderInput
Description
Specifies the quote to be converted to a purchase order.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
Example
{"cart_id": "xyz789"}
PlacePurchaseOrderOutput
Description
Contains the results of the request to place a purchase order.
Fields
| Field Name | Description |
|---|---|
purchase_order - PurchaseOrder!
|
Placed purchase order. |
Example
{"purchase_order": PurchaseOrder}
Price
Description
Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments.
Fields
| Field Name | Description |
|---|---|
adjustments - [PriceAdjustment]
|
A list of price adjustments. |
amount - ProductViewMoney
|
Contains the monetary value and currency code of a product. |
Example
{
"adjustments": [PriceAdjustment],
"amount": ProductViewMoney
}
PriceAdjustment
Description
Specifies the amount and type of price adjustment.
Example
{"amount": 987.65, "code": "abc123"}
PriceDetails
Description
Can be used to retrieve the main price details in case of bundle product
Example
{
"discount_percentage": 987.65,
"main_final_price": 123.45,
"main_price": 123.45
}
PriceRange
Description
Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.
Fields
| Field Name | Description |
|---|---|
maximum_price - ProductPrice
|
The highest possible price for the product. |
minimum_price - ProductPrice!
|
The lowest possible price for the product. |
Example
{
"maximum_price": ProductPrice,
"minimum_price": ProductPrice
}
PriceTypeEnum
Description
Defines the price type.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FIXED"
PriceViewEnum
Description
Defines whether a bundle product's price is displayed as the lowest possible value or as a range.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRICE_RANGE"
ProductAttribute
Description
Contains a product attribute code and value.
Example
{
"code": "abc123",
"value": "abc123"
}
ProductCustomAttributes
Description
Product custom attributes
Fields
| Field Name | Description |
|---|---|
errors - [AttributeMetadataError]!
|
Errors when retrieving custom attributes metadata. |
items - [AttributeValueInterface]!
|
Requested custom attributes |
Example
{
"errors": [AttributeMetadataError],
"items": [AttributeValueInterface]
}
ProductDiscount
Description
Contains the discount applied to a product price.
Example
{"amount_off": 123.45, "percent_off": 987.65}
ProductImage
Description
Contains product image information, including the image URL and label.
Example
{
"disabled": false,
"label": "xyz789",
"position": 123,
"url": "abc123"
}
ProductImageThumbnail
Values
| Enum Value | Description |
|---|---|
|
|
Use thumbnail of product as image. |
|
|
Use thumbnail of product's parent as image. |
Example
"ITSELF"
ProductInfoInput
Description
Product Information used for Pickup Locations search.
Fields
| Input Field | Description |
|---|---|
sku - String!
|
Product SKU. |
Example
{"sku": "xyz789"}
ProductInterface
Description
Contains fields that are common to all types of products.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
Possible Types
| ProductInterface Types |
|---|
Example
{
"canonical_url": "xyz789",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_message_available": false,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "abc123",
"manufacturer": 123,
"max_sale_qty": 987.65,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 123.45,
"name": "xyz789",
"new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "abc123",
"stock_status": "IN_STOCK",
"swatch_image": "xyz789",
"thumbnail": ProductImage,
"uid": "4",
"upsell_products": [ProductInterface],
"url_key": "abc123"
}
ProductLinks
Description
An implementation of ProductLinksInterface.
Fields
| Field Name | Description |
|---|---|
link_type - String
|
One of related, associated, upsell, or crosssell. |
linked_product_sku - String
|
The SKU of the linked product. |
linked_product_type - String
|
The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). |
position - Int
|
The position within the list of product links. |
sku - String
|
The identifier of the linked product. |
Example
{
"link_type": "xyz789",
"linked_product_sku": "abc123",
"linked_product_type": "xyz789",
"position": 123,
"sku": "abc123"
}
ProductLinksInterface
Description
Contains information about linked products, including the link type and product type of each item.
Fields
| Field Name | Description |
|---|---|
link_type - String
|
One of related, associated, upsell, or crosssell. |
linked_product_sku - String
|
The SKU of the linked product. |
linked_product_type - String
|
The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). |
position - Int
|
The position within the list of product links. |
sku - String
|
The identifier of the linked product. |
Possible Types
| ProductLinksInterface Types |
|---|
Example
{
"link_type": "xyz789",
"linked_product_sku": "xyz789",
"linked_product_type": "abc123",
"position": 123,
"sku": "abc123"
}
ProductMediaGalleryEntriesAssetImage
Description
Contains basic information about the image asset.
Example
{
"asset_id": "xyz789",
"media_type": "abc123",
"media_url": "abc123"
}
ProductMediaGalleryEntriesAssetVideo
Description
Contains basic information about the video asset.
Example
{
"media_type": "abc123",
"video_asset_id": "abc123",
"video_media_url": "abc123"
}
ProductMediaGalleryEntriesVideoContent
Description
Contains a link to a video file and basic information about the video.
Fields
| Field Name | Description |
|---|---|
media_type - String
|
Must be external-video. |
video_description - String
|
A description of the video. |
video_metadata - String
|
Optional data about the video. |
video_provider - String
|
Describes the video source. |
video_title - String
|
The title of the video. |
video_url - String
|
The URL to the video. |
Example
{
"media_type": "xyz789",
"video_description": "abc123",
"video_metadata": "abc123",
"video_provider": "abc123",
"video_title": "abc123",
"video_url": "xyz789"
}
ProductPrice
Description
Represents a product price.
Fields
| Field Name | Description |
|---|---|
discount - ProductDiscount
|
The price discount. Represents the difference between the regular and final price. |
final_price - Money!
|
The final price of the product after applying discounts. |
fixed_product_taxes - [FixedProductTax]
|
An array of the multiple Fixed Product Taxes that can be applied to a product price. |
regular_price - Money!
|
The regular price of the product. |
Example
{
"discount": ProductDiscount,
"final_price": Money,
"fixed_product_taxes": [FixedProductTax],
"regular_price": Money
}
ProductSearchItem
Description
A single product returned by the query
Fields
| Field Name | Description |
|---|---|
applied_query_rule - AppliedQueryRule
|
The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) |
highlights - [Highlight]
|
An object that provides highlighted text for matched words |
productView - ProductView
|
Contains a product view |
Example
{
"applied_query_rule": AppliedQueryRule,
"highlights": [Highlight],
"productView": ProductView
}
ProductSearchResponse
Description
Contains the output of a productSearch query
Fields
| Field Name | Description |
|---|---|
facets - [Aggregation]
|
Details about the static and dynamic facets relevant to the search |
items - [ProductSearchItem]
|
An array of products returned by the query |
page_info - SearchResultPageInfo
|
Information for rendering pages of search results |
related_terms - [String]
|
An array of strings that might include merchant-defined synonyms |
suggestions - [String]
|
An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query |
total_count - Int
|
The total number of products returned that matched the query |
Example
{
"facets": [Aggregation],
"items": [ProductSearchItem],
"page_info": SearchResultPageInfo,
"related_terms": ["abc123"],
"suggestions": ["abc123"],
"total_count": 987
}
ProductSearchSortInput
Description
The product attribute to sort on
Example
{"attribute": "xyz789", "direction": "ASC"}
ProductStockStatus
Description
This enumeration states whether a product stock status is in stock or out of stock
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IN_STOCK"
ProductVideo
Description
Contains information about a product video.
Fields
| Field Name | Description |
|---|---|
disabled - Boolean
|
Indicates whether the image is hidden from view. |
label - String
|
The label of the product image or video. |
position - Int
|
The media item's position after it has been sorted. |
url - String
|
The URL of the product image or video. |
video_content - ProductMediaGalleryEntriesVideoContent
|
Contains a ProductMediaGalleryEntriesVideoContent object. |
Example
{
"disabled": false,
"label": "xyz789",
"position": 987,
"url": "abc123",
"video_content": ProductMediaGalleryEntriesVideoContent
}
ProductView
Description
Defines the product fields available to the SimpleProductView and ComplexProductView types.
Fields
| Field Name | Description |
|---|---|
addToCartAllowed - Boolean
|
A flag stating if the product can be added to cart This field is deprecated and will be removed. |
inStock - Boolean
|
A flag stating if the product is in stock This field is deprecated and will be removed. |
lowStock - Boolean
|
A flag stating if the product stock is low This field is deprecated and will be removed. |
attributes - [ProductViewAttribute]
|
A list of merchant-defined attributes designated for the storefront. |
Arguments
|
|
description - String
|
The detailed description of the product. |
id - ID!
|
The product ID, generated as a composite key, unique per locale. |
images - [ProductViewImage]
|
A list of images defined for the product. |
Arguments
|
|
videos - [ProductViewVideo]
|
A list of videos defined for the product. |
lastModifiedAt - DateTime
|
Date and time when the product was last updated. |
metaDescription - String
|
A brief overview of the product for search results listings. |
metaKeyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
metaTitle - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
name - String
|
Product name. |
shortDescription - String
|
A summary of the product. |
inputOptions - [ProductViewInputOption]
|
A list of input options. This field is deprecated and will be removed. |
sku - String
|
Product SKU. |
externalId - String
|
External Id This field is deprecated and will be removed. |
url - String
|
Canonical URL of the product. This field is deprecated and will be removed. |
urlKey - String
|
The URL key of the product. |
links - [ProductViewLink]
|
A list of product links. |
Arguments
|
|
queryType - String
|
Indicates if the product was retrieved from the primary or the backup query |
visibility - String
|
Visibility setting of the product |
Possible Types
| ProductView Types |
|---|
Example
{
"addToCartAllowed": true,
"inStock": true,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "xyz789",
"id": "4",
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "abc123",
"metaKeyword": "xyz789",
"metaTitle": "xyz789",
"name": "xyz789",
"shortDescription": "abc123",
"inputOptions": [ProductViewInputOption],
"sku": "xyz789",
"externalId": "abc123",
"url": "xyz789",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "xyz789",
"visibility": "abc123"
}
ProductViewAttribute
Description
A container for customer-defined attributes that are displayed the storefront.
Example
{
"label": "xyz789",
"name": "abc123",
"roles": ["abc123"],
"value": {}
}
ProductViewCurrency
Description
The list of supported currency codes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AED"
ProductViewImage
Description
Contains details about a product image.
Example
{
"label": "abc123",
"roles": ["abc123"],
"url": "abc123"
}
ProductViewInputOption
Description
Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of an option value |
title - String
|
The display name of the option value |
required - Boolean
|
Wether this option is required or not |
type - String
|
The type of data entry |
markupAmount - Float
|
Price markup or markdown |
suffix - String
|
SKU suffix to add to the product |
sortOrder - Int
|
Sort order |
range - ProductViewInputOptionRange
|
|
imageSize - ProductViewInputOptionImageSize
|
|
fileExtensions - String
|
Example
{
"id": "4",
"title": "abc123",
"required": true,
"type": "abc123",
"markupAmount": 987.65,
"suffix": "abc123",
"sortOrder": 987,
"range": ProductViewInputOptionRange,
"imageSize": ProductViewInputOptionImageSize,
"fileExtensions": "abc123"
}
ProductViewInputOptionImageSize
Example
{"width": 123, "height": 987}
ProductViewInputOptionRange
Example
{"from": 987.65, "to": 987.65}
ProductViewLink
Description
The product link type.
Fields
| Field Name | Description |
|---|---|
product - ProductView!
|
Contains the details of the product found in the link. |
linkTypes - [String!]!
|
Stores the types of the links with this product. |
Example
{
"product": ProductView,
"linkTypes": ["abc123"]
}
ProductViewMoney
Description
Defines a monetary value, including a numeric value and a currency code.
Fields
| Field Name | Description |
|---|---|
currency - ProductViewCurrency
|
A three-letter currency code, such as USD or EUR. |
value - Float
|
A number expressing a monetary value. |
Example
{"currency": "AED", "value": 987.65}
ProductViewOption
Description
Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the option. |
multi - Boolean
|
Indicates whether the option allows multiple choices. |
required - Boolean
|
Indicates whether the option must be selected. |
title - String
|
The display name of the option. |
values - [ProductViewOptionValue!]
|
List of available option values. |
Example
{
"id": "4",
"multi": true,
"required": false,
"title": "abc123",
"values": [ProductViewOptionValue]
}
ProductViewOptionValue
Description
Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of an option value. |
title - String
|
The display name of the option value. |
inStock - Boolean
|
Indicates if the option is in stock. |
Possible Types
| ProductViewOptionValue Types |
|---|
Example
{
"id": "4",
"title": "abc123",
"inStock": false
}
ProductViewOptionValueConfiguration
Description
An implementation of ProductViewOptionValue for configuration values.
Example
{
"id": "4",
"title": "abc123",
"inStock": true
}
ProductViewOptionValueProduct
Description
An implementation of ProductViewOptionValue that adds details about a simple product.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of an option value. |
isDefault - Boolean
|
States if the option value is default or not. |
product - SimpleProductView
|
Details about a simple product. |
quantity - Float
|
Default quantity of an option value. |
title - String
|
The display name of the option value. |
inStock - Boolean
|
Indicates if the option is in stock. |
Example
{
"id": 4,
"isDefault": false,
"product": SimpleProductView,
"quantity": 123.45,
"title": "abc123",
"inStock": true
}
ProductViewOptionValueSwatch
Description
An implementation of ProductViewOptionValueSwatch for swatches.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of an option value. |
title - String
|
The display name of the option value. |
type - SwatchType
|
Indicates the type of the swatch. |
value - String
|
The value of the swatch depending on the type of the swatch. |
inStock - Boolean
|
Indicates if the option is in stock. |
Example
{
"id": "4",
"title": "abc123",
"type": "TEXT",
"value": "xyz789",
"inStock": false
}
ProductViewPrice
Description
Base product price view, inherent for simple products.
Fields
| Field Name | Description |
|---|---|
final - Price
|
Price value after discounts, excluding personalized promotions. |
regular - Price
|
Base product price specified by the merchant. |
tiers - [ProductViewTierPrice]
|
Volume based pricing |
roles - [String]
|
Price roles, stating if the price should be visible or hidden. |
Example
{
"final": Price,
"regular": Price,
"tiers": [ProductViewTierPrice],
"roles": ["abc123"]
}
ProductViewPriceRange
Description
The minimum and maximum price of a complex product.
Fields
| Field Name | Description |
|---|---|
maximum - ProductViewPrice
|
Maximum price. |
minimum - ProductViewPrice
|
Minimum price. |
Example
{
"maximum": ProductViewPrice,
"minimum": ProductViewPrice
}
ProductViewTierCondition
ProductViewTierExactMatchCondition
ProductViewTierPrice
Fields
| Field Name | Description |
|---|---|
tier - Price
|
Volume based price |
quantity - [ProductViewTierCondition!]!
|
Condition to active price |
Example
{
"tier": Price,
"quantity": [ProductViewTierRangeCondition]
}
ProductViewTierRangeCondition
Example
{"gte": 987.65, "lt": 123.45}
ProductViewVariant
Fields
| Field Name | Description |
|---|---|
selections - [String!]
|
List of option values that make up the variant. |
product - ProductView
|
Product corresponding to the variant. |
Example
{
"selections": ["xyz789"],
"product": ProductView
}
ProductViewVariantResults
Fields
| Field Name | Description |
|---|---|
variants - [ProductViewVariant]!
|
List of product variants. |
cursor - String
|
Pagination cursor |
Example
{
"variants": [ProductViewVariant],
"cursor": "xyz789"
}
ProductViewVideo
Description
Contains details about a product video
Fields
| Field Name | Description |
|---|---|
preview - ProductViewImage
|
Preview image for the video |
url - String!
|
The URL to the product video. |
description - String
|
Description of the product video. |
title - String
|
The title of the product video. |
Example
{
"preview": ProductViewImage,
"url": "abc123",
"description": "xyz789",
"title": "xyz789"
}
PurchaseHistory
Example
{
"date": "2007-12-03T10:15:30Z",
"items": ["xyz789"]
}
PurchaseOrder
Description
Contains details about a purchase order.
Fields
| Field Name | Description |
|---|---|
approval_flow - [PurchaseOrderRuleApprovalFlow]!
|
The approval flows for each applied rules. |
available_actions - [PurchaseOrderAction]!
|
Purchase order actions available to the customer. Can be used to display action buttons on the client. |
comments - [PurchaseOrderComment]!
|
The set of comments applied to the purchase order. |
created_at - String!
|
The date the purchase order was created. |
created_by - Customer
|
The company user who created the purchase order. |
history_log - [PurchaseOrderHistoryItem]!
|
The log of the events related to the purchase order. |
number - String!
|
The purchase order number. |
order - CustomerOrder
|
The reference to the order placed based on the purchase order. |
quote - Cart
|
The quote related to the purchase order. |
status - PurchaseOrderStatus!
|
The current status of the purchase order. |
uid - ID!
|
A unique identifier for the purchase order. |
updated_at - String!
|
The date the purchase order was last updated. |
Example
{
"approval_flow": [PurchaseOrderRuleApprovalFlow],
"available_actions": ["REJECT"],
"comments": [PurchaseOrderComment],
"created_at": "xyz789",
"created_by": Customer,
"history_log": [PurchaseOrderHistoryItem],
"number": "xyz789",
"order": CustomerOrder,
"quote": Cart,
"status": "PENDING",
"uid": "4",
"updated_at": "xyz789"
}
PurchaseOrderAction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REJECT"
PurchaseOrderActionError
Description
Contains details about a failed action.
Fields
| Field Name | Description |
|---|---|
message - String!
|
The returned error message. |
type - PurchaseOrderErrorType!
|
The error type. |
Example
{"message": "xyz789", "type": "NOT_FOUND"}
PurchaseOrderApprovalFlowEvent
Description
Contains details about a single event in the approval flow of the purchase order.
Fields
| Field Name | Description |
|---|---|
message - String
|
A formatted message. |
name - String
|
The approver name. |
role - String
|
The approver role. |
status - PurchaseOrderApprovalFlowItemStatus
|
The status related to the event. |
updated_at - String
|
The date and time the event was updated. |
Example
{
"message": "xyz789",
"name": "abc123",
"role": "abc123",
"status": "PENDING",
"updated_at": "xyz789"
}
PurchaseOrderApprovalFlowItemStatus
PurchaseOrderApprovalRule
Description
Contains details about a purchase order approval rule.
Fields
| Field Name | Description |
|---|---|
applies_to_roles - [CompanyRole]!
|
The name of the user(s) affected by the the purchase order approval rule. |
approver_roles - [CompanyRole]!
|
The name of the user who needs to approve purchase orders that trigger the approval rule. |
condition - PurchaseOrderApprovalRuleConditionInterface
|
Condition which triggers the approval rule. |
created_at - String!
|
The date the purchase order rule was created. |
created_by - String!
|
The name of the user who created the purchase order approval rule. |
description - String
|
Description of the purchase order approval rule. |
name - String!
|
The name of the purchase order approval rule. |
status - PurchaseOrderApprovalRuleStatus!
|
The status of the purchase order approval rule. |
uid - ID!
|
The unique identifier for the purchase order approval rule. |
updated_at - String!
|
The date the purchase order rule was last updated. |
Example
{
"applies_to_roles": [CompanyRole],
"approver_roles": [CompanyRole],
"condition": PurchaseOrderApprovalRuleConditionInterface,
"created_at": "abc123",
"created_by": "xyz789",
"description": "xyz789",
"name": "abc123",
"status": "ENABLED",
"uid": 4,
"updated_at": "abc123"
}
PurchaseOrderApprovalRuleConditionAmount
Description
Contains approval rule condition details, including the amount to be evaluated.
Fields
| Field Name | Description |
|---|---|
amount - Money!
|
The amount to be be used for evaluation of the approval rule condition. |
attribute - PurchaseOrderApprovalRuleType
|
The type of purchase order approval rule. |
operator - PurchaseOrderApprovalRuleConditionOperator
|
The operator to be used for evaluating the approval rule condition. |
Example
{
"amount": Money,
"attribute": "GRAND_TOTAL",
"operator": "MORE_THAN"
}
PurchaseOrderApprovalRuleConditionInterface
Description
Purchase order rule condition details.
Fields
| Field Name | Description |
|---|---|
attribute - PurchaseOrderApprovalRuleType
|
The type of purchase order approval rule. |
operator - PurchaseOrderApprovalRuleConditionOperator
|
The operator to be used for evaluating the approval rule condition. |
Possible Types
| PurchaseOrderApprovalRuleConditionInterface Types |
|---|
Example
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
PurchaseOrderApprovalRuleConditionOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MORE_THAN"
PurchaseOrderApprovalRuleConditionQuantity
Description
Contains approval rule condition details, including the quantity to be evaluated.
Fields
| Field Name | Description |
|---|---|
attribute - PurchaseOrderApprovalRuleType
|
The type of purchase order approval rule. |
operator - PurchaseOrderApprovalRuleConditionOperator
|
The operator to be used for evaluating the approval rule condition. |
quantity - Int
|
The quantity to be used for evaluation of the approval rule condition. |
Example
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
PurchaseOrderApprovalRuleInput
Description
Defines a new purchase order approval rule.
Fields
| Input Field | Description |
|---|---|
applies_to - [ID]!
|
A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future. |
approvers - [ID]!
|
A list of B2B user roles that can approve this purchase order approval rule. |
condition - CreatePurchaseOrderApprovalRuleConditionInput!
|
The condition of the purchase order approval rule. |
description - String
|
A summary of the purpose of the purchase order approval rule. |
name - String!
|
The purchase order approval rule name. |
status - PurchaseOrderApprovalRuleStatus!
|
The status of the purchase order approval rule. |
Example
{
"applies_to": ["4"],
"approvers": ["4"],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "xyz789",
"name": "abc123",
"status": "ENABLED"
}
PurchaseOrderApprovalRuleMetadata
Description
Contains metadata that can be used to render rule edit forms.
Fields
| Field Name | Description |
|---|---|
available_applies_to - [CompanyRole]!
|
A list of B2B user roles that the rule can be applied to. |
available_condition_currencies - [AvailableCurrency]!
|
A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules. |
available_requires_approval_from - [CompanyRole]!
|
A list of B2B user roles that can be specified as approvers for the approval rules. |
Example
{
"available_applies_to": [CompanyRole],
"available_condition_currencies": [AvailableCurrency],
"available_requires_approval_from": [CompanyRole]
}
PurchaseOrderApprovalRuleStatus
PurchaseOrderApprovalRuleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GRAND_TOTAL"
PurchaseOrderApprovalRules
Description
Contains the approval rules that the customer can see.
Fields
| Field Name | Description |
|---|---|
items - [PurchaseOrderApprovalRule]!
|
A list of purchase order approval rules visible to the customer. |
page_info - SearchResultPageInfo
|
Result pagination details. |
total_count - Int
|
The total number of purchase order approval rules visible to the customer. |
Example
{
"items": [PurchaseOrderApprovalRule],
"page_info": SearchResultPageInfo,
"total_count": 123
}
PurchaseOrderComment
Description
Contains details about a comment.
Example
{
"author": Customer,
"created_at": "xyz789",
"text": "xyz789",
"uid": "4"
}
PurchaseOrderErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_FOUND"
PurchaseOrderHistoryItem
Description
Contains details about a status change.
Example
{
"activity": "xyz789",
"created_at": "abc123",
"message": "xyz789",
"uid": 4
}
PurchaseOrderRuleApprovalFlow
Description
Contains details about approval roles applied to the purchase order and status changes.
Fields
| Field Name | Description |
|---|---|
events - [PurchaseOrderApprovalFlowEvent]!
|
The approval flow event related to the rule. |
rule_name - String!
|
The name of the applied rule. |
Example
{
"events": [PurchaseOrderApprovalFlowEvent],
"rule_name": "xyz789"
}
PurchaseOrderStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
PurchaseOrders
Description
Contains a list of purchase orders.
Fields
| Field Name | Description |
|---|---|
items - [PurchaseOrder]!
|
Purchase orders matching the search criteria. |
page_info - SearchResultPageInfo
|
Page information of search result's current page. |
total_count - Int
|
Total number of purchase orders found matching the search criteria. |
Example
{
"items": [PurchaseOrder],
"page_info": SearchResultPageInfo,
"total_count": 987
}
PurchaseOrdersActionInput
Description
Defines which purchase orders to act on.
Fields
| Input Field | Description |
|---|---|
purchase_order_uids - [ID]!
|
An array of purchase order UIDs. |
Example
{"purchase_order_uids": ["4"]}
PurchaseOrdersActionOutput
Description
Returns a list of updated purchase orders and any error messages.
Fields
| Field Name | Description |
|---|---|
errors - [PurchaseOrderActionError]!
|
An array of error messages encountered while performing the operation. |
purchase_orders - [PurchaseOrder]!
|
A list of purchase orders. |
Example
{
"errors": [PurchaseOrderActionError],
"purchase_orders": [PurchaseOrder]
}
PurchaseOrdersFilterInput
Description
Defines the criteria to use to filter the list of purchase orders.
Fields
| Input Field | Description |
|---|---|
company_purchase_orders - Boolean
|
Include only purchase orders made by subordinate company users. |
created_date - FilterRangeTypeInput
|
Filter by the creation date of the purchase order. |
require_my_approval - Boolean
|
Include only purchase orders that are waiting for the customer’s approval. |
status - PurchaseOrderStatus
|
Filter by the status of the purchase order. |
Example
{
"company_purchase_orders": false,
"created_date": FilterRangeTypeInput,
"require_my_approval": true,
"status": "PENDING"
}
QueryContextInput
Fields
| Input Field | Description |
|---|---|
customerGroup - String!
|
The customer group code. Field reserved for future use. Currently, passing this field will have no impact on search results, that is, the search results will be for "Not logged in" customer |
userViewHistory - [ViewHistoryInput!]
|
User view history with timestamp |
Example
{
"customerGroup": "xyz789",
"userViewHistory": [ViewHistoryInput]
}
QuoteItemsSortInput
Description
Specifies the field to use for sorting quote items
Fields
| Input Field | Description |
|---|---|
field - SortQuoteItemsEnum!
|
Specifies the quote items field to sort by |
order - SortEnum!
|
Specifies the order of quote items' sorting |
Example
{"field": "ITEM_ID", "order": "ASC"}
QuoteTemplateLineItemNoteInput
Description
Sets quote item note.
Example
{
"item_id": "4",
"note": "xyz789",
"templateId": "4"
}
QuoteTemplateNotificationMessage
Description
Contains a notification message for a negotiable quote template.
Example
{
"message": "xyz789",
"type": "abc123"
}
RangeBucket
Description
For use on numeric product fields
Example
{
"count": 123,
"from": 123.45,
"title": "abc123",
"to": 987.65
}
ReCaptchaConfigOutput
Fields
| Field Name | Description |
|---|---|
configurations - ReCaptchaConfiguration
|
Configuration details for reCaptcha type |
is_enabled - Boolean!
|
Indicates whether reCaptcha type is enabled |
Example
{
"configurations": ReCaptchaConfiguration,
"is_enabled": true
}
ReCaptchaConfiguration
Description
Contains reCAPTCHA form configuration details.
Fields
| Field Name | Description |
|---|---|
badge_position - String
|
The position of the invisible reCAPTCHA badge on each page. |
language_code - String
|
A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. |
minimum_score - Float
|
The minimum score that identifies a user interaction as a potential risk. |
re_captcha_type - ReCaptchaTypeEmum!
|
|
technical_failure_message - String!
|
The message that appears when reCaptcha fails. |
theme - String!
|
Theme to be used to render reCaptcha. |
validation_failure_message - String!
|
The message that appears to the user if validation fails. |
website_key - String!
|
The website key generated when the Google reCAPTCHA account was registered. |
Example
{
"badge_position": "xyz789",
"language_code": "abc123",
"minimum_score": 987.65,
"re_captcha_type": "INVISIBLE",
"technical_failure_message": "abc123",
"theme": "xyz789",
"validation_failure_message": "abc123",
"website_key": "xyz789"
}
ReCaptchaConfigurationV3
Description
Contains reCAPTCHA V3-Invisible configuration details.
Fields
| Field Name | Description |
|---|---|
badge_position - String!
|
The position of the invisible reCAPTCHA badge on each page. |
failure_message - String!
|
The message that appears to the user if validation fails. |
forms - [ReCaptchaFormEnum]!
|
A list of forms on the storefront that have been configured to use reCAPTCHA V3. |
is_enabled - Boolean!
|
Return whether recaptcha is enabled or not |
language_code - String
|
A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. |
minimum_score - Float!
|
The minimum score that identifies a user interaction as a potential risk. |
theme - String!
|
Theme to be used to render reCaptcha. |
website_key - String!
|
The website key generated when the Google reCAPTCHA account was registered. |
Example
{
"badge_position": "xyz789",
"failure_message": "xyz789",
"forms": ["PLACE_ORDER"],
"is_enabled": true,
"language_code": "abc123",
"minimum_score": 123.45,
"theme": "abc123",
"website_key": "xyz789"
}
ReCaptchaFormEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PLACE_ORDER"
ReCaptchaTypeEmum
RecommendationUnit
Description
Recommendation Unit containing product and other details
Fields
| Field Name | Description |
|---|---|
displayOrder - Int
|
Order in which recommendation units are displayed |
pageType - String
|
Page type |
productsView - [ProductView]
|
List of product view |
storefrontLabel - String
|
Storefront label to be displayed on the storefront |
totalProducts - Int
|
Total products returned in recommedations |
typeId - String
|
Type of recommendation |
unitId - String
|
Id of the preconfigured unit |
unitName - String
|
Name of the preconfigured unit |
Example
{
"displayOrder": 123,
"pageType": "abc123",
"productsView": [ProductView],
"storefrontLabel": "abc123",
"totalProducts": 987,
"typeId": "abc123",
"unitId": "abc123",
"unitName": "xyz789"
}
Recommendations
Description
Recommendations response
Fields
| Field Name | Description |
|---|---|
results - [RecommendationUnit]
|
List of rec units with products recommended |
totalResults - Int
|
total number of rec units for which recommendations are returned |
Example
{"results": [RecommendationUnit], "totalResults": 987}
Region
RemoveCouponFromCartInput
Description
Specifies the cart from which to remove a coupon.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
Example
{"cart_id": "abc123"}
RemoveCouponFromCartOutput
Description
Contains details about the cart after removing a coupon.
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The cart after removing a coupon. |
Example
{"cart": Cart}
RemoveCouponsFromCartInput
Description
Remove coupons from the cart.
Example
{
"cart_id": "abc123",
"coupon_codes": ["xyz789"]
}
RemoveGiftCardFromCartInput
Description
Defines the input required to run the removeGiftCardFromCart mutation.
Example
{
"cart_id": "abc123",
"gift_card_code": "abc123"
}
RemoveGiftCardFromCartOutput
Description
Defines the possible output for the removeGiftCardFromCart mutation.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The contents of the specified shopping cart. |
Example
{"cart": Cart}
RemoveGiftRegistryItemsOutput
Description
Contains the results of a request to remove an item from a gift registry.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry after removing items. |
Example
{"gift_registry": GiftRegistry}
RemoveGiftRegistryOutput
Description
Contains the results of a request to delete a gift registry.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
Indicates whether the gift registry was successfully deleted. |
Example
{"success": false}
RemoveGiftRegistryRegistrantsOutput
Description
Contains the results of a request to delete a registrant.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry after deleting registrants. |
Example
{"gift_registry": GiftRegistry}
RemoveItemFromCartInput
Description
Specifies which items to remove from the cart.
Example
{
"cart_id": "xyz789",
"cart_item_uid": "4"
}
RemoveItemFromCartOutput
Description
Contains details about the cart after removing an item.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after removing an item. |
Example
{"cart": Cart}
RemoveNegotiableQuoteItemsInput
Description
Defines the items to remove from the specified negotiable quote.
Example
{"quote_item_uids": ["4"], "quote_uid": 4}
RemoveNegotiableQuoteItemsOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after removing items. |
Example
{"quote": NegotiableQuote}
RemoveNegotiableQuoteTemplateItemsInput
Description
Defines the items to remove from the specified negotiable quote.
Example
{"item_uids": [4], "template_id": 4}
RemoveProductsFromCompareListInput
Description
Defines which products to remove from a compare list.
Example
{"products": ["4"], "uid": 4}
RemoveProductsFromWishlistOutput
Description
Contains the customer's wish list and any errors encountered.
Fields
| Field Name | Description |
|---|---|
user_errors - [WishListUserInputError]!
|
An array of errors encountered while deleting products from a wish list. |
wishlist - Wishlist!
|
Contains the wish list with after items were successfully deleted. |
Example
{
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
RemoveReturnTrackingInput
Description
Defines the tracking information to delete.
Fields
| Input Field | Description |
|---|---|
return_shipping_tracking_uid - ID!
|
The unique ID for a ReturnShippingTracking object. |
Example
{"return_shipping_tracking_uid": "4"}
RemoveReturnTrackingOutput
Description
Contains the response after deleting tracking information.
Fields
| Field Name | Description |
|---|---|
return - Return
|
Contains details about the modified return. |
Example
{"return": Return}
RemoveRewardPointsFromCartOutput
Description
Contains the customer cart.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The customer cart after reward points are removed. |
Example
{"cart": Cart}
RemoveStoreCreditFromCartInput
Description
Defines the input required to run the removeStoreCreditFromCart mutation.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID that identifies the customer's cart. |
Example
{"cart_id": "abc123"}
RemoveStoreCreditFromCartOutput
Description
Defines the possible output for the removeStoreCreditFromCart mutation.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The contents of the specified shopping cart. |
Example
{"cart": Cart}
RenameNegotiableQuoteInput
Description
Sets new name for a negotiable quote.
Example
{
"quote_comment": "xyz789",
"quote_name": "abc123",
"quote_uid": 4
}
RenameNegotiableQuoteOutput
Description
Contains the updated negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after updating the name. |
Example
{"quote": NegotiableQuote}
ReorderItemsOutput
Description
Contains the cart and any errors after adding products.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
Detailed information about the customer's cart. |
userInputErrors - [CheckoutUserInputError]!
|
An array of reordering errors. |
Example
{
"cart": Cart,
"userInputErrors": [CheckoutUserInputError]
}
RequestGuestReturnInput
Description
Contains information needed to start a return request.
Fields
| Input Field | Description |
|---|---|
comment_text - String
|
Text the buyer entered that describes the reason for the refund request. |
contact_email - String
|
The email address the buyer enters to receive notifications about the status of the return. |
items - [RequestReturnItemInput]!
|
An array of items to be returned. |
token - String!
|
Order token. |
Example
{
"comment_text": "xyz789",
"contact_email": "xyz789",
"items": [RequestReturnItemInput],
"token": "abc123"
}
RequestNegotiableQuoteInput
Description
Defines properties of a negotiable quote request.
Fields
| Input Field | Description |
|---|---|
cart_id - ID!
|
The cart ID of the buyer requesting a new negotiable quote. |
comment - NegotiableQuoteCommentInput!
|
Comments the buyer entered to describe the request. |
is_draft - Boolean
|
Flag indicating if quote is draft or not. |
quote_name - String!
|
The name the buyer assigned to the negotiable quote request. |
Example
{
"cart_id": "4",
"comment": NegotiableQuoteCommentInput,
"is_draft": true,
"quote_name": "xyz789"
}
RequestNegotiableQuoteOutput
Description
Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
Details about the negotiable quote. |
Example
{"quote": NegotiableQuote}
RequestNegotiableQuoteTemplateInput
Description
Defines properties of a negotiable quote template request.
Fields
| Input Field | Description |
|---|---|
cart_id - ID!
|
The cart ID of the quote to create the new negotiable quote template from. |
Example
{"cart_id": "4"}
RequestReturnInput
Description
Contains information needed to start a return request.
Fields
| Input Field | Description |
|---|---|
comment_text - String
|
Text the buyer entered that describes the reason for the refund request. |
contact_email - String
|
The email address the buyer enters to receive notifications about the status of the return. |
items - [RequestReturnItemInput]!
|
An array of items to be returned. |
order_uid - ID!
|
The unique ID for a Order object. |
Example
{
"comment_text": "abc123",
"contact_email": "xyz789",
"items": [RequestReturnItemInput],
"order_uid": 4
}
RequestReturnItemInput
Description
Contains details about an item to be returned.
Fields
| Input Field | Description |
|---|---|
entered_custom_attributes - [EnteredCustomAttributeInput]
|
Details about a custom attribute that was entered. |
order_item_uid - ID!
|
The unique ID for a OrderItemInterface object. |
quantity_to_return - Float!
|
The quantity of the item to be returned. |
selected_custom_attributes - [SelectedCustomAttributeInput]
|
An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product. |
Example
{
"entered_custom_attributes": [
EnteredCustomAttributeInput
],
"order_item_uid": 4,
"quantity_to_return": 123.45,
"selected_custom_attributes": [
SelectedCustomAttributeInput
]
}
RequestReturnOutput
Description
Contains the response to a return request.
Example
{
"return": Return,
"returns": Returns
}
RequisitionList
Description
Defines the contents of a requisition list.
Fields
| Field Name | Description |
|---|---|
description - String
|
Optional text that describes the requisition list. |
items - RequistionListItems
|
An array of products added to the requisition list. |
items_count - Int!
|
The number of items in the list. |
name - String!
|
The requisition list name. |
uid - ID!
|
The unique requisition list ID. |
updated_at - String
|
The time of the last modification of the requisition list. |
Example
{
"description": "xyz789",
"items": RequistionListItems,
"items_count": 987,
"name": "abc123",
"uid": 4,
"updated_at": "xyz789"
}
RequisitionListFilterInput
Description
Defines requisition list filters.
Fields
| Input Field | Description |
|---|---|
name - FilterMatchTypeInput
|
Filter by the display name of the requisition list. |
uids - FilterEqualTypeInput
|
Filter requisition lists by one or more requisition list IDs. |
Example
{
"name": FilterMatchTypeInput,
"uids": FilterEqualTypeInput
}
RequisitionListItemInterface
Description
The interface for requisition list items.
Fields
| Field Name | Description |
|---|---|
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The amount added. |
uid - ID!
|
The unique ID for the requisition list item. |
Possible Types
| RequisitionListItemInterface Types |
|---|
Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 987.65,
"uid": "4"
}
RequisitionListItemsInput
Description
Defines the items to add.
Fields
| Input Field | Description |
|---|---|
entered_options - [EnteredOptionInput]
|
Entered option IDs. |
parent_sku - String
|
For configurable products, the SKU of the parent product. |
quantity - Float
|
The quantity of the product to add. |
selected_options - [String]
|
Selected option IDs. |
sku - String!
|
The product SKU. |
Example
{
"entered_options": [EnteredOptionInput],
"parent_sku": "xyz789",
"quantity": 123.45,
"selected_options": ["abc123"],
"sku": "xyz789"
}
RequisitionLists
Description
Defines customer requisition lists.
Fields
| Field Name | Description |
|---|---|
items - [RequisitionList]
|
An array of requisition lists. |
page_info - SearchResultPageInfo
|
Pagination metadata. |
total_count - Int
|
The number of returned requisition lists. |
Example
{
"items": [RequisitionList],
"page_info": SearchResultPageInfo,
"total_count": 123
}
RequistionListItems
Description
Contains an array of items added to a requisition list.
Fields
| Field Name | Description |
|---|---|
items - [RequisitionListItemInterface]!
|
An array of items in the requisition list. |
page_info - SearchResultPageInfo
|
Pagination metadata. |
total_pages - Int!
|
The number of pages returned. |
Example
{
"items": [RequisitionListItemInterface],
"page_info": SearchResultPageInfo,
"total_pages": 987
}
Return
Description
Contains details about a return.
Fields
| Field Name | Description |
|---|---|
available_shipping_carriers - [ReturnShippingCarrier]
|
A list of shipping carriers available for returns. |
comments - [ReturnComment]
|
A list of comments posted for the return request. |
created_at - String!
|
The date the return was requested. |
customer - ReturnCustomer!
|
Data from the customer who created the return request. |
items - [ReturnItem]
|
A list of items being returned. |
number - String!
|
A human-readable return number. |
order - CustomerOrder
|
The order associated with the return. |
shipping - ReturnShipping
|
Shipping information for the return. |
status - ReturnStatus
|
The status of the return request. |
uid - ID!
|
The unique ID for a Return object. |
Example
{
"available_shipping_carriers": [ReturnShippingCarrier],
"comments": [ReturnComment],
"created_at": "abc123",
"customer": ReturnCustomer,
"items": [ReturnItem],
"number": "abc123",
"order": CustomerOrder,
"shipping": ReturnShipping,
"status": "PENDING",
"uid": "4"
}
ReturnComment
Description
Contains details about a return comment.
Example
{
"author_name": "xyz789",
"created_at": "abc123",
"text": "xyz789",
"uid": 4
}
ReturnCustomer
Description
The customer information for the return.
Example
{
"email": "abc123",
"firstname": "xyz789",
"lastname": "xyz789"
}
ReturnItem
Description
Contains details about a product being returned.
Fields
| Field Name | Description |
|---|---|
custom_attributesV2 - [AttributeValueInterface]
|
Custom attributes that are visible on the storefront. |
order_item - OrderItemInterface!
|
Provides access to the product being returned, including information about selected and entered options. |
quantity - Float!
|
The quantity of the item the merchant authorized to be returned. |
request_quantity - Float!
|
The quantity of the item requested to be returned. |
status - ReturnItemStatus!
|
The return status of the item. |
uid - ID!
|
The unique ID for a ReturnItem object. |
Example
{
"custom_attributesV2": [AttributeValueInterface],
"order_item": OrderItemInterface,
"quantity": 987.65,
"request_quantity": 123.45,
"status": "PENDING",
"uid": "4"
}
ReturnItemAttributeMetadata
Description
Return Item attribute metadata.
Fields
| Field Name | Description |
|---|---|
code - ID!
|
The unique identifier for an attribute code. This value should be in lowercase letters without spaces. |
default_value - String
|
Default attribute value. |
entity_type - AttributeEntityTypeEnum!
|
The type of entity that defines the attribute. |
frontend_class - String
|
The frontend class of the attribute. |
frontend_input - AttributeFrontendInputEnum
|
The frontend input type of the attribute. |
input_filter - InputFilterEnum
|
The template used for the input of the attribute (e.g., 'date'). |
is_required - Boolean!
|
Whether the attribute value is required. |
is_unique - Boolean!
|
Whether the attribute value must be unique. |
label - String
|
The label assigned to the attribute. |
multiline_count - Int
|
The number of lines of the attribute value. |
options - [CustomAttributeOptionInterface]!
|
Attribute options. |
sort_order - Int
|
The position of the attribute in the form. |
validate_rules - [ValidationRule]
|
The validation rules of the attribute value. |
Example
{
"code": 4,
"default_value": "abc123",
"entity_type": "CATALOG_PRODUCT",
"frontend_class": "abc123",
"frontend_input": "BOOLEAN",
"input_filter": "NONE",
"is_required": true,
"is_unique": true,
"label": "abc123",
"multiline_count": 987,
"options": [CustomAttributeOptionInterface],
"sort_order": 987,
"validate_rules": [ValidationRule]
}
ReturnItemStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
ReturnShipping
Description
Contains details about the return shipping address.
Fields
| Field Name | Description |
|---|---|
address - ReturnShippingAddress
|
The merchant-defined return shipping address. |
tracking - [ReturnShippingTracking]
|
The unique ID for a ReturnShippingTracking object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information. |
Arguments
|
|
Example
{
"address": ReturnShippingAddress,
"tracking": [ReturnShippingTracking]
}
ReturnShippingAddress
Description
Contains details about the shipping address used for receiving returned items.
Fields
| Field Name | Description |
|---|---|
city - String!
|
The city for product returns. |
contact_name - String
|
The merchant's contact person. |
country - Country!
|
An object that defines the country for product returns. |
postcode - String!
|
The postal code for product returns. |
region - Region!
|
An object that defines the state or province for product returns. |
street - [String]!
|
The street address for product returns. |
telephone - String
|
The telephone number for product returns. |
Example
{
"city": "xyz789",
"contact_name": "abc123",
"country": Country,
"postcode": "xyz789",
"region": Region,
"street": ["xyz789"],
"telephone": "abc123"
}
ReturnShippingCarrier
Description
Contains details about the carrier on a return.
Example
{
"label": "abc123",
"uid": "4"
}
ReturnShippingTracking
Description
Contains shipping and tracking details.
Fields
| Field Name | Description |
|---|---|
carrier - ReturnShippingCarrier!
|
Contains details of a shipping carrier. |
status - ReturnShippingTrackingStatus
|
Details about the status of a shipment. |
tracking_number - String!
|
A tracking number assigned by the carrier. |
uid - ID!
|
The unique ID for a ReturnShippingTracking object assigned to the tracking item. |
Example
{
"carrier": ReturnShippingCarrier,
"status": ReturnShippingTrackingStatus,
"tracking_number": "abc123",
"uid": 4
}
ReturnShippingTrackingStatus
Description
Contains the status of a shipment.
Fields
| Field Name | Description |
|---|---|
text - String!
|
Text that describes the status. |
type - ReturnShippingTrackingStatusType!
|
Indicates whether the status type is informational or an error. |
Example
{"text": "abc123", "type": "INFORMATION"}
ReturnShippingTrackingStatusType
ReturnStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
Returns
Description
Contains a list of customer return requests.
Fields
| Field Name | Description |
|---|---|
items - [Return]
|
A list of return requests. |
page_info - SearchResultPageInfo
|
Pagination metadata. |
total_count - Int
|
The total number of return requests. |
Example
{
"items": [Return],
"page_info": SearchResultPageInfo,
"total_count": 987
}
RevokeCustomerTokenOutput
Description
Contains the result of a request to revoke a customer token.
Fields
| Field Name | Description |
|---|---|
result - Boolean!
|
The result of a request to revoke a customer token. |
Example
{"result": false}
RewardPoints
Description
Contains details about a customer's reward points.
Fields
| Field Name | Description |
|---|---|
balance - RewardPointsAmount
|
The current balance of reward points. |
balance_history - [RewardPointsBalanceHistoryItem]
|
The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null. |
exchange_rates - RewardPointsExchangeRates
|
The current exchange rates for reward points. |
subscription_status - RewardPointsSubscriptionStatus
|
The subscription status of emails related to reward points. |
Example
{
"balance": RewardPointsAmount,
"balance_history": [RewardPointsBalanceHistoryItem],
"exchange_rates": RewardPointsExchangeRates,
"subscription_status": RewardPointsSubscriptionStatus
}
RewardPointsAmount
RewardPointsBalanceHistoryItem
Description
Contain details about the reward points transaction.
Fields
| Field Name | Description |
|---|---|
balance - RewardPointsAmount
|
The award points balance after the completion of the transaction. |
change_reason - String!
|
The reason the balance changed. |
date - String!
|
The date of the transaction. |
points_change - Float!
|
The number of points added or deducted in the transaction. |
Example
{
"balance": RewardPointsAmount,
"change_reason": "abc123",
"date": "xyz789",
"points_change": 123.45
}
RewardPointsExchangeRates
Description
Lists the reward points exchange rates. The values depend on the customer group.
Fields
| Field Name | Description |
|---|---|
earning - RewardPointsRate
|
How many points are earned for a given amount spent. |
redemption - RewardPointsRate
|
How many points must be redeemed to get a given amount of currency discount at the checkout. |
Example
{
"earning": RewardPointsRate,
"redemption": RewardPointsRate
}
RewardPointsRate
Description
Contains details about customer's reward points rate.
Fields
| Field Name | Description |
|---|---|
currency_amount - Float!
|
The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents. |
points - Float!
|
The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption. |
Example
{"currency_amount": 123.45, "points": 987.65}
RewardPointsSubscriptionStatus
Description
Indicates whether the customer subscribes to reward points emails.
Fields
| Field Name | Description |
|---|---|
balance_updates - RewardPointsSubscriptionStatusesEnum!
|
Indicates whether the customer subscribes to 'Reward points balance updates' emails. |
points_expiration_notifications - RewardPointsSubscriptionStatusesEnum!
|
Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. |
Example
{
"balance_updates": "SUBSCRIBED",
"points_expiration_notifications": "SUBSCRIBED"
}
RewardPointsSubscriptionStatusesEnum
SDKParams
Description
Defines the name and value of a SDK parameter
Example
{
"name": "xyz789",
"value": "abc123"
}
SalesCommentItem
Description
Contains details about a comment.
Example
{
"message": "xyz789",
"timestamp": "xyz789"
}
ScalarBucket
Description
For use on string and other scalar product fields
Example
{"count": 123, "id": 4, "title": "xyz789"}
ScopeTypeEnum
Description
This enumeration defines the scope type for customer orders.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GLOBAL"
SearchClauseInput
Description
A product attribute to filter on
Fields
| Input Field | Description |
|---|---|
attribute - String!
|
The attribute code of a product attribute |
contains - String
|
attribute value should contain the specified string |
eq - String
|
A string value to filter on |
in - [String]
|
An array of string values to filter on |
range - SearchRangeInput
|
A range of numeric values to filter on |
startsWith - String
|
attribute value should start with the specified string |
Example
{
"attribute": "abc123",
"contains": "xyz789",
"eq": "xyz789",
"in": ["xyz789"],
"range": SearchRangeInput,
"startsWith": "abc123"
}
SearchRangeInput
Description
A range of numeric values for use in a search
Example
{"from": 987.65, "to": 123.45}
SearchResultPageInfo
Description
Provides navigation for the query response.
Example
{"current_page": 987, "page_size": 123, "total_pages": 123}
SelectedBundleOption
Description
Contains details about a selected bundle option.
Fields
| Field Name | Description |
|---|---|
label - String!
|
The display name of the selected bundle product option. |
type - String!
|
The type of selected bundle product option. |
uid - ID!
|
The unique ID for a SelectedBundleOption object |
values - [SelectedBundleOptionValue]!
|
An array of selected bundle option values. |
Example
{
"label": "xyz789",
"type": "abc123",
"uid": 4,
"values": [SelectedBundleOptionValue]
}
SelectedBundleOptionValue
Description
Contains details about a value for a selected bundle option.
Fields
| Field Name | Description |
|---|---|
label - String!
|
The display name of the value for the selected bundle product option. |
original_price - Money!
|
The original price of the value for the selected bundle product option. |
priceV2 - Money!
|
The price of the value for the selected bundle product option. |
quantity - Float!
|
The quantity of the value for the selected bundle product option. |
uid - ID!
|
The unique ID for a SelectedBundleOptionValue object |
Example
{
"label": "xyz789",
"original_price": Money,
"priceV2": Money,
"quantity": 123.45,
"uid": "4"
}
SelectedConfigurableOption
Description
Contains details about a selected configurable option.
Fields
| Field Name | Description |
|---|---|
configurable_product_option_uid - ID!
|
The unique ID for a ConfigurableProductOptions object. |
configurable_product_option_value_uid - ID!
|
The unique ID for a ConfigurableProductOptionsValues object. |
option_label - String!
|
The display text for the option. |
value_label - String!
|
The display name of the selected configurable option. |
Example
{
"configurable_product_option_uid": 4,
"configurable_product_option_value_uid": "4",
"option_label": "xyz789",
"value_label": "abc123"
}
SelectedCustomAttributeInput
Description
Contains details about an attribute the buyer selected.
Example
{
"attribute_code": "xyz789",
"value": "abc123"
}
SelectedCustomizableOption
Description
Identifies a customized product that has been placed in a cart.
Fields
| Field Name | Description |
|---|---|
customizable_option_uid - ID!
|
The unique ID for a specific CustomizableOptionInterface object, such as a CustomizableFieldOption, CustomizableFileOption, or CustomizableAreaOption object. |
is_required - Boolean!
|
Indicates whether the customizable option is required. |
label - String!
|
The display name of the selected customizable option. |
sort_order - Int!
|
A value indicating the order to display this option. |
type - String!
|
The type of CustomizableOptionInterface object. |
values - [SelectedCustomizableOptionValue]!
|
An array of selectable values. |
Example
{
"customizable_option_uid": 4,
"is_required": false,
"label": "xyz789",
"sort_order": 123,
"type": "abc123",
"values": [SelectedCustomizableOptionValue]
}
SelectedCustomizableOptionValue
Description
Identifies the value of the selected customized option.
Fields
| Field Name | Description |
|---|---|
customizable_option_value_uid - ID!
|
The unique ID for a value object that corresponds to the object represented by the customizable_option_uid attribute. |
label - String!
|
The display name of the selected value. |
price - CartItemSelectedOptionValuePrice!
|
The price of the selected customizable value. |
value - String!
|
The text identifying the selected value. |
Example
{
"customizable_option_value_uid": 4,
"label": "abc123",
"price": CartItemSelectedOptionValuePrice,
"value": "xyz789"
}
SelectedPaymentMethod
Description
Describes the payment method selected by the shopper.
Fields
| Field Name | Description |
|---|---|
code - String!
|
The payment method code. |
oope_payment_method_config - OopePaymentMethodConfig
|
Configuration for out of process payment methods |
purchase_order_number - String
|
The purchase order number. |
title - String!
|
The payment method title. |
Example
{
"code": "abc123",
"oope_payment_method_config": OopePaymentMethodConfig,
"purchase_order_number": "xyz789",
"title": "abc123"
}
SelectedShippingMethod
Description
Contains details about the selected shipping method and carrier.
Fields
| Field Name | Description |
|---|---|
additional_data - [ShippingAdditionalData]
|
Additional data related to the shipping method. |
amount - Money!
|
The cost of shipping using this shipping method. |
carrier_code - String!
|
A string that identifies a commercial carrier or an offline shipping method. |
carrier_title - String!
|
The label for the carrier code. |
method_code - String!
|
A shipping method code associated with a carrier. |
method_title - String!
|
The label for the method code. |
price_excl_tax - Money!
|
The cost of shipping using this shipping method, excluding tax. |
price_incl_tax - Money!
|
The cost of shipping using this shipping method, including tax. |
Example
{
"additional_data": [ShippingAdditionalData],
"amount": Money,
"carrier_code": "xyz789",
"carrier_title": "abc123",
"method_code": "abc123",
"method_title": "xyz789",
"price_excl_tax": Money,
"price_incl_tax": Money
}
SendNegotiableQuoteForReviewInput
Description
Specifies which negotiable quote to send for review.
Fields
| Input Field | Description |
|---|---|
comment - NegotiableQuoteCommentInput
|
A comment for the seller to review. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"comment": NegotiableQuoteCommentInput,
"quote_uid": "4"
}
SendNegotiableQuoteForReviewOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after sending for seller review. |
Example
{"quote": NegotiableQuote}
SetBillingAddressOnCartInput
Description
Sets the billing address.
Fields
| Input Field | Description |
|---|---|
billing_address - BillingAddressInput!
|
The billing address. |
cart_id - String!
|
The unique ID of a Cart object. |
Example
{
"billing_address": BillingAddressInput,
"cart_id": "xyz789"
}
SetBillingAddressOnCartOutput
Description
Contains details about the cart after setting the billing address.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after setting the billing address. |
Example
{"cart": Cart}
SetCartAsInactiveOutput
SetCustomAttributesOnCompanyInput
Description
Defines the company custom attributes.
Fields
| Input Field | Description |
|---|---|
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for company. |
id - ID!
|
The unique ID of a company object. |
Example
{"custom_attributes": [CustomAttributeInput], "id": 4}
SetCustomAttributesOnCompanyOutput
Description
Contains the company.
Fields
| Field Name | Description |
|---|---|
company - Company
|
The company after assigning custom attributes. |
Example
{"company": Company}
SetCustomAttributesOnNegotiableQuoteInput
Description
Defines the negotiable quote custom attributes.
Fields
| Input Field | Description |
|---|---|
custom_attributes - [CustomAttributeInput]
|
An array of custom attributes for NegotiableQuote. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"custom_attributes": [CustomAttributeInput],
"quote_uid": 4
}
SetCustomAttributesOnNegotiableQuoteOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after assigning custom attributes. |
Example
{"quote": NegotiableQuote}
SetGiftOptionsOnCartInput
Description
Defines the gift options applied to the cart.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID that identifies the shopper's cart. |
gift_message - GiftMessageInput
|
Gift message details for the cart. |
gift_receipt_included - Boolean!
|
Whether customer requested gift receipt for the cart. |
gift_wrapping_id - ID
|
The unique ID for a GiftWrapping object to be used for the cart. |
printed_card_included - Boolean!
|
Whether customer requested printed card for the cart. |
Example
{
"cart_id": "abc123",
"gift_message": GiftMessageInput,
"gift_receipt_included": true,
"gift_wrapping_id": 4,
"printed_card_included": false
}
SetGiftOptionsOnCartOutput
Description
Contains the cart after gift options have been applied.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The modified cart object. |
Example
{"cart": Cart}
SetGuestEmailOnCartInput
Description
Defines the guest email and cart.
Example
{
"cart_id": "abc123",
"email": "abc123"
}
SetGuestEmailOnCartOutput
Description
Contains details about the cart after setting the email of a guest.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after setting the guest email. |
Example
{"cart": Cart}
SetLineItemNoteOutput
Description
Contains the updated negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after sending for seller review. |
Example
{"quote": NegotiableQuote}
SetNegotiableQuoteBillingAddressInput
Description
Sets the billing address.
Fields
| Input Field | Description |
|---|---|
billing_address - NegotiableQuoteBillingAddressInput!
|
The billing address to be added. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"billing_address": NegotiableQuoteBillingAddressInput,
"quote_uid": "4"
}
SetNegotiableQuoteBillingAddressOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after assigning a billing address. |
Example
{"quote": NegotiableQuote}
SetNegotiableQuotePaymentMethodInput
Description
Defines the payment method of the specified negotiable quote.
Fields
| Input Field | Description |
|---|---|
payment_method - NegotiableQuotePaymentMethodInput!
|
The payment method to be assigned to the negotiable quote. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"payment_method": NegotiableQuotePaymentMethodInput,
"quote_uid": "4"
}
SetNegotiableQuotePaymentMethodOutput
Description
Contains details about the negotiable quote after setting the payment method.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The updated negotiable quote. |
Example
{"quote": NegotiableQuote}
SetNegotiableQuoteShippingAddressInput
Description
Defines the shipping address to assign to the negotiable quote.
Fields
| Input Field | Description |
|---|---|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
shipping_addresses - [NegotiableQuoteShippingAddressInput]
|
An array of shipping addresses to apply to the negotiable quote. |
Example
{
"quote_uid": 4,
"shipping_addresses": [
NegotiableQuoteShippingAddressInput
]
}
SetNegotiableQuoteShippingAddressOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after assigning a shipping address. |
Example
{"quote": NegotiableQuote}
SetNegotiableQuoteShippingMethodsInput
Description
Defines the shipping method to apply to the negotiable quote.
Fields
| Input Field | Description |
|---|---|
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
shipping_methods - [ShippingMethodInput]!
|
An array of shipping methods to apply to the negotiable quote. |
Example
{
"quote_uid": 4,
"shipping_methods": [ShippingMethodInput]
}
SetNegotiableQuoteShippingMethodsOutput
Description
Contains the negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The negotiable quote after applying shipping methods. |
Example
{"quote": NegotiableQuote}
SetNegotiableQuoteTemplateShippingAddressInput
Description
Defines the shipping address to assign to the negotiable quote template.
Fields
| Input Field | Description |
|---|---|
shipping_address - NegotiableQuoteTemplateShippingAddressInput!
|
A shipping adadress to apply to the negotiable quote template. |
template_id - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"shipping_address": NegotiableQuoteTemplateShippingAddressInput,
"template_id": 4
}
SetPaymentMethodOnCartInput
Description
Applies a payment method to the cart.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
payment_method - PaymentMethodInput!
|
The payment method data to apply to the cart. |
Example
{
"cart_id": "xyz789",
"payment_method": PaymentMethodInput
}
SetPaymentMethodOnCartOutput
Description
Contains details about the cart after setting the payment method.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after setting the payment method. |
Example
{"cart": Cart}
SetShippingAddressesOnCartInput
Description
Specifies an array of addresses to use for shipping.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
shipping_addresses - [ShippingAddressInput]!
|
An array of shipping addresses. |
Example
{
"cart_id": "abc123",
"shipping_addresses": [ShippingAddressInput]
}
SetShippingAddressesOnCartOutput
Description
Contains details about the cart after setting the shipping addresses.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after setting the shipping addresses. |
Example
{"cart": Cart}
SetShippingMethodsOnCartInput
Description
Applies one or shipping methods to the cart.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
shipping_methods - [ShippingMethodInput]!
|
An array of shipping methods. |
Example
{
"cart_id": "xyz789",
"shipping_methods": [ShippingMethodInput]
}
SetShippingMethodsOnCartOutput
Description
Contains details about the cart after setting the shipping methods.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after setting the shipping methods. |
Example
{"cart": Cart}
ShipBundleItemsEnum
Description
Defines whether bundle items must be shipped together.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TOGETHER"
ShipmentItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID for a ShipmentItemInterface object. |
order_item - OrderItemInterface
|
The order item associated with the shipment item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product. |
product_sku - String!
|
The SKU of the base product. |
quantity_shipped - Float!
|
The number of shipped items. |
Example
{
"id": 4,
"order_item": OrderItemInterface,
"product_name": "abc123",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_shipped": 987.65
}
ShipmentItemInterface
Description
Order shipment item details.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID for a ShipmentItemInterface object. |
order_item - OrderItemInterface
|
The order item associated with the shipment item. |
product_name - String
|
The name of the base product. |
product_sale_price - Money!
|
The sale price for the base product. |
product_sku - String!
|
The SKU of the base product. |
quantity_shipped - Float!
|
The number of shipped items. |
Possible Types
| ShipmentItemInterface Types |
|---|
Example
{
"id": 4,
"order_item": OrderItemInterface,
"product_name": "xyz789",
"product_sale_price": Money,
"product_sku": "abc123",
"quantity_shipped": 123.45
}
ShipmentTracking
Description
Contains order shipment tracking details.
Example
{
"carrier": "xyz789",
"number": "xyz789",
"title": "xyz789"
}
ShippingAdditionalData
Example
{
"key": "abc123",
"value": "xyz789"
}
ShippingAddressInput
Description
Defines a single shipping address.
Fields
| Input Field | Description |
|---|---|
address - CartAddressInput
|
Defines a shipping address. |
customer_address_id - Int
|
An ID from the customer's address book that uniquely identifies the address to be used for shipping. |
customer_notes - String
|
Text provided by the shopper. |
pickup_location_code - String
|
The code of Pickup Location which will be used for In-Store Pickup. |
Example
{
"address": CartAddressInput,
"customer_address_id": 987,
"customer_notes": "abc123",
"pickup_location_code": "abc123"
}
ShippingCartAddress
Description
Contains shipping addresses and methods.
Fields
| Field Name | Description |
|---|---|
available_shipping_methods - [AvailableShippingMethod]
|
An array that lists the shipping methods that can be applied to the cart. |
cart_items_v2 - [CartItemInterface]
|
An array that lists the items in the cart. |
city - String!
|
The city specified for the billing or shipping address. |
company - String
|
The company specified for the billing or shipping address. |
country - CartAddressCountry!
|
An object containing the country label and code. |
custom_attributes - [AttributeValueInterface]!
|
The custom attribute values of the billing or shipping address. |
customer_notes - String
|
Text provided by the shopper. |
fax - String
|
The customer's fax number. |
firstname - String!
|
The first name of the customer or guest. |
id - Int
|
Id of the customer address. |
lastname - String!
|
The last name of the customer or guest. |
middlename - String
|
The middle name of the person associated with the billing/shipping address. |
pickup_location_code - String
|
|
postcode - String
|
The ZIP or postal code of the billing or shipping address. |
prefix - String
|
An honorific, such as Dr., Mr., or Mrs. |
region - CartAddressRegion
|
An object containing the region label and code. |
same_as_billing - Boolean!
|
Indicates whether the shipping address is same as billing address. |
selected_shipping_method - SelectedShippingMethod
|
An object that describes the selected shipping method. |
street - [String]!
|
An array containing the street for the billing or shipping address. |
suffix - String
|
A value such as Sr., Jr., or III. |
telephone - String
|
The telephone number for the billing or shipping address. |
uid - String!
|
The unique id of the customer address. |
vat_id - String
|
The VAT company number for billing or shipping address. |
Example
{
"available_shipping_methods": [AvailableShippingMethod],
"cart_items_v2": [CartItemInterface],
"city": "xyz789",
"company": "xyz789",
"country": CartAddressCountry,
"custom_attributes": [AttributeValueInterface],
"customer_notes": "abc123",
"fax": "xyz789",
"firstname": "xyz789",
"id": 987,
"lastname": "abc123",
"middlename": "xyz789",
"pickup_location_code": "abc123",
"postcode": "xyz789",
"prefix": "abc123",
"region": CartAddressRegion,
"same_as_billing": false,
"selected_shipping_method": SelectedShippingMethod,
"street": ["abc123"],
"suffix": "abc123",
"telephone": "abc123",
"uid": "abc123",
"vat_id": "abc123"
}
ShippingDiscount
Description
Defines an individual shipping discount. This discount can be applied to shipping.
Fields
| Field Name | Description |
|---|---|
amount - Money!
|
The amount of the discount. |
Example
{"amount": Money}
ShippingHandling
Description
Contains details about shipping and handling costs.
Fields
| Field Name | Description |
|---|---|
amount_excluding_tax - Money
|
The shipping amount, excluding tax. |
amount_including_tax - Money
|
The shipping amount, including tax. |
discounts - [ShippingDiscount]
|
The applied discounts to the shipping. |
taxes - [TaxItem]
|
Details about taxes applied for shipping. |
total_amount - Money!
|
The total amount for shipping. |
Example
{
"amount_excluding_tax": Money,
"amount_including_tax": Money,
"discounts": [ShippingDiscount],
"taxes": [TaxItem],
"total_amount": Money
}
ShippingMethodInput
Description
Defines the shipping carrier and method.
Fields
| Input Field | Description |
|---|---|
carrier_code - String!
|
A string that identifies a commercial carrier or an offline delivery method. |
method_code - String!
|
A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page. |
Example
{
"carrier_code": "xyz789",
"method_code": "abc123"
}
SimpleCartItem
Description
An implementation for simple product cart items.
Fields
| Field Name | Description |
|---|---|
available_gift_wrapping - [GiftWrapping]!
|
The list of available gift wrapping options for the cart item. |
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array containing the customizable options the shopper selected. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
gift_message - GiftMessage
|
The entered gift message for the cart item |
gift_wrapping - GiftWrapping
|
The selected gift wrapping for the cart item. |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"available_gift_wrapping": [GiftWrapping],
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"gift_message": GiftMessage,
"gift_wrapping": GiftWrapping,
"is_available": true,
"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": 987.65,
"uid": 4
}
SimpleProduct
Description
Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
weight - Float
|
The weight of the item, in units defined by the store. |
Example
{
"canonical_url": "xyz789",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"manufacturer": 987,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "xyz789",
"meta_title": "xyz789",
"min_sale_qty": 123.45,
"name": "abc123",
"new_from_date": "xyz789",
"new_to_date": "abc123",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "xyz789",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 987.65,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "abc123",
"small_image": ProductImage,
"special_price": 987.65,
"special_to_date": "xyz789",
"stock_status": "IN_STOCK",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": 4,
"upsell_products": [ProductInterface],
"url_key": "xyz789",
"weight": 987.65
}
SimpleProductView
Description
Represents simple products. Simple product prices do not contain price ranges.
Fields
| Field Name | Description |
|---|---|
addToCartAllowed - Boolean
|
A flag stating if the product can be added to cart This field is deprecated and will be removed. |
inStock - Boolean
|
A flag stating if the product is in stock This field is deprecated and will be removed. |
lowStock - Boolean
|
A flag stating if the product stock is low This field is deprecated and will be removed. |
attributes - [ProductViewAttribute]
|
A list of merchant-defined attributes designated for the storefront. |
Arguments
|
|
description - String
|
The detailed description of the product. |
id - ID!
|
The product ID, generated as a composite key, unique per locale. |
images - [ProductViewImage]
|
A list of images defined for the product. |
Arguments
|
|
videos - [ProductViewVideo]
|
A list of videos defined for the product. |
inputOptions - [ProductViewInputOption]
|
A list of input options. This field is deprecated and will be removed. |
lastModifiedAt - DateTime
|
Date and time when the product was last updated. |
metaDescription - String
|
A brief overview of the product for search results listings. |
metaKeyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
metaTitle - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
name - String
|
Product name. |
price - ProductViewPrice
|
Base product price view. |
shortDescription - String
|
A summary of the product. |
sku - String
|
Product SKU. |
externalId - String
|
External Id This field is deprecated and will be removed. |
url - String
|
Canonical URL of the product. This field is deprecated and will be removed. |
urlKey - String
|
The URL key of the product. |
links - [ProductViewLink]
|
A list of product links |
Arguments
|
|
queryType - String
|
Indicates if the product was retrieved from the primary or the backup query |
visibility - String
|
Visibility setting of the product |
Example
{
"addToCartAllowed": true,
"inStock": false,
"lowStock": false,
"attributes": [ProductViewAttribute],
"description": "abc123",
"id": 4,
"images": [ProductViewImage],
"videos": [ProductViewVideo],
"inputOptions": [ProductViewInputOption],
"lastModifiedAt": "2007-12-03T10:15:30Z",
"metaDescription": "xyz789",
"metaKeyword": "xyz789",
"metaTitle": "abc123",
"name": "abc123",
"price": ProductViewPrice,
"shortDescription": "xyz789",
"sku": "abc123",
"externalId": "xyz789",
"url": "xyz789",
"urlKey": "xyz789",
"links": [ProductViewLink],
"queryType": "abc123",
"visibility": "xyz789"
}
SimpleRequisitionListItem
Description
Contains details about simple products added to a requisition list.
Fields
| Field Name | Description |
|---|---|
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The amount added. |
uid - ID!
|
The unique ID for the requisition list item. |
Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 987.65,
"uid": "4"
}
SimpleWishlistItem
Description
Contains a simple product wish list item.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
"product": ProductInterface,
"quantity": 987.65
}
SmartButtonMethodInput
Description
Smart button payment inputs
Example
{
"payment_source": "xyz789",
"payments_order_id": "xyz789",
"paypal_order_id": "xyz789"
}
SmartButtonsConfig
Fields
| Field Name | Description |
|---|---|
button_styles - ButtonStyles
|
The styles for the PayPal Smart Button configuration |
code - String
|
The payment method code as defined in the payment gateway |
display_message - Boolean
|
Indicates whether to display the PayPal Pay Later message |
display_venmo - Boolean
|
Indicates whether to display Venmo |
is_visible - Boolean
|
Indicates whether the payment method is displayed |
message_styles - MessageStyles
|
Contains details about the styles for the PayPal Pay Later message |
payment_intent - String
|
Defines the payment intent (Authorize or Capture |
sdk_params - [SDKParams]
|
The PayPal parameters required to load the JS SDK |
sort_order - String
|
The relative order the payment method is displayed on the checkout page |
title - String
|
The name displayed for the payment method |
Example
{
"button_styles": ButtonStyles,
"code": "xyz789",
"display_message": true,
"display_venmo": true,
"is_visible": false,
"message_styles": MessageStyles,
"payment_intent": "abc123",
"sdk_params": [SDKParams],
"sort_order": "abc123",
"title": "xyz789"
}
SortEnum
Description
Indicates whether to return results in ascending or descending order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SortField
Description
Defines a possible sort field.
Example
{
"label": "xyz789",
"value": "xyz789"
}
SortFields
Description
Contains a default value for sort fields and all available sort fields.
Fields
| Field Name | Description |
|---|---|
default - String
|
The default sort field value. |
options - [SortField]
|
An array of possible sort fields. |
Example
{
"default": "abc123",
"options": [SortField]
}
SortQuoteItemsEnum
Description
Specifies the field to use for sorting quote items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ITEM_ID"
SortableAttribute
Description
Contains product attributes that be used for sorting in a productSearch query
Fields
| Field Name | Description |
|---|---|
attribute - String!
|
The unique identifier for an attribute code. This value should be in lowercase letters and without space |
frontendInput - String
|
Indicates how field rendered on storefront |
label - String
|
The display name assigned to the attribute |
numeric - Boolean
|
Indicates whether this attribute has a numeric value, such as a price or integer |
Example
{
"attribute": "abc123",
"frontendInput": "xyz789",
"label": "xyz789",
"numeric": true
}
StatsBucket
Description
For retrieving statistics across multiple buckets
Example
{
"max": 123.45,
"min": 987.65,
"title": "abc123"
}
StoreConfig
Description
Contains information about a store's configuration.
Fields
| Field Name | Description |
|---|---|
allow_gift_receipt - String
|
Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No). |
allow_gift_wrapping_on_order - String
|
Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No). |
allow_gift_wrapping_on_order_items - String
|
Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No). |
allow_items - String
|
The value of the Allow Gift Messages for Order Items option |
allow_order - String
|
The value of the Allow Gift Messages on Order Level option |
allow_printed_card - String
|
Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). |
autocomplete_on_storefront - Boolean
|
Indicates whether to enable autocomplete on login and forgot password forms. |
base_currency_code - String
|
The base currency code. |
base_link_url - String
|
A fully-qualified URL that is used to create relative links to the base_url. |
base_media_url - String
|
The fully-qualified URL that specifies the location of media files. |
base_static_url - String
|
The fully-qualified URL that specifies the location of static view files. |
base_url - String
|
The store’s fully-qualified base URL. |
cart_expires_in_days - Int
|
checkout/cart/delete_quote_after: quote lifetime in days. |
cart_gift_wrapping - String
|
Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). |
cart_merge_preference - String!
|
Configuration data from checkout/cart/cart_merge_preference |
cart_printed_card - String
|
Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). |
cart_summary_display_quantity - Int
|
checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities. |
catalog_default_sort_by - String
|
The default sort order of the search results list. |
category_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
|
Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages. |
category_url_suffix - String
|
The suffix applied to category pages, such as .htm or .html. |
check_money_order_enable_for_specific_countries - Boolean
|
Indicates whether only specific countries can use this payment method. |
check_money_order_enabled - Boolean
|
Indicates whether the Check/Money Order payment method is enabled. |
check_money_order_make_check_payable_to - String
|
The name of the party to whom the check must be payable. |
check_money_order_max_order_total - String
|
The maximum order amount required to qualify for the Check/Money Order payment method. |
check_money_order_min_order_total - String
|
The minimum order amount required to qualify for the Check/Money Order payment method. |
check_money_order_new_order_status - String
|
The status of new orders placed using the Check/Money Order payment method. |
check_money_order_payment_from_specific_countries - String
|
A comma-separated list of specific countries allowed to use the Check/Money Order payment method. |
check_money_order_send_check_to - String
|
The full street address or PO Box where the checks are mailed. |
check_money_order_sort_order - Int
|
A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout. |
check_money_order_title - String
|
The title of the Check/Money Order payment method displayed on the storefront. |
configurable_product_image - ProductImageThumbnail!
|
checkout/cart/configurable_product_image: which image to use for configurable products. |
configurable_thumbnail_source - String
|
Indicates whether the parent or child (itself) thumbnail should be used in the cart for configurable products. |
contact_enabled - Boolean!
|
Indicates whether the Contact Us form in enabled. |
countries_with_required_region - String
|
Extended Config Data - general/region/state_required |
create_account_confirmation - Boolean
|
Indicates if the new accounts need confirmation. |
customer_access_token_lifetime - Float
|
Customer access token lifetime. |
default_country - String
|
Extended Config Data - general/country/default |
default_display_currency_code - String
|
The default display currency code. |
display_product_prices_in_catalog - Int!
|
Configuration data from tax/display/type |
display_shipping_prices - Int!
|
Configuration data from tax/display/shipping |
display_state_if_optional - Boolean
|
Extended Config Data - general/region/display_all |
enable_multiple_wishlists - String
|
Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). |
fixed_product_taxes_apply_tax_to_fpt - Boolean!
|
Configuration data from tax/weee/apply_vat |
fixed_product_taxes_display_prices_in_emails - Int!
|
Configuration data from tax/weee/display_email |
fixed_product_taxes_display_prices_in_product_lists - Int!
|
Configuration data from tax/weee/display_list |
fixed_product_taxes_display_prices_in_sales_modules - Int!
|
Configuration data from tax/weee/display_sales |
fixed_product_taxes_display_prices_on_product_view_page - Int!
|
Configuration data from tax/weee/display |
fixed_product_taxes_enable - Boolean!
|
Configuration data from tax/weee/enable |
fixed_product_taxes_include_fpt_in_subtotal - Boolean!
|
Configuration data from tax/weee/include_in_subtotal |
graphql_share_customer_group - Boolean!
|
Configuration data from customer/account_information/graphql_share_customer_group |
grid_per_page - Int
|
The default number of products per page in Grid View. |
grid_per_page_values - String
|
A list of numbers that define how many products can be displayed in Grid View. |
grouped_product_image - ProductImageThumbnail!
|
checkout/cart/grouped_product_image: which image to use for grouped products. |
is_checkout_agreements_enabled - Boolean!
|
Configuration data from checkout/options/enable_agreements |
is_default_store - Boolean
|
Indicates whether the store view has been designated as the default within the store group. |
is_default_store_group - Boolean
|
Indicates whether the store group has been designated as the default within the website. |
is_guest_checkout_enabled - Boolean
|
checkout/options/guest_checkout: whether the guest checkout is enabled or not. |
is_negotiable_quote_active - Boolean
|
Indicates whether negotiable quote functionality is enabled. |
is_one_page_checkout_enabled - Boolean
|
checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not |
is_requisition_list_active - String
|
Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). |
list_mode - String
|
The format of the search results list. |
list_per_page - Int
|
The default number of products per page in List View. |
list_per_page_values - String
|
A list of numbers that define how many products can be displayed in List View. |
locale - String
|
The store locale. |
magento_reward_general_is_enabled - String
|
Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). |
magento_reward_general_is_enabled_on_front - String
|
Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled). |
magento_reward_general_min_points_balance - String
|
The minimum point balance customers must have before they can redeem them. A null value indicates no minimum. |
magento_reward_general_publish_history - String
|
When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled). |
magento_reward_points_invitation_customer - String
|
The number of points for a referral when an invitee registers on the site. |
magento_reward_points_invitation_customer_limit - String
|
The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. |
magento_reward_points_invitation_order - String
|
The number of points for a referral, when an invitee places their first order on the site. |
magento_reward_points_invitation_order_limit - String
|
The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit. |
magento_reward_points_newsletter - String
|
The number of points earned by registered customers who subscribe to a newsletter. |
magento_reward_points_order - String
|
Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance. |
magento_reward_points_register - String
|
The number of points customer gets for registering. |
magento_reward_points_review - String
|
The number of points for writing a review. |
magento_reward_points_review_limit - String
|
The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. |
magento_wishlist_general_is_enabled - String
|
Indicates whether wishlists are enabled (1) or disabled (0). |
max_items_in_order_summary - Int
|
checkout/options/max_items_display_count: maximum number of items to display in order summary. |
maximum_number_of_wishlists - String
|
If multiple wish lists are enabled, the maximum number of wish lists the customer can have. |
minicart_display - Boolean
|
checkout/sidebar/display: whether to display the minicart or not. |
minicart_max_items - Int
|
checkout/sidebar/count: maximum number of items to show in minicart. |
minimum_password_length - String
|
The minimum number of characters required for a valid password. |
newsletter_enabled - Boolean!
|
Indicates whether newsletters are enabled. |
optional_zip_countries - String
|
Extended Config Data - general/country/optional_zip_countries |
order_cancellation_enabled - Boolean!
|
Indicates whether orders can be cancelled by customers or not. |
order_cancellation_reasons - [CancellationReason]!
|
An array containing available cancellation reasons. |
orders_invoices_credit_memos_display_full_summary - Boolean!
|
Configuration data from tax/sales_display/full_summary |
orders_invoices_credit_memos_display_grandtotal - Boolean!
|
Configuration data from tax/sales_display/grandtotal |
orders_invoices_credit_memos_display_price - Int!
|
Configuration data from tax/sales_display/price |
orders_invoices_credit_memos_display_shipping_amount - Int!
|
Configuration data from tax/sales_display/shipping |
orders_invoices_credit_memos_display_subtotal - Int!
|
Configuration data from tax/sales_display/subtotal |
orders_invoices_credit_memos_display_zero_tax - Boolean!
|
Configuration data from tax/sales_display/zero_tax |
printed_card_priceV2 - Money
|
The default price of a printed card that accompanies an order. |
product_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
|
Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages. |
product_url_suffix - String
|
The suffix applied to product pages, such as .htm or .html. |
quickorder_active - Boolean!
|
Indicates whether quick order functionality is enabled. |
required_character_classes_number - String
|
The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. |
returns_enabled - String!
|
Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. |
root_category_uid - ID
|
The unique ID for a CategoryInterface object. |
sales_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings
|
Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages. |
sales_gift_wrapping - String
|
Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). |
sales_printed_card - String
|
Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). |
secure_base_link_url - String
|
A secure fully-qualified URL that is used to create relative links to the base_url. |
secure_base_media_url - String
|
The secure fully-qualified URL that specifies the location of media files. |
secure_base_static_url - String
|
The secure fully-qualified URL that specifies the location of static view files. |
secure_base_url - String
|
The store’s fully-qualified secure base URL. |
share_active_segments - Boolean!
|
Configuration data from customer/magento_customersegment/share_active_segments |
share_applied_cart_rule - Boolean!
|
Configuration data from promo/graphql/share_applied_cart_rule |
shopping_cart_display_full_summary - Boolean
|
Extended Config Data - tax/cart_display/full_summary |
shopping_cart_display_grand_total - Boolean
|
Extended Config Data - tax/cart_display/grandtotal |
shopping_cart_display_price - Int
|
Extended Config Data - tax/cart_display/price |
shopping_cart_display_shipping - Int
|
Extended Config Data - tax/cart_display/shipping |
shopping_cart_display_subtotal - Int
|
Extended Config Data - tax/cart_display/subtotal |
shopping_cart_display_tax_gift_wrapping - TaxWrappingEnum
|
Extended Config Data - tax/cart_display/gift_wrapping |
shopping_cart_display_zero_tax - Boolean
|
Extended Config Data - tax/cart_display/zero_tax |
store_code - ID
|
The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the Store header to provide the scope. |
store_group_code - ID
|
The unique ID assigned to the store group. In the Admin, this is called the Store Name. |
store_group_name - String
|
The label assigned to the store group. |
store_name - String
|
The label assigned to the store view. |
store_sort_order - Int
|
The store view sort order. |
timezone - String
|
The time zone of the store. |
title_separator - String
|
The character that separates the category name and subcategory in the browser title bar. |
use_store_in_url - Boolean
|
Indicates whether the store code should be used in the URL. |
website_code - ID
|
The unique ID for the website. |
website_name - String
|
The label assigned to the website. |
weight_unit - String
|
The unit of weight. |
zero_subtotal_enable_for_specific_countries - Boolean
|
Indicates whether only specific countries can use this payment method. |
zero_subtotal_enabled - Boolean
|
Indicates whether the Zero Subtotal payment method is enabled. |
zero_subtotal_new_order_status - String
|
The status of new orders placed using the Zero Subtotal payment method. |
zero_subtotal_payment_action - String
|
When the new order status is 'Processing', this can be set to authorize_capture to automatically invoice all items that have a zero balance. |
zero_subtotal_payment_from_specific_countries - String
|
A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. |
zero_subtotal_sort_order - Int
|
A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout. |
zero_subtotal_title - String
|
The title of the Zero Subtotal payment method displayed on the storefront. |
Example
{
"allow_gift_receipt": "abc123",
"allow_gift_wrapping_on_order": "abc123",
"allow_gift_wrapping_on_order_items": "abc123",
"allow_items": "xyz789",
"allow_order": "abc123",
"allow_printed_card": "abc123",
"autocomplete_on_storefront": true,
"base_currency_code": "xyz789",
"base_link_url": "xyz789",
"base_media_url": "xyz789",
"base_static_url": "abc123",
"base_url": "xyz789",
"cart_expires_in_days": 123,
"cart_gift_wrapping": "xyz789",
"cart_merge_preference": "xyz789",
"cart_printed_card": "xyz789",
"cart_summary_display_quantity": 987,
"catalog_default_sort_by": "xyz789",
"category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"category_url_suffix": "abc123",
"check_money_order_enable_for_specific_countries": true,
"check_money_order_enabled": true,
"check_money_order_make_check_payable_to": "xyz789",
"check_money_order_max_order_total": "xyz789",
"check_money_order_min_order_total": "xyz789",
"check_money_order_new_order_status": "abc123",
"check_money_order_payment_from_specific_countries": "abc123",
"check_money_order_send_check_to": "abc123",
"check_money_order_sort_order": 987,
"check_money_order_title": "abc123",
"configurable_product_image": "ITSELF",
"configurable_thumbnail_source": "abc123",
"contact_enabled": false,
"countries_with_required_region": "abc123",
"create_account_confirmation": false,
"customer_access_token_lifetime": 123.45,
"default_country": "abc123",
"default_display_currency_code": "abc123",
"display_product_prices_in_catalog": 123,
"display_shipping_prices": 987,
"display_state_if_optional": false,
"enable_multiple_wishlists": "xyz789",
"fixed_product_taxes_apply_tax_to_fpt": false,
"fixed_product_taxes_display_prices_in_emails": 987,
"fixed_product_taxes_display_prices_in_product_lists": 987,
"fixed_product_taxes_display_prices_in_sales_modules": 987,
"fixed_product_taxes_display_prices_on_product_view_page": 123,
"fixed_product_taxes_enable": false,
"fixed_product_taxes_include_fpt_in_subtotal": false,
"graphql_share_customer_group": true,
"grid_per_page": 987,
"grid_per_page_values": "abc123",
"grouped_product_image": "ITSELF",
"is_checkout_agreements_enabled": true,
"is_default_store": false,
"is_default_store_group": true,
"is_guest_checkout_enabled": true,
"is_negotiable_quote_active": false,
"is_one_page_checkout_enabled": true,
"is_requisition_list_active": "xyz789",
"list_mode": "xyz789",
"list_per_page": 987,
"list_per_page_values": "abc123",
"locale": "abc123",
"magento_reward_general_is_enabled": "abc123",
"magento_reward_general_is_enabled_on_front": "abc123",
"magento_reward_general_min_points_balance": "xyz789",
"magento_reward_general_publish_history": "abc123",
"magento_reward_points_invitation_customer": "xyz789",
"magento_reward_points_invitation_customer_limit": "xyz789",
"magento_reward_points_invitation_order": "xyz789",
"magento_reward_points_invitation_order_limit": "xyz789",
"magento_reward_points_newsletter": "xyz789",
"magento_reward_points_order": "xyz789",
"magento_reward_points_register": "abc123",
"magento_reward_points_review": "abc123",
"magento_reward_points_review_limit": "abc123",
"magento_wishlist_general_is_enabled": "xyz789",
"max_items_in_order_summary": 123,
"maximum_number_of_wishlists": "abc123",
"minicart_display": false,
"minicart_max_items": 987,
"minimum_password_length": "abc123",
"newsletter_enabled": false,
"optional_zip_countries": "abc123",
"order_cancellation_enabled": true,
"order_cancellation_reasons": [CancellationReason],
"orders_invoices_credit_memos_display_full_summary": false,
"orders_invoices_credit_memos_display_grandtotal": true,
"orders_invoices_credit_memos_display_price": 123,
"orders_invoices_credit_memos_display_shipping_amount": 123,
"orders_invoices_credit_memos_display_subtotal": 123,
"orders_invoices_credit_memos_display_zero_tax": false,
"printed_card_priceV2": Money,
"product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"product_url_suffix": "xyz789",
"quickorder_active": false,
"required_character_classes_number": "abc123",
"returns_enabled": "xyz789",
"root_category_uid": "4",
"sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
"sales_gift_wrapping": "abc123",
"sales_printed_card": "xyz789",
"secure_base_link_url": "abc123",
"secure_base_media_url": "xyz789",
"secure_base_static_url": "xyz789",
"secure_base_url": "abc123",
"share_active_segments": false,
"share_applied_cart_rule": true,
"shopping_cart_display_full_summary": false,
"shopping_cart_display_grand_total": true,
"shopping_cart_display_price": 987,
"shopping_cart_display_shipping": 987,
"shopping_cart_display_subtotal": 987,
"shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
"shopping_cart_display_zero_tax": false,
"store_code": "4",
"store_group_code": 4,
"store_group_name": "xyz789",
"store_name": "abc123",
"store_sort_order": 987,
"timezone": "abc123",
"title_separator": "abc123",
"use_store_in_url": true,
"website_code": "4",
"website_name": "abc123",
"weight_unit": "xyz789",
"zero_subtotal_enable_for_specific_countries": false,
"zero_subtotal_enabled": true,
"zero_subtotal_new_order_status": "xyz789",
"zero_subtotal_payment_action": "xyz789",
"zero_subtotal_payment_from_specific_countries": "abc123",
"zero_subtotal_sort_order": 987,
"zero_subtotal_title": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubmitNegotiableQuoteTemplateForReviewInput
Description
Specifies the quote template properties to update.
Fields
| Input Field | Description |
|---|---|
comment - String
|
A comment for the seller to review. |
max_order_commitment - Int
|
Commitment for maximum orders |
min_order_commitment - Int
|
Commitment for minimum orders |
name - String
|
The title assigned to the negotiable quote template. |
reference_document_links - [NegotiableQuoteTemplateReferenceDocumentLinkInput]
|
An array of reference document links to add to the negotiable quote template. |
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{
"comment": "abc123",
"max_order_commitment": 123,
"min_order_commitment": 987,
"name": "xyz789",
"reference_document_links": [
NegotiableQuoteTemplateReferenceDocumentLinkInput
],
"template_id": 4
}
SubscribeEmailToNewsletterOutput
Description
Contains the result of the subscribeEmailToNewsletter operation.
Fields
| Field Name | Description |
|---|---|
status - SubscriptionStatusesEnum
|
The status of the subscription request. |
Example
{"status": "NOT_ACTIVE"}
SubscriptionStatusesEnum
Description
Indicates the status of the request.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_ACTIVE"
Subtree
Example
{"depth": 123, "startLevel": 987}
SwatchDataInterface
Fields
| Field Name | Description |
|---|---|
value - String
|
The value can be represented as color (HEX code), image link, or text. |
Possible Types
| SwatchDataInterface Types |
|---|
Example
{"value": "abc123"}
SwatchInputTypeEnum
Description
Swatch attribute metadata input types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOLEAN"
SwatchType
SyncPaymentOrderInput
Description
Synchronizes the payment order details
Example
{
"cartId": "abc123",
"id": "xyz789"
}
TaxItem
Description
Contains tax item details.
Example
{
"amount": Money,
"rate": 987.65,
"title": "abc123"
}
TaxWrappingEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DISPLAY_EXCLUDING_TAX"
TextSwatchData
Fields
| Field Name | Description |
|---|---|
value - String
|
The value can be represented as color (HEX code), image link, or text. |
Example
{"value": "xyz789"}
ThreeDSMode
Description
3D Secure mode.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OFF"
TierPrice
Description
Defines a price based on the quantity purchased.
Fields
| Field Name | Description |
|---|---|
discount - ProductDiscount
|
The price discount that this tier represents. |
final_price - Money
|
The price of the product at this tier. |
quantity - Float
|
The minimum number of items that must be purchased to qualify for this price tier. |
Example
{
"discount": ProductDiscount,
"final_price": Money,
"quantity": 987.65
}
UpdateCartItemsInput
Description
Modifies the specified items in the cart.
Fields
| Input Field | Description |
|---|---|
cart_id - String!
|
The unique ID of a Cart object. |
cart_items - [CartItemUpdateInput]!
|
An array of items to be updated. |
Example
{
"cart_id": "xyz789",
"cart_items": [CartItemUpdateInput]
}
UpdateCartItemsOutput
Description
Contains details about the cart after updating items.
Fields
| Field Name | Description |
|---|---|
cart - Cart!
|
The cart after updating products. |
errors - [CartUserInputError]!
|
Contains errors encountered while updating an item to the cart. |
Example
{
"cart": Cart,
"errors": [CartUserInputError]
}
UpdateCompanyOutput
Description
Contains the response to the request to update the company.
Fields
| Field Name | Description |
|---|---|
company - Company!
|
The updated company instance. |
Example
{"company": Company}
UpdateCompanyRoleOutput
Description
Contains the response to the request to update the company role.
Fields
| Field Name | Description |
|---|---|
role - CompanyRole!
|
The updated company role instance. |
Example
{"role": CompanyRole}
UpdateCompanyStructureOutput
Description
Contains the response to the request to update the company structure.
Fields
| Field Name | Description |
|---|---|
company - Company!
|
The updated company instance. |
Example
{"company": Company}
UpdateCompanyTeamOutput
Description
Contains the response to the request to update a company team.
Fields
| Field Name | Description |
|---|---|
team - CompanyTeam!
|
The updated company team instance. |
Example
{"team": CompanyTeam}
UpdateCompanyUserOutput
Description
Contains the response to the request to update the company user.
Fields
| Field Name | Description |
|---|---|
user - Customer!
|
The updated company user instance. |
Example
{"user": Customer}
UpdateGiftRegistryInput
Description
Defines updates to a GiftRegistry object.
Fields
| Input Field | Description |
|---|---|
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
|
Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. |
event_name - String
|
The updated name of the event. |
message - String
|
The updated message describing the event. |
privacy_settings - GiftRegistryPrivacySettings
|
Indicates whether the gift registry is PRIVATE or PUBLIC. |
shipping_address - GiftRegistryShippingAddressInput
|
The updated shipping address for all gift registry items. |
status - GiftRegistryStatus
|
Indicates whether the gift registry is ACTIVE or INACTIVE. |
Example
{
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
"event_name": "abc123",
"message": "abc123",
"privacy_settings": "PRIVATE",
"shipping_address": GiftRegistryShippingAddressInput,
"status": "ACTIVE"
}
UpdateGiftRegistryItemInput
Description
Defines updates to an item in a gift registry.
Example
{
"gift_registry_item_uid": 4,
"note": "abc123",
"quantity": 123.45
}
UpdateGiftRegistryItemsOutput
Description
Contains the results of a request to update gift registry items.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry after updating updating items. |
Example
{"gift_registry": GiftRegistry}
UpdateGiftRegistryOutput
Description
Contains the results of a request to update a gift registry.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The updated gift registry. |
Example
{"gift_registry": GiftRegistry}
UpdateGiftRegistryRegistrantInput
Description
Defines updates to an existing registrant.
Fields
| Input Field | Description |
|---|---|
dynamic_attributes - [GiftRegistryDynamicAttributeInput]
|
As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed. |
email - String
|
The updated email address of the registrant. |
firstname - String
|
The updated first name of the registrant. |
gift_registry_registrant_uid - ID!
|
The unique ID of a giftRegistryRegistrant object. |
lastname - String
|
The updated last name of the registrant. |
Example
{
"dynamic_attributes": [
GiftRegistryDynamicAttributeInput
],
"email": "xyz789",
"firstname": "xyz789",
"gift_registry_registrant_uid": "4",
"lastname": "abc123"
}
UpdateGiftRegistryRegistrantsOutput
Description
Contains the results a request to update registrants.
Fields
| Field Name | Description |
|---|---|
gift_registry - GiftRegistry
|
The gift registry after updating registrants. |
Example
{"gift_registry": GiftRegistry}
UpdateNegotiableQuoteItemsQuantityOutput
Description
Contains the updated negotiable quote.
Fields
| Field Name | Description |
|---|---|
quote - NegotiableQuote
|
The updated negotiable quote. |
Example
{"quote": NegotiableQuote}
UpdateNegotiableQuoteQuantitiesInput
Description
Specifies the items to update.
Fields
| Input Field | Description |
|---|---|
items - [NegotiableQuoteItemQuantityInput]!
|
An array of items to update. |
quote_uid - ID!
|
The unique ID of a NegotiableQuote object. |
Example
{
"items": [NegotiableQuoteItemQuantityInput],
"quote_uid": 4
}
UpdateNegotiableQuoteTemplateItemsQuantityOutput
Description
Contains the updated negotiable quote template.
Fields
| Field Name | Description |
|---|---|
quote_template - NegotiableQuoteTemplate
|
The updated negotiable quote template. |
Example
{"quote_template": NegotiableQuoteTemplate}
UpdateNegotiableQuoteTemplateQuantitiesInput
Description
Specifies the items to update.
Fields
| Input Field | Description |
|---|---|
items - [NegotiableQuoteTemplateItemQuantityInput]!
|
An array of items to update. |
template_id - ID!
|
The unique ID of a NegotiableQuoteTemplate object. |
Example
{
"items": [NegotiableQuoteTemplateItemQuantityInput],
"template_id": 4
}
UpdateProductsInWishlistOutput
Description
Contains the customer's wish list and any errors encountered.
Fields
| Field Name | Description |
|---|---|
user_errors - [WishListUserInputError]!
|
An array of errors encountered while updating products in a wish list. |
wishlist - Wishlist!
|
Contains the wish list with all items that were successfully updated. |
Example
{
"user_errors": [WishListUserInputError],
"wishlist": Wishlist
}
UpdatePurchaseOrderApprovalRuleInput
Description
Defines the changes to be made to an approval rule.
Fields
| Input Field | Description |
|---|---|
applies_to - [ID]
|
An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future. |
approvers - [ID]
|
An updated list of B2B user roles that can approve this purchase order approval rule. |
condition - CreatePurchaseOrderApprovalRuleConditionInput
|
The updated condition of the purchase order approval rule. |
description - String
|
The updated approval rule description. |
name - String
|
The updated approval rule name. |
status - PurchaseOrderApprovalRuleStatus
|
The updated status of the purchase order approval rule. |
uid - ID!
|
Unique identifier for the purchase order approval rule. |
Example
{
"applies_to": [4],
"approvers": ["4"],
"condition": CreatePurchaseOrderApprovalRuleConditionInput,
"description": "abc123",
"name": "abc123",
"status": "ENABLED",
"uid": 4
}
UpdateRequisitionListInput
Description
An input object that defines which requistion list characteristics to update.
Example
{
"description": "xyz789",
"name": "abc123"
}
UpdateRequisitionListItemsInput
Description
Defines which items in a requisition list to update.
Fields
| Input Field | Description |
|---|---|
entered_options - [EnteredOptionInput]
|
An array of customer-entered options. |
item_id - ID!
|
The ID of the requisition list item to update. |
quantity - Float
|
The new quantity of the item. |
selected_options - [String]
|
An array of selected option IDs. |
Example
{
"entered_options": [EnteredOptionInput],
"item_id": 4,
"quantity": 123.45,
"selected_options": ["xyz789"]
}
UpdateRequisitionListItemsOutput
Description
Output of the request to update items in the specified requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The requisition list after updating items. |
Example
{"requisition_list": RequisitionList}
UpdateRequisitionListOutput
Description
Output of the request to rename the requisition list.
Fields
| Field Name | Description |
|---|---|
requisition_list - RequisitionList
|
The renamed requisition list. |
Example
{"requisition_list": RequisitionList}
UpdateWishlistOutput
Description
Contains the name and visibility of an updated wish list.
Fields
| Field Name | Description |
|---|---|
name - String!
|
The wish list name. |
uid - ID!
|
The unique ID of a Wishlist object. |
visibility - WishlistVisibilityEnum!
|
Indicates whether the wish list is public or private. |
Example
{
"name": "xyz789",
"uid": "4",
"visibility": "PUBLIC"
}
UserCompaniesInput
Description
Defines the input for returning matching companies the customer is assigned to.
Fields
| Input Field | Description |
|---|---|
currentPage - Int
|
Specifies which page of results to return. The default value is 1. |
pageSize - Int
|
Specifies the maximum number of results to return at once. This attribute is optional. |
sort - [CompaniesSortInput]
|
Defines the sorting of the results. |
Example
{
"currentPage": 987,
"pageSize": 123,
"sort": [CompaniesSortInput]
}
UserCompaniesOutput
Description
An object that contains a list of companies customer is assigned to.
Fields
| Field Name | Description |
|---|---|
items - [CompanyBasicInfo]!
|
An array of companies customer is assigned to. |
page_info - SearchResultPageInfo!
|
Provides navigation for the query response. |
Example
{
"items": [CompanyBasicInfo],
"page_info": SearchResultPageInfo
}
ValidatePurchaseOrderError
Description
Contains details about a failed validation attempt.
Fields
| Field Name | Description |
|---|---|
message - String!
|
The returned error message. |
type - ValidatePurchaseOrderErrorType!
|
Error type. |
Example
{"message": "abc123", "type": "NOT_FOUND"}
ValidatePurchaseOrderErrorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOT_FOUND"
ValidatePurchaseOrdersInput
Description
Defines the purchase orders to be validated.
Fields
| Input Field | Description |
|---|---|
purchase_order_uids - [ID]!
|
An array of the purchase order IDs. |
Example
{"purchase_order_uids": [4]}
ValidatePurchaseOrdersOutput
Description
Contains the results of validation attempts.
Fields
| Field Name | Description |
|---|---|
errors - [ValidatePurchaseOrderError]!
|
An array of error messages encountered while performing the operation. |
purchase_orders - [PurchaseOrder]!
|
An array of the purchase orders in the request. |
Example
{
"errors": [ValidatePurchaseOrderError],
"purchase_orders": [PurchaseOrder]
}
ValidationRule
Description
Defines a customer attribute validation rule.
Fields
| Field Name | Description |
|---|---|
name - ValidationRuleEnum
|
Validation rule name applied to a customer attribute. |
value - String
|
Validation rule value. |
Example
{
"name": "DATE_RANGE_MAX",
"value": "abc123"
}
ValidationRuleEnum
Description
List of validation rule names applied to a customer attribute.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE_RANGE_MAX"
VaultConfigOutput
Description
Retrieves the vault configuration
Fields
| Field Name | Description |
|---|---|
credit_card - VaultCreditCardConfig
|
Credit card vault method configuration |
Example
{"credit_card": VaultCreditCardConfig}
VaultCreditCardConfig
Fields
| Field Name | Description |
|---|---|
is_vault_enabled - Boolean
|
Is vault enabled |
sdk_params - [SDKParams]
|
The parameters required to load the Paypal JS SDK |
three_ds_mode - ThreeDSMode
|
3DS mode |
Example
{
"is_vault_enabled": false,
"sdk_params": [SDKParams],
"three_ds_mode": "OFF"
}
VaultMethodInput
Description
Vault payment inputs
Example
{
"payment_source": "abc123",
"payments_order_id": "abc123",
"paypal_order_id": "xyz789",
"public_hash": "xyz789"
}
VaultSetupTokenInput
Description
The payment source information
Fields
| Input Field | Description |
|---|---|
payment_source - PaymentSourceInput!
|
The payment source information |
Example
{"payment_source": PaymentSourceInput}
ViewHistory
Example
{
"date": "2007-12-03T10:15:30Z",
"sku": "xyz789"
}
ViewHistoryInput
Example
{
"dateTime": "2007-12-03T10:15:30Z",
"sku": "xyz789"
}
VirtualCartItem
Description
An implementation for virtual product cart items.
Fields
| Field Name | Description |
|---|---|
custom_attributes - [CustomAttribute]
|
The custom attributes for the cart item |
customizable_options - [SelectedCustomizableOption]!
|
An array containing customizable options the shopper selected. |
discount - [Discount]
|
Contains discount for quote line item. |
errors - [CartItemError]
|
An array of errors encountered while loading the cart item |
is_available - Boolean!
|
True if requested quantity is less than available stock, false otherwise. |
max_qty - Float
|
Line item max qty in quote template |
min_qty - Float
|
Line item min qty in quote template |
not_available_message - String
|
Message to display when the product is not available with this selected option. |
note_from_buyer - [ItemNote]
|
The buyer's quote line item note. |
note_from_seller - [ItemNote]
|
The seller's quote line item note. |
prices - CartItemPrices
|
Contains details about the price of the item, including taxes and discounts. |
product - ProductInterface!
|
Details about an item in the cart. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this item in the cart. |
uid - ID!
|
The unique ID for a CartItemInterface object. |
Example
{
"custom_attributes": [CustomAttribute],
"customizable_options": [SelectedCustomizableOption],
"discount": [Discount],
"errors": [CartItemError],
"is_available": false,
"max_qty": 987.65,
"min_qty": 123.45,
"not_available_message": "xyz789",
"note_from_buyer": [ItemNote],
"note_from_seller": [ItemNote],
"prices": CartItemPrices,
"product": ProductInterface,
"quantity": 123.45,
"uid": "4"
}
VirtualProduct
Description
Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.
Fields
| Field Name | Description |
|---|---|
canonical_url - String
|
The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. |
categories - [CategoryInterface]
|
The categories assigned to a product. |
country_of_manufacture - String
|
The product's country of origin. |
crosssell_products - [ProductInterface]
|
Crosssell Products |
custom_attributesV2 - ProductCustomAttributes
|
Product custom attributes. |
Arguments
|
|
description - ComplexTextValue
|
Detailed information about the product. The value can include simple HTML tags. |
gift_message_available - Boolean!
|
Returns a value indicating gift message availability for the product. |
gift_wrapping_available - Boolean!
|
Returns a value indicating gift wrapping availability for the product. |
gift_wrapping_price - Money
|
Returns value and currency indicating gift wrapping price for the product. |
image - ProductImage
|
The relative path to the main image on the product page. |
is_returnable - String
|
Indicates whether the product can be returned. |
manufacturer - Int
|
A number representing the product's manufacturer. |
max_sale_qty - Float
|
Maximum Qty Allowed in Shopping Cart |
media_gallery - [MediaGalleryInterface]
|
An array of media gallery objects. |
meta_description - String
|
A brief overview of the product for search results listings, maximum 255 characters. |
meta_keyword - String
|
A comma-separated list of keywords that are visible only to search engines. |
meta_title - String
|
A string that is displayed in the title bar and tab of the browser and in search results lists. |
min_sale_qty - Float
|
Minimum Qty Allowed in Shopping Cart |
name - String
|
The product name. Customers use this name to identify the product. |
new_from_date - String
|
The beginning date for new product listings, and determines if the product is featured as a new product. |
new_to_date - String
|
The end date for new product listings. |
only_x_left_in_stock - Float
|
Product stock only x left count |
options - [CustomizableOptionInterface]
|
An array of options for a customizable product. |
options_container - String
|
If the product has multiple options, determines where they appear on the product page. |
price_range - PriceRange!
|
The range of prices for the product |
price_tiers - [TierPrice]
|
An array of TierPrice objects. |
product_links - [ProductLinksInterface]
|
An array of ProductLinks objects. |
quantity - Float
|
Quantity of available stock |
related_products - [ProductInterface]
|
An array of products to be displayed in a Related Products block. |
short_description - ComplexTextValue
|
A short description of the product. Its use depends on the theme. |
sku - String
|
A number or code assigned to a product to identify the product, options, price, and manufacturer. |
small_image - ProductImage
|
The relative path to the small image, which is used on catalog pages. |
special_price - Float
|
The discounted price of the product. |
special_to_date - String
|
The end date for a product with a special price. |
stock_status - ProductStockStatus
|
Stock status of the product |
swatch_image - String
|
The file name of a swatch image. |
thumbnail - ProductImage
|
The relative path to the product's thumbnail image. |
uid - ID!
|
The unique ID for a ProductInterface object. |
upsell_products - [ProductInterface]
|
Upsell Products |
url_key - String
|
The part of the URL that identifies the product |
Example
{
"canonical_url": "abc123",
"categories": [CategoryInterface],
"country_of_manufacture": "abc123",
"crosssell_products": [ProductInterface],
"custom_attributesV2": ProductCustomAttributes,
"description": ComplexTextValue,
"gift_message_available": true,
"gift_wrapping_available": false,
"gift_wrapping_price": Money,
"image": ProductImage,
"is_returnable": "xyz789",
"manufacturer": 123,
"max_sale_qty": 123.45,
"media_gallery": [MediaGalleryInterface],
"meta_description": "xyz789",
"meta_keyword": "xyz789",
"meta_title": "abc123",
"min_sale_qty": 123.45,
"name": "abc123",
"new_from_date": "xyz789",
"new_to_date": "xyz789",
"only_x_left_in_stock": 987.65,
"options": [CustomizableOptionInterface],
"options_container": "abc123",
"price_range": PriceRange,
"price_tiers": [TierPrice],
"product_links": [ProductLinksInterface],
"quantity": 123.45,
"related_products": [ProductInterface],
"short_description": ComplexTextValue,
"sku": "xyz789",
"small_image": ProductImage,
"special_price": 123.45,
"special_to_date": "abc123",
"stock_status": "IN_STOCK",
"swatch_image": "abc123",
"thumbnail": ProductImage,
"uid": "4",
"upsell_products": [ProductInterface],
"url_key": "xyz789"
}
VirtualRequisitionListItem
Description
Contains details about virtual products added to a requisition list.
Fields
| Field Name | Description |
|---|---|
customizable_options - [SelectedCustomizableOption]!
|
Selected custom options for an item in the requisition list. |
product - ProductInterface!
|
Details about a requisition list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The amount added. |
uid - ID!
|
The unique ID for the requisition list item. |
Example
{
"customizable_options": [SelectedCustomizableOption],
"product": ProductInterface,
"quantity": 987.65,
"uid": 4
}
VirtualWishlistItem
Description
Contains a virtual product wish list item.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Example
{
"added_at": "xyz789",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
"product": ProductInterface,
"quantity": 987.65
}
WishListUserInputError
Description
An error encountered while performing operations with WishList.
Fields
| Field Name | Description |
|---|---|
code - WishListUserInputErrorType!
|
A wish list-specific error code. |
message - String!
|
A localized error message. |
Example
{
"code": "PRODUCT_NOT_FOUND",
"message": "xyz789"
}
WishListUserInputErrorType
Description
A list of possible error types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRODUCT_NOT_FOUND"
Wishlist
Description
Contains a customer wish list.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The unique ID for a Wishlist object. |
items_count - Int
|
The number of items in the wish list. |
items_v2 - WishlistItems
|
An array of items in the customer's wish list. |
name - String
|
The name of the wish list. |
sharing_code - String
|
An encrypted code that Magento uses to link to the wish list. |
updated_at - String
|
The time of the last modification to the wish list. |
visibility - WishlistVisibilityEnum!
|
Indicates whether the wish list is public or private. |
Example
{
"id": 4,
"items_count": 987,
"items_v2": WishlistItems,
"name": "abc123",
"sharing_code": "abc123",
"updated_at": "xyz789",
"visibility": "PUBLIC"
}
WishlistCartUserInputError
Description
Contains details about errors encountered when a customer added wish list items to the cart.
Fields
| Field Name | Description |
|---|---|
code - WishlistCartUserInputErrorType!
|
An error code that describes the error encountered. |
message - String!
|
A localized error message. |
wishlistId - ID!
|
The unique ID of the Wishlist object containing an error. |
wishlistItemId - ID!
|
The unique ID of the wish list item containing an error. |
Example
{
"code": "PRODUCT_NOT_FOUND",
"message": "abc123",
"wishlistId": "4",
"wishlistItemId": "4"
}
WishlistCartUserInputErrorType
Description
A list of possible error types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRODUCT_NOT_FOUND"
WishlistItemCopyInput
Description
Specifies the IDs of items to copy and their quantities.
Example
{
"quantity": 987.65,
"wishlist_item_id": "4"
}
WishlistItemInput
Description
Defines the items to add to a wish list.
Fields
| Input Field | Description |
|---|---|
entered_options - [EnteredOptionInput]
|
An array of options that the customer entered. |
parent_sku - String
|
For complex product types, the SKU of the parent product. |
quantity - Float!
|
The amount or number of items to add. |
selected_options - [ID]
|
An array of strings corresponding to options the customer selected. |
sku - String!
|
The SKU of the product to add. For complex product types, specify the child product SKU. |
Example
{
"entered_options": [EnteredOptionInput],
"parent_sku": "xyz789",
"quantity": 123.45,
"selected_options": [4],
"sku": "xyz789"
}
WishlistItemInterface
Description
The interface for wish list items.
Fields
| Field Name | Description |
|---|---|
added_at - String!
|
The date and time the item was added to the wish list. |
customizable_options - [SelectedCustomizableOption]!
|
Custom options selected for the wish list item. |
description - String
|
The description of the item. |
id - ID!
|
The unique ID for a WishlistItemInterface object. |
product - ProductInterface!
|
Product details of the wish list item. Product information is part of a composable Catalog Service. |
quantity - Float!
|
The quantity of this wish list item. |
Possible Types
| WishlistItemInterface Types |
|---|
Example
{
"added_at": "abc123",
"customizable_options": [SelectedCustomizableOption],
"description": "xyz789",
"id": 4,
"product": ProductInterface,
"quantity": 123.45
}
WishlistItemMoveInput
Description
Specifies the IDs of the items to move and their quantities.
Example
{
"quantity": 123.45,
"wishlist_item_id": "4"
}
WishlistItemUpdateInput
Description
Defines updates to items in a wish list.
Fields
| Input Field | Description |
|---|---|
description - String
|
Customer-entered comments about the item. |
entered_options - [EnteredOptionInput]
|
An array of options that the customer entered. |
quantity - Float
|
The new amount or number of this item. |
selected_options - [ID]
|
An array of strings corresponding to options the customer selected. |
wishlist_item_id - ID!
|
The unique ID for a WishlistItemInterface object. |
Example
{
"description": "xyz789",
"entered_options": [EnteredOptionInput],
"quantity": 123.45,
"selected_options": ["4"],
"wishlist_item_id": 4
}
WishlistItems
Description
Contains an array of items in a wish list.
Fields
| Field Name | Description |
|---|---|
items - [WishlistItemInterface]!
|
A list of items in the wish list. |
page_info - SearchResultPageInfo
|
Contains pagination metadata. |
Example
{
"items": [WishlistItemInterface],
"page_info": SearchResultPageInfo
}
WishlistVisibilityEnum
Description
Defines the wish list visibility types.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PUBLIC"
finishUploadInput
Fields
| Input Field | Description |
|---|---|
key - String!
|
The unique key identifier from the upload |
media_resource_type - MediaResourceType!
|
The type of media resource being uploaded |
Example
{
"key": "xyz789",
"media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
}
finishUploadOutput
initiateUploadInput
Fields
| Input Field | Description |
|---|---|
key - String!
|
The name of the file to be uploaded, cannot contain slashes |
media_resource_type - MediaResourceType!
|
The type of media resource being uploaded |
Example
{
"key": "xyz789",
"media_resource_type": "CUSTOMER_ATTRIBUTE_FILE"
}