Types

FilterEqualTypeInput

Defines a filter that matches the input exactly.

Input Fields

Example

{
  "eq": "abc123",
  "in": ["xyz789"]
}

FilterMatchTypeEnum

Values

Example

""FULL""

FilterMatchTypeInput

Defines a filter that performs a fuzzy search.

Input Fields

Example

{"match": "abc123", "match_type": "FULL"}

FilterRangeTypeInput

Defines a filter that matches a range of values, such as prices or dates.

Input Fields

Example

{
  "from": "xyz789",
  "to": "xyz789"
}

FilterStringTypeInput

Defines a filter for an input string.

Input Fields

Example

{
  "eq": "abc123",
  "in": ["xyz789"],
  "match": "xyz789"
}

FilterTypeInput

Defines the comparison operators that can be used in a filter.

Input Fields

Example

{
  "eq": "abc123",
  "finset": ["abc123"],
  "from": "abc123",
  "gt": "abc123",
  "gteq": "abc123",
  "in": ["abc123"],
  "like": "abc123",
  "lt": "abc123",
  "lteq": "xyz789",
  "moreq": "xyz789",
  "neq": "xyz789",
  "nin": ["abc123"],
  "notnull": "abc123",
  "null": "xyz789",
  "to": "abc123"
}

FixedProductTax

A single FPT that can be applied to a product price.

Fields

Example

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

FixedProductTaxDisplaySettings

Lists display settings for the Fixed Product Tax.

Values

Example

""INCLUDE_FPT_WITHOUT_DETAILS""

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

GenerateCustomerTokenAsAdminInput

Identifies which customer requires remote shopping assistance.

Input Fields

Example

{"customer_email": "xyz789"}

GenerateCustomerTokenAsAdminOutput

Contains the generated customer token.

Fields

Example

{"customer_token": "abc123"}

GenerateNegotiableQuoteFromTemplateInput

Specifies the template id, from which to generate quote from.

Input Fields

Example

{"template_id": "4"}

GenerateNegotiableQuoteFromTemplateOutput

Contains the generated negotiable quote id.

Fields

Example

{"negotiable_quote_uid": "4"}

GetPaymentSDKOutput

Gets the payment SDK URLs and values

Fields

Example

{"sdkParams": [PaymentSDKParamsItem]}

GiftCardAccount

Contains details about the gift card account.

Fields

Example

{
  "balance": Money,
  "code": "abc123",
  "expiration_date": "abc123"
}

GiftCardAccountInput

Contains the gift card code.

Input Fields

Example

{"gift_card_code": "xyz789"}

GiftCardAmounts

Contains the value of a gift card, the website that generated the card, and related information.

Fields

Example

{
  "attribute_id": 987,
  "uid": 4,
  "value": 987.65,
  "value_id": 987,
  "website_id": 987,
  "website_value": 123.45
}

GiftCardCartItem

Contains details about a gift card that has been added to a cart.

Fields

Example

{
  "amount": Money,
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": false,
  "max_qty": 987.65,
  "message": "xyz789",
  "min_qty": 123.45,
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "recipient_email": "abc123",
  "recipient_name": "abc123",
  "sender_email": "xyz789",
  "sender_name": "abc123",
  "uid": "4"
}

GiftCardCreditMemoItem

Fields

Example

{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 123.45
}

GiftCardInvoiceItem

Fields

Example

