Business Units

The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Get BusinessUnit by Key

GET

https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Get Associate in BusinessUnit

Get Associate in BusinessUnit by ID

GET

https://api.{region}.commercetools.com/{projectKey}/business-units/{businessUnitId}/associates/{associateId}

Retrieves roles and permissions of an Associate in a Business Unit.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`businessUnitId` String	`id` of the BusinessUnit.
`associateId` String	`id` of the Customer acting as an Associate in the Business Unit.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/business-units/{businessUnitId}/associates/{associateId} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitAssociateResponsejson

{
  "customer": {
    "typeId": "customer",
    "id": "some-customer-id"
  },
  "associateRoles": [
    {
      "id": "first-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "admin",
      "buyerAssignable": true,
      "name": "Admin",
      "permissions": ["UpdateAssociates"]
    },
    {
      "id": "second-associate-role-id",
      "version": 1,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "approver",
      "buyerAssignable": true,
      "name": "Approver",
      "permissions": ["UpdateApprovalFlows"]
    }
  ],
  "inheritedAssociateRoles": [
    {
      "id": "inherited-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "buyer",
      "buyerAssignable": true,
      "name": "Buyer",
      "permissions": ["ViewMyQuotes"]
    }
  ],
  "permissions": ["UpdateAssociates", "UpdateApprovalFlows", "ViewMyQuotes"]
}

Get Associate in BusinessUnit by Key

GET

https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}/associates/{associateId}

Retrieves roles and permissions of an Associate in a Business Unit.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the BusinessUnit.
`associateId` String	`id` of the Customer acting as an Associate in the Business Unit.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}/associates/{associateId} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitAssociateResponsejson

{
  "customer": {
    "typeId": "customer",
    "id": "some-customer-id"
  },
  "associateRoles": [
    {
      "id": "first-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "admin",
      "buyerAssignable": true,
      "name": "Admin",
      "permissions": ["UpdateAssociates"]
    },
    {
      "id": "second-associate-role-id",
      "version": 1,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "approver",
      "buyerAssignable": true,
      "name": "Approver",
      "permissions": ["UpdateApprovalFlows"]
    }
  ],
  "inheritedAssociateRoles": [
    {
      "id": "inherited-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "buyer",
      "buyerAssignable": true,
      "name": "Buyer",
      "permissions": ["ViewMyQuotes"]
    }
  ],
  "permissions": ["UpdateAssociates", "UpdateApprovalFlows", "ViewMyQuotes"]
}

Get BusinessUnit in Store

Get BusinessUnit in Store by ID

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id}

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Get BusinessUnit in Store by Key

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Get Associate in BusinessUnit in Store

Get Associate in BusinessUnit in Store by ID

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{businessUnitId}/associates/{associateId}

Retrieves roles and permissions of an Associate in a Business Unit in a Store.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`businessUnitId` String	`id` of the BusinessUnit.
`associateId` String	`id` of the Customer acting as an Associate in the Business Unit.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{businessUnitId}/associates/{associateId} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitAssociateResponsejson

{
  "customer": {
    "typeId": "customer",
    "id": "some-customer-id"
  },
  "associateRoles": [
    {
      "id": "first-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "admin",
      "buyerAssignable": true,
      "name": "Admin",
      "permissions": ["UpdateAssociates"]
    },
    {
      "id": "second-associate-role-id",
      "version": 1,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "approver",
      "buyerAssignable": true,
      "name": "Approver",
      "permissions": ["UpdateApprovalFlows"]
    }
  ],
  "inheritedAssociateRoles": [
    {
      "id": "inherited-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "buyer",
      "buyerAssignable": true,
      "name": "Buyer",
      "permissions": ["ViewMyQuotes"]
    }
  ],
  "permissions": ["UpdateAssociates", "UpdateApprovalFlows", "ViewMyQuotes"]
}

Get Associate in BusinessUnit in Store by Key

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}/associates/{associateId}

Retrieves roles and permissions of an Associate in a Business Unit in a Store.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the BusinessUnit.
`associateId` String	`id` of the Customer acting as an Associate in the Business Unit.

Response:

200

BusinessUnitPagedQueryResponse

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}/associates/{associateId} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitAssociateResponsejson

