Shop API - Checkout

Complete the checkout process and create orders.

Save Billing Address

Save billing address for checkout.

mutation SaveBillingAddress($input: SaveAddressInput!) {
  saveCustomerAddress(input: $input) {
    address {
      id
      firstName
      lastName
      address
      city
      state
      country
      zipCode
    }
  }
}

Variables:

{
  "input": {
    "firstName": "John",
    "lastName": "Doe",
    "address": "123 Main St",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "zipCode": "10001"
  }
}

Estimate Shipping

Get available shipping methods and costs.

mutation EstimateShipping($input: EstimateShippingInput!) {
  estimateShipping(input: $input) {
    shippingMethods {
      edges {
        node {
          code
          title
          description
          price
        }
      }
    }
  }
}

Variables:

{
  "input": {
    "cartId": "cart-id",
    "country": "US",
    "state": "CA",
    "zipCode": "90210"
  }
}

Set Shipping Method

Select a shipping method for the order.

mutation SetShipping($input: ShippingMethodInput!) {
  saveShippingMethod(input: $input) {
    cart {
      id
      shippingTotal
      grandTotal
    }
  }
}

Variables:

{
  "input": {
    "cartId": "cart-id",
    "shippingMethodCode": "flatrate_flatrate"
  }
}

Get Payment Methods

Retrieve available payment methods for the store.

query GetPaymentMethods($cartId: String!) {
  paymentMethods(cartId: $cartId) {
    edges {
      node {
        code
        title
        description
        image
      }
    }
  }
}

Set Payment Method

Select a payment method for the order.

mutation SetPayment($input: PaymentMethodInput!) {
  savePaymentMethod(input: $input) {
    status
    message
  }
}

Variables:

{
  "input": {
    "cartId": "cart-id",
    "method": "paypal"
  }
}

Create Order (Authenticated)

Place an order as an authenticated customer.

mutation CreateOrder($input: CreateOrderInput!) {
  createOrder(input: $input) {
    order {
      id
      incrementId
      status
      grandTotal
      createdAt
    }
  }
}

Variables:

{
  "input": {
    "cartId": "cart-id",
    "billingAddressId": "1",
    "shippingAddressId": "1",
    "shippingMethod": "flatrate_flatrate",
    "paymentMethod": "paypal"
  }
}

Create Order (Guest)

Place an order as a guest user.

mutation CreateGuestOrder($input: CreateGuestOrderInput!) {
  createGuestOrder(input: $input) {
    order {
      id
      incrementId
      status
      grandTotal
    }
  }
}

Variables:

{
  "input": {
    "cartId": "cart-id",
    "billingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "address": "123 Main St",
      "city": "New York",
      "country": "US",
      "state": "NY",
      "zipCode": "10001"
    },
    "shippingMethod": "flatrate_flatrate",
    "paymentMethod": "paypal"
  }
}

Related Resources

• Cart
• Orders
• Customers