Create an organization

How to create an organization via API

To create a new organization, send a POST request to the /api/organizations endpoint, passing the resource arguments in the request body.

Request

POST https://provisioning.commercelayer.io/api/organizations

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.config	object	Optional
attributes.support_phone	string	Optional
attributes.support_email	string	Optional
attributes.logo_url	string	Optional
attributes.favicon_url	string	Optional
attributes.primary_color	string	Optional
attributes.contrast_color	string	Optional
attributes.gtm_id	string	Optional
attributes.gtm_id_test	string	Optional
attributes.discount_disabled	boolean	Optional
attributes.account_disabled	boolean	Optional
attributes.acceptance_disabled	boolean	Optional
attributes.region	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional

Example

Request

The following request creates a new organization:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/organizations' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "organizations",
    "attributes": {
      "name": "The Blue Brand"
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "organizations",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde"
    },
    "attributes": {
      "name": "The Blue Brand",
      "slug": "the-blue-brand",
      "domain": "the-blue-brand.commercelayer.io",
      "config": {
        "mfe": {
          "default": {
            "links": {
              "cart": "https://cart.example.com/:order_id?accessToken=:access_token",
              "checkout": "https://checkout.example.com/:order_id?accessToken=:access_token",
              "identity": "https://example.com/login",
              "microstore": "https://example.com/microstore/?accessToken=:access_token",
              "my_account": "https://example.com/my-custom-account?accessToken=:access_token"
            },
            "checkout": {
              "thankyou_page": "https://example.com/thanks/:lang/:order_id",
              "billing_countries": [
                {
                  "value": "ES",
                  "label": "Espana"
                },
                {
                  "value": "IT",
                  "label": "Italia"
                },
                {
                  "value": "US",
                  "label": "Unites States of America"
                }
              ],
              "shipping_countries": [
                {
                  "value": "ES",
                  "label": "Espana"
                },
                {
                  "value": "IT",
                  "label": "Italia"
                },
                {
                  "value": "US",
                  "label": "Unites States of America"
                }
              ],
              "billing_states": {
                "FR": [
                  {
                    "value": "PA",
                    "label": "Paris"
                  },
                  {
                    "value": "LY",
                    "label": "Lyon"
                  },
                  {
                    "value": "NI",
                    "label": "Nice"
                  },
                  {
                    "value": "MA",
                    "label": "Marseille"
                  },
                  {
                    "value": "BO",
                    "label": "Bordeaux"
                  }
                ]
              },
              "shipping_states": {
                "FR": [
                  {
                    "value": "PA",
                    "label": "Paris"
                  },
                  {
                    "value": "LY",
                    "label": "Lyon"
                  },
                  {
                    "value": "NI",
                    "label": "Nice"
                  },
                  {
                    "value": "MA",
                    "label": "Marseille"
                  },
                  {
                    "value": "BO",
                    "label": "Bordeaux"
                  }
                ]
              },
              "default_country": "US"
            },
            "urls": {
              "privacy": "https://example.com/privacy/:lang",
              "terms": "https://example.com/terms/:lang"
            }
          },
          "market:id:ZKcv13rT": {
            "links": {
              "cart": "https://example.com/custom-cart/:order_id?accessToken=:access_token"
            },
            "checkout": {
              "thankyou_page": "https://example.com/thanks/:order_id"
            }
          }
        }
      },
      "support_phone": "+01 30800857",
      "support_email": "[e-mail]",
      "logo_url": "https://bluebrand.com/img/logo.svg",
      "favicon_url": "https://bluebrand.com/img/favicon.ico",
      "primary_color": "#C8984E",
      "contrast_color": "#FFFFCC",
      "gtm_id": "GTM-5FJXX6",
      "gtm_id_test": "GTM-5FJXX7",
      "discount_disabled": false,
      "account_disabled": false,
      "acceptance_disabled": false,
      "max_concurrent_promotions": 10,
      "max_concurrent_imports": 30,
      "region": "eu-west-1",
      "can_switch_live": false,
      "subscription_info": {
        "plan_type": "growth",
        "limits": {
          "markets": 5,
          "skus": 10000,
          "organizations": 2,
          "memberships": 5
        },
        "totals": {
          "organizations": 1,
          "markets": 0,
          "memberships": 2,
          "skus": 0
        }
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "memberships": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/relationships/memberships",
          "related": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/memberships"
        }
      },
      "roles": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/relationships/roles",
          "related": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/roles"
        }
      },
      "permissions": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/relationships/permissions",
          "related": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/permissions"
        }
      },
      "api_credentials": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/relationships/api_credentials",
          "related": "https://provisioning.commercelayer.io/api/organizations/xYZkjABcde/api_credentials"
        }
      }
    }
  }
}