Types

KeyValue

Contains a key-value pair.

Fields

Example

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

LayerFilter

Contains information for rendering layered navigation.

Fields

Example

{
  "filter_items": [LayerFilterItemInterface],
  "filter_items_count": 987,
  "name": "xyz789",
  "request_var": "xyz789"
}

LayerFilterItem

Fields

Example

{
  "items_count": 987,
  "label": "xyz789",
  "value_string": "xyz789"
}

LayerFilterItemInterface

Fields

Possible Types

Example

{
  "items_count": 123,
  "label": "xyz789",
  "value_string": "abc123"
}

LineItemNoteInput

Sets quote item note.

Input Fields

Example

{
  "note": "xyz789",
  "quote_item_uid": "4",
  "quote_uid": "4"
}

MediaGalleryEntry

Defines characteristics about images and videos associated with a specific product.

Fields

Example

{
  "content": ProductMediaGalleryEntriesContent,
  "disabled": true,
  "file": "xyz789",
  "id": 987,
  "label": "abc123",
  "media_type": "xyz789",
  "position": 987,
  "types": ["xyz789"],
  "uid": 4,
  "video_content": ProductMediaGalleryEntriesVideoContent
}

MediaGalleryInterface

Contains basic information about a product image or video.

Fields

Possible Types

Example

{
  "disabled": false,
  "label": "abc123",
  "position": 987,
  "types": ["xyz789"],
  "url": "xyz789"
}

MessageStyleLogo

Fields

Example

{"type": "abc123"}

MessageStyles

Fields

Example

{
  "layout": "xyz789",
  "logo": MessageStyleLogo
}

Money

Defines a monetary value, including a numeric value and a currency code.

Fields

Example

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

MoveCartItemsToGiftRegistryOutput

Contains the customer's gift registry and any errors encountered.

Fields

Example

{
  "gift_registry": GiftRegistry,
  "status": false,
  "user_errors": [GiftRegistryItemsUserError]
}

MoveItemsBetweenRequisitionListsInput

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

Input Fields

Example

{"requisitionListItemUids": ["4"]}

MoveItemsBetweenRequisitionListsOutput

Output of the request to move items to another requisition list.

Fields

Example

{
  "destination_requisition_list": RequisitionList,
  "source_requisition_list": RequisitionList
}

MoveLineItemToRequisitionListInput

Move Line Item to Requisition List.

Input Fields

Example

{
  "quote_item_uid": "4",
  "quote_uid": 4,
  "requisition_list_uid": 4
}

MoveLineItemToRequisitionListOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

MoveProductsBetweenWishlistsOutput

Contains the source and target wish lists after moving products.

Fields

Example

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

NegotiableQuote

Contains details about a negotiable quote.

Fields

Example

{
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": NegotiableQuoteBillingAddress,
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "abc123",
  "email": "xyz789",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": false,
  "items": [CartItemInterface],
  "name": "abc123",
  "prices": CartPrices,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "total_quantity": 123.45,
  "uid": 4,
  "updated_at": "xyz789"
}

NegotiableQuoteAddressCountry

Defines the company's country.

Fields

Example

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

NegotiableQuoteAddressInput

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

Input Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": "abc123",
  "region_id": 123,
  "save_in_address_book": true,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressInterface

Fields

Possible Types

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["xyz789"],
  "telephone": "abc123"
}

NegotiableQuoteAddressRegion

Defines the company's state or province.

Fields

Example

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

NegotiableQuoteBillingAddress

Fields

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["xyz789"],
  "telephone": "abc123"
}

NegotiableQuoteBillingAddressInput

Defines the billing address.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "same_as_shipping": false,
  "use_for_shipping": true
}

NegotiableQuoteComment

Contains a single plain text comment from either the buyer or seller.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "created_at": "xyz789",
  "creator_type": "BUYER",
  "text": "xyz789",
  "uid": "4"
}

NegotiableQuoteCommentCreatorType

Values

Example

""BUYER""

NegotiableQuoteCommentInput

Contains the commend provided by the buyer.

