Organizations > Entities > entitiesCreate
Commerce APIOrganizationsEntitiesentitiesCreate

entitiesCreate

POST:entities.json

Description

Create a new entity.

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

Topic: Entities

Arguments

data: [EntityCreate!]!

Main argument for mutations.


entity_id: String

Unique entity identifier. See also: Unique Identifiers

Example: "en_EQzGqWoY"


Data Argument Fields

name: String!

The name of the entity

Example: "FooBar Inc."

Valid when: name is not empty

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


organization_id: String!

Organization this entity belongs to

Example: "og_EQzGqWoY"

Valid when: organization_id is not empty

Valid when: organization_id matches regexp pattern: ^og_


Result

[Entity!]

Preview (typescript)

Loading module