{
  "customer": {
    "typeId": "customer",
    "id": "some-customer-id"
  },
  "associateRoles": [
    {
      "id": "first-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "admin",
      "buyerAssignable": true,
      "name": "Admin",
      "permissions": ["UpdateAssociates"]
    },
    {
      "id": "second-associate-role-id",
      "version": 1,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "approver",
      "buyerAssignable": true,
      "name": "Approver",
      "permissions": ["UpdateApprovalFlows"]
    }
  ],
  "inheritedAssociateRoles": [
    {
      "id": "inherited-associate-role-id",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "key": "buyer",
      "buyerAssignable": true,
      "name": "Buyer",
      "permissions": ["ViewMyQuotes"]
    }
  ],
  "permissions": ["UpdateAssociates", "UpdateApprovalFlows", "ViewMyQuotes"]
}

Query BusinessUnits

GET

https://api.{region}.commercetools.com/{projectKey}/business-units

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested. Default: `20` Minimum: `0` Maximum: `500`
`offset` Int	Number of elements skipped. Default: `0` Maximum: `10000`
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed. Default: `true`
`var.<varName>` String	Predicate parameter values. The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 1,
  "total": 1,
  "results": [
    {
      "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "name": "commercetools",
      "unitType": "Company",
      "key": "commercetools",
      "status": "Active",
      "topLevelUnit": {
        "typeId": "business-unit",
        "key": "commercetools"
      },
      "addresses": [],
      "associates": [],
      "associateMode": "Explicit",
      "inheritedAssociates": [],
      "approvalRuleMode": "Explicit",
      "storeMode": "Explicit",
      "stores": []
    }
  ]
}

Query BusinessUnits in Store

GET

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

`where` QueryPredicate	The parameter can be passed multiple times.
`sort` Sort	The parameter can be passed multiple times.
`expand` Expansion	The parameter can be passed multiple times.
`limit` Int	Number of results requested. Default: `20` Minimum: `0` Maximum: `500`
`offset` Int	Number of elements skipped. Default: `0` Maximum: `10000`
`withTotal` Boolean	Controls the calculation of the total number of query results. Set to `false` to improve query performance when the `total` is not needed. Default: `true`
`var.<varName>` String	Predicate parameter values. The parameter can be passed multiple times.

Response:

200

BusinessUnitPagedQueryResponse

asapplication/json

Request Example:cURL

curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitPagedQueryResponsejson

{
  "limit": 20,
  "offset": 0,
  "count": 1,
  "total": 1,
  "results": [
    {
      "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
      "version": 5,
      "createdAt": "2022-04-19T15:36:17.510Z",
      "lastModifiedAt": "2022-04-20T15:41:55.816Z",
      "name": "commercetools",
      "unitType": "Company",
      "key": "commercetools",
      "status": "Active",
      "topLevelUnit": {
        "typeId": "business-unit",
        "key": "commercetools"
      },
      "addresses": [],
      "associates": [],
      "associateMode": "Explicit",
      "inheritedAssociates": [],
      "approvalRuleMode": "Explicit",
      "storeMode": "Explicit",
      "stores": []
    }
  ]
}

Check if BusinessUnit exists

Check if BusinessUnit exists by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/business-units/{id}

Checks if a BusinessUnit exists with the provided id. Returns a 200 OK status if the BusinessUnit exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the BusinessUnit.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if BusinessUnit exists by Key

HEAD

https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}

Checks if a BusinessUnit exists with the provided key. Returns a 200 OK status if the BusinessUnit exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the BusinessUnit.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if BusinessUnit exists by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/business-units

Checks if one or more BusinessUnits exist for the provided query predicate. Returns a 200 OK status if any BusinessUnits match the query predicate, or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

where

QueryPredicate

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if BusinessUnit exists in Store

Check if BusinessUnit exists in Store by ID

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id}

Checks if a BusinessUnit exists with the provided id. Returns a 200 OK status if the BusinessUnit exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the BusinessUnit.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if BusinessUnit exists in Store by Key

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}

Checks if a BusinessUnit exists with the provided key. Returns a 200 OK status if the BusinessUnit exists or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the BusinessUnit.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Check if BusinessUnit exists in Store by Query Predicate

HEAD

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units

Checks if one or more BusinessUnits exist for the provided query predicate. Returns a 200 OK status if any BusinessUnits match the query predicate, or a 404 Not Found otherwise.

OAuth 2.0 Scopes:

view_business_units:{projectKey}view_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

where

QueryPredicate

The parameter can be passed multiple times.

Response:

200

Request Example:cURL

curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Create BusinessUnit

