Interface OrderSetStoreAction

Sets the Store the Order is assigned to. It should be used to migrate Orders to a new Store. No validations are performed (such as that the Customer is allowed to create Orders in the Store).

Produces the [Order Store Set](ctp:api:type:OrderStoreSetMessage) Message.
Returns a `400` error if `store` references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.
interface OrderSetStoreAction {
    action: "setStore";
    store?: StoreResourceIdentifier;
}

Properties

action store?

Properties

Readonly action

action: "setStore"

Optional Readonly store

store?: StoreResourceIdentifier

Value to set. If empty, any existing value is removed.

If `store` references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a `400` error is returned.

Settings

Member Visibility

Theme

On This Page

actionstore