API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Courier
  • 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
      GET
    • List courier operate
      GET
    • List courier integrated
      GET
  • Address Directory
    • Province
    • District
    • Ward
  1. Courier

List courier integrated

Developing
GET
/api/v1/public/couriers/list-courier-integrated
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/couriers/list-courier-integrated' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": [
    {
      "id": 172,
      "country": "VN",
      "config": {},
      "courier_prefix": "sof",
      "refresh_token": null,
      "refresh_expired_time": 0,
      "expired_time": 0,
      "access_token": null,
      "public_info": {
        "courier_name": "Self-ship orders",
        "use_insurance": true,
        "can_check_content": true
      },
      "is_active": true,
      "is_delete": false,
      "is_default": false,
      "created_time": 1724925251,
      "updated_time": 1724925251,
      "user": 190,
      "business": 276,
      "courier": {
        "id": 16,
        "name": "Tự Vận Chuyển",
        "prefix": "sof",
        "description": "Hình thức người bán tự vận chuyển cho đơn hàng của mình. Tự quản lý quá trình vận chuyển và giao hàng đối với những đơn hàng mà người bán đã nhận.",
        "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/delivery.png",
        "tracking_url": null,
        "logo_label": null,
        "platform": null,
        "rating": 4,
        "is_bridge": false,
        "group": "GROUP_STANDARD",
        "is_allow_multi": true,
        "priority": 2,
        "is_fulfill_now": false,
        "link_support": null,
        "support_map_pickup": false,
        "support_map_user": false,
        "use_lib": null,
        "group_display": "Standard"
      },
      "courier_service_integration": [
        1699
      ]
    },
    {
      "id": 187,
      "country": "VN",
      "config": {},
      "courier_prefix": "nandh",
      "refresh_token": null,
      "refresh_expired_time": 0,
      "expired_time": 0,
      "access_token": null,
      "public_info": {
        "use_insurance": true,
        "can_check_content": true
      },
      "is_active": true,
      "is_delete": false,
      "is_default": false,
      "created_time": 1731300085,
      "updated_time": 1731300098,
      "user": 190,
      "business": 276,
      "courier": {
        "id": 9,
        "name": "N&H Logistics",
        "prefix": "nandh",
        "description": "N&H Logistics là công ty cung cấp giải pháp Fulfillment tổng thể từ lưu kho, hoàn tất đơn hàng, vận chuyển đến quản lý hậu cần cho doanh nghiệp trên đa nền tảng.",
        "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/AppIcon~ios-marketing.png",
        "tracking_url": null,
        "logo_label": null,
        "platform": null,
        "rating": 5,
        "is_bridge": true,
        "group": "GROUP_NH",
        "is_allow_multi": false,
        "priority": 1,
        "is_fulfill_now": false,
        "link_support": null,
        "support_map_pickup": false,
        "support_map_user": false,
        "use_lib": null,
        "group_display": "N&H Express"
      },
      "courier_service_integration": [
        1773,
        1774,
        1775,
        1776,
        1777,
        1778,
        1779,
        1780,
        1781,
        1782,
        1783,
        1784,
        1785,
        1786,
        1787,
        1788,
        1789,
        1790,
        1791,
        1792,
        1772
      ]
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 2
}

Request

Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
required
data
array [object {18}] 
required
id
integer 
required
country
string 
required
config
object 
required
courier_prefix
string 
required
refresh_token
null 
required
refresh_expired_time
integer 
required
expired_time
integer 
required
access_token
null 
required
public_info
object 
required
is_active
boolean 
required
is_delete
boolean 
required
is_default
boolean 
required
created_time
integer 
required
updated_time
integer 
required
user
integer 
required
business
integer 
required
courier
object 
required
courier_service_integration
array[integer]
required
error
boolean 
required
error_code
null 
required
log_id
null 
required
messages
string 
required
total
integer 
required
Previous
List courier operate
Next
Province
Built with