Returns orders for the seller.

GET /api/v2/orders
Api key auth

Query parameters

  • new boolean

    Get new orders only

    Default value is false.

  • createdAt string

    Date of older orders (format: yyyy-mm-dd)

  • updatedAt string

    Date of older order updates (format: yyyy-mm-dd)

  • status string

    Shipping status

  • page string

    Default value is 1.

  • pageSize string

    Default value is 50.

Responses

  • 200 application/json

    Returns order list

    Hide response attributes Show response attributes object
    • count integer
    • page integer
    • pageSize integer
    • result array[object]
      Hide result attributes Show result attributes object
      • id integer
      • public_id string
      • shipping_status string
      • to_ship boolean
      • bordereau_url string
      • price_h_t integer
      • price_t_v_a integer
      • price_t_t_c integer
      • shipping_h_t integer
      • shipping_t_v_a integer
      • shipping_t_t_c integer
      • shipping_address_json string
      • tracking_slug string
      • tracking_number string
      • delivered_at string
      • invoiced_at string
      • created_at string
      • cart_items array[object]
        Hide cart_items attributes Show cart_items attributes object
        • tax_class string | null
        • product_name string | null
        • product_sku string | null
        • product_quantity integer
        • unit_price_h_t number(float)
        • unit_price_t_v_a number(float)
        • unit_price_t_t_c number(float)
        • color string | null
        • grade string | null
        • attr_test string | null
        • product_extra_infos object | null Deprecated

          Deprecated field. Contains legacy additional information. Use color, grade and attr_test fields instead.
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • code integer
    • msg string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code integer
    • msg string
GET /api/v2/orders 
curl \
 --request GET 'https://bi.agora.place/api/v2/orders' \
 --header "apikey: $API_KEY"
Response examples (200) 
{
  "count": 42,
  "page": 42,
  "pageSize": 42,
  "result": [
    {
      "id": 42,
      "public_id": "string",
      "shipping_status": "string",
      "to_ship": true,
      "bordereau_url": "string",
      "price_h_t": 42,
      "price_t_v_a": 42,
      "price_t_t_c": 42,
      "shipping_h_t": 42,
      "shipping_t_v_a": 42,
      "shipping_t_t_c": 42,
      "shipping_address_json": "string",
      "tracking_slug": "string",
      "tracking_number": "string",
      "delivered_at": "string",
      "invoiced_at": "string",
      "created_at": "string",
      "cart_items": [
        {
          "tax_class": "TVA Classique",
          "product_name": "Samsung Galaxy J3 2017 Dual Sim",
          "product_sku": "SM-J330FZ",
          "product_quantity": 5,
          "unit_price_h_t": 119.9,
          "unit_price_t_v_a": 23.98,
          "unit_price_t_t_c": 143.88,
          "color": "Noir",
          "grade": "Grade C",
          "attr_test": "PREMIUM",
          "product_extra_infos": {}
        }
      ]
    }
  ]
}
Response examples (400) 
{
  "code": 400,
  "msg": "Bad Request"
}
Response examples (500) 
{
  "code": 500,
  "msg": "Internal Server Error"
}