Choose a version:

Anchor to shopPayPaymentRequestSessionCreate

shopPayPaymentRequestSessionCreate

mutation

Creates a Shop Pay payment request session for processing payments. The session includes a checkout URL where customers complete their purchase and a token for subsequent operations like submitting the payment.

The sourceIdentifier must be unique across all orders to ensure accurate reconciliation.

For a complete integration guide including the JavaScript SDK setup and checkout flow, refer to the Shop Component API documentation. For implementation steps, see the development journey guide. For common error scenarios, see the troubleshooting guide.

Anchor to Arguments

Arguments

Anchor to paymentRequestpaymentRequest

•ShopPayPaymentRequestInput!

required

A payment request object.

Anchor to sourceIdentifiersourceIdentifier

•String!

required

A unique identifier for the payment request session.

Was this section helpful?

Anchor to ShopPayPaymentRequestSessionCreatePayload returnsShopPayPaymentRequestSessionCreatePayload returns

Anchor to shopPayPaymentRequestSessionshopPayPaymentRequestSession •ShopPayPaymentRequestSession: The new Shop Pay payment request session object.
Anchor to userErrorsuserErrors •[UserErrorsShopPayPaymentRequestSessionUserErrors!]! non-null: Error codes for failed Shop Pay payment request session mutations.

Was this section helpful?

Examples

shopPayPaymentRequestSessionCreate reference

Mutation Reference

mutation shopPayPaymentRequestSessionCreate($sourceIdentifier: String!, $paymentRequest: ShopPayPaymentRequestInput!) {

shopPayPaymentRequestSessionCreate(sourceIdentifier: $sourceIdentifier, paymentRequest: $paymentRequest) {

shopPayPaymentRequestSession {

# ShopPayPaymentRequestSession fields

}

userErrors {

field

message

}

Input

{

"sourceIdentifier": "<your-sourceIdentifier>",

"paymentRequest": {

"discountCodes": [

"<your-discountCodes>"

"lineItems": [

{

"label": "<your-label>",

"quantity": 1,

"sku": "<your-sku>",

"requiresShipping": true,

"image": {},

"originalLinePrice": {},

"finalLinePrice": {},

"lineDiscounts": [

{}

"originalItemPrice": {},

"finalItemPrice": {},

"itemDiscounts": [

{}

]

}

"shippingLines": [

{

"code": "<your-code>",

"label": "<your-label>",

"amount": {}

}

"total": {

"amount": "29.99",

"currencyCode": "USD"

"subtotal": {

"amount": "29.99",

"currencyCode": "USD"

"discounts": [

{

"label": "<your-label>",

"amount": {}

}

"totalShippingPrice": {

"discounts": [

{}

"originalTotal": {},

"finalTotal": {}

"totalTax": {

"amount": "29.99",

"currencyCode": "USD"

"deliveryMethods": [

{

"code": "<your-code>",

"label": "<your-label>",

"detail": "<your-detail>",

"amount": {},

"minDeliveryDate": "",

"maxDeliveryDate": "",

"deliveryExpectationLabel": "<your-deliveryExpectationLabel>"

}

"selectedDeliveryMethodType": "SHIPPING",

"locale": "<your-locale>",

"presentmentCurrency": "USD",

"paymentMethod": "<your-paymentMethod>"

}

Variables

{
  "sourceIdentifier": "<your-sourceIdentifier>",
  "paymentRequest": {
    "discountCodes": [
      "<your-discountCodes>"
    ],
    "lineItems": [
      {
        "label": "<your-label>",
        "quantity": 1,
        "sku": "<your-sku>",
        "requiresShipping": true,
        "image": {},
        "originalLinePrice": {},
        "finalLinePrice": {},
        "lineDiscounts": [
          {}
        ],
        "originalItemPrice": {},
        "finalItemPrice": {},
        "itemDiscounts": [
          {}
        ]
      }
    ],
    "shippingLines": [
      {
        "code": "<your-code>",
        "label": "<your-label>",
        "amount": {}
      }
    ],
    "total": {
      "amount": "29.99",
      "currencyCode": "USD"
    },
    "subtotal": {
      "amount": "29.99",
      "currencyCode": "USD"
    },
    "discounts": [
      {
        "label": "<your-label>",
        "amount": {}
      }
    ],
    "totalShippingPrice": {
      "discounts": [
        {}
      ],
      "originalTotal": {},
      "finalTotal": {}
    },
    "totalTax": {
      "amount": "29.99",
      "currencyCode": "USD"
    },
    "deliveryMethods": [
      {
        "code": "<your-code>",
        "label": "<your-label>",
        "detail": "<your-detail>",
        "amount": {},
        "minDeliveryDate": "",
        "maxDeliveryDate": "",
        "deliveryExpectationLabel": "<your-deliveryExpectationLabel>"
      }
    ],
    "selectedDeliveryMethodType": "SHIPPING",
    "locale": "<your-locale>",
    "presentmentCurrency": "USD",
    "paymentMethod": "<your-paymentMethod>"
  }
}

Schema

input ShopPayPaymentRequestInput {
  discountCodes: [String!]
  lineItems: [ShopPayPaymentRequestLineItemInput!]
  shippingLines: [ShopPayPaymentRequestShippingLineInput!]
  total: MoneyInput!
  subtotal: MoneyInput!
  discounts: [ShopPayPaymentRequestDiscountInput!]
  totalShippingPrice: ShopPayPaymentRequestTotalShippingPriceInput
  totalTax: MoneyInput
  deliveryMethods: [ShopPayPaymentRequestDeliveryMethodInput!]
  selectedDeliveryMethodType: ShopPayPaymentRequestDeliveryMethodType
  locale: String!
  presentmentCurrency: CurrencyCode!
  paymentMethod: String
}

input ShopPayPaymentRequestLineItemInput {
  label: String
  quantity: Int!
  sku: String
  requiresShipping: Boolean
  image: ShopPayPaymentRequestImageInput
  originalLinePrice: MoneyInput
  finalLinePrice: MoneyInput
  lineDiscounts: [ShopPayPaymentRequestDiscountInput!]
  originalItemPrice: MoneyInput
  finalItemPrice: MoneyInput
  itemDiscounts: [ShopPayPaymentRequestDiscountInput!]
}

input ShopPayPaymentRequestShippingLineInput {
  code: String
  label: String
  amount: MoneyInput
}

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}

input ShopPayPaymentRequestDiscountInput {
  label: String
  amount: MoneyInput
}

input ShopPayPaymentRequestTotalShippingPriceInput {
  discounts: [ShopPayPaymentRequestDiscountInput!]
  originalTotal: MoneyInput
  finalTotal: MoneyInput
}

input ShopPayPaymentRequestDeliveryMethodInput {
  code: String
  label: String
  detail: String
  amount: MoneyInput
  minDeliveryDate: ISO8601DateTime
  maxDeliveryDate: ISO8601DateTime
  deliveryExpectationLabel: String
}