Input Fields

Example

{"comment": "xyz789"}

NegotiableQuoteCustomLogChange

Contains custom log entries added by third-party extensions.

Fields

Example

{
  "new_value": "xyz789",
  "old_value": "xyz789",
  "title": "abc123"
}

NegotiableQuoteFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

{
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput
}

NegotiableQuoteHistoryChanges

Contains a list of changes to a negotiable quote.

Fields

Example

{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}

NegotiableQuoteHistoryCommentChange

Contains a comment submitted by a seller or buyer.

Fields

Example

{"comment": "xyz789"}

NegotiableQuoteHistoryEntry

Contains details about a change for a negotiable quote.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "abc123",
  "uid": "4"
}

NegotiableQuoteHistoryEntryChangeType

Values

Example

""CREATED""

NegotiableQuoteHistoryExpirationChange

Contains a new expiration date and the previous date.

Fields

Example

{
  "new_expiration": "xyz789",
  "old_expiration": "xyz789"
}

NegotiableQuoteHistoryProductsRemovedChange

Contains lists of products that have been removed from the catalog and negotiable quote.

Fields

Example

{
  "products_removed_from_catalog": [4],
  "products_removed_from_quote": [ProductInterface]
}

NegotiableQuoteHistoryStatusChange

Lists a new status change applied to a negotiable quote and the previous status.

Fields

Example

{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}

NegotiableQuoteHistoryStatusesChange

Contains a list of status changes that occurred for the negotiable quote.

Fields

Example

{"changes": [NegotiableQuoteHistoryStatusChange]}

NegotiableQuoteHistoryTotalChange

Contains a new price and the previous price.

Fields

Example

{
  "new_price": Money,
  "old_price": Money
}

NegotiableQuoteInvalidStateError

An error indicating that an operation was attempted on a negotiable quote in an invalid state.

Fields

Example

{"message": "abc123"}

NegotiableQuoteItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

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

NegotiableQuotePaymentMethodInput

Defines the payment method to be applied to the negotiable quote.

Input Fields

Example

{
  "code": "xyz789",
  "purchase_order_number": "xyz789"
}

NegotiableQuoteReferenceDocumentLink

Contains a reference document link for a negotiable quote template.

Fields

Example

{
  "document_identifier": "xyz789",
  "document_name": "abc123",
  "link_id": "4",
  "reference_document_url": "xyz789"
}

NegotiableQuoteShippingAddress

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "xyz789",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteShippingAddressInput

Defines shipping addresses for the negotiable quote.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "customer_notes": "abc123"
}

NegotiableQuoteSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Example

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

NegotiableQuoteSortableField

Values

Example

""QUOTE_NAME""

NegotiableQuoteStatus

Values

Example

""SUBMITTED""

NegotiableQuoteTemplate

Contains details about a negotiable quote template.

Fields

Example

{
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "expiration_date": "xyz789",
  "history": [NegotiableQuoteHistoryEntry],
  "is_min_max_qty_used": true,
  "is_virtual": false,
  "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": 123.45
}

NegotiableQuoteTemplateFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

{
  "state": FilterEqualTypeInput,
  "status": FilterEqualTypeInput
}

NegotiableQuoteTemplateGridItem

Contains data for a negotiable quote template in a grid.

Fields

Example

{
  "activated_at": "abc123",
  "company_name": "xyz789",
  "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": "abc123",
  "orders_placed": 987,
  "sales_rep_name": "abc123",
  "state": "xyz789",
  "status": "xyz789",
  "submitted_by": "xyz789",
  "template_id": 4
}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

{
  "item_id": "4",
  "max_qty": 123.45,
  "min_qty": 987.65,
  "quantity": 123.45
}

NegotiableQuoteTemplateReferenceDocumentLinkInput

Defines the reference document link to add to a negotiable quote template.

Input Fields

Example

{
  "document_identifier": "abc123",
  "document_name": "abc123",
  "link_id": 4,
  "reference_document_url": "xyz789"
}

NegotiableQuoteTemplateShippingAddressInput

