Get Customer - Boxme API

Request

Query Params

create_from

integer

optional

Timestamp

Example:

1701363600

create_to

integer

optional

Timestamp

Example:

1704041999

customer_type

string

optional

Refer to customer type: personal/offline/corporate/concession/consignment, ...

Example:

online

page_size

integer

required

25, 50, 100

Example:

25

page

integer

required

Example:

1

Header Params

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://s.boxme.asia/api/v2/orders/customers/list/?create_from=1701363600&create_to=1704041999&customer_type=online&page_size=25&page=1' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

data

object

required

total_count

integer

required

customers

array [object {11}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "total_count": 1,
    "customers": [
      {
        "id": 82112,
        "customer_code": "CUS0011",
        "name": "Duc test",
        "type": "warehouse",
        "phone": "840231232323",
        "email": "",
        "config": {
          "is_co_inspection": false,
          "is_invoice_waiting": false,
          "door_to_door": false,
          "queue_service": false,
          "expected_on_day": 2,
          "expected_on_time": "13-15",
          "packing_note": "test",
          "shipping_note": "sadas"
        },
        "delivery_address": {
          "contact_name": "Store 1",
          "contact_phone": "09084373743",
          "country": "VN",
          "province_id": 2,
          "district_id": 33,
          "sub_district_id": 112,
          "zipcode": "00000",
          "address": "18 Tam Trinh"
        },
        "is_active": true,
        "created_time": 1695610196,
        "updated_time": 1695610196
      }
    ]
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "1705561400"
}