paymentTermsDelete

mutation

Requires write_payment_terms access scope. Also: User must have either orders or draft orders access according to the reference.

Delete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.

Arguments

Anchor to inputinput • PaymentTermsDeleteInput!required: The input fields used to delete the payment terms.

Was this section helpful?

Anchor to PaymentTermsDeletePayload returnsPaymentTermsDeletePayload returns

Anchor to deletedIddeletedId • ID: The deleted payment terms ID.
Anchor to userErrorsuserErrors • [PaymentTermsDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete payment terms
paymentTermsDelete reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) {

paymentTermsDelete(input: $input) {

deletedId

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"paymentTermsId": "gid://shopify/PaymentTerms/977822362"

}

);

const data = await response.json();

mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) {
  paymentTermsDelete(input: $input) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) { paymentTermsDelete(input: $input) { deletedId userErrors { field message } } }",
 "variables": {
    "input": {
      "paymentTermsId": "gid://shopify/PaymentTerms/977822362"
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) {
    paymentTermsDelete(input: $input) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "paymentTermsId": "gid://shopify/PaymentTerms/977822362"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) {
      paymentTermsDelete(input: $input) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "paymentTermsId": "gid://shopify/PaymentTerms/977822362"
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation PaymentTermsDelete($input: PaymentTermsDeleteInput!) {
    paymentTermsDelete(input: $input) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "paymentTermsId": "gid://shopify/PaymentTerms/977822362"
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"paymentTermsId": "gid://shopify/PaymentTerms/977822362"

}

Response

JSON

{

"paymentTermsDelete": {

"deletedId": "gid://shopify/PaymentTerms/977822362",

"userErrors": []

}