{
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

GiftCardItem

Contains details about a gift card.

Fields

Example

{
  "message": "abc123",
  "recipient_email": "abc123",
  "recipient_name": "abc123",
  "sender_email": "abc123",
  "sender_name": "xyz789"
}

GiftCardOptions

Contains details about the sender, recipient, and amount of a gift card.

Fields

Example

{
  "amount": Money,
  "custom_giftcard_amount": Money,
  "message": "xyz789",
  "recipient_email": "xyz789",
  "recipient_name": "abc123",
  "sender_email": "xyz789",
  "sender_name": "abc123"
}

GiftCardOrderItem

Fields

Example

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

GiftCardProduct

Defines properties of a gift card.

Fields

Example

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

GiftCardRequisitionListItem

Contains details about gift cards added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "gift_card_options": GiftCardOptions,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

GiftCardShipmentItem

Fields

Example

{
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 123.45
}

GiftCardTypeEnum

Specifies the gift card type.

Values

Example

""VIRTUAL""

GiftCardWishlistItem

A single gift card added to a wish list.

Fields

Example

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

GiftMessage

Contains the text of a gift message, its sender, and recipient

Fields

Example

{
  "from": "abc123",
  "message": "xyz789",
  "to": "abc123"
}

GiftMessageInput

Defines a gift message.

Input Fields

Example

{
  "from": "xyz789",
  "message": "abc123",
  "to": "abc123"
}

GiftOptionsPrices

Contains prices for gift wrapping options.

Fields

Example

{
  "gift_wrapping_for_items": Money,
  "gift_wrapping_for_order": Money,
  "printed_card": Money
}

GiftRegistry

Contains details about a gift registry.

Fields

Example

{
  "created_at": "xyz789",
  "dynamic_attributes": [GiftRegistryDynamicAttribute],
  "event_name": "xyz789",
  "items": [GiftRegistryItemInterface],
  "message": "xyz789",
  "owner_name": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [GiftRegistryRegistrant],
  "shipping_address": CustomerAddress,
  "status": "ACTIVE",
  "type": GiftRegistryType,
  "uid": 4
}

GiftRegistryDynamicAttribute

Fields

Example

{
  "code": "4",
  "group": "EVENT_INFORMATION",
  "label": "xyz789",
  "value": "abc123"
}

GiftRegistryDynamicAttributeGroup

Defines the group type of a gift registry dynamic attribute.

Values

Example

""EVENT_INFORMATION""

GiftRegistryDynamicAttributeInput

Defines a dynamic attribute.

Input Fields

Example

{"code": 4, "value": "abc123"}

GiftRegistryDynamicAttributeInterface

Fields

Possible Types

Example

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

GiftRegistryDynamicAttributeMetadata

Fields

Example

{
  "attribute_group": "abc123",
  "code": "4",
  "input_type": "xyz789",
  "is_required": false,
  "label": "xyz789",
  "sort_order": 123
}

GiftRegistryDynamicAttributeMetadataInterface

Fields

Possible Types

Example

{
  "attribute_group": "xyz789",
  "code": "4",
  "input_type": "xyz789",
  "is_required": false,
  "label": "xyz789",
  "sort_order": 123
}

GiftRegistryItem

Fields

Example

{
  "created_at": "abc123",
  "note": "xyz789",
  "product": ProductInterface,
  "quantity": 123.45,
  "quantity_fulfilled": 123.45,
  "uid": 4
}

GiftRegistryItemInterface

Fields

Possible Types

Example

{
  "created_at": "abc123",
  "note": "abc123",
  "product": ProductInterface,
  "quantity": 123.45,
  "quantity_fulfilled": 123.45,
  "uid": "4"
}

GiftRegistryItemUserErrorInterface

Contains the status and any errors that encountered with the customer's gift register item.

Fields

Possible Types

Example

{
  "status": true,
  "user_errors": [GiftRegistryItemsUserError]
}

GiftRegistryItemsUserError

Contains details about an error that occurred when processing a gift registry item.

Fields

Example

{
  "code": "OUT_OF_STOCK",
  "gift_registry_item_uid": "4",
  "gift_registry_uid": 4,
  "message": "xyz789",
  "product_uid": "4"
}

GiftRegistryItemsUserErrorType

Defines the error type.

Values

Example

""OUT_OF_STOCK""

GiftRegistryOutputInterface

Contains the customer's gift registry.

Fields

Possible Types

Example

{"gift_registry": GiftRegistry}

GiftRegistryPrivacySettings

Defines the privacy setting of the gift registry.

Values

Example

""PRIVATE""

GiftRegistryRegistrant

Contains details about a registrant.

Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryRegistrantDynamicAttribute
  ],
  "email": "abc123",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "uid": 4
}

GiftRegistryRegistrantDynamicAttribute

Fields

Example

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

GiftRegistrySearchResult

Contains the results of a gift registry search.

Fields

Example

{
  "event_date": "xyz789",
  "event_title": "abc123",
  "gift_registry_uid": 4,
  "location": "xyz789",
  "name": "xyz789",
  "type": "xyz789"
}

GiftRegistryShippingAddressInput

Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

Input Fields

Example

{"address_data": CustomerAddressInput, "address_id": 4}

GiftRegistryStatus

Defines the status of the gift registry.

Values

Example

""ACTIVE""

GiftRegistryType

Contains details about a gift registry type.

Fields

Example

{
  "dynamic_attributes_metadata": [
    GiftRegistryDynamicAttributeMetadataInterface
  ],
  "label": "xyz789",
  "uid": "4"
}