Creating a Business Unit produces the BusinessUnitCreated Message.

POST

https://api.{region}.commercetools.com/{projectKey}/business-units

OAuth 2.0 Scopes:

manage_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:BusinessUnitDraftasapplication/json

Response:

201

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "name" : "commercetools",
  "unitType" : "Company",
  "key" : "commercetools"
}
DATA

201 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Create BusinessUnit in Store

Creating a Business Unit produces the BusinessUnitCreated Message.

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units

OAuth 2.0 Scopes:

manage_business_units:{projectKey}manage_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:BusinessUnitDraftasapplication/json

Response:

201

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "name" : "commercetools",
  "unitType" : "Company",
  "key" : "commercetools"
}
DATA

201 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Update BusinessUnit

Update BusinessUnit by ID

POST

https://api.{region}.commercetools.com/{projectKey}/business-units/{id}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the BusinessUnit on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of BusinessUnitUpdateAction	Update actions to be performed on the BusinessUnit.

Response:

200

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 3,
  "actions" : [ {
    "action" : "addAddress",
    "address" : {
      "streetName" : "Any Street",
      "streetNumber" : "1337",
      "postalCode" : "11111",
      "city" : "Any City",
      "country" : "US"
    }
  } ]
}
DATA

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Update BusinessUnit by Key

POST

https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the BusinessUnit on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of BusinessUnitUpdateAction	Update actions to be performed on the BusinessUnit.

Response:

200

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 3,
  "actions" : [ {
    "action" : "addAddress",
    "address" : {
      "streetName" : "Any Street",
      "streetNumber" : "1337",
      "postalCode" : "11111",
      "city" : "Any City",
      "country" : "US"
    }
  } ]
}
DATA

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Update BusinessUnit in Store

Update BusinessUnit in Store by ID

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}manage_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the BusinessUnit on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of BusinessUnitUpdateAction	Update actions to be performed on the BusinessUnit.

Response:

200

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 3,
  "actions" : [ {
    "action" : "addAddress",
    "address" : {
      "streetName" : "Any Street",
      "streetNumber" : "1337",
      "postalCode" : "11111",
      "city" : "Any City",
      "country" : "US"
    }
  } ]
}
DATA

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Update BusinessUnit in Store by Key

POST

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}manage_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the BusinessUnit.

Query parameters:

expand

The parameter can be passed multiple times.

Request Body:

application/json

`version` Int	Expected version of the BusinessUnit on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.
`actions` Array of BusinessUnitUpdateAction	Update actions to be performed on the BusinessUnit.

Response:

200

asapplication/json

Request Example:cURL

curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA 
{
  "version" : 3,
  "actions" : [ {
    "action" : "addAddress",
    "address" : {
      "streetName" : "Any Street",
      "streetNumber" : "1337",
      "postalCode" : "11111",
      "city" : "Any City",
      "country" : "US"
    }
  } ]
}
DATA

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Add Address

Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.

`action` String	`"addAddress"`
`address` BaseAddress	Address to add to the addresses of the Business Unit.

Example: json

{
  "action": "addAddress",
  "address": {
    "id": "exampleAddress",
    "key": "exampleKey",
    "title": "My Address",
    "salutation": "Mr.",
    "firstName": "Example",
    "lastName": "Person",
    "streetName": "Example Street",
    "streetNumber": "4711",
    "additionalStreetInfo": "Backhouse",
    "postalCode": "80933",
    "city": "Exemplary City",
    "region": "Exemplary Region",
    "state": "Exemplary State",
    "country": "DE",
    "company": "My Company Name",
    "department": "Sales",
    "building": "Hightower 1",
    "apartment": "247",
    "pOBox": "2471",
    "phone": "+49 89 12345678",
    "mobile": "+49 171 2345678",
    "email": "mail@example.com",
    "fax": "+49 89 12345679",
    "additionalAddressInfo": "no additional Info",
    "externalId": "Information not needed"
  }
}

Add Associate

To add Associates in bulk to Business Units, use the Set Associates action instead.

Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.

`action` String	`"addAssociate"`
`associate` AssociateDraft	The Associate to add.

Example: json

{
  "action": "addAssociate",
  "associate": {
    "customer": {
      "typeId": "customer",
      "id": "some-customer-id"
    },
    "associateRoleAssignments": [
      {
        "associateRole": {
          "typeId": "associate-role",
          "key": "admin"
        },
        "inheritance": "Enabled"
      },
      {
        "associateRole": {
          "typeId": "associate-role",
          "key": "buyer"
        }
      }
    ]
  }
}

