paymentTermsCreate - admin-graphql - MUTATION

Version: 2024-10

Description:

Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.

Access Scopes

`write_payment_terms` access scope. Also: The user must have access to orders or draft orders.

Arguments

• paymentTermsAttributes: PaymentTermsCreateInput! - The attributes used to create the payment terms.
• referenceId: ID! - Specifies the reference orderId to add the payment terms for.

Returns

• paymentTerms: PaymentTerms The created payment terms.
• userErrors: PaymentTermsCreateUserError! The list of errors that occurred from executing the mutation.

Examples

• Create due on receipt payment terms

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }\",\n \"variables\": {\n    \"referenceId\": \"gid://shopify/Order/922426937\",\n    \"paymentTermsAttributes\": {\n      \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/1\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n        paymentTerms {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/1\"\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"referenceId\": \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\": {\n    \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/1\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\" => [\n    \"paymentTermsTemplateId\" => \"gid://shopify/PaymentTermsTemplate/1\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/1\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n  paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n    paymentTerms {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
    }
  }

  response: {
    "data": {
      "paymentTermsCreate": {
        "paymentTerms": {
          "id": "gid://shopify/PaymentTerms/1054663035"
        },
        "userErrors": []
      }
    }
  }

  Create fixed payment terms

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }\",\n \"variables\": {\n    \"referenceId\": \"gid://shopify/Order/922426937\",\n    \"paymentTermsAttributes\": {\n      \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n      \"paymentSchedules\": [\n        {\n          \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n        paymentTerms {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n        \"paymentSchedules\": [\n          {\n            \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n          }\n        ]\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"referenceId\": \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\": {\n    \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n    \"paymentSchedules\": [{\"dueAt\"=>\"2022-06-13T22:35:23.311Z\"}]\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\" => [\n    \"paymentTermsTemplateId\" => \"gid://shopify/PaymentTermsTemplate/7\",\n    \"paymentSchedules\" => [{\"dueAt\"=>\"2022-06-13T22:35:23.311Z\"}],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n        \"paymentSchedules\": [\n          {\n            \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n  paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n    paymentTerms {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
      "paymentSchedules": [
        {
          "dueAt": "2022-06-13T22:35:23.311Z"
        }
      ]
    }
  }

  response: {
    "data": {
      "paymentTermsCreate": {
        "paymentTerms": {
          "id": "gid://shopify/PaymentTerms/1054663034"
        },
        "userErrors": []
      }
    }
  }

  Create net payment terms

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }\",\n \"variables\": {\n    \"referenceId\": \"gid://shopify/Order/922426937\",\n    \"paymentTermsAttributes\": {\n      \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n      \"paymentSchedules\": [\n        {\n          \"issuedAt\": \"2022-06-13T22:30:18.019Z\"\n        }\n      ]\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n        paymentTerms {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n        \"paymentSchedules\": [\n          {\n            \"issuedAt\": \"2022-06-13T22:30:18.019Z\"\n          }\n        ]\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"referenceId\": \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\": {\n    \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n    \"paymentSchedules\": [{\"issuedAt\"=>\"2022-06-13T22:30:18.019Z\"}]\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/Order/922426937\",\n  \"paymentTermsAttributes\" => [\n    \"paymentTermsTemplateId\" => \"gid://shopify/PaymentTermsTemplate/2\",\n    \"paymentSchedules\" => [{\"issuedAt\"=>\"2022-06-13T22:30:18.019Z\"}],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n      paymentTerms {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"referenceId\": \"gid://shopify/Order/922426937\",\n      \"paymentTermsAttributes\": {\n        \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n        \"paymentSchedules\": [\n          {\n            \"issuedAt\": \"2022-06-13T22:30:18.019Z\"\n          }\n        ]\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {\n  paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {\n    paymentTerms {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
      "paymentSchedules": [
        {
          "issuedAt": "2022-06-13T22:30:18.019Z"
        }
      ]
    }
  }

  response: {
    "data": {
      "paymentTermsCreate": {
        "paymentTerms": {
          "id": "gid://shopify/PaymentTerms/1054663033"
        },
        "userErrors": []
      }
    }
  }