syncPaymentOrder mutation

data-variant=info

data-slots=text

This mutation is available automatically on Adobe Commerce as a Cloud Service. On Adobe Commerce on Cloud and on-premises instances, you must install Payment Services for Adobe Commerce 2.10.0 or higher to use this mutation.

The syncPaymentOrder mutation synchronizes the payment order details for the PayPal Smart Buttons and Apple Pay payment methods. This mutation updates the quote with the shipping, billing, email, and phone number details. It returns a Boolean value indicating whether the synchronization was successful.

You must run this mutation after running the createPaymentOrder mutation.

Syntax

mutation {
  syncPaymentOrder(
    input: syncPaymentOrderInput!
  )
}

Reference

The syncPaymentOrder reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example runs the syncPaymentOrder mutation.

Request:

mutation {
  syncPaymentOrder(input: {
    cartId: "AJCY8dhIfuch9LcDHAxEkw7oG3DjGdKt"
    id: "8J864634M9466143S"
  })
}

Response:

{
  "data": {
    "syncPaymentOrder": true
  }
}