Add Billing Address Identifier

Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.

`action` String	`"addBillingAddressId"`
`addressId` String	ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "addBillingAddressId",
  "addressId": "{{addressId}}"
}

Add Shipping Address Identifier

Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.

`action` String	`"addShippingAddressId"`
`addressId` String	ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "addShippingAddressId",
  "addressId": "{{addressId}}"
}

Add Store

Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message. Only applicable when storeMode is Explicit.

`action` String	`"addStore"`
`store` StoreResourceIdentifier	Store to add.

Example: json

{
  "action": "addStore",
  "store": {
    "key": "{{store-key}}",
    "typeId": "store"
  }
}

Change Address

Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.

`action` String	`"changeAddress"`
`addressId` String	ID of the address to change. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to change. Either `addressId` or `addressKey` is required.
`address` BaseAddress	New address to set.

Example: json

{
  "action": "changeAddress",
  "addressId": "{{addressId}}",
  "address": {
    "id": "exampleAddress",
    "key": "exampleKey",
    "title": "My Address",
    "salutation": "Mr.",
    "firstName": "Example",
    "lastName": "Person",
    "streetName": "Example Street",
    "streetNumber": "4711",
    "additionalStreetInfo": "Backhouse",
    "postalCode": "80933",
    "city": "Exemplary City",
    "region": "Exemplary Region",
    "state": "Exemplary State",
    "country": "DE",
    "company": "My Company Name",
    "department": "Sales",
    "building": "Hightower 1",
    "apartment": "247",
    "pOBox": "2471",
    "phone": "+49 89 12345678",
    "mobile": "+49 171 2345678",
    "email": "email@example.com",
    "fax": "+49 89 12345679",
    "additionalAddressInfo": "no additional Info",
    "externalId": "Information not needed"
  }
}

Change Associate

Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.

`action` String	`"changeAssociate"`
`associate` AssociateDraft	New version of an existing Associate.

Example: json

{
  "action": "changeAssociate",
  "associate": {
    "customer": {
      "typeId": "customer",
      "id": "some-customer-id"
    },
    "associateRoleAssignments": [
      {
        "associateRole": {
          "typeId": "associate-role",
          "key": "admin"
        },
        "inheritance": "Enabled"
      },
      {
        "associateRole": {
          "typeId": "associate-role",
          "key": "buyer"
        }
      }
    ]
  }
}

Change Associate Mode

Only Business Units of type Division can be changed to ExplicitAndFromParent. This update action generates a BusinessUnitAssociateModeChanged Message.

`action` String	`"changeAssociateMode"`
`associateMode` BusinessUnitAssociateMode	The new value for `associateMode`.

Change Approval Rule Mode

Updates Approval Rules inheritance behavior between Business Units.

Only Business Units of type Division can be changed to ExplicitAndFromParent.

This update action generates a BusinessUnitApprovalRuleModeChanged Message.

`action` String	`"changeApprovalRuleMode"`
`approvalRuleMode` BusinessUnitApprovalRuleMode	The new value for `approvalRuleMode`.

Example: json

{
  "action": "changeApprovalRuleMode",
  "approvalRuleMode": "Explicit"
}

Change Name

Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.

`action` String	`"changeName"`
`name` String	New name to set.

Example: json

{
  "action": "changeName",
  "name": "commercetools"
}

Change Parent Unit

You can organize Business Units hierarchically up to 5 levels. Each top-level unit can include up to 4 000 Divisions, including direct and indirect children.

This action generates a BusinessUnitParentChanged Message.

`action` String	`"changeParentUnit"`
`parentUnit` BusinessUnitResourceIdentifier	New parent unit of the Business Unit. It must be associated with the same Stores, as the old parent unit. The Business Unit `inheritedAssociates` and `inheritedStores` field values will be eventually consistent.

Example: json

{
  "action": "changeParentUnit",
  "parentUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  }
}

You can perform only one hierarchy move operation at a time. If another changeParentUnit or setUnitType update action is performed simultaneously, a ConcurrentModification error is returned. The error is also returned if the BusinessUnit topLevelUnit field is being updated asynchronously in the background, as it is eventually consistent.

Set Unit Type BETA

This update action is not available via the Me or as-associate API.

You can organize Business Units hierarchically up to 5 levels. Each top-level unit can include up to 4 000 Divisions, including direct and indirect children.

