Get ambassador orders (Platform)

GET /platform/ambassadors/{id}/orders

Path parameters

  • id integer Required

    The ambassador id

Responses

  • 200 application/json

    returns all ambassadors (paginated)

    Hide response attributes Show response attributes object
    • current_page integer(int32)
    • data array[object]
      Hide data attributes Show data attributes array[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
      • id_meeting integer(int32)
      • id_meeting_external string(nullable)
      • customer_id string
      • order_info string
      • currency string
      • date_order string
      • type string
      • id_chat_segment integer(int32)
      • id_chatroom integer(int32)
      • date_insert string
      • date_update string
      • assignment string

        Values are conversation_assigned, affiliation_assigned, or unassigned.

      • buyer object
        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
      • products array[object]
        Hide products attributes Show products attributes object
        • id_product integer(int32)
        • name string(nullable)
        • type string(nullable)
        • discount_percentage number(float)
        • price_catalog integer(float)
        • reference_unit_price integer(float)
        • sku string(nullable)
        • youtube_id string(nullable)
        • url string(nullable)
        • description string(nullable)
        • images array[object]
          Hide images attributes Show images attributes object
          • id_i18n_content integer
          • lang string

            Values are en_GB, fr_FR, es_ES, or de_DE.

          • content string
        • price number(float)
        • stock integer(float)
        • stock_available number(float)
        • old_image string(nullable)
        • order_details object
          Hide order_details attributes Show order_details attributes object
          • id_order integer(int32)
          • id_product integer(int32)
          • quantity integer(int32)
          • unit_price number(float)
          • sku string
          • currency string
          • total_price integer(float)

            unit_price * quantity

      • total_products_quantity integer(int32)

        Total quantity of products in the order

    • first_page_url string
    • from integer(int32)
    • last_page integer(int32)
    • last_page_url string
    • 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

GET /platform/ambassadors/{id}/orders
curl \
 --request GET 'https://domain.tld/api/v2/platform/ambassadors/{id}/orders' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "current_page": 42,
  "data": [
    {
      "id_order": 42,
      "id_order_external": "string",
      "total_amount": 42.0,
      "total_paid": 42.0,
      "total_ws": 42.0,
      "id_popliste": 42,
      "source": "string",
      "last_status": "string",
      "id_meeting": 42,
      "id_meeting_external": "string",
      "customer_id": "string",
      "order_info": "string",
      "currency": "string",
      "date_order": "string",
      "type": "string",
      "id_chat_segment": 42,
      "id_chatroom": 42,
      "date_insert": "string",
      "date_update": "string",
      "assignment": "conversation_assigned",
      "buyer": {
        "id_ambassador": 42,
        "image": "string",
        "firstname": "string",
        "lastname": "string",
        "username": "string",
        "email": "string",
        "email_tmp": "string",
        "active": 42,
        "status": 42,
        "online": true,
        "last_action_date": "2025-05-04T09:42:00Z",
        "customer_id": "string",
        "anonymized": true
      },
      "products": [
        {
          "id_product": 42,
          "name": "string",
          "type": "string",
          "discount_percentage": 42.0,
          "price_catalog": 42,
          "reference_unit_price": 42,
          "sku": "string",
          "youtube_id": "string",
          "url": "string",
          "description": "string",
          "images": [
            {
              "id_i18n_content": 42,
              "lang": "en_GB",
              "content": "Hello"
            }
          ],
          "price": 42.0,
          "stock": 42,
          "stock_available": 42.0,
          "old_image": "string",
          "order_details": {
            "id_order": 42,
            "id_product": 42,
            "quantity": 42,
            "unit_price": 42.0,
            "sku": "string",
            "currency": "string",
            "total_price": 42
          }
        }
      ],
      "total_products_quantity": 42
    }
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}
Response examples (401)
{
  "message": "Unauthorized."
}