Order

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_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
    • city
      Type: string
    • country
      Type: string
    • external_id
      Type: string
    • id
      Type: integerFormat: uint
    • name
      Type: string
    • postal_code
      Type: string
    • region
      Type: string
    • street
      Type: string
  • delivery_estimated_at
    Type: stringFormat: date-time

    Estimated delivery date

  • delivery_method
    Type: stringenum

    Delivery method

    values
    • delivery
    • pickup
  • external_id_buyer
    Type: string

    External order ID (buyer perspective)

  • external_id_seller
    Type: string

    External order ID (seller 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

  • items
    Type: array object[] · OrderItem[]
    • amount
      Type: numberFormat: float

      Ordered amount

    • currency
      Type: string

      Currency code

    • display_name
      Type: string

      Product display name

    • ean_code
      Type: string

      Product EAN

    • id
      Type: integerFormat: uint

      Item ID

    • origin
      Type: string

      Product origin

    • prepared
      Type: boolean

      Item preparation status

    • price
      Type: numberFormat: float

      Unit price

    • price_unit
      Type: string

      Price unit

    • product_hash_id
      Type: string

      Product hash ID

    • product_id
      Type: integerFormat: uint

      Product ID

    • served_amount
      Type: numberFormat: float

      Served/prepared amount

    • served_price
      Type: numberFormat: float

      Served unit price

    • sku
      Type: string

      Product SKU

    • total_price
      Type: numberFormat: float

      Total price (amount * price)

    • unit
      Type: string

      Unit of measure

  • more_info
    Type: string

    Additional order notes

  • pickup_estimated_at
    Type: stringFormat: date-time

    Estimated pickup date

  • pickup_from
    Type: object
    • city
      Type: string
    • country
      Type: string
    • external_id
      Type: string
    • id
      Type: integerFormat: uint
    • name
      Type: string
    • postal_code
      Type: string
    • region
      Type: string
    • street
      Type: string
  • 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