ViewOrder

  • Order information

    • buyer_id
      Type: integerFormat: uint

      Buyer user ID

    • closed_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • counterpart_id
      Type: string

      Relevant counterpart ID based on perspective

    • counterpart_id_buyer
      Type: string

      Counterpart ID (buyer perspective)

    • counterpart_id_seller
      Type: string

      Counterpart ID (seller perspective)

    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • currency
      Type: string

      Currency code

    • deliver_to
      Type: object
    • delivery_estimated_at
      Type: stringFormat: date-time

      Estimated delivery date

    • delivery_method
      Type: stringenum

      Delivery method

      values
      • delivery
      • pickup
    • external_id
      Type: string

      Relevant external ID based on perspective

    • external_id_buyer
      Type: string

      External order ID (buyer perspective)

    • external_id_seller
      Type: string

      External order ID (seller perspective)

    • external_status
      Type: string

      Relevant external status based on perspective

    • external_status_buyer
      Type: string

      External status (buyer perspective)

    • external_status_seller
      Type: string

      External status (seller perspective)

    • hash_id
      Type: string

      Order hash ID

    • id
      Type: integerFormat: uint

      Order ID

    • is_read
      Type: boolean

      Whether order has been read

    • items
      Type: array object[] · OrderItem[]
    • more_info
      Type: string

      Additional order notes

    • pickup_estimated_at
      Type: stringFormat: date-time

      Estimated pickup date

    • pickup_from
      Type: object
    • price
      Type: numberFormat: float

      Total order price

    • seller_id
      Type: integerFormat: uint

      Seller user ID

    • status
      Type: stringenum

      Order status

      values
      • draft
      • pending
      • accepted
      • canceled
      • incomplete
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • weight
      Type: numberFormat: float

      Total weight

    • weight_unit
      Type: stringenum

      Weight unit

      values
      • kg
      • lb
    • workspace_id
      Type: integerFormat: uint

      Seller workspace ID