For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • MUTcreateCart
          • MUTdeleteCart
          • MUTaddCartLineItems
          • MUTupdateCartLineItem
          • MUTdeleteCartLineItem
          • MUTupdateCartCurrency
          • MUTassignCartToCustomer
          • MUTunassignCartFromCustomer
          • MUTcreateCartMetafield
          • MUTupdateCartMetafield
          • MUTdeleteCartMetafield
          • MUTcreateCartRedirectUrls
          • MUTcreateCheckout
          • MUTupdateCheckout
          • MUTaddCheckoutBillingAddress
          • MUTupdateCheckoutBillingAddress
          • MUTupdateCheckoutCustomerMessage
          • MUTselectCheckoutShippingOption
          • MUTapplyCheckoutCoupon
          • MUTunapplyCheckoutCoupon
          • MUTapplyCheckoutGiftCertificate
          • MUTunapplyCheckoutGiftCertificate
          • MUTapplyCheckoutSpamProtection
          • MUTaddCheckoutShippingConsignments
          • MUTupdateCheckoutShippingConsignment
          • MUTdeleteCheckoutConsignment
          • MUTcompleteCheckout
          • MUTlogin
          • MUTlogout
          • MUTcreateWishlist
          • MUTaddWishlistItems
          • MUTdeleteWishlistItems
          • MUTupdateWishlist
          • MUTdeleteWishlists
          • MUTloginWithCustomerLoginJwt
          • MUTsubmitContactUs
          • MUTgenerateSessionSyncJwt
          • MUTvalidateSessionSyncJwt
          • MUTproductViewedEvent
          • MUTpageViewedEvent
          • MUTvisitStartedEvent
          • MUTsearchProductEvent
          • MUTpreviewGiftCertificate
          • MUTregisterCompany
          • MUTaddProductReview
          • MUTchangePassword
          • MUTrequestResetPassword
          • MUTresetPassword
          • MUTregisterCustomer
          • MUTupdateCustomer
          • MUTaddCustomerAddress
          • MUTupdateCustomerAddress
          • MUTdeleteCustomerAddress
          • MUTpayment
          • MUTsubscribe
          • MUTunsubscribe
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontMutations

registerCompany

Example Query
1mutation ExampleMutation($input: RegisterCompanyInput) {
2  registerCompany(input: $input) {
3    entityId
4    status
5    errors
6  }
7}
Variables
1{
2  "input": {
3    "name": "example",
4    "email": "example",
5    "phone": "example",
6    "fileList": [
7      {
8        "fileId": "example"
9      }
10    ],
11    "companyUser": {
12      "extraFields": {
13        "multipleChoices": [
14          {
15            "name": "example",
16            "fieldValue": "example"
17          }
18        ],
19        "numbers": [
20          {
21            "name": "example",
22            "number": "BigDecimal"
23          }
24        ],
25        "texts": [
26          {
27            "name": "example",
28            "text": "example"
29          }
30        ],
31        "multilineTexts": [
32          {
33            "name": "example",
34            "multilineText": "example"
35          }
36        ]
37      }
38    },
39    "extraFields": {
40      "multipleChoices": [
41        {
42          "name": "example",
43          "fieldValue": "example"
44        }
45      ],
46      "numbers": [
47        {
48          "name": "example",
49          "number": "BigDecimal"
50        }
51      ],
52      "texts": [
53        {
54          "name": "example",
55          "text": "example"
56        }
57      ],
58      "multilineTexts": [
59        {
60          "name": "example",
61          "multilineText": "example"
62        }
63      ]
64    },
65    "address": {
66      "firstName": "example",
67      "lastName": "example",
68      "address1": "example",
69      "address2": "example",
70      "city": "example",
71      "countryCode": "example",
72      "stateOrProvince": "example",
73      "phone": "example",
74      "postalCode": "example",
75      "extraFields": {
76        "multipleChoices": [
77          {
78            "name": "example",
79            "fieldValue": "example"
80          }
81        ],
82        "numbers": [
83          {
84            "name": "example",
85            "number": "BigDecimal"
86          }
87        ],
88        "texts": [
89          {
90            "name": "example",
91            "text": "example"
92          }
93        ],
94        "multilineTexts": [
95          {
96            "name": "example",
97            "multilineText": "example"
98          }
99        ]
100      }
101    }
102  }
103}
Example response
1{
2  "data": {
3    "registerCompany": {
4      "entityId": 0,
5      "status": "APPROVED",
6      "errors": [
7        {
8          "path": [
9            "example"
10          ],
11          "message": "example"
12        }
13      ]
14    }
15  }
16}
Register a new company for B2B.
Was this page helpful?
Previous

previewGiftCertificate

Next

addProductReview

Built with

Arguments

inputRegisterCompanyInputRequired
The values to use for company registration.

Returns

a RegisterCompanyResult
errorslist of RegisterCompanyErrors
List of errors that occurred during registration.
entityIdInteger
The unique identifier of the registered company.
statusEnum

The current status of the registration process (e.g., PENDING, APPROVED).

Allowed values: