Versions Compared

Key

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

批量创建客户发货单:接口描述

URL

https://

branch.birdsystem.com

<系统域名>/client/Client-Dispatch-Upload/Client-Dispatch-Json

接口功能

创建客户发货单

支持格式

JSON/TEXT

开发人员

 

请求方式

POST

发布日期

 

发货单-参数

字段

注释

是否必填

类型

id

客户发货单ID(添加发货单,无需填写)

选填

INT

type

发货单类型/种类

必填
填写参数可参考
客户发货单种类

/发货单类型

VARCHAR

warehouse_id_origination

发货仓ID/始发仓

必填
填写参数可参考如下文档接口获取

获取客户可用仓库
当发货单的类型type为DIRECT的时候时,这个字段不用填,始终跟warehouse_id_destination一致,当type为SPONTANEOUS和WAREHOUSE_TRANSFER时,选填,不填则跟warehouse_id_destination一致,其余情况必填

INT

warehouse_id_destination

目的仓ID

必填
填写参数可参考接口文档

获取客户可用仓库

INT

final_freight_method

最终运输方式

必填
填写参数可参考接口文档

最终运输方式描述

最终运输方式

VARCHAR

sea_trans_calc_fee_method

海运计费方式

选填

VARCHAR

warehouse_dispatch_freight

仓库货运

选填

warehouse_dispatch_freight_id

头程物流计划ID

系统自动分配

INT

delivery_time

客户预计发货时间

选填

TIMESTAMP

YYYY- MM- DD格式的日期

confirm_delivery_time

客户实际发货时间

修改状态已发货时,系统自动分配

TIMESTAMP

client_dispatch_final_address_contact

联系人

选填

VARCHAR

client_dispatch_final_address_business_name

公司

选填

VARCHAR

client_dispatch_final_address_line1

地址行1

选填

VARCHAR

client_dispatch_final_address_line2

地址行2

选填

VARCHAR

client_dispatch_final_address_line3

地址行3

选填

VARCHAR

client_dispatch_final_address_city

城市

选填

VARCHAR

client_dispatch_final_address_county

省份

选填

VARCHAR

client_dispatch_final_address_post_code

邮编

选填

VARCHAR

client_dispatch_final_address_country_iso

国家代码

选填

VARCHAR

client_dispatch_final_address_telephone

电话

选填

INT

client_dispatch_final_address_email

邮箱

选填

VARCHAR

client_dispatch_shipping_agent-id

发货单代理人id

选填

INT

is_use_whole_warehouse_dispatch_freight

是否包柜

海运时必填

INT(0或1)

client_dispatch_delivery_type_id

到仓调度类型ID

选填,ID或代码必填一个

INT

client_dispatch_delivery_type_code

到仓调度类型代码

选填,ID或代码必填一个
填写参数可参考接口文档获取到仓调度类型
code值请看/client/Client-Dispatch-Delivery-Type 
如果到仓调度类型的列is_delivery_to_warehouse为0, 则发货单需要填写最终发货地址的联系人, 国家.  

VARCHAR

delivery_reference

基本细节--运输跟踪号

选填

VARCHAR

reference

跟踪号

选填

VARCHAR

client_vat_number_id

VAT号码

选填
填写参数可参考接口文档获取VAT账号
通过/client/Client-Dispatch-Vat-Number获取

INT

confirmed

允许仓库根据实际到仓时间优化物流计划

选填

取值0:需要更换物流计划时提示:是否更换物流计划
取值1:表示允许系统自动更换
取值2:表示不允许系统自动更换.

note

备注

选填

VARCHAR

shipping_agent_id

发货方式id

必填,其他参数详情可查看下面文档

Expand
title发货方式字段描述
发货方式字段描述 VARCHAR

发货方式

INT

shipping_agent_note

客户发货到仓库时的备注信息

TEXT

final_address_*

地址薄

选填

estimate_arrival_destination_warehouse_time

预计到达目的仓时间,仅用于自发头程的发货单

选填

TIMESTAMP

YYYY- MM-DD HH:ii:ss格式的日期时间

发货箱参数

字段

注释

是否必填

类型

client_dispatch_container_type_code

客户发货箱类型

必填
code值请看 /client/Client-Dispatch-Container-Type

VARCHAR

quantity

数量

必填

INT

product_id

产品ID

必填
填写参数可参考接口文档

产品查询API

产品查询

INT

client_dispatch_container_reference

发货箱的跟踪号

选填

STRING

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

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