Defines shipping addresses for the negotiable quote template.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "customer_notes": "xyz789"
}

NegotiableQuoteTemplateSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Example

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

NegotiableQuoteTemplateSortableField

Values

Example

""TEMPLATE_ID""

NegotiableQuoteTemplatesOutput

Contains a list of negotiable templates that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuoteTemplateGridItem],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NegotiableQuoteUidNonFatalResultInterface

Fields

Possible Types

Example

{"quote_uid": "4"}

NegotiableQuoteUidOperationSuccess

Contains details about a successful operation on a negotiable quote.

Fields

Example

{"quote_uid": 4}

NegotiableQuoteUser

A limited view of a Buyer or Seller in the negotiable quote process.

Fields

Example

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

NegotiableQuotesOutput

Contains a list of negotiable that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuote],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 123
}

NoSuchEntityUidError

Contains an error message when an invalid UID was specified.

Fields

Example

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

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Example

{"template_id": "4"}

Order

Contains the order ID.

Fields

Example

{
  "order_id": "abc123",
  "order_number": "xyz789"
}

OrderActionType

The list of available order actions.

Values

Example

""REORDER""

OrderAddress

Contains detailed information about an order's billing and shipping addresses.

Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInterface],
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": "abc123",
  "region_id": "4",
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "abc123"
}

OrderCustomerInfo

Fields

Example

{
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "prefix": "xyz789",
  "suffix": "abc123"
}

OrderItem

Fields

Example

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

OrderItemInterface

Order item details.

Fields

Possible Types

Example

{
  "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": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 123.45,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

OrderItemOption

Represents order item options like selected or entered.

Fields

Example

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

OrderItemPrices

Fields

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

Contains details about the payment method used to pay for the order.

Fields

Example

{
  "additional_data": [KeyValue],
  "name": "abc123",
  "type": "xyz789"
}

OrderShipment

Contains order shipment details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": "4",
  "items": [ShipmentItemInterface],
  "number": "abc123",
  "tracking": [ShipmentTracking]
}

OrderTokenInput

Input to retrieve an order based on token.

Input Fields

Example

{"token": "xyz789"}

OrderTotal

Contains details about the sales total amounts used to calculate the final price.

Fields

Example

{
  "base_grand_total": Money,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excl_tax": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "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
}

PayflowExpressInput

Contains required input for Payflow Express Checkout payments.

Input Fields

Example

{
  "payer_id": "xyz789",
  "token": "xyz789"
}

PayflowLinkInput

A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce 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 Payflow Link and Payments Advanced payment methods.

Input Fields

Example

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

PayflowLinkMode

Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

Values

Example

""TEST""

PayflowLinkToken

Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.

Fields

Example

{
  "mode": "TEST",
  "paypal_url": "xyz789",
  "secure_token": "abc123",
  "secure_token_id": "abc123"
}

PayflowLinkTokenInput

Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

Input Fields

Example

{"cart_id": "abc123"}

PayflowProInput

Contains input for the Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cc_details": CreditCardDetailsInput,
  "is_active_payment_token_enabler": false
}

PayflowProResponseInput

Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cart_id": "xyz789",
  "paypal_payload": "xyz789"
}

PayflowProResponseOutput

Fields

Example

{"cart": Cart}

PayflowProTokenInput

Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cart_id": "abc123",
  "urls": PayflowProUrlInput
}

PayflowProUrlInput

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 the Payflow Pro and Payment Pro payment methods.

Input Fields

Example

{
  "cancel_url": "abc123",
  "error_url": "abc123",
  "return_url": "abc123"
}

PaymentConfigItem

Contains payment fields that are common to all types of payment methods.

Fields

Possible Types

Example

{
  "code": "xyz789",
  "is_visible": true,
  "payment_intent": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "abc123"
}

PaymentConfigOutput

Retrieves the payment configuration for a given location

Fields

Example

{
  "apple_pay": ApplePayConfig,
  "fastlane": FastlaneConfig,
  "google_pay": GooglePayConfig,
  "hosted_fields": HostedFieldsConfig,
  "smart_buttons": SmartButtonsConfig
}

