Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

接口简介

url

http://

test.birdsystem.com

<系统域名>/client/public/company-list

接口功能

站点信息查询. 在操作其他业务接口(产品、邮递服务、入库单、出库单)时,需要提供的company_id即来自于此,表示客户在XX站点操作订单,产品,发货单。

支持格式

json

开发人员

请求方式

get

发布日期


请求参数描述

参数名

字段类型

说明

无参数, 默认查询所有为正常状态的站点.

返回JSON描述

返回字段

字段类型

说明

country_name

VARCHAR

国家名称

return_country_name

VARCHAR

退货地址名称

site_id

int

站点ID

id

int

公司ID

name

VARCHAR

公司名称

site_name

VARCHAR

站点名称

email

VATCHAR

电子邮件

telephone

VARCHAR

电话

address_line1

VARCHAR

地址行1

address_line2

VARCHAR

地址行2

address_line3

VARCHAR

地址行3

city

VARCHAR

城市

county

VARCHAR

省/郡

post_code

VARCHAR

邮编

country_iso

CHAR(2)

国家

return_name

VARCHAR

退货名称

return_address_line1

VARCHAR

退货地址行1

return_address_line2

VARCHAR

退货地址行2

return_address_line3

VARCHAR

退货地址行3

return_city

VARCHAR

退货城市

return_county

VARCHAR

退货省/郡

return_post_code

VARCHAR

退货邮编

return_country_iso

CHAR(2)

退货国家

lading_bill_name

VARCHAR

提单名称

lading_bill_telephone

VARCHAR

提单电话

lading_bill_email

VARCHAR

提单电子邮件

lading_bill_address_line1

VARCHAR

提单地址行1

lading_bill_address_line2

VARCHAR

提单地址行2

lading_bill_address_line3

VARCHAR

提单地址行3

lading_bill_city

VARCHAR

提单城市

lading_bill_county

VARCHAR

提单省/郡

lading_bill_post_code

VARCHAR

提单邮编

lading_bill_country_iso

CHAR(2)

提单国家

settle_time

time

 结算时间

status

VARCHAR

状态

is_dynamic_warehouse

bool

是否动态仓

primary_keys

VARCHAR

主键

案例:

(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

Expand
title(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

使用接口调试工具postman
Http请求格式:

Code Block
languagejson
GET /client/public/company-list HTTP/1.1
Host: {{Bird_URL}}
Headres:
  api_key: {{api_key}}
  company_id: {{company_id}}
  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254

返回JSON格式结果

Code Block
languagejson
{
    "total": 17,
    "data": [
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 1,
            "name": "Fulfilment (Gibraltar) Ltd",
            "site_name": "1",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "GB",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 11,
            "name": "FN INTL",
            "site_name": "11",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "CN",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 12,
            "name": "FISE Services GmbH",
            "site_name": "12",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "DE",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 17,
            "name": "Birdsystem USA2",
            "site_name": "17",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "US",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 18,
            "name": "COLISIO",
            "site_name": "18",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "FR",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 19,
            "name": "Fulfilment (Gibraltar) Ltd",
            "site_name": "19",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "GB",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 20,
            "name": "Fulfilment (Gibraltar) Ltd",
            "site_name": "20",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "GB",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 26,
            "name": "Fulfilment (Gibraltar) Ltd",
            "site_name": "26",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "GB",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 35,
            "name": "ECDC",
            "site_name": "35",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "BE",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 36,
            "name": "FN INTL",
            "site_name": "36 CN 华南站",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "CN",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 39,
            "name": "ECDC",
            "site_name": "39",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "BE",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 44,
            "name": "共享站",
            "site_name": "44",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "CN",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 54,
            "name": "FISE Services GmbH",
            "site_name": "54",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "DE",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 55,
            "name": "FN INTL",
            "site_name": "55",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "CN",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 56,
            "name": "Fulfilment (Gibraltar) Ltd",
            "site_name": "56",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "GB",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 2,
            "name": "INPRIME LOGISTICS MGMT LTD",
            "site_name": "CN 深圳站",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "CN",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        },
        {
            "country_name": null,
            "return_country_name": null,
            "site_id": null,
            "id": 3,
            "name": "Falcon e-Fulfillment GmbH",
            "site_name": "DE 德国站",
            "email": null,
            "telephone": null,
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "city": null,
            "county": null,
            "post_code": null,
            "country_iso": "DE",
            "return_name": null,
            "return_address_line1": null,
            "return_address_line2": null,
            "return_address_line3": null,
            "return_city": null,
            "return_county": null,
            "return_post_code": null,
            "return_country_iso": null,
            "lading_bill_name": null,
            "lading_bill_telephone": null,
            "lading_bill_email": null,
            "lading_bill_address_line1": null,
            "lading_bill_address_line2": null,
            "lading_bill_address_line3": null,
            "lading_bill_city": null,
            "lading_bill_county": null,
            "lading_bill_post_code": null,
            "lading_bill_country_iso": null,
            "settle_time": null,
            "status": null,
            "is_dynamic_warehouse": null,
            "primary_keys": [
                "id"
            ]
        }
    ],
    "success": true,
    "moduleName": "client"
}

...