GoDaddy
Support
API ReferenceCommerceCustomers & ordersOrders GraphQLOrderMutationupdateOrder

updateOrder

View as Markdown

Update an existing order

mutation

Requires one of commerce.order:create, commerce.order:update, commerce.order:cancel, or commerce.order:complete (use the scope that matches the operation).

Update an existing order

Required headers

HeaderRequiredDescription
x-store-idYesID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED".

Go to Authentication for credential setup.

Arguments

  • input UpdateOrderInput! required
    • context OrderContextInputUpdate! required
    • id ID! required
    • billing OrderBillingInfoInput optional
    • canceledAt DateTime optional
    • completedAt DateTime optional
    • customerId String optional
    • deprecatedNote String optional — Deprecated: Replaced by the notes array
    • discounts [UpdateDiscountInput!] optional
    • fees [UpdateFeeInput!] optional
    • fulfilledAt DateTime optional
    • fulfillmentModes [String!] optional — Automatically set based on lineItem fulfillment modes. This field is read-only.
    • lineItems [UpdateLineItemInput!] optional
    • metafields [OrderMetafieldInput!] optional
    • notes [UpdateNoteInput!] optional
    • number String optional
    • numberDisplay String optional
    • paidAt DateTime optional
    • processedAt DateTime optional
    • refundedAt DateTime optional
    • shipping OrderShippingInfoInput optional
    • shippingLines [UpdateShippingLineInput!] optional
    • staffUserIds [String!] optional
    • statuses OrderStatusesInputUpdate optional
    • tags [String!] optional
    • taxes [UpdateOrderTaxInput!] optional
    • totals OrderTotalsInput optional
    • transactionIds [String!] optional

Possible returns

  • Order Order

Last updated on

How is this guide?