👩‍💻

【Shopify.dev和訳】Storefront API/Reference/Checktouts②

2021/10/23に公開約79,400字

この記事について

この記事は、Storefront API/Reference/Checktoutsの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Checkout APIs (MUTATIONS)

MUTATIONS

checkoutAttributesUpdate(mutation)

allowPartialAddressestrueの場合、チェックアウトの属性を更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutAttributesUpdate($checkoutId: ID!, $input: CheckoutAttributesUpdateInput!) {
  checkoutAttributesUpdate(checkoutId: $checkoutId, input: $input) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
input ( CheckoutAttributesUpdateInput! ) required チェックアウトの属性を更新するために使用されるフィールド。

CheckoutAttributesUpdateInput fields

allowPartialAddressesBoolean
属性の完全な検証をスキップして、チェックアウトで部分的なアドレスを設定できます。必要な属性は、都市、州、および国です。アドレスの完全な検証は、完了時に引き続き実行されます。各操作のデフォルトはfalseです。

customAttributes ([AttributeInput!])
チェックアウトに追加される追加情報のリスト。

note (String)
ショップのオーナーがチェックアウトに添付できるオプションのメモのテキスト。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutAttributesUpdateV2(mutation)

allowPartialAddressestrueの場合、チェックアウトの属性を更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutAttributesUpdateV2($checkoutId: ID!, $input: CheckoutAttributesUpdateV2Input!) {
  checkoutAttributesUpdateV2(checkoutId: $checkoutId, input: $input) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "input": {}
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
input ( CheckoutAttributesUpdateV2Input! ) required 更新するチェックアウト属性。

CheckoutAttributesUpdateV2Input fields

allowPartialAddresses (Boolean)
属性の完全な検証をスキップして、チェックアウトで部分的なアドレスを設定できます。 必要な属性は、都市、州、および国です。アドレスの完全な検証は、完了時に引き続き実行されます。各操作のデフォルトはfalseです。

customAttributes ([AttributeInput!])
チェックアウトに追加される追加情報のリスト。

note (String)
ショップのオーナーがチェックアウトに添付できるオプションのメモのテキスト。

Return fields

checkout (Checkout)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCompleteFree(mutation)

支払い情報を提供せずにチェックアウトを完了します。この mutation は、無料のアイテムまたは購入価格がギフトカードでカバーされているアイテムに使用できます。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCompleteFree($checkoutId: ID!) {
  checkoutCompleteFree(checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCompleteWithCreditCard(mutation)

Shopify の Vault のクレジットカードトークンを使用してチェックアウトを完了します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCompleteWithCreditCard($checkoutId: ID!, $payment: CreditCardPaymentInput!) {
  checkoutCompleteWithCreditCard(checkoutId: $checkoutId, payment: $payment) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    payment {
      id
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "payment": {
    "amount": "placeholder",
    "idempotencyKey": "placeholder",
    "billingAddress": {},
    "vaultId": "placeholder"
  }
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
payment ( CreditCardPaymentInput! ) required 支払いとして適用するクレジットカード情報。

CreditCardPaymentInput fields

amount (Money!) required
お支払い金額。

billingAddress (MailingAddressInput!) required
支払いの請求先住所。

idempotencyKey (String!) required
重複請求を回避するために使用される、クライアントが生成した一意のキー。重複した支払いが見つかった場合、新しい支払いを作成する代わりに元の支払いが返されます。詳細については、べき等リクエストを参照してください。

test (Boolean)
可能であれば、テストモードで支払いを実行します。デフォルトはfalse

vaultId (String!) required
Shopify の Card Vault から返された ID。

Return fields

checkout (Checkout!)
支払いが適用されたチェックアウト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

payment (Payment)
試みられた支払いの表現。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCompleteWithTokenizedPayment(mutation)

トークン化された支払いでチェックアウトを完了します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCompleteWithTokenizedPayment($checkoutId: ID!, $payment: TokenizedPaymentInput!) {
  checkoutCompleteWithTokenizedPayment(checkoutId: $checkoutId, payment: $payment) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    payment {
      id
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "payment": {
    "amount": "placeholder",
    "idempotencyKey": "placeholder",
    "billingAddress": {},
    "type": "placeholder",
    "paymentData": "placeholder"
  }
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
payment ( TokenizedPaymentInput! ) required トークン化された支払いとして適用する情報。

TokenizedPaymentInput fields

amount (Money!) required
お支払い金額。

billingAddress (MailingAddressInput!) required
支払いの請求先住所。

idempotencyKey (String!) required
重複請求を回避するために使用される、クライアントが生成した一意のキー。重複した支払いが見つかった場合、新しい支払いを作成する代わりに元の支払いが返されます。詳細については、べき等リクエストを参照してください。

identifier (String)
AndroidPay の支払いにのみ使用されるパブリックハッシュキー。

paymentData (String!) required
トークン化された支払いに必要な支払いデータを含む単純な文字列または JSON。

test (Boolean)
可能であれば、テストモードで支払いを実行します。デフォルトはfalse

type (String!) required
支払いトークンのタイプ。

Return fields

checkout (Checkout!)
支払いが適用されたチェックアウト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

payment (Payment)
試みられた支払いの表現。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCompleteWithTokenizedPaymentV2(mutation)

トークン化された支払いでチェックアウトを完了します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCompleteWithTokenizedPaymentV2($checkoutId: ID!, $payment: TokenizedPaymentInputV2!) {
  checkoutCompleteWithTokenizedPaymentV2(
    checkoutId: $checkoutId
    payment: $payment
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    payment {
      id
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "payment": {
    "paymentAmount": {
      "amount": "placeholder",
      "currencyCode": "placeholder"
    },
    "idempotencyKey": "placeholder",
    "billingAddress": {},
    "paymentData": "placeholder",
    "type": "placeholder"
  }
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
payment ( TokenizedPaymentInputV2! ) required トークン化された支払いとして適用する情報。

TokenizedPaymentInputV2 fields

billingAddress (MailingAddressInput!) required
支払いの請求先住所。

idempotencyKey (String!) required
重複請求を回避するために使用される、クライアントが生成した一意のキー。重複した支払いが見つかった場合、新しい支払いを作成する代わりに元の支払いが返されます。詳細については、べき等リクエストを参照してください。

identifier (String)
AndroidPay の支払いにのみ使用されるパブリックハッシュキー。

paymentAmount (MoneyInput!) required
支払いの金額と通貨。

paymentData (String!) required
トークン化された支払いに必要な支払いデータを含む単純な文字列または JSON。

test (Boolean)
可能であれば、テストモードで支払いを実行します。デフォルトはfalse

type (String!) required
支払いトークンのタイプ。

Return fields

checkout (Checkout!)
支払いが適用されたチェックアウト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

payment (Payment)
試みられた支払いの表現。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCompleteWithTokenizedPaymentV3(mutation)

トークン化された支払いでチェックアウトを完了します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCompleteWithTokenizedPaymentV3($checkoutId: ID!, $payment: TokenizedPaymentInputV3!) {
  checkoutCompleteWithTokenizedPaymentV3(
    checkoutId: $checkoutId
    payment: $payment
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    payment {
      id
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "payment": {
    "paymentAmount": {
      "amount": "placeholder",
      "currencyCode": "placeholder"
    },
    "idempotencyKey": "placeholder",
    "billingAddress": {},
    "paymentData": "placeholder",
    "type": "placeholder"
  }
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
payment ( TokenizedPaymentInputV3! ) required トークン化された支払いとして適用する情報。

TokenizedPaymentInputV2 fields

billingAddress (MailingAddressInput!) required
支払いの請求先住所。

idempotencyKey (String!) required
重複請求を回避するために使用される、クライアントが生成した一意のキー。重複した支払いが見つかった場合、新しい支払いを作成する代わりに元の支払いが返されます。詳細については、べき等リクエストを参照してください。

identifier (String)
AndroidPay の支払いにのみ使用されるパブリックハッシュキー。

paymentAmount (MoneyInput!) required
支払いの金額と通貨。

paymentData (String!) required
トークン化された支払いに必要な支払いデータを含む単純な文字列または JSON。

test (Boolean)
可能であれば、テストモードで支払いを実行します。デフォルトはfalse

type (PaymentTokenType!) required
支払いトークンのタイプ。

Return fields

checkout (Checkout!)
支払いが適用されたチェックアウト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

payment (Payment)
試みられた支払いの表現。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCreate(mutation)

新しいチェックアウトを作成します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCreate($input: CheckoutCreateInput!) {
  checkoutCreate(input: $input) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    queueToken
  }
}

変数

{
  "input": {}
}

引数

引数 説明
input ( CheckoutCreateInput! ) required チェックアウトの作成に使用されるフィールド。
queueToken ( String ) チェックアウトキュートークン。一部の店舗でのみご利用いただけます。

CheckoutCreateInput fields

allowPartialAddresses (Boolean)
属性の完全な検証をスキップして、チェックアウトで部分的なアドレスを設定できます。必要な属性は、都市、州、および国です。アドレスの完全な検証は、完了時に引き続き実行されます。デフォルトはnullです。

buyerIdentity (CheckoutBuyerIdentityInput)
チェックアウトに関連付けられた顧客の ID。

customAttributes ([AttributeInput!])
チェックアウトに追加される追加情報のリスト。

email (String)
顧客がチェックアウトしたい電子メール。

lineItems ([CheckoutLineItemInput!])
ラインアイテムオブジェクトのリスト。各オブジェクトには、チェックアウトのアイテムに関する情報が含まれています。

note (String)
ショップのオーナーがチェックアウトに添付できるオプションのメモのテキスト。

presentmentCurrencyCode (CurrencyCode)
ショップで有効になっている提示通貨の 1 つの 3 文字の通貨コード。このフィールドを含めると、指定した通貨でチェックアウトが作成されます。デフォルトでは、新しいチェックアウトはショップの主要通貨で作成されます。この引数は非推奨です。代わりにcountryフィールドを使用してください。

shippingAddress (MailingAddressInput)
広告申込情報の配送先住所。

Return fields

checkout (Checkout)
新しいチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

queueToken (String)
チェックアウトキュートークン。一部の店舗でのみご利用いただけます。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCustomerAssociate(mutation)

顧客をチェックアウトに関連付けます。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCustomerAssociate($checkoutId: ID!, $customerAccessToken: String!) {
  checkoutCustomerAssociate(
    checkoutId: $checkoutId
    customerAccessToken: $customerAccessToken
  ) {
    checkout {
      id
    }
    customer {
      id
    }
    userErrors {
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
customerAccessToken ( String! ) required 関連付ける顧客の顧客アクセストークン。

Return fields

checkout (Checkout)
更新されたチェックアウトオブジェクト。

customer (Customer)
関連する顧客オブジェクト。

userErrors ([UserError!]!)
mutation の実行によって発生したエラーのリスト。

checkoutCustomerAssociateV2(mutation)

顧客をチェックアウトに関連付けます。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCustomerAssociateV2($checkoutId: ID!, $customerAccessToken: String!) {
  checkoutCustomerAssociateV2(
    checkoutId: $checkoutId
    customerAccessToken: $customerAccessToken
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
    customer {
      id
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "customerAccessToken": "ae0f1d2e179c9571122a0595a6ac8125"
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
customerAccessToken ( String! ) required 関連付ける顧客の顧客アクセストークン。

Return fields

checkout (Checkout)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

customer (Customer)
関連する顧客オブジェクト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCustomerDisassociate(mutation)

現在のチェックアウト顧客とチェックアウトの関連付けを解除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCustomerDisassociate($checkoutId: ID!) {
  checkoutCustomerDisassociate(checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutCustomerDisassociateV2(mutation)

現在のチェックアウト顧客とチェックアウトの関連付けを解除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutCustomerDisassociateV2($checkoutId: ID!) {
  checkoutCustomerDisassociateV2(checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutDiscountCodeApply(mutation)

割引コードを使用して、既存のチェックアウトに割引を適用します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutDiscountCodeApply($discountCode: String!, $checkoutId: ID!) {
  checkoutDiscountCodeApply(discountCode: $discountCode, checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "discountCode": "placeholder",
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
discountCode ( String! ) required チェックアウトに適用する割引コード。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutDiscountCodeApplyV2(mutation)

割引コードを使用して、既存のチェックアウトに割引を適用します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutDiscountCodeApplyV2($discountCode: String!, $checkoutId: ID!) {
  checkoutDiscountCodeApplyV2(
    discountCode: $discountCode
    checkoutId: $checkoutId
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "discountCode": "placeholder",
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
discountCode ( String! ) required チェックアウトに適用する割引コード。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutDiscountCodeRemove(mutation)

適用された割引を既存のチェックアウトから削除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutDiscountCodeRemove($checkoutId: ID!) {
  checkoutDiscountCodeRemove(checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutEmailUpdate(mutation)

既存のチェックアウトの電子メールを更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutEmailUpdate($checkoutId: ID!, $email: String!) {
  checkoutEmailUpdate(checkoutId: $checkoutId, email: $email) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "email": "user@example.com"
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
email ( String! ) チェックアウトを更新するための電子メール。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutEmailUpdateV2(mutation)

既存のチェックアウトの電子メールを更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutEmailUpdateV2($checkoutId: ID!, $email: String!) {
  checkoutEmailUpdateV2(checkoutId: $checkoutId, email: $email) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "email": "user@example.com"
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
email ( String! ) チェックアウトを更新するための電子メール。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutGiftCardApply(mutation)

ギフトカードコードを使用して、既存のチェックアウトにギフトカードを適用します。これにより、現在適用されているすべてのギフトカードが置き換えられます。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutGiftCardApply($giftCardCode: String!, $checkoutId: ID!) {
  checkoutGiftCardApply(giftCardCode: $giftCardCode, checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "giftCardCode": "placeholder",
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
giftCardCode ( String! ) チェックアウト時に適用するギフトカードのコード。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutGiftCardRemove(mutation)

適用されたギフトカードをチェックアウトから削除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutGiftCardRemove($appliedGiftCardId: ID!, $checkoutId: ID!) {
  checkoutGiftCardRemove(
    appliedGiftCardId: $appliedGiftCardId
    checkoutId: $checkoutId
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "appliedGiftCardId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
appliedGiftCardId ( ID! ) required チェックアウトから削除する適用済みギフトカードの ID。
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutGiftCardRemoveV2(mutation)

適用されたギフトカードをチェックアウトから削除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutGiftCardRemoveV2($appliedGiftCardId: ID!, $checkoutId: ID!) {
  checkoutGiftCardRemoveV2(
    appliedGiftCardId: $appliedGiftCardId
    checkoutId: $checkoutId
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "appliedGiftCardId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
appliedGiftCardId ( ID! ) required チェックアウトから削除する適用済みギフトカードの ID。
checkoutId ( ID! ) required チェックアウトの ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutGiftCardsAppend(mutation)

既存のチェックアウトにギフトカードを追加します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutGiftCardsAppend($giftCardCodes: [String!]!, $checkoutId: ID!) {
  checkoutGiftCardsAppend(giftCardCodes: $giftCardCodes, checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "giftCardCodes": ["placeholder"],
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
giftCardCodes ( [String!]! ) required チェックアウトに追加するギフトカードコードのリスト。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutLineItemsAdd(mutation)

ラインアイテムのリストをチェックアウトに追加します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutLineItemsAdd($lineItems: [CheckoutLineItemInput!]!, $checkoutId: ID!) {
  checkoutLineItemsAdd(lineItems: $lineItems, checkoutId: $checkoutId) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "lineItems": [
    {
      "quantity": 1,
      "variantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
    }
  ],
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
lineItems ( [CheckoutLineItemInput!]! ) required チェックアウトに追加するラインアイテムオブジェクトのリスト。

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])
ラインアイテムに関する Key-Value ペアの配列形式の追加情報。

quantity (Int!) required
広告申込情報の数量。

variantId (ID!) required
ラインアイテムの製品バリアントの識別子。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutLineItemsRemove(mutation)

既存のチェックアウトからラインアイテムを削除します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutLineItemsRemove($checkoutId: ID!, $lineItemIds: [ID!]!) {
  checkoutLineItemsRemove(checkoutId: $checkoutId, lineItemIds: $lineItemIds) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineItemIds": ["Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="]
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
lineItemIds ( [ID!]! ) required 削除するラインアイテム ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutLineItemsReplace(mutation)

ラインアイテムのリストをチェックアウトに設定します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutLineItemsReplace($lineItems: [CheckoutLineItemInput!]!, $checkoutId: ID!) {
  checkoutLineItemsReplace(lineItems: $lineItems, checkoutId: $checkoutId) {
    checkout {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

変数

{
  "lineItems": [
    {
      "quantity": 1,
      "variantId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
    }
  ],
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
lineItemIds ( [CheckoutLineItemInput!]! ) required チェックアウト時に設定するラインアイテムオブジェクトのリスト。

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])
ラインアイテムに関する Key-Value ペアの配列形式の追加情報。

quantity (Int!) required
広告申込情報の数量。

variantId (ID!) required
ラインアイテムの製品バリアントの識別子。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

checkoutLineItemsUpdate(mutation)

チェックアウト時にラインアイテムを更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutLineItemsUpdate($checkoutId: ID!, $lineItems: [CheckoutLineItemUpdateInput!]!) {
  checkoutLineItemsUpdate(checkoutId: $checkoutId, lineItems: $lineItems) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "lineItems": [{}]
}

引数

引数 説明
checkoutId ( ID! ) required 広告申込情報を更新するチェックアウト。
lineItemIds ( [CheckoutLineItemUpdateInput!]! ) required 更新するラインアイテム。

CheckoutLineItemInput fields

customAttributes ([AttributeInput!])
ラインアイテムに関する Key-Value ペアの配列形式の追加情報。

id (ID) required
広告申込情報の識別子。

quantity (Int) required
広告申込情報の数量。

variantId (ID!) required
広告申込情報のバリアント ID。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutShippingAddressUpdate(mutation)

既存のチェックアウトの配送先住所を更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutShippingAddressUpdate($shippingAddress: MailingAddressInput!, $checkoutId: ID!) {
  checkoutShippingAddressUpdate(
    shippingAddress: $shippingAddress
    checkoutId: $checkoutId
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "shippingAddress": {},
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
shippingAddress ( MailingAddressInput! ) required 広告申込情報の配送先住所。

MailingAddressInput fields

address1 (String)
アドレスの最初の行。通常、住所または私書箱番号。

address2 (String)
アドレスの 2 行目。通常、アパート、スイート、またはユニットの番号。

city (String)
都市、地区、村、または町の名前。

company (String)
顧客の会社または組織の名前。

country (String)
国の名前。

firstName (String)
顧客の名。

lastName (String)
顧客の姓。

phone (String)
顧客の一意の電話番号。

E.164 標準を使用してフォーマットされています。たとえば、+ 16135551111 です。

province (String)
州、州、地区など、住所の地域。

zip (String)
住所の郵便番号。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutShippingAddressUpdateV2(mutation)

既存のチェックアウトの配送先住所を更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutShippingAddressUpdateV2($shippingAddress: MailingAddressInput!, $checkoutId: ID!) {
  checkoutShippingAddressUpdateV2(
    shippingAddress: $shippingAddress
    checkoutId: $checkoutId
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "shippingAddress": {},
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
shippingAddress ( MailingAddressInput! ) required 広告申込情報の配送先住所。

MailingAddressInput fields

address1 (String)
アドレスの最初の行。通常、住所または私書箱番号。

address2 (String)
アドレスの 2 行目。通常、アパート、スイート、またはユニットの番号。

city (String)
都市、地区、村、または町の名前。

company (String)
顧客の会社または組織の名前。

country (String)
国の名前。

firstName (String)
顧客の名。

lastName (String)
顧客の姓。

phone (String)
顧客の一意の電話番号。

E.164 標準を使用してフォーマットされています。たとえば、+ 16135551111 です。

province (String)
州、州、地区など、住所の地域。

zip (String)
住所の郵便番号。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

checkoutShippingLineUpdate(mutation)

既存のチェックアウトの出荷ラインを更新します。

このパートで

Interactive の例

これは mutation クエリの例です。以下の埋め込みインタラクティブツールを使用して、クエリを編集します。

ヒント:フィールドの自動入力にはCtrl+Spaceを使用してください。

mutation checkoutShippingLineUpdate($checkoutId: ID!, $shippingRateHandle: String!) {
  checkoutShippingLineUpdate(
    checkoutId: $checkoutId
    shippingRateHandle: $shippingRateHandle
  ) {
    checkout {
      id
    }
    checkoutUserErrors {
      code
      field
      message
    }
  }
}

変数

{
  "checkoutId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "shippingRateHandle": "placeholder"
}

引数

引数 説明
checkoutId ( ID! ) required チェックアウトの ID。
shippingRateHandle ( String! ) required Checkoutの配送プロバイダー、価格、およびタイトルの組み合わせに対する一意の識別子。これにより、顧客はavailableShippingRatesを選択できます。

Return fields

checkout (Checkout!)
更新されたチェックアウトオブジェクト。

checkoutUserErrors ([CheckoutUserError!]!)
mutation の実行によって発生したエラーのリスト。

Deprecated return fields

  • userErrors ([UserError!]!)
    mutation の実行によって発生したエラーのリスト。

非推奨の警告

代わりにcheckoutUserErrorsを使用してください
:::

Discussion

ログインするとコメントできます