Docs
Dashboard

OrderUpdateInput

Input

Input for updating an order

#

Fields


billingAddress
AddressInput

An optional billing address for the order

externalReference
String

An optional external reference for the order

id
ID!

The ID of the order to be updated

metadata
[KeyValuePairOfStringAndStringInput!]

Optional key/value metadata for the order. If null is explicitly provided, metadata will be cleared.

metafields
[OrderMetafieldInput!]

The metafield values to add or update on the order. Existing metafields not included in the list are preserved. When explicitly specified as null, all assigned order metafields are removed.

orderState
OrderState

The new state of the order

Possible enum values
  • CANCELLED

    The order was cancelled before completion.

  • COMPLETE

    Processing of the order has been completed.

  • CONFIRMED

    The order has been accepted for processing.

  • OPEN

    The order has been created and can still be processed.

shipmentState
ShipmentState

The new shipment state of the order

Possible enum values
  • CANCELLED

    The order's shipment was cancelled.

  • DELIVERED

    The order's shipment has reached its destination.

  • PENDING

    No shipment is ready to leave yet.

  • READY

    At least one shipment is prepared and waiting to be sent.

  • SHIPPED

    The order's shipment has been handed over for delivery.

shippingAddress
AddressInput

An optional shipping address for the order