Code Block
languagejson
[
    {
 POST /client/Client-Dispatch-Upload/Client-Dispatch-Json? HTTP/1.1

Host: {{Bird_URL}}

Headres:

     "client_dispatch_container_product_list": [
   api_key: {{api_key}}

  company_id: {{company_id}}

  Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254

Body

{  raw
[
    {
        "client_dispatch_container_referenceproduct_list": "1452",[
            {
                "client_dispatch_container_reference": "1452",
                "client_dispatch_container_type_code": "CUSTOM",
                "product_id": "2253112",
                "quantity": 1
            },
            {
                "client_dispatch_container_reference": "1452",
                "client_dispatch_container_type_code": "CUSTOM",
                "product_id": "2253112",
                "quantity": 1
            }
        ],
        "type": "SPONTANEOUS",
        "warehouse_id_destination": "1",
        "warehouse_id_origination": "83",
        "final_freight_method": "AIR",
        "sea_trans_calc_fee_method":"",
        "warehouse_dispatch_freight_id":null,
        "delivery_time": "2021-05-30 09:00:0029",
        "client_dispatch_final_address_contact": "name",
        "client_dispatch_final_address_business_name":"company_name",
        "client_dispatch_final_address_line1":"adderss1",
        "client_dispatch_final_address_line2":"adderss2",
        "client_dispatch_final_address_line3":"adderss3",
        "client_dispatch_final_address_telephone":"phone",
        "client_dispatch_final_address_city":"shenzheng",
        "client_dispatch_final_address_county":"guangdong",
        "client_dispatch_final_address_post_code":"12345",
        "client_dispatch_final_address_country_iso":"GB",
        "client_dispatch_final_address_email":"1515@qq.com",
        "client_dispatch_delivery_type_code": "01",
        "confirmed": "1",
        "delivery_reference": "delivery_reference",
        "is_use_whole_warehouse_dispatch_freight": "1",
        "note": "注释",
        "reference": "RKPG201229000002",
        "shipping_agent_idestimate_arrival_destination_warehouse_time": "42023-05-01 00:00:00",
        "shipping_agent_delivery_referenceid": "renae",4"
    },
    {
        "shippingclient_dispatch_agentcontainer_propertyproduct_11list":"bird", [
         "shipping_agent_property_12":"20",
   {
       "shipping_agent_property_13":"20",         "shippingclient_agentdispatch_propertycontainer_36reference":"2021-05-30 09:00:00" "1452",
    },     {         ""client_dispatch_container_producttype_listcode": [
            {"CUSTOM",
                 "client_dispatch_container_referenceproduct_id": "14522253112",
                "client_dispatch_container_type_codequantity": "CUSTOM", 1
            },
     "product_id": "2253112",
                "quantity": 1
            },
            {
                "client_dispatch_container_reference": "1452",
                "client_dispatch_container_type_code": "CUSTOM",
                "product_id": "2253112",
                "quantity": 1
            }
        ],
        "type": "SPONTANEOUS",
        "warehouse_id_destination": "1",
        "warehouse_id_origination": "83",
        "final_freight_method": "AIR",
        "sea_trans_calc_fee_method":"",
        "warehouse_dispatch_freight_id":null,
        "deliverywarehouse_id_timedestination": "2021-05-30 09:00:001",
        "clientwarehouse_dispatch_final_address_contactid_origination": "name83",
        "client_dispatch_final_addressfreight_business_namemethod": "company_nameAIR",
        "clientsea_dispatchtrans_finalcalc_addressfee_line1method":"adderss1",
        "clientwarehouse_dispatch_finalfreight_address_line2id":"adderss2"null,
        "client_dispatch_final_address_line3delivery_time": "adderss32021-05-29",
        "client_dispatch_final_address_telephonecontact": "phonename",
        "client_dispatch_final_address_business_cityname":"shenzhengcompany_name",
        "client_dispatch_final_address_countyline1":"guangdongadderss1",
        "client_dispatch_final_address_post_codeline2":"12345adderss2",
        "client_dispatch_final_address_country_isoline3":"GBadderss3",
        "client_dispatch_final_address_emailtelephone":"1515@qq.comphone",
        "client_dispatch_deliveryfinal_typeaddress_codecity": "01shenzheng",
        "confirmedclient_dispatch_final_address_county": "1guangdong",
        "delivery_referenceclient_dispatch_final_address_post_code": "delivery_reference12345",
        "isclient_usedispatch_wholefinal_warehouseaddress_dispatchcountry_freightiso": "1GB",
        "noteclient_dispatch_final_address_email": "注释1515@qq.com",
        "referenceclient_dispatch_delivery_type_code": "RKPG20122900000201",
        "shipping_agent_idconfirmed": "41",
        "shipping_agent_delivery_reference": "renaedelivery_reference",
        "shipping_agent_property_11":"bird"is_use_whole_warehouse_dispatch_freight": "1",
        "shipping_agent_property_12note": "20注释",
        "shipping_agent_property_13reference": "20RKPG201229000002",
        "shipping_agent_property_36id":"2021-05-30 09:00:00 "4"
    }
]

返回结果

Code Block
{
    "data": [
        "696977811696977071",
        "696977812696977072"
    ],
    "message": null,
    "success": true,
    "moduleName": "client"
}