PaymentLocation

Defines the origin location for that payment request

Values

Example

""PRODUCT_DETAIL""

PaymentMethodInput

Defines the payment method.

Input Fields

Example

{
  "braintree": BraintreeInput,
  "braintree_ach_direct_debit": BraintreeInput,
  "braintree_ach_direct_debit_vault": BraintreeVaultInput,
  "braintree_applepay_vault": BraintreeVaultInput,
  "braintree_cc_vault": BraintreeCcVaultInput,
  "braintree_googlepay_vault": BraintreeVaultInput,
  "braintree_paypal": BraintreeInput,
  "braintree_paypal_vault": BraintreeVaultInput,
  "code": "xyz789",
  "hosted_pro": HostedProInput,
  "payflow_express": PayflowExpressInput,
  "payflow_link": PayflowLinkInput,
  "payflowpro": PayflowProInput,
  "payflowpro_cc_vault": VaultTokenInput,
  "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,
  "paypal_express": PaypalExpressInput,
  "purchase_order_number": "abc123"
}

PaymentOrderOutput

Contains the payment order details

Fields

Example

{
  "id": "xyz789",
  "mp_order_id": "xyz789",
  "payment_source_details": PaymentSourceDetails,
  "status": "abc123"
}

PaymentSDKParamsItem

Fields

Example

{
  "code": "xyz789",
  "params": [SDKParams]
}

PaymentSourceDetails

Fields

Example

{"card": Card}

PaymentSourceInput

The payment source information

Input Fields

Example

{"card": CardPaymentSourceInput}

PaymentSourceOutput

The payment source information

Fields

Example

{"card": CardPaymentSourceOutput}

PaymentToken

The stored payment method available to the customer.

Fields

Example

{
  "details": "abc123",
  "payment_method_code": "abc123",
  "public_hash": "abc123",
  "type": "card"
}

PaymentTokenTypeEnum

The list of available payment token types.

Values

Example

""card""

PaypalExpressInput

Contains required input for Express Checkout and Payments Standard payments.

Input Fields

Example

{
  "payer_id": "abc123",
  "token": "abc123"
}

PaypalExpressTokenInput

Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

Input Fields

Example

{
  "cart_id": "abc123",
  "code": "xyz789",
  "express_button": true,
  "urls": PaypalExpressUrlsInput,
  "use_paypal_credit": true
}

PaypalExpressTokenOutput

Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.

Fields

Example

{
  "paypal_urls": PaypalExpressUrlList,
  "token": "xyz789"
}

PaypalExpressUrlList

Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.

Fields

Example

{
  "edit": "abc123",
  "start": "xyz789"
}

PaypalExpressUrlsInput

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 Express Checkout and Payments Standard payment methods.

Input Fields

Example

{
  "cancel_url": "xyz789",
  "pending_url": "abc123",
  "return_url": "xyz789",
  "success_url": "xyz789"
}

PhysicalProductInterface

Contains attributes specific to tangible products.

Fields

Possible Types

Example

{"weight": 123.45}

PickupLocation

Defines Pickup Location information.

Fields

Example

{
  "city": "xyz789",
  "contact_name": "abc123",
  "country_id": "xyz789",
  "description": "abc123",
  "email": "abc123",
  "fax": "xyz789",
  "latitude": 123.45,
  "longitude": 987.65,
  "name": "xyz789",
  "phone": "xyz789",
  "pickup_location_code": "xyz789",
  "postcode": "xyz789",
  "region": "xyz789",
  "region_id": 987,
  "street": "xyz789"
}

PickupLocationFilterInput

PickupLocationFilterInput defines the list of attributes and filters for the search.

Input Fields

Example

{
  "city": FilterTypeInput,
  "country_id": FilterTypeInput,
  "name": FilterTypeInput,
  "pickup_location_code": FilterTypeInput,
  "postcode": FilterTypeInput,
  "region": FilterTypeInput,
  "region_id": FilterTypeInput,
  "street": FilterTypeInput
}

