Create a company
Description
Create a company with a company contact and company location.
Query
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
Variables
{
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
}
cURL
curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CompanyCreate($input: CompanyCreateInput!) { companyCreate(input: $input) { company { id name externalId mainContact { id customer { id email firstName lastName } } contacts(first: 5) { edges { node { id customer { email firstName lastName } } } } contactRoles(first: 5) { edges { node { id name } } } locations(first: 5) { edges { node { id name shippingAddress { firstName lastName address1 city province zip country } } } } } userErrors { field message code } } }",
"variables": {
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
}
}'
React Router
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
{
variables: {
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
},
},
);
const json = await response.json();
return json.data;
}
Ruby
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 CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
QUERY
variables = {
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
}
response = client.query(query: query, variables: variables)
Node.js
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
"variables": {
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
},
},
});
Shopify CLI
shopify app execute \
--query \
'mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}' \
--variables \
'{
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
}'
Direct API Access
const response = await fetch('shopify:admin/api/unstable/graphql.json', {
method: 'POST',
body: JSON.stringify({
query: `
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
externalId
mainContact {
id
customer {
id
email
firstName
lastName
}
}
contacts(first: 5) {
edges {
node {
id
customer {
email
firstName
lastName
}
}
}
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
`,
variables: {
"input": {
"company": {
"name": "Postal Cards Inc",
"externalId": "01456606-0001"
},
"companyLocation": {
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"address2": "8th Floor",
"city": "Ottawa",
"zoneCode": "ON",
"zip": "K2P 1L4",
"countryCode": "CA"
},
"billingSameAsShipping": true
},
"companyContact": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
},
}),
});
const { data } = await response.json();
console.log(data);
Response
{
"companyCreate": {
"company": {
"id": "gid://shopify/Company/1059559575",
"name": "Postal Cards Inc",
"externalId": "01456606-0001",
"mainContact": {
"id": "gid://shopify/CompanyContact/1059341835",
"customer": {
"id": "gid://shopify/Customer/1073339466",
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
},
"contacts": {
"edges": [
{
"node": {
"id": "gid://shopify/CompanyContact/1059341835",
"customer": {
"email": "avery.brown@example.com",
"firstName": "Avery",
"lastName": "Brown"
}
}
}
]
},
"contactRoles": {
"edges": [
{
"node": {
"id": "gid://shopify/CompanyContactRole/1007033458",
"name": "Location admin"
}
},
{
"node": {
"id": "gid://shopify/CompanyContactRole/1007033459",
"name": "Ordering only"
}
}
]
},
"locations": {
"edges": [
{
"node": {
"id": "gid://shopify/CompanyLocation/966871284",
"name": "Ottawa Postal Cards",
"shippingAddress": {
"firstName": "Avery",
"lastName": "Brown",
"address1": "150 Elgin Street",
"city": "Ottawa",
"province": "Ontario",
"zip": "K2P 1L4",
"country": "Canada"
}
}
}
]
}
},
"userErrors": []
}
}
Create a company with required fields only
Description
Create a company with no company contact and the default company location.
Query
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
Variables
{
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
}
cURL
curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CompanyCreate($input: CompanyCreateInput!) { companyCreate(input: $input) { company { id name mainContact { id } contactRoles(first: 5) { edges { node { id name } } } locations(first: 5) { edges { node { id name shippingAddress { firstName lastName address1 city province zip country } } } } } userErrors { field message code } } }",
"variables": {
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
}
}'
React Router
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
{
variables: {
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
},
},
);
const json = await response.json();
return json.data;
}
Ruby
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 CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
QUERY
variables = {
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
}
response = client.query(query: query, variables: variables)
Node.js
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
"variables": {
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
},
},
});
Shopify CLI
shopify app execute \
--query \
'mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}' \
--variables \
'{
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
}'
Direct API Access
const response = await fetch('shopify:admin/api/unstable/graphql.json', {
method: 'POST',
body: JSON.stringify({
query: `
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
`,
variables: {
"input": {
"company": {
"name": "Postal Cards Inc"
}
}
},
}),
});
const { data } = await response.json();
console.log(data);
Response
{
"companyCreate": {
"company": {
"id": "gid://shopify/Company/1059559574",
"name": "Postal Cards Inc",
"mainContact": null,
"contactRoles": {
"edges": [
{
"node": {
"id": "gid://shopify/CompanyContactRole/1007033456",
"name": "Location admin"
}
},
{
"node": {
"id": "gid://shopify/CompanyContactRole/1007033457",
"name": "Ordering only"
}
}
]
},
"locations": {
"edges": [
{
"node": {
"id": "gid://shopify/CompanyLocation/966871283",
"name": "Postal Cards Inc",
"shippingAddress": null
}
}
]
}
},
"userErrors": []
}
}
Creating a company without a name returns an error
Description
Create a company with no company contact and the default company location.
Query
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
Variables
{
"input": {
"company": {
"externalId": "123"
}
}
}
cURL
curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CompanyCreate($input: CompanyCreateInput!) { companyCreate(input: $input) { company { id name mainContact { id } contactRoles(first: 5) { edges { node { id name } } } locations(first: 5) { edges { node { id name shippingAddress { firstName lastName address1 city province zip country } } } } } userErrors { field message code } } }",
"variables": {
"input": {
"company": {
"externalId": "123"
}
}
}
}'
React Router
import { authenticate } from "../shopify.server";
export const loader = async ({request}) => {
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
{
variables: {
"input": {
"company": {
"externalId": "123"
}
}
},
},
);
const json = await response.json();
return json.data;
}
Ruby
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 CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
QUERY
variables = {
"input": {
"company": {
"externalId": "123"
}
}
}
response = client.query(query: query, variables: variables)
Node.js
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}`,
"variables": {
"input": {
"company": {
"externalId": "123"
}
}
},
},
});
Shopify CLI
shopify app execute \
--query \
'mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}' \
--variables \
'{
"input": {
"company": {
"externalId": "123"
}
}
}'
Direct API Access
const response = await fetch('shopify:admin/api/unstable/graphql.json', {
method: 'POST',
body: JSON.stringify({
query: `
mutation CompanyCreate($input: CompanyCreateInput!) {
companyCreate(input: $input) {
company {
id
name
mainContact {
id
}
contactRoles(first: 5) {
edges {
node {
id
name
}
}
}
locations(first: 5) {
edges {
node {
id
name
shippingAddress {
firstName
lastName
address1
city
province
zip
country
}
}
}
}
}
userErrors {
field
message
code
}
}
}
`,
variables: {
"input": {
"company": {
"externalId": "123"
}
}
},
}),
});
const { data } = await response.json();
console.log(data);
Response
{
"companyCreate": {
"company": null,
"userErrors": [
{
"field": [
"input",
"company",
"name"
],
"message": "Name must exist",
"code": "REQUIRED"
}
]
}
}