Adobe
Developer
Commerce
Commerce
Web APIs
Get Started
REST
GraphQL
Console
Sign in
Edit Profile
Sign out
Introduction
Usage
Authorization
Caching
Filtering with custom attributes
GraphQL status codes and responses
Headers
Introspection queries
Protected mutations
Security configuration
Staging queries
Development
Create a resolver
Extend the existing schema
Implement an identity class
Create a custom urlResolver service
Debug queries
Handle exceptions
Functional testing
Schema
Attributes
Queries
attributesForm
attributesList
attributesMetadata
customAttributeMetadata
customAttributeMetadataV2
Interfaces
Cart
Queries
cart
pickupLocations
Mutations
addBundleProductsToCart
addConfigurableProductsToCart
addDownloadableProductsToCart
addProductsToCart
addSimpleProductsToCart
addVirtualProductsToCart
applyCouponToCart
applyCouponsToCart
applyGiftCartToCart
applyRewardPointsToCart
applyStoreCreditToCart
assignCustomerToGuestCart
clearCart
createEmptyCart
createGuestCart
mergeCarts
placeOrder
redeemGiftCardBalanceAsStoreCredit
removeCouponFromCart
removeCouponsFromCart
removeGiftCardFromCart
removeItemFromCart
removeRewardPointsFromCart
removeStoreCreditFromCart
setBillingAddressOnCart
setGiftOptionsOnCart
setGuestEmailOnCart
setPaymentMethodAndPlaceOrder
setPaymentMethodOnCart
setShippingAddressesOnCart
setShippingMethodsOnCart
updateCartItems
Interfaces
Catalog Service
Checkout
Queries
checkoutAgreements
customerPaymentTokens
getHostedProUrl
getPayflowLinkToken
Mutations
createBraintreeClientToken
createKlarnaPaymentsSession
createPayflowProToken
createPaypalExpressToken
deletePaymentToken
handlePayflowProResponse
Company (B2B)
Queries
company
isCompanyAdminEmailAvailable
isCompanyEmailAvailable
isCompanyRoleNameAvailable
isCompanyUserEmailAvailable
Mutations
createCompany
createCompanyRole
createCompanyTeam
createCompanyUser
deleteCompanyRole
deleteCompanyTeam
deleteCompanyUser
updateCompany
updateCompanyRole
updateCompanyStructure
updateCompanyTeam
updateCompanyUser
Unions
CompanyStructureEntity
Customer
Queries
customer
customerCart
customerDownloadableProducts
customerOrders
giftCardAccount
isEmailAvailable
Mutations
assignCompareListToCustomer
changeCustomerPassword
confirmEmail
createCustomer
createCustomerAddress
createCustomerV2
deleteCustomerAddress
generateCustomerToken
generateCustomerTokenAsAdmin
requestPasswordResetEmail
resetPassword
revokeCustomerToken
sendEmailToFriend
subscribeEmailToNewsletter
updateCustomer
updateCustomerAddress
updateCustomerEmail
updateCustomerV2
Gift registry
Queries
giftRegistry
giftRegistryEmailSearch
giftRegistryIdSearch
giftRegistryTypes
giftRegistryTypeSearch
Mutations
addGiftRegistryRegistrants
createGiftRegistry
moveCartItemsToGiftRegistry
removeGiftRegistry
removeGiftRegistryItems
removeGiftRegistryRegistrants
shareGiftRegistry
updateGiftRegistry
updateGiftRegistryItems
updateGiftRegistryRegistrants
Live Search
Negotiable quotes (B2B)
Queries
negotiableQuote
negotiableQuotes
Mutations
closeNegotiableQuotes
deleteNegotiableQuotes
placeNegotiableQuoteOrder
removeNegotiableQuoteItems
requestNegotiableQuote
sendNegotiableQuoteForReview
setNegotiableQuoteBillingAddress
setNegotiableQuotePaymentMethod
setNegotiableQuoteShippingAddress
setNegotiableQuoteShippingMethods
updateNegotiableQuoteQuantities
Interfaces
Unions
Orders
Mutations
addReturnComment
addReturnTracking
cancelOrder
confirmReturn
removeReturnTracking
reorderItems
requestGuestReturn
requestReturn
Interfaces
CreditMemoInterface
InvoiceItemInterface
OrderItemInterface
ShipmentItemInterface
Queries
guestOrder
guestOrderByToken
Product Recommendations
Products
Queries
categories
category
categoryList
compareList
products
productReviewRatingsMetadata
route
urlResolver
Mutations
addProductsToCompareList
createCompareList
createProductReview
deleteCompareList
removeProductsFromCompareList
Interfaces
AttributeMetadata
CategoryInterface
CustomizableOptionInterface
ProductInterface
ProductInterface implementations
BundleProduct data types
ConfigurableProduct data types
DownloadableProduct data types
GiftCardProduct data types
GroupedProduct data types
SimpleProduct data types
VirtualProduct data types
PWA implementations
RoutableInterface
Purchase orders (B2B)
Mutations
addPurchaseOrderComment
addPurchaseOrderItemsToCart
approvePurchaseOrders
cancelPurchaseOrders
placeOrderForPurchaseOrder
placePurchaseOrder
rejectPurchaseOrders
Purchase order rules (B2B)
Mutations
createPurchaseOrderApprovalRule
deletePurchaseOrderApprovalRule
updatePurchaseOrderApprovalRule
validatePurchaseOrders
Interfaces
Requisition lists (B2B)
Mutations
addProductsToRequisitionList
addRequisitionListItemsToCart
clearCustomerCart
copyItemsBetweenRequisitionLists
createRequisitionLists
deleteRequisitionList
deleteRequisitionListItems
moveItemsBetweenRequisitionLists
updateRequisitionList
updateRequisitionListItems
Interfaces
Store
Queries
availableStores
cmsBlocks
cmsPage
countries
country
currency
dynamicBlocks
reCaptchaV3Config
recaptchaFormConfig
storeConfig
Mutations
contactUs
Wish list
Queries
wishlist
Mutations
addProductsToWishlist
addWishlistItemsToCart
copyProductsBetweenWishlists
createWishlist
deleteWishlist
moveProductsBetweenWishlists
removeProductsFromWishlist
updateProductsInWishlist
updateWishlist
Interfaces
WishlistItemInterface
Core payment methods
Braintree
Braintree vault
Klarna
PayPal Express Checkout
Express Checkout for other PayPal solutions
PayPal Payflow Link
PayPal Payflow Pro
PayPal Payflow Pro Vault
PayPal Payments Advanced
PayPal Website Payments Pro Hosted Solution
Payment Services extension
Workflows
Checkout
Minicart
Vault a card during a checkout authorization
Vault a credit card without a purchase
Vaulted card
Queries
getPaymentConfig
getPaymentOrder
getPaymentSDK
getVaultConfig
Mutations
createPaymentOrder
createVaultCardPaymentToken
createVaultCardSetupToken
syncPaymentOrder
Tutorial
GraphQL checkout tutorial
Step 1: Create a customer
Step 2: Create an empty cart
Step 3: Add products to the cart
Step 4: Set the shipping address
Step 5: Set the billing address
Step 6: Set the delivery method
Step 7: Apply a coupon
Step 8: Set email on the cart
Step 9: Set the payment method
Step 10: Place the order
Reference (2.4.7)
2.4.7
2.4.6
Release notes
Products
Commerce
GraphQL
Schema
Orders
Interfaces
Edit in GitHub
Log an issue
Orders interfaces
Use the following interfaces to return details about customer orders:
CreditMemoItemInterface
InvoiceItemInterface
OrderItemInterface
ShipmentItemInterface
requestReturn
CreditMemoInterface
Last updated 9/7/2023
Was this helpful?
Yes
No