PickupLocationSortInput

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

Input Fields

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

Top level object returned in a pickup locations search.

Fields

Example

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

PlaceNegotiableQuoteOrderInput

Specifies the negotiable quote to convert to an order.

Input Fields

Example

{"quote_uid": "4"}

PlaceNegotiableQuoteOrderOutput

An output object that returns the generated order.

Fields

Example

{"order": Order}

PlaceOrderError

An error encountered while placing an order.

Fields

Example

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

PlaceOrderErrorCodes

Values

Example

""CART_NOT_FOUND""

PlaceOrderForPurchaseOrderInput

Specifies the purchase order to convert to an order.

Input Fields

Example

{"purchase_order_uid": 4}

PlaceOrderForPurchaseOrderOutput

Contains the results of the request to place an order.

Fields

Example

{"order": CustomerOrder}

PlaceOrderInput

Specifies the quote to be converted to an order.

Input Fields

Example

{"cart_id": "abc123"}

PlaceOrderOutput

Contains the results of the request to place an order.

Fields

Example

{
  "errors": [PlaceOrderError],
  "order": Order,
  "orderV2": CustomerOrder
}

PlacePurchaseOrderInput

Specifies the quote to be converted to a purchase order.

Input Fields

Example

{"cart_id": "xyz789"}

PlacePurchaseOrderOutput

Contains the results of the request to place a purchase order.

Fields

Example

{"purchase_order": PurchaseOrder}

Price

Deprecated. Use ProductPrice instead. Defines the price of a product as well as any tax-related adjustments.

Fields

Example

{
  "adjustments": [PriceAdjustment],
  "amount": Money
}

PriceAdjustment

Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.

Fields

Example

{
  "amount": Money,
  "code": "TAX",
  "description": "INCLUDED"
}

PriceAdjustmentCodesEnum

PriceAdjustment.code is deprecated.

Values

Example

""TAX""

PriceAdjustmentDescriptionEnum

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

Values

Example

""INCLUDED""

PriceDetails

Can be used to retrieve the main price details in case of bundle product

Fields

Example

{
  "discount_percentage": 123.45,
  "main_final_price": 987.65,
  "main_price": 123.45
}

PriceRange

Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

Fields

Example

{
  "maximum_price": ProductPrice,
  "minimum_price": ProductPrice
}

PriceTypeEnum

Defines the price type.

Values

Example

""FIXED""

PriceViewEnum

Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

Values

Example

""PRICE_RANGE""

ProductAttribute

Contains a product attribute code and value.

Fields

Example

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

ProductAttributeFilterInput

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

Input Fields

Example

{
  "category_id": FilterEqualTypeInput,
  "category_uid": FilterEqualTypeInput,
  "category_url_path": FilterEqualTypeInput,
  "description": FilterMatchTypeInput,
  "name": FilterMatchTypeInput,
  "price": FilterRangeTypeInput,
  "short_description": FilterMatchTypeInput,
  "sku": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput
}

ProductAttributeSortInput

Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option

Input Fields

Example

{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}

ProductCustomAttributes

Product custom attributes

Fields

Example

{
  "errors": [AttributeMetadataError],
  "items": [AttributeValueInterface]
}

ProductDiscount

Contains the discount applied to a product price.

Fields

Example

{"amount_off": 987.65, "percent_off": 123.45}

ProductFilterInput

ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Example

