Query parameters

• sort string

  example :to sort the orders by id_order (-id_order: descending, id_order: ascending)

  Values are id_order, id_order_external, total_paid, or date_order.

• filter[order_search] string

  retrieve orders by id_order, id_order_external.

• filter[id_ambassador] integer

  Filter by id_ambassador in attribution ambassador

• filter[attribution] string

  Filter assigned orders

  Values are assigned, affiliation_assigned, or conversation_assigned.

• filter[last_status] string

  Filter by last_status

  Values are OK, OK_DELAY, E-BOOKING, CANCELLED, RETURNED, PENDING, or FULFILLED.

• filter[type] string

  Filter by order type

  Values are MAG, STORE, WEB, or .

• filter[id_ambassador_post] integer

  Filter orders by linked ambassador post

• filter[id_chatroom] integer

  Filter orders by linked chatroom

• filter[id_buyer] integer

  Filter orders by linked buyer

• page integer

  page number

• per_page integer

  number of items per page

Responses

• 200 application/json

  returns all orders (paginated)

  Hide response attributes Show response attributes object

  • current_page integer(int32)
  • data array[object]
    Hide data attributes Show data attributes object

    • id_order integer(int32)
    • id_order_external string(nullable)
    • total_amount number(float)
    • total_paid number(float)
    • total_ws number(float)
    • id_popliste integer(int32)
    • source string
    • last_status string
    • ambassador object

      Additional properties are allowed.

      Hide ambassador attributes Show ambassador attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • id_meeting integer(int32)
    • id_meeting_external string(nullable)
    • customer_id string
    • order_info string
    • buyer object

      Additional properties are allowed.

      Hide buyer attributes Show buyer attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • currency string
    • date_order string
    • type string
    • id_chat_segment integer(int32)
    • ambassador_chat object

      Additional properties are allowed.

      Hide ambassador_chat attributes Show ambassador_chat attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • id_chatroom integer(int32)
    • date_insert string
    • date_update string
  • first_page_url string
  • from integer(int32)
  • last_page integer(int32)
  • last_page_url string
  • links array[object]
    Hide links attributes Show links attributes object

    • url string(nullable)
    • label string
    • active boolean
  • next_page_url string
  • path string
  • per_page integer(int32)
  • prev_page_url string(nullable)
  • to integer(int32)
  • total integer(int32)
• 401 application/json

  Unauthorized.

  Hide response attribute Show response attribute object

  • message string
• 403

  Forbidden - You don't have permission to access this route