GET /platform/ambassadors/{id}/orders

Path parameters

  • id integer Required

    The ambassador id

Query parameters

  • filter[placed_between] string(date-time)

    filter by placed date between two dates

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]
      • products array[object]
        Hide products attribute Show products attribute object
        • 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)
  • 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": [
    {
      "products": [
        {
          "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
}