{
  "category_id": FilterTypeInput,
  "country_of_manufacture": FilterTypeInput,
  "created_at": FilterTypeInput,
  "custom_layout": FilterTypeInput,
  "custom_layout_update": FilterTypeInput,
  "description": FilterTypeInput,
  "gift_message_available": FilterTypeInput,
  "has_options": FilterTypeInput,
  "image": FilterTypeInput,
  "image_label": FilterTypeInput,
  "is_returnable": FilterTypeInput,
  "manufacturer": FilterTypeInput,
  "max_price": FilterTypeInput,
  "meta_description": FilterTypeInput,
  "meta_keyword": FilterTypeInput,
  "meta_title": FilterTypeInput,
  "min_price": FilterTypeInput,
  "name": FilterTypeInput,
  "news_from_date": FilterTypeInput,
  "news_to_date": FilterTypeInput,
  "options_container": FilterTypeInput,
  "or": ProductFilterInput,
  "price": FilterTypeInput,
  "required_options": FilterTypeInput,
  "short_description": FilterTypeInput,
  "sku": FilterTypeInput,
  "small_image": FilterTypeInput,
  "small_image_label": FilterTypeInput,
  "special_from_date": FilterTypeInput,
  "special_price": FilterTypeInput,
  "special_to_date": FilterTypeInput,
  "swatch_image": FilterTypeInput,
  "thumbnail": FilterTypeInput,
  "thumbnail_label": FilterTypeInput,
  "tier_price": FilterTypeInput,
  "updated_at": FilterTypeInput,
  "url_key": FilterTypeInput,
  "url_path": FilterTypeInput,
  "weight": FilterTypeInput
}

ProductImage

Contains product image information, including the image URL and label.

Fields

Example

{
  "disabled": true,
  "label": "abc123",
  "position": 987,
  "types": ["xyz789"],
  "url": "xyz789"
}

ProductImageThumbnail

Values

Example

""ITSELF""

ProductInfoInput

Product Information used for Pickup Locations search.

Input Fields

Example

{"sku": "xyz789"}

ProductInterface

Contains fields that are common to all types of products.

Fields

Possible Types

Example

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

ProductLinks

An implementation of ProductLinksInterface.

Fields

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "xyz789",
  "linked_product_type": "abc123",
  "position": 987,
  "sku": "xyz789"
}

ProductLinksInterface

Contains information about linked products, including the link type and product type of each item.

Fields

Possible Types

Example

{
  "link_type": "abc123",
  "linked_product_sku": "xyz789",
  "linked_product_type": "xyz789",
  "position": 987,
  "sku": "xyz789"
}

ProductMediaGalleryEntriesContent

Contains an image in base64 format and basic information about the image.

Fields

Example

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

ProductMediaGalleryEntriesVideoContent

Contains a link to a video file and basic information about the video.

Fields

Example

{
  "media_type": "abc123",
  "video_description": "abc123",
  "video_metadata": "xyz789",
  "video_provider": "xyz789",
  "video_title": "xyz789",
  "video_url": "abc123"
}

ProductPrice

Represents a product price.

Fields

Example

{
  "discount": ProductDiscount,
  "final_price": Money,
  "fixed_product_taxes": [FixedProductTax],
  "regular_price": Money
}

ProductPrices

Deprecated. Use PriceRange instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.

Fields

Example

{
  "maximalPrice": Price,
  "minimalPrice": Price,
  "regularPrice": Price
}

ProductReview

Contains details of a product review.

Fields

Example

{
  "average_rating": 123.45,
  "created_at": "abc123",
  "nickname": "xyz789",
  "product": ProductInterface,
  "ratings_breakdown": [ProductReviewRating],
  "summary": "abc123",
  "text": "xyz789"
}

ProductReviewRating

Contains data about a single aspect of a product review.

Fields

Example

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

ProductReviewRatingInput

Contains the reviewer's rating for a single aspect of a review.

Input Fields

Example

{
  "id": "abc123",
  "value_id": "xyz789"
}

ProductReviewRatingMetadata

Contains details about a single aspect of a product review.

Fields

Example

{
  "id": "xyz789",
  "name": "abc123",
  "values": [ProductReviewRatingValueMetadata]
}

ProductReviewRatingValueMetadata

Contains details about a single value in a product review.

Fields

Example

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

ProductReviewRatingsMetadata

Contains an array of metadata about each aspect of a product review.

Fields

Example

{"items": [ProductReviewRatingMetadata]}

ProductReviews

Contains an array of product reviews.

Fields

Example

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

ProductStockStatus

This enumeration states whether a product stock status is in stock or out of stock

Values

Example

