Skip to content
Last update: January 30, 2024

UpdateOrderShipmentDynamicProperties mutation

This mutation updates dynamic properties for the order shipping method.

Arguments

The InputUpdateOrderShipmentDynamicPropertiesType is a type that represents the input object for updating dynamic properties of an order shipment.

Fields

Field Description
orderId {String} The Id of the order for which the order shipment's dynamic properties will be updated.
shipmentId {String} The Id of the order shipment for which the dynamic properties will be updated.
dynamicProperties {[InputDynamicPropertyValueType]!} The dynamic property value types representing the updated dynamic properties of the order shipment.

Possible returns

Possible return Description
CustomerOrderType A customer order.
mutation updateOrderShipmentDynamicProperties ($command: InputUpdateOrderShipmentDynamicPropertiesType!) {
updateOrderShipmentDynamicProperties (command: $command)
{
id
shipments{
dynamicProperties
{
    value
    name
}}
}}
{
"command": {
    "orderId": "2be32440-ee84-4dd5-aa9b-fcbe35bf61f0",
    "shipmentId": "testshipmentid",
    "dynamicProperties": [
    {
        "name": "propery1",
        "value": "value1"
    }
    ]
}
}