This action generates a BusinessUnitTypeSet Message.

`action` String	`"setUnitType"`
`unitType` BusinessUnitType	New type of the Business Unit. If `unitType="Company"`, the Business Unit `storeMode`, `associateMode`, and `approvalRuleMode` field values must be `Explicit`.
`parentUnit` BusinessUnitResourceIdentifier	New parent unit for the Business Unit, if `unitType="Division"`.

Example: json

{
  "action": "setUnitType",
  "unitType": "Division",
  "parentUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  }
}

Change Status

Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.

`action` String	`"changeStatus"`
`status` String	New status to set.

Example: json

{
  "action": "changeStatus",
  "status": "Inactive"
}

Remove Address

Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.

`action` String	`"removeAddress"`
`addressId` String	ID of the address to be removed. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to be removed. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "removeAddress",
  "addressId": "{{addressId}}"
}

Remove Associate

Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.

`action` String	`"removeAssociate"`
`customer` CustomerResourceIdentifier	Associate to remove.

Example: json

{
  "action": "removeAssociate",
  "customer": {
    "typeId": "customer",
    "id": "some-customer-id"
  }
}

Remove Store

Removes a Store from the Business Unit. Newly created Carts and Orders can no longer reference the removed Store for the Business Unit. We recommend cleaning up unordered Carts that still have the Store assigned after calling this update action since those cannot be converted to Orders. Orders created before the Store was removed remain unchanged. Generates a BusinessUnitStoreRemoved Message. Only applicable when storeMode is Explicit.

`action` String	`"removeStore"`
`store` StoreResourceIdentifier	Store to remove.

Example: json

{
  "action": "removeStore",
  "store": {
    "key": "{{store-key}}",
    "typeId": "store"
  }
}

Remove Billing Address Identifier

Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.

`action` String	`"removeBillingAddressId"`
`addressId` String	ID of the address to be removed from `billingAddressIds`. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to be removed from `billingAddressIds`. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "removeBillingAddressId",
  "addressId": "{{addressId}}"
}

Remove Shipping Address Identifier

Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.

`action` String	`"removeShippingAddressId"`
`addressId` String	ID of the address to be removed from `shippingAddressIds`. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to be removed from `shippingAddressIds`. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "removeShippingAddressId",
  "addressId": "{{addressId}}"
}

Set Address CustomField

Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.

`action` String	`"setAddressCustomField"`
`addressId` String	ID of the address to be extended.
`name` String	Name of the Custom Field.
`value` CustomFieldValue	If `value` is absent or `null`, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action": "setAddressCustomField",
  "name": "exampleStringField",
  "value": "TextString",
  "addressId": "{{address-id}}"
}

Set Associates

Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.

`action` String	`"setAssociates"`
`associates` Array of AssociateDraft	The new list of Associates. If empty, existing values will be removed. MaxItems: `2000`

Example: json

{
  "action": "setAssociates",
  "associates": [
    {
      "customer": {
        "typeId": "customer",
        "id": "some-customer-id"
      },
      "associateRoleAssignments": [
        {
          "associateRole": {
            "typeId": "associate-role",
            "key": "admin"
          },
          "inheritance": "Enabled"
        }
      ]
    },
    {
      "customer": {
        "typeId": "customer",
        "id": "another-customer-id"
      },
      "associateRoleAssignments": [
        {
          "associateRole": {
            "typeId": "associate-role",
            "key": "buyer"
          }
        }
      ]
    }
  ]
}

Set Custom Type in Address

Adding or updating a Custom Type on an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.

