Skip to content

Commit b71e64c

Browse files
committed
Updated API from documentation release
1 parent 1664a84 commit b71e64c

File tree

5 files changed

+29
-0
lines changed

5 files changed

+29
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"action": "setBusinessUnit",
3+
"businessUnit": {
4+
"key": "{{business-unit-key}}",
5+
"typeId": "business-unit"
6+
}
7+
}

api-specs/api/types/shopping-list/ShoppingList.raml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ properties:
5656
type: StoreKeyReference
5757
description: |
5858
Store to which the ShoppingList is assigned.
59+
businessUnit?:
60+
type: BusinessUnitKeyReference
61+
description: |
62+
[Reference](ctp:api:type:Reference) to the Business Unit the Shopping List belongs to.
5963
custom?:
6064
type: CustomFields
6165
description: |

api-specs/api/types/shopping-list/ShoppingListDraft.raml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ properties:
5050
type: StoreResourceIdentifier
5151
description: |
5252
Assigns the new ShoppingList to the [Store](ctp:api:type:Store).
53+
businessUnit?:
54+
type: BusinessUnitResourceIdentifier
55+
description: |
56+
[ResourceIdentifier](ctp:api:type:ResourceIdentifier) of the Business Unit the Shopping List should belong to. When the `customer` of the Shopping List is set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
5357
custom?:
5458
type: CustomFieldsDraft
5559
description: Custom Fields defined for the ShoppingList.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#%RAML 1.0 DataType
2+
(package): ShoppingList
3+
type: ShoppingListUpdateAction
4+
displayName: ShoppingListSetBusinessUnitAction
5+
discriminatorValue: setBusinessUnit
6+
example: !include ../../../examples/ShoppingList/ShoppingListSetBusinessUnitAction.json
7+
description: |
8+
Updates the Business Unit on the Shopping List. The Shopping List must have an existing Business Unit assigned already.
9+
properties:
10+
businessUnit:
11+
type: BusinessUnitResourceIdentifier
12+
description: |
13+
The Business Unit to assign to the Shopping List, which must have access to the [Store](/../api/projects/stores) that is set on the Shopping List.

api-specs/api/types/types.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2121,6 +2121,7 @@ ShoppingListChangeTextLineItemsOrderAction: !include shopping-list/updates/Shopp
21212121
ShoppingListRemoveLineItemAction: !include shopping-list/updates/ShoppingListRemoveLineItemAction.raml
21222122
ShoppingListRemoveTextLineItemAction: !include shopping-list/updates/ShoppingListRemoveTextLineItemAction.raml
21232123
ShoppingListSetAnonymousIdAction: !include shopping-list/updates/ShoppingListSetAnonymousIdAction.raml
2124+
ShoppingListSetBusinessUnitAction: !include shopping-list/updates/ShoppingListSetBusinessUnitAction.raml
21242125
ShoppingListSetCustomFieldAction: !include shopping-list/updates/ShoppingListSetCustomFieldAction.raml
21252126
ShoppingListSetCustomTypeAction: !include shopping-list/updates/ShoppingListSetCustomTypeAction.raml
21262127
ShoppingListSetCustomerAction: !include shopping-list/updates/ShoppingListSetCustomerAction.raml

0 commit comments

Comments
 (0)