""IN_STOCK""

ProductTierPrices

Deprecated. Use TierPrice instead. Defines a tier price, which is a quantity discount offered to a specific customer group.

Fields

Example

{
  "customer_group_id": "xyz789",
  "percentage_value": 123.45,
  "qty": 987.65,
  "value": 123.45,
  "website_id": 987.65
}

ProductVideo

Contains information about a product video.

Fields

Example

{
  "disabled": false,
  "label": "abc123",
  "position": 123,
  "types": ["abc123"],
  "url": "abc123",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

Products

Contains the results of a products query.

Fields

Example

{
  "aggregations": [Aggregation],
  "filters": [LayerFilter],
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "suggestions": [SearchSuggestion],
  "total_count": 987
}

PurchaseOrder

Contains details about a purchase order.

Fields

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

Example

""REJECT""

PurchaseOrderActionError

Contains details about a failed action.

Fields

Example

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

PurchaseOrderApprovalFlowEvent

Contains details about a single event in the approval flow of the purchase order.

Fields

Example

{
  "message": "xyz789",
  "name": "abc123",
  "role": "xyz789",
  "status": "PENDING",
  "updated_at": "xyz789"
}

PurchaseOrderApprovalFlowItemStatus

Values

Example

""PENDING""

PurchaseOrderApprovalRule

Contains details about a purchase order approval rule.

Fields

Example

{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "abc123",
  "created_by": "abc123",
  "description": "abc123",
  "name": "abc123",
  "status": "ENABLED",
  "uid": "4",
  "updated_at": "xyz789"
}

PurchaseOrderApprovalRuleConditionAmount

Contains approval rule condition details, including the amount to be evaluated.

Fields

Example

{
  "amount": Money,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN"
}

PurchaseOrderApprovalRuleConditionInterface

Purchase order rule condition details.

Fields

Possible Types

Example

{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}

PurchaseOrderApprovalRuleConditionOperator

Values

Example

""MORE_THAN""

PurchaseOrderApprovalRuleConditionQuantity

Contains approval rule condition details, including the quantity to be evaluated.

Fields

Example

{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}

PurchaseOrderApprovalRuleInput

Defines a new purchase order approval rule.

Input Fields

Example

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

PurchaseOrderApprovalRuleMetadata

Contains metadata that can be used to render rule edit forms.

Fields

Example

{
  "available_applies_to": [CompanyRole],
  "available_condition_currencies": [AvailableCurrency],
  "available_requires_approval_from": [CompanyRole]
}

PurchaseOrderApprovalRuleStatus

Values

Example

""ENABLED""

PurchaseOrderApprovalRuleType

Values

Example

""GRAND_TOTAL""

PurchaseOrderApprovalRules

Contains the approval rules that the customer can see.

Fields

Example

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

PurchaseOrderComment

Contains details about a comment.

Fields

Example

{
  "author": Customer,
  "created_at": "xyz789",
  "text": "xyz789",
  "uid": "4"
}

PurchaseOrderErrorType

Values

Example

""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Example

{
  "activity": "abc123",
  "created_at": "abc123",
  "message": "abc123",
  "uid": "4"
}

PurchaseOrderRuleApprovalFlow

Contains details about approval roles applied to the purchase order and status changes.

Fields

Example

{
  "events": [PurchaseOrderApprovalFlowEvent],
  "rule_name": "xyz789"
}

PurchaseOrderStatus

Values

Example

""PENDING""

PurchaseOrders

Contains a list of purchase orders.

Fields

Example

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

PurchaseOrdersActionInput

Defines which purchase orders to act on.

Input Fields

Example

{"purchase_order_uids": [4]}

PurchaseOrdersActionOutput

Returns a list of updated purchase orders and any error messages.

Fields

Example

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

PurchaseOrdersFilterInput

Defines the criteria to use to filter the list of purchase orders.

Input Fields

Example

{
  "company_purchase_orders": true,
  "created_date": FilterRangeTypeInput,
  "require_my_approval": true,
  "status": "PENDING"
}