Organizations > Organizations > organizationsCreate
Commerce APIOrganizationsOrganizationsorganizationsCreate

organizationsCreate

POST:organizations.json

Description

Create a new organization.

Even though API takes array as body, creating only one organization at a time is allowed. API looks like that for consistency reasons.

Topic: Organizations

Arguments

data: [OrganizationCreate!]!

Main argument for mutations.


organization_id: String

Unique organization identifier. See also: Unique Identifiers

Example: "og_EQzGqWoY"


Data Argument Fields

billing_address: AddressCreate!

Billing address of the organization


name: String!

The name of the organization

Example: "FooBar Inc."

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


plan_id: String

Unique identifier for the subscription plan a shop is on

Example: "Medium"


test: Boolean

Whether organization is in test mode or not

Example: false


Result

[Organization!]

Preview (typescript)

Loading module