Skip to content

Commit 1d236d1

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 77fcf46 commit 1d236d1

File tree

8 files changed

+105
-0
lines changed

8 files changed

+105
-0
lines changed

‎api-specs/api/examples/Order/OrderSetBusinessUnitAction.json‎

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/examples/OrderEdit/StagedOrderSetBusinessUnitAction.json‎

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/message/OrderBusinessUnitSetMessage.raml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: OrderMessage
4+
displayName: OrderBusinessUnitSetMessage
5+
discriminatorValue: OrderBusinessUnitSet
6+
description: |
7+
Generated after a successful [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.
8+
properties:
9+
businessUnit?:
10+
type: BusinessUnitKeyReference
11+
description: |
12+
[BusinessUnit](ctp:api:type:BusinessUnit) on the [Order](ctp:api:type:Order) after the [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.
13+
oldbusinessUnit?:
14+
type: BusinessUnitKeyReference
15+
description: |
16+
[BusinessUnit](ctp:api:type:BusinessUnit) on the [Order](ctp:api:type:Order) before the [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.

‎api-specs/api/types/message/payload/OrderBusinessUnitSetMessagePayload.raml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: OrderMessagePayload
4+
displayName: OrderBusinessUnitSetMessagePayload
5+
discriminatorValue: OrderBusinessUnitSet
6+
description: |
7+
Generated after a successful [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.
8+
properties:
9+
businessUnit?:
10+
type: BusinessUnitKeyReference
11+
description: |
12+
[BusinessUnit](ctp:api:type:BusinessUnit) on the [Order](ctp:api:type:Order) after the [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.
13+
oldbusinessUnit?:
14+
type: BusinessUnitKeyReference
15+
description: |
16+
[BusinessUnit](ctp:api:type:BusinessUnit) on the [Order](ctp:api:type:Order) before the [Set Business Unit](ctp:api:type:OrderSetBusinessUnitAction) update action on Orders or [Set Business Unit](ctp:api:type:StagedOrderSetBusinessUnitAction) update action on Order Edits.

‎api-specs/api/types/order-edit/updates/StagedOrderSetBusinessUnitAction.raml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#%RAML 1.0 DataType
2+
(package): OrderEdit
3+
example: !include ../../../examples/OrderEdit/StagedOrderSetBusinessUnitAction.json
4+
type: StagedOrderUpdateAction
5+
displayName: StagedOrderSetBusinessUnitAction
6+
discriminatorValue: setBusinessUnit
7+
description: |
8+
Updates the Business Unit on the Order. Setting the Order's `businessUnit` does not recalculate prices or discounts on the Order.
9+
10+
Produces the [OrderBusinessUnitSet](ctp:api:type:OrderBusinessUnitSetMessage) Message.
11+
properties:
12+
businessUnit?:
13+
type: BusinessUnitResourceIdentifier
14+
description: |
15+
New Business Unit to assign to the Order. If empty, any existing value is removed.
16+
17+
If the referenced Business Unit does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned.

‎api-specs/api/types/order/updates/OrderSetBusinessUnitAction.raml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#%RAML 1.0 DataType
2+
(package): Order
3+
example: !include ../../../examples/Order/OrderSetBusinessUnitAction.json
4+
type: OrderUpdateAction
5+
displayName: OrderSetBusinessUnitAction
6+
discriminatorValue: setBusinessUnit
7+
description: |
8+
Updates the Business Unit on the Order. Setting the Order's `businessUnit` does not recalculate prices or discounts on the Order.
9+
10+
Produces the [OrderBusinessUnitSet](ctp:api:type:OrderBusinessUnitSetMessage) Message.
11+
properties:
12+
businessUnit?:
13+
type: BusinessUnitResourceIdentifier
14+
description: |
15+
New Business Unit to assign to the Order. If empty, any existing value is removed.
16+
17+
If the referenced Business Unit does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned.

‎api-specs/api/types/types.raml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -955,6 +955,7 @@ MessagePagedQueryResponse: !include message/MessagePagedQueryResponse.raml
955955
MessagesConfiguration: !include message/MessagesConfiguration.raml
956956
MessagesConfigurationDraft: !include message/MessagesConfigurationDraft.raml
957957
OrderBillingAddressSetMessage: !include message/OrderBillingAddressSetMessage.raml
958+
OrderBusinessUnitSetMessage: !include message/OrderBusinessUnitSetMessage.raml
958959
OrderCreatedMessage: !include message/OrderCreatedMessage.raml
959960
OrderCustomFieldAddedMessage: !include message/OrderCustomFieldAddedMessage.raml
960961
OrderCustomFieldChangedMessage: !include message/OrderCustomFieldChangedMessage.raml
@@ -1225,6 +1226,7 @@ InventoryEntryQuantitySetMessagePayload: !include message/payload/InventoryEntry
12251226
LineItemStateTransitionMessagePayload: !include message/payload/LineItemStateTransitionMessagePayload.raml
12261227
MessagePayload: !include message/payload/MessagePayload.raml
12271228
OrderBillingAddressSetMessagePayload: !include message/payload/OrderBillingAddressSetMessagePayload.raml
1229+
OrderBusinessUnitSetMessagePayload: !include message/payload/OrderBusinessUnitSetMessagePayload.raml
12281230
OrderCreatedMessagePayload: !include message/payload/OrderCreatedMessagePayload.raml
12291231
OrderCustomFieldAddedMessagePayload: !include message/payload/OrderCustomFieldAddedMessagePayload.raml
12301232
OrderCustomFieldChangedMessagePayload: !include message/payload/OrderCustomFieldChangedMessagePayload.raml
@@ -1431,6 +1433,7 @@ StagedOrderSetBillingAddressAction: !include order-edit/updates/StagedOrderSetBi
14311433
StagedOrderSetBillingAddressCustomFieldAction: !include order-edit/updates/StagedOrderSetBillingAddressCustomFieldAction.raml
14321434
# yamllint disable-line rule:line-length
14331435
StagedOrderSetBillingAddressCustomTypeAction: !include order-edit/updates/StagedOrderSetBillingAddressCustomTypeAction.raml
1436+
StagedOrderSetBusinessUnitAction: !include order-edit/updates/StagedOrderSetBusinessUnitAction.raml
14341437
StagedOrderSetCountryAction: !include order-edit/updates/StagedOrderSetCountryAction.raml
14351438
StagedOrderSetCustomFieldAction: !include order-edit/updates/StagedOrderSetCustomFieldAction.raml
14361439
# yamllint disable-line rule:line-length
@@ -1589,6 +1592,7 @@ OrderRemovePaymentAction: !include order/updates/OrderRemovePaymentAction.raml
15891592
OrderSetBillingAddressAction: !include order/updates/OrderSetBillingAddressAction.raml
15901593
OrderSetBillingAddressCustomFieldAction: !include order/updates/OrderSetBillingAddressCustomFieldAction.raml
15911594
OrderSetBillingAddressCustomTypeAction: !include order/updates/OrderSetBillingAddressCustomTypeAction.raml
1595+
OrderSetBusinessUnitAction: !include order/updates/OrderSetBusinessUnitAction.raml
15921596
OrderSetCustomFieldAction: !include order/updates/OrderSetCustomFieldAction.raml
15931597
OrderSetCustomLineItemCustomFieldAction: !include order/updates/OrderSetCustomLineItemCustomFieldAction.raml
15941598
OrderSetCustomLineItemCustomTypeAction: !include order/updates/OrderSetCustomLineItemCustomTypeAction.raml

‎api-specs/graphql/schema.sdl‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6886,6 +6886,12 @@ type OrderBillingAddressSet implements MessagePayload & OrderMessagePayload {
68866886
type: String!
68876887
}
68886888

6889+
type OrderBusinessUnitSet implements MessagePayload & OrderMessagePayload {
6890+
businessUnit: KeyReferenceInput
6891+
oldBusinessUnit: KeyReferenceInput
6892+
type: String!
6893+
}
6894+
68896895
input OrderCartCommand {
68906896
id: String
68916897
cart: ResourceIdentifierInput
@@ -7302,6 +7308,7 @@ input OrderUpdateAction {
73027308
setLineItemCustomType: SetOrderLineItemCustomType
73037309
setLineItemShippingDetails: SetOrderLineItemShippingDetails
73047310
setLocale: SetOrderLocale
7311+
setBusinessUnit: SetOrderBusinessUnit
73057312
setOrderNumber: SetOrderNumber
73067313
setParcelCustomField: SetOrderParcelCustomField
73077314
setParcelCustomType: SetOrderParcelCustomType
@@ -11465,6 +11472,10 @@ input SetOrderBillingAddressCustomType {
1146511472
typeId: String
1146611473
}
1146711474

11475+
input SetOrderBusinessUnit {
11476+
businessUnit: ResourceIdentifierInput
11477+
}
11478+
1146811479
input SetOrderCustomField {
1146911480
name: String!
1147011481
value: String
@@ -12372,6 +12383,15 @@ type SetStagedOrderBillingAddressOutput implements StagedOrderUpdateActionOutput
1237212383
address: AddressDraft
1237312384
}
1237412385

12386+
input SetStagedOrderBusinessUnit {
12387+
businessUnit: ResourceIdentifierInput
12388+
}
12389+
12390+
type SetStagedOrderBusinessUnitOutput implements StagedOrderUpdateActionOutput {
12391+
type: String!
12392+
businessUnitResId: ResourceIdentifier
12393+
}
12394+
1237512395
input SetStagedOrderCountry {
1237612396
country: Country
1237712397
}
@@ -13745,6 +13765,7 @@ input StagedOrderUpdateAction {
1374513765
setLineItemTaxRate: SetStagedOrderLineItemTaxRate
1374613766
setLineItemTotalPrice: SetStagedOrderLineItemTotalPrice
1374713767
setLocale: SetStagedOrderLocale
13768+
setBusinessUnit: SetStagedOrderBusinessUnit
1374813769
setOrderNumber: SetStagedOrderOrderNumber
1374913770
setOrderTotalTax: SetStagedOrderOrderTotalTax
1375013771
setParcelCustomField: SetStagedOrderParcelCustomField

0 commit comments

Comments
 (0)