Returns orders for seller.

GET /api/v2/orders

Query parameters

new boolean

get new orders only

Default value is false.
createdAt string

date of oldier order (format: yyyy-mm-dd)
updatedAt string

date of oldier order update (format: yyyy-mm-dd)
status string

Shipping status of the order ('pending_confirmation': no tracking added yet, 'ongoing_shipping': order is moving, 'shipped': order is delivered, 'error_shipping': an error as occured during the shipment, 'cancelled': order as been cancelled )
page string

actual page

Default value is 1.
pageSize string

page's size

Default value is 50.

Responses

200 application/json

Returns orders for seller
Hide response attributes Show response attributes object
- count integer
  
  number of items
- page integer
  
  current page
- pageSize integer
  
  number of items per page
- result array[object]
  
  array of result
  
  Hide result attributes Show result attributes object
  
  id integer
  
  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
  
  shipping_status string
  
  tracking_slug string
  
  tracking_number string
  
  delivered_at string
  
  invoiced_at string
  
  public_id string
  
  created_at string
  
  to_ship boolean
  
  cart_items array[object]
  
  Hide cart_items attributes Show cart_items attributes object
  
  tax_class string
  
  product_sku string
  
  product_name string
  
  product_quantity integer
  
  product_extra_infos object
  
  Additional properties are allowed.
  
  Hide product_extra_infos attributes Show product_extra_infos attributes object
  
  grouped_id integer
  
  id integer
  
  product_id integer
  
  price integer
  
  position string
  
  name string
  
  grade string
  
  tax_class string
  
  color string
  
  packaging string
  
  sku string
  
  stock integer
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'

Response examples (200)

{
  "count": 42,
  "page": 42,
  "pageSize": 42,
  "result": [
    {
      "id": 111111,
      "bordereau_url": "762b60bbe9f82bca7b80f5747fe959a4",
      "price_h_t": 1000,
      "price_t_v_a": 200,
      "price_t_t_c": 1200,
      "shipping_h_t": 100,
      "shipping_t_v_a": 20,
      "shipping_t_t_c": 120,
      "shipping_address_json": "{\"street\":\"a\",\"additionnal\":\"a\",\"postcode\":\"75000\",\"city\":\"a\",\"country\":\"FR\",\"firstname\":\"a\",\"lastname\":\"a\",\"company\":\"A\", \"type\":\"shipping\",\"email\":\"email@dipli.com\",\"telephone\":\"061111111111\",\"deliveryinfos\":null,\"ref\":null}",
      "shipping_status": "pending_confirmation",
      "tracking_slug": "ups",
      "tracking_number": "X12FA123GT",
      "delivered_at": "2022-09-01",
      "invoiced_at": "2022-09-01",
      "public_id": "A-111111",
      "created_at": "2022-09-01",
      "to_ship": true,
      "cart_items": [
        {
          "tax_class": "TVA Classique",
          "product_sku": "APPLE_IPHONE_8_SKU",
          "product_name": "Apple iPhone 8 64",
          "product_quantity": 10,
          "product_extra_infos": {
            "id": 11699153,
            "sku": "O3_MQ3D2ZD/A",
            "name": "Apple iPhone 8 32",
            "color": "Gris sideral",
            "grade": "Grade C",
            "price": 12000,
            "stock": 1,
            "position": "1er",
            "packaging": "Chargeur et cable",
            "tax_class": "Tva classique",
            "grouped_id": 707026,
            "product_id": 25005
          }
        }
      ]
    }
  ]
}

Response examples (400)

{
  "code": 400,
  "msg": "Bad Request"
}

Response examples (500)

{
  "code": 500,
  "msg": "Internale Server Error"
}