`action` String	`"setAddressCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the `address` with Custom Fields. If absent, any existing Type and Custom Fields are removed from the `address`.
`fields` FieldContainer	Sets the Custom Fields for the `address`.
`addressId` String	ID of the address to be extended.

Example: json

{
  "action": "setAddressCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringField": "TextString"
  },
  "addressId": "{{address-id}}"
}

Set Contact Email

Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.

`action` String	`"setContactEmail"`
`contactEmail` String	Email to set. If `contactEmail` is absent or `null`, the existing contact email, if any, will be removed.

Example: json

{
  "action": "setContactEmail",
  "contactEmail": "contact@example.com"
}

Set CustomField

Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.

`action` String	`"setCustomField"`
`name` String	Name of the Custom Field to add, update, or remove.
`value` CustomFieldValue	If `value` is absent or `null`, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If `value` is provided, it is set for the field defined by `name`.

Example: json

{
  "action": "setCustomField",
  "name": "exampleStringField",
  "value": "TextString"
}

Set Custom Type

Adding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	Defines the Type that extends the BusinessUnit with Custom Fields. If absent, any existing Type and Custom Fields are removed from the BusinessUnit.
`fields` FieldContainer	Sets the Custom Fields for the BusinessUnit.

Example: json

{
  "action": "setCustomType",
  "type": {
    "id": "{{type-id}}",
    "typeId": "type"
  },
  "fields": {
    "exampleStringField": "TextString"
  }
}

Set Default Billing Address

Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.

`action` String	`"setDefaultBillingAddress"`
`addressId` String	ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to add as a billing address. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "setDefaultBillingAddress",
  "addressId": "{{addressId}}"
}

Set Default Shipping Address

Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.

`action` String	`"setDefaultShippingAddress"`
`addressId` String	ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
`addressKey` String	Key of the address to add as a shipping address. Either `addressId` or `addressKey` is required.

Example: json

{
  "action": "setDefaultShippingAddress",
  "addressId": "{{addressId}}"
}

Set Stores

Sets the Stores of the Business Unit. Can only be set if the Business Unit storeMode is Explicit. Carts and Orders created after the Set Stores update must use the new Stores of the Business Unit and, if set, their Product Selections, and Channels. Orders created before the Set Stores update action remain unchanged. Setting the Stores on a Business Unit generates a BusinessUnitStoresSet Message.

`action` String	`"setStores"`
`stores` Array of StoreResourceIdentifier	Stores to set. Overrides the current list of Stores.

Example: json

{
  "action": "setStores",
  "stores": [
    {
      "key": "{{store-key}}",
      "typeId": "store"
    }
  ]
}

Set Store Mode

Only Business Units of type Division can be have a store mode of FromParent. Changing the storeMode to FromParent empties the stores array on the BusinessUnit. This update action generates a BusinessUnitStoreModeChanged Message.

`action` String	`"setStoreMode"`
`storeMode` BusinessUnitStoreMode	Set to `Explicit` to specify Stores for the Business Unit. Set to `FromParent` to inherit Stores from a parent.
`stores` Array of StoreResourceIdentifier	Set the Stores the Business Unit is associated with. Can only be set if `storeMode` is `Explicit`.

Example: json

{
  "action": "setStoreMode",
  "storeMode": "FromParent"
}

Delete BusinessUnit

Deleting a Business Unit produces the BusinessUnitDeleted Message. A Business Unit can only be deleted if it is not referenced by a Cart, Order, Quote, Shopping List, or another Business Unit.

Delete BusinessUnit by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/business-units/{id}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`id` String	`id` of the BusinessUnit.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/business-units/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Delete BusinessUnit by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`key` String	`key` of the BusinessUnit.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/business-units/key={key}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Delete BusinessUnit in Store

Deleting a Business Unit produces the BusinessUnitDeleted Message. A Business Unit can only be deleted if it is not referenced by a Cart, Order, Quote, or another Business Unit.

Delete BusinessUnit in Store by ID

DELETE

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}manage_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`id` String	`id` of the BusinessUnit.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200

asapplication/json

Request Example:cURL

curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"

200 Response Example: BusinessUnitjson

{
  "id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
  "version": 5,
  "createdAt": "2022-04-19T15:36:17.510Z",
  "lastModifiedAt": "2022-04-20T15:41:55.816Z",
  "name": "commercetools",
  "unitType": "Company",
  "key": "commercetools",
  "status": "Active",
  "storeMode": "Explicit",
  "stores": [],
  "topLevelUnit": {
    "typeId": "business-unit",
    "key": "commercetools"
  },
  "addresses": [],
  "associates": [],
  "associateMode": "Explicit",
  "inheritedAssociates": [],
  "approvalRuleMode": "Explicit"
}

Delete BusinessUnit in Store by Key

DELETE

https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/business-units/key={key}

OAuth 2.0 Scopes:

manage_business_units:{projectKey}manage_business_units:{projectKey}:{storeKey}

Path parameters:

`region` String	Region in which the Project is hosted.
`projectKey` String	`key` of the Project.
`storeKey` String	`key` of the Store.
`key` String	`key` of the BusinessUnit.

Query parameters:

`version` Int	Last seen version of the resource.
`expand` Expansion	The parameter can be passed multiple times.

Response:

200