title: Order Edit
description: Order edit keeps track of order items changes.
type: object
required:
  - canceled_at
  - canceled_by
  - confirmed_by
  - confirmed_at
  - created_at
  - created_by
  - declined_at
  - declined_by
  - declined_reason
  - id
  - internal_note
  - order_id
  - payment_collection_id
  - requested_at
  - requested_by
  - status
  - updated_at
properties:
  id:
    description: The order edit's ID
    type: string
    example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
  order_id:
    description: The ID of the order that is edited
    type: string
    example: order_01G2SG30J8C85S4A5CHM2S1NS2
  order:
    description: Available if the relation `order` is expanded.
    nullable: true
    type: object
  changes:
    description: Available if the relation `changes` is expanded.
    type: array
    items:
      $ref: ./OrderItemChange.yaml
  internal_note:
    description: An optional note with additional details about the order edit.
    nullable: true
    type: string
    example: Included two more items B to the order.
  created_by:
    description: The unique identifier of the user or customer who created the order edit.
    type: string
  requested_by:
    description: >-
      The unique identifier of the user or customer who requested the order
      edit.
    nullable: true
    type: string
  requested_at:
    description: The date with timezone at which the edit was requested.
    nullable: true
    type: string
    format: date-time
  confirmed_by:
    description: >-
      The unique identifier of the user or customer who confirmed the order
      edit.
    nullable: true
    type: string
  confirmed_at:
    description: The date with timezone at which the edit was confirmed.
    nullable: true
    type: string
    format: date-time
  declined_by:
    description: The unique identifier of the user or customer who declined the order edit.
    nullable: true
    type: string
  declined_at:
    description: The date with timezone at which the edit was declined.
    nullable: true
    type: string
    format: date-time
  declined_reason:
    description: An optional note why  the order edit is declined.
    nullable: true
    type: string
  canceled_by:
    description: >-
      The unique identifier of the user or customer who cancelled the order
      edit.
    nullable: true
    type: string
  canceled_at:
    description: The date with timezone at which the edit was cancelled.
    nullable: true
    type: string
    format: date-time
  subtotal:
    description: The total of subtotal
    type: integer
    example: 8000
  discount_total:
    description: The total of discount
    type: integer
    example: 800
  shipping_total:
    description: The total of the shipping amount
    type: integer
    example: 800
  gift_card_total:
    description: The total of the gift card amount
    type: integer
    example: 800
  gift_card_tax_total:
    description: The total of the gift card tax amount
    type: integer
    example: 800
  tax_total:
    description: The total of tax
    type: integer
    example: 0
  total:
    description: The total amount of the edited order.
    type: integer
    example: 8200
  difference_due:
    description: >-
      The difference between the total amount of the order and total amount of
      edited order.
    type: integer
    example: 8200
  status:
    description: The status of the order edit.
    type: string
    enum:
      - confirmed
      - declined
      - requested
      - created
      - canceled
  items:
    description: Available if the relation `items` is expanded.
    type: array
    items:
      $ref: ./LineItem.yaml
  payment_collection_id:
    description: The ID of the payment collection
    nullable: true
    type: string
    example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
  payment_collection:
    description: Available if the relation `payment_collection` is expanded.
    nullable: true
    $ref: ./PaymentCollection.yaml
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time