Returns orders for dropship partner.

GET /api-drop/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

status of order ('ongoing_shipping' / 'error_shipping' / 'cancelled' / 'pending_confirmation' / 'shipped')
page string

actual page

Default value is 1.
pageSize string

page's size

Default value is 50.

Responses

200

Returns orders for dropship partner
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 array[object]
  
  id integer
  
  public_id string
  
  by_agora boolean
  
  to_ship boolean
  
  order_at string
  
  delivered_at string
  
  bordereau_url string
  
  payment_status string
  
  shipping_status string
  
  billing_address_json string
  
  shipping_address_json string
  
  anonymous_email string
  
  tracking_courier string
  
  tracking_number string
  
  total_ttc integer
  
  total_ht integer
  
  shipping_h_t integer
  
  shipping_t_t_c integer
  
  canceled_at string
  
  cart_items array[object]
  
  Hide cart_items attributes Show cart_items attributes array[object]
  
  tax_class string
  
  product_sku string
  
  product_name string
  
  product_quantity integer
  
  product_extra_infos string
400

Bad request
Hide response attributes Show response attributes object
- code integer
- msg string
500

Internal server error
Hide response attributes Show response attributes object
- code integer
- msg string

GET /api-drop/v2/orders

curl \
 -X GET https://bi.agora.place/api-drop/v2/orders \
 -H "apikey: $API_KEY"

Response examples (200)

{
  "count": 42,
  "page": 42,
  "pageSize": 42,
  "result": [
    {
      "id": 111111,
      "public_id": "A-111111",
      "by_agora": true,
      "to_ship": true,
      "order_at": "2022-09-05T14:34:30+01:00",
      "delivered_at": "2022-09-11T10:30:10+01:00",
      "bordereau_url": "762b60bbe9f82bca7b80f5747fe959a4",
      "payment_status": "payment_received",
      "shipping_status": "pending_confirmation",
      "billing_address_json": "{\"street\":\"a\",\"additionnal\":\"a\",\"postcode\":\"75000\",\"city\":\"a\",\"country\":\"FR\",\"firstname\":\"a\",\"lastname\":\"a\",\"company\":\"A\", \"type\":\"billing\",\"email\":\"email@dipli.com\",\"telephone\":\"061111111111\",\"deliveryinfos\":null,\"ref\":null}",
      "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}",
      "anonymous_email": "810231556_1512390@orders.agora.place",
      "tracking_courier": "ups",
      "tracking_number": "X12FA123GT",
      "total_ttc": 19900,
      "total_ht": 16583,
      "shipping_h_t": 1000,
      "shipping_t_t_c": 1200,
      "canceled_at": "2022-09-15T10:30:10+01:00",
      "cart_items": [
        {
          "tax_class": "TVA Classique",
          "product_sku": "APPLE_IPHONE_8_SKU",
          "product_name": "Apple iPhone 8 64",
          "product_quantity": 10,
          "product_extra_infos": "{\"extended_images\":[\"f6f5692eecb63dde4c94.jpg\"],\"grouped_id\":707026,\"id\":11699153,\"product_id\":25005,\"price\":12000,\"position\":\"1er\",\"name\":\"Apple iPhone 8 32\",\"grade\":\"Grade C\",\"tax_class\":\"Tva classique\",\"color\":\"Gris sideral\",\"packaging\":\"Chargeur et cable\",\"sku\":\"O3_MQ3D2ZD\\/A\",\"stock\":1}"
        }
      ]
    }
  ]
}

Response examples (200)

{
  "count": 42,
  "page": 42,
  "pageSize": 42,
  "result": [
    {
      "id": 111111,
      "public_id": "A-111111",
      "by_agora": true,
      "to_ship": true,
      "order_at": "2022-09-05T14:34:30+01:00",
      "delivered_at": "2022-09-11T10:30:10+01:00",
      "bordereau_url": "762b60bbe9f82bca7b80f5747fe959a4",
      "payment_status": "payment_received",
      "shipping_status": "pending_confirmation",
      "billing_address_json": "{\"street\":\"a\",\"additionnal\":\"a\",\"postcode\":\"75000\",\"city\":\"a\",\"country\":\"FR\",\"firstname\":\"a\",\"lastname\":\"a\",\"company\":\"A\", \"type\":\"billing\",\"email\":\"email@dipli.com\",\"telephone\":\"061111111111\",\"deliveryinfos\":null,\"ref\":null}",
      "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}",
      "anonymous_email": "810231556_1512390@orders.agora.place",
      "tracking_courier": "ups",
      "tracking_number": "X12FA123GT",
      "total_ttc": 19900,
      "total_ht": 16583,
      "shipping_h_t": 1000,
      "shipping_t_t_c": 1200,
      "canceled_at": "2022-09-15T10:30:10+01:00",
      "cart_items": [
        {
          "tax_class": "TVA Classique",
          "product_sku": "APPLE_IPHONE_8_SKU",
          "product_name": "Apple iPhone 8 64",
          "product_quantity": 10,
          "product_extra_infos": "{\"extended_images\":[\"f6f5692eecb63dde4c94.jpg\"],\"grouped_id\":707026,\"id\":11699153,\"product_id\":25005,\"price\":12000,\"position\":\"1er\",\"name\":\"Apple iPhone 8 32\",\"grade\":\"Grade C\",\"tax_class\":\"Tva classique\",\"color\":\"Gris sideral\",\"packaging\":\"Chargeur et cable\",\"sku\":\"O3_MQ3D2ZD\\/A\",\"stock\":1}"
        }
      ]
    }
  ]
}

Response examples (400)

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

Response examples (400)

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

Response examples (500)

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

Response examples (500)

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