Anchor to section titled 'undefined'

OrderEditSession
object

Requires read_order_edits access scope.

An edit session for an order.

Anchor to section titled 'Fields'

Fields

Anchor to OrderEditSession.id
id
ID!
non-null

The unique ID of the order edit session.

Was this section helpful?
Map
  • No referencing fields
    • OrderEditSession
    Anchor to section titled 'Queries'

    Queries

    Anchor to orderEditSession
    orderEditSession
    query

    Returns an Order editing session by order ID.

    Was this section helpful?
    <?>
    OrderEditSession Queries
    OrderEditSession

    Queried by

    Anchor to section titled 'Mutations'

    Mutations

    Anchor to orderEditAddCustomItem
    orderEditAddCustomItem
    mutation
    Access requirements

    Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.

    Anchor to orderEditAddLineItemDiscount
    orderEditAddLineItemDiscount
    mutation
    Access requirements

    Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditAddShippingLine
    orderEditAddShippingLine
    mutation
    Access requirements

    Adds a shipping line to an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditAddVariant
    orderEditAddVariant
    mutation
    Access requirements

    Adds a line item from an existing product variant.

    Anchor to orderEditBegin
    orderEditBegin
    mutation
    Access requirements

    Starts editing an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.

    Anchor to orderEditRemoveDiscount
    orderEditRemoveDiscount
    mutation
    Access requirements

    Removes a discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditRemoveShippingLine
    orderEditRemoveShippingLine
    mutation
    Access requirements

    Removes a shipping line from an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditSetQuantity
    orderEditSetQuantity
    mutation
    Access requirements

    Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditUpdateDiscount
    orderEditUpdateDiscount
    mutation
    Access requirements

    Updates a manual line level discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Anchor to orderEditUpdateShippingLine
    orderEditUpdateShippingLine
    mutation
    Access requirements

    Updates a shipping line on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

    Was this section helpful?
    <~>
    OrderEditSession Mutations
    OrderEditSession

    Mutated by

    Anchor to section titled 'Implements'

    Implements

    Anchor to Node
    Node
    interface
    Was this section helpful?
    ||-
    OrderEditSession Implements
    OrderEditSession

    Implements