API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Config
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
    • Return order detail
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Config

List Box Dimension

GET
/api/v1/public/users/box-dimension/list
This API is used to retrieve a list of box dimensions defined by the user. These dimensions represent the size of packages that will be sent via the shipping carrier and are used to estimate shipping fees for orders.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/users/box-dimension/list?page=1&page_size=5' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": [
    {
      "id": 129,
      "name": "BOX25x15x10",
      "weight": 1,
      "width": 15,
      "height": 10,
      "length": 25,
      "is_default": false,
      "is_delete": false,
      "is_active": true,
      "created_time": 1730426226,
      "updated_time": 1731665233
    },
    {
      "id": 120,
      "name": "BOX10x10x10",
      "weight": 100,
      "width": 10,
      "height": 10,
      "length": 10,
      "is_default": true,
      "is_delete": false,
      "is_active": true,
      "created_time": 1724925077,
      "updated_time": 1731665240
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 2
}

Request

Query Params
page
integer 
required
Example:
1
page_size
integer 
required
<= 100
Example:
5
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
HTTP status code, e.g., 200 indicates success.
data
array [object {11}] 
optional
List of box dimension objects. Each object contains:
id
integer 
optional
Unique identifier of the box dimension.
name
string 
optional
Name of the box, typically formatted by dimensions (e.g., "BOX25x15x10").
weight
integer 
optional
Weight of the empty box in grams or kilograms.
width
integer 
optional
Width of the box (numeric unit assumed to be centimeters or millimeters).
height
integer 
optional
Height of the box.
length
integer 
optional
Length of the box.
is_default
boolean 
optional
Indicates whether this box is the default choice (true/false).
is_delete
boolean 
optional
Indicates if the box configuration is marked as deleted.
is_active
boolean 
optional
Indicates if the box is currently active and usable.
created_time
integer 
optional
Timestamp of when the box was created (in Unix time).
updated_time
integer 
optional
Timestamp of the most recent update (in Unix time).
error
boolean 
optional
Shows whether an error occurred.
error_code
string  | null 
optional
Contains an error code if applicable.
log_id
string  | null 
optional
Log ID for tracking the request.
messages
string 
optional
Message from the server, usually empty on success.
total
integer 
optional
Total number of box dimensions returned.
Previous
List Pickup Address
Next
List vendor
Built with