GiftWrapping

Contains details about the selected or available gift wrapping options.

Fields

Example

{
  "design": "abc123",
  "id": 4,
  "image": GiftWrappingImage,
  "price": Money,
  "uid": "4"
}

GiftWrappingImage

Points to an image associated with a gift wrapping option.

Fields

Example

{
  "label": "xyz789",
  "url": "abc123"
}

GooglePayButtonStyles

Fields

Example

{
  "color": "abc123",
  "height": 987,
  "type": "abc123"
}

GooglePayConfig

Fields

Example

{
  "button_styles": GooglePayButtonStyles,
  "code": "abc123",
  "is_visible": false,
  "payment_intent": "xyz789",
  "payment_source": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "abc123"
}

GooglePayMethodInput

Google Pay inputs

Input Fields

Example

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

GroupedProduct

Defines a grouped product, which consists of simple standalone products that are presented as a group.

Fields

Example

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

GroupedProductItem

Contains information about an individual grouped product item.

Fields

Example

{
  "position": 123,
  "product": ProductInterface,
  "qty": 987.65
}

GroupedProductWishlistItem

A grouped product wish list item.

Fields

Example

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

HostedFieldsConfig

Fields

Example

{
  "cc_vault_code": "xyz789",
  "code": "xyz789",
  "is_vault_enabled": true,
  "is_visible": true,
  "payment_intent": "abc123",
  "payment_source": "xyz789",
  "requires_card_details": true,
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "three_ds": true,
  "title": "abc123"
}

HostedFieldsInput

Hosted Fields payment inputs

Input Fields

Example

{
  "cardBin": "xyz789",
  "cardExpiryMonth": "xyz789",
  "cardExpiryYear": "xyz789",
  "cardLast4": "xyz789",
  "holderName": "abc123",
  "is_active_payment_token_enabler": false,
  "payment_source": "xyz789",
  "payments_order_id": "abc123",
  "paypal_order_id": "abc123"
}

HostedProInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.

Input Fields

Example

{
  "cancel_url": "xyz789",
  "return_url": "xyz789"
}

HostedProUrl

Contains the secure URL used for the Payments Pro Hosted Solution payment method.

Fields

Example

{"secure_form_url": "xyz789"}

HostedProUrlInput

Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

Input Fields

Example

{"cart_id": "xyz789"}

HttpQueryParameter

Contains target path parameters.

Fields

Example

{
  "name": "xyz789",
  "value": "xyz789"
}

ID

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

Fields

Example

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

InputFilterEnum

List of templates/filters applied to customer attribute input.

Values

Example

""NONE""

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

123

InternalError

Contains an error message when an internal error occurred.

Fields

Example

{"message": "abc123"}

Invoice

Contains invoice details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [InvoiceItemInterface],
  "number": "xyz789",
  "total": InvoiceTotal
}

InvoiceItem

Fields

Example

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

InvoiceItemInterface

Contains detailes about invoiced items.

Fields

Possible Types

Example

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

InvoiceTotal

Contains price details from an invoice.

Fields

Example

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

IsCompanyAdminEmailAvailableOutput

Contains the response of a company admin email validation query.

Fields

Example

{"is_email_available": true}

IsCompanyEmailAvailableOutput

Contains the response of a company email validation query.

Fields

Example

{"is_email_available": false}

IsCompanyRoleNameAvailableOutput

Contains the response of a role name validation query.

Fields

Example

{"is_role_name_available": false}

IsCompanyUserEmailAvailableOutput

Contains the response of a company user email validation query.

Fields

Example

{"is_email_available": true}

IsEmailAvailableOutput

Contains the result of the isEmailAvailable query.

Fields

Example

{"is_email_available": true}

ItemNote

The note object for quote line item.

Fields

Example

{
  "created_at": "xyz789",
  "creator_id": 987,
  "creator_type": 123,
  "negotiable_quote_item_uid": "4",
  "note": "xyz789",
  "note_uid": 4
}

ItemSelectedBundleOption

A list of options of the selected bundle product.

Fields

Example

{
  "id": 4,
  "label": "abc123",
  "uid": 4,
  "values": [ItemSelectedBundleOptionValue]
}

ItemSelectedBundleOptionValue

A list of values for the selected bundle product.

Fields

Example

{
  "id": 4,
  "price": Money,
  "product_name": "xyz789",
  "product_sku": "abc123",
  "quantity": 987.65,
  "uid": "4"
}