open-api
首页
open-api
  • 快速开始
  • 授权登录
  • 客户
  • 销售订单
    • 销售订单
    • 销售订单枚举:货币,付款方式,国家/地区,订单类型,订单状态,订单创建方式GET
    • 销售订单字段GET
    • 销售订单删除POST
    • 销售订单新建/编辑POST
    • 销售订单列表GET
    • 销售订单详情GET
  • 采购订单
  • 产品
  • 回款登记
  • 回款单
  • 付款单
  • 费用单
  • 报价单
  • 供应商
  • 商机
  • 用户
  • 销售出库单
  • 库存
  • 线索
  • 资金
  • 采购入库单
  • 采购退货单
  • 统计分析
  • 示例接口(勿用)
  • 阿里账号信息GET
  • 阿里资金账户信息GET
亮色模式
  1. 销售订单

销售订单新建/编辑

POST/v1/invoices/order/push

错误码解释

异常码 异常消息 异常解决方案
404 Not Found Resource没有权限编辑XXX 若传入user_id字段,则会根据该用户ID校验用户是否有操作订单相关字段权限,若出现该错误可以到【角色权限中新增权限】或者【更改传入有订单权限的用户ID】

价格条款

需要对接 price_contract 价格条款 字段的同学,临时参考下面价格条款传入对应的CODE,后面会维护在销售订单枚举接口中,目前小满CRM只下面几种:
传入例子:

{
     "price_contract": "EXW"
}
价格条款CODE 价格条款名称
EXW 卖方工厂交货
FOB 指定装运港船上交货
CFR 成本加运费
CIF 成本加运费保险费
DDU 未完税交货
DDP 完税后交货
FCA 货交承运人
CPT 运费付至
FAS 指定装运港船边交货
CIP 运费、保险费付至
DPU 卸货地交货
DEQ 目的港码头交货
DAP 目的地交货
DAF 边境交货
DE 目的港船上交货

订单产品特殊对接

注意!注意!若订单中存在多条明细,明细有相同的规格产品时,比如A,B记录都是相同的规格产品,可能在单价上存在差异,那么在新建订单后,获取返回值中的product_list的unique_id自行保留起来做好映射。下次编辑时需要带入,否则编辑时接口将会根据product_id进行去重保留一条记录。

请求参数

Header 参数
Authorization
string 
必需

从/v1/oauth2/access_token获取到的access_token

示例值:
access_token
Body 参数application/json
12345677
array[string]
可选

若自定义多选字段,数组传入,值来自/v1/invoices/order/fields中对应字段的ext_info中的一个或多个

12345678
string 
可选

若自定义单选字段,值来自/v1/invoices/order/fields中对应字段的ext_info中的一个

order_id
integer 
可选

订单ID,编辑时可以传入订单ID或者订单编号

order_no
string 
可选

订单编号,编辑时可以传入订单ID或者订单编号

account_date
string 
可选

订单日期,YYYY-mm-dd

name
string 
订单名称
可选
exchange_rate
number <float>
可选

折现人民币汇率,exchange_rate不传入时默认取当前系统设置的汇率,这里有传币种,不传exchange_rate的话就会exchange_rate和exhange_rate_usd都取系统实时

exchange_rate_usd
number <float>
可选

折现美元汇率,exchange_rate不传入时默认取当前系统实时的汇率

currency
string 
必需

币种,传入值来自/v1/invoices/order/orderEnums返回值中currency_list的code

amount
number <float>
订单金额
可选
amount_rmb
number <float>
订单金额(人民币)
可选
amount_usd
number <float>
订单金额(美元)
可选
addition_cost_amount
number <float>
附加费用总金额
可选
product_total_amount
number <float>
产品总金额
可选
product_total_count
integer 
产品总数量
可选
price_contract
string 
可选

价格条款,参考说明中的价格条款枚举值

receive_remittance_way
string 
可选

付款方式,传入值来自/v1/invoices/order/orderEnums返回值中pay_list的code

price_contract_remark
string 
价格条款说明
可选
receive_remittance_remark
string 
收汇方式说明
可选
insurance_remark
string 
保险说明
可选
order_contract
string 
订单条款
可选
company_id
integer 
可选

客户ID,请从客户列表中获取客户ID传入

company_name
string 
客户名称
可选
company_phone
string 
客户电话
可选
company_fax
string 
客户传真
可选
company_address
string 
客户地址
可选
country
string 
可选

国家/地区:ISO两位编码

opportunity_id
integer 
可选

商机id,请从商机列表等中拿到商机ID传入

shipment_deadline_remark
string 
交货期
可选
departments
array [object {2}] 
业绩归属部门
可选
department_id
integer 
必需

业绩归属部门id,传入值来自/v1/user/departmentList中的id

rate
number 
必需

业绩占比,传入的所有占比累加最多等于100

users
array [object {2}] 
业绩归属人
可选
user_id
integer 
必需

业绩归属人id,传入值来自/v1/user/list中的user_id

rate
number 
必需

业绩占比,传入的所有占比累加最多等于100

product_list
array [object {8}] 
产品子列表
可选
product_id
integer 
必需

产品ID,请从产品列表或者产品明细中获取产品ID传入

sku_id
integer 
必需

产品SKU ID,请从产品列表或者产品明细中获取产品SKUID传入

count
number 
数量
必需
unit_price
number <float>
单价
必需
other_cost
number <float>
其他费用
可选
cost_amount
number <float>
可选

金额小计,一般为数量*单价+其他费用

unique_id
integer 
可选

该明细ID是小满订单明细真实唯一ID,存在相同记录的明细,需要自行新建订单后,保存返回的unique_id,再次编辑时可以传入,否则明细会根据product_id只保存一条明细

remove
integer 
可选

若要删除明细,则要明确传入该标志,为1时会删除

customer_id
integer 
可选

联系人ID,请从客户列表或者客户联系人列表中获取联系人ID传入

customer_name
string 
联系人名称
可选
customer_phone
string 
联系人电话
可选
customer_email
string 
联系人邮箱
可选
customer_address
string 
联系人地址
可选
transport_mode
string 
可选

运输方式,值为 空运、海运、陆运、邮政、快递、其他

shipment_deadline
string 
装运期限
可选
shipment_port
string 
装运港口
可选
target_port
string 
目的港口
可选
more_or_less
string 
溢短装
可选
package_remark
string 
包装说明
可选
marked
string 
唛头
可选
handler
array[string]
可选

处理人,数组传入,传入值来自/v1/user/list中的user_id

create_user
integer 
可选

创建人,传入值来自/v1/user/list中的user_id

create_time
string 
创建时间
可选
remark
integer 
备注
可选
source_type
integer 
可选

订单类型:1 CRM订单,默认1,传入值来自/v1/invoices/order/orderEnums返回值中source_type_list的code

status
integer 
可选

订单状态,传入值来自/v1/invoices/order/orderEnums返回值中order_status_list中的code

tax_refund_type
integer 
可选

是否退税,1不退税,2退税,默认0

cost_list
array [object {4}] 
费用
可选
cost_name
string 
费用名称
必需
percent_type
integer 
必需

枚举值,计算规则 0:(加(+)绝对值、1:加(+)占产品总金额百分比、2:减(-)绝对值、3:减(-)占产品总金额百分比)

percent_amount
number 
必需

计算金额值,比如1%,那就是产品金额*1%

cost
number 
必需

最终费用金额,根据计算金额值计算出来后的费用

file_list
array[string]
可选

附件,数组传入,完整可以访问的文件链接

capital_account_id
integer 
可选

资金账号ID,值来自/v1/capitalAccount/list的capital_account_id

user_id
integer 
当前操作用户
必需
示例
{
  "12345677": "单选1",
  "12345678": [
    "多选1",
    "多选2"
  ],
  "order_id": "",
  "order_no": "",
  "account_date": "2024-01-29",
  "name": "erp同步订单",
  "company_id": "3448551934",
  "customer_id": "3448551921",
  "currency": "USD",
  "users": [
    {
      "user_id": "11858712",
      "rate": 100
    }
  ],
  "departments": [
    {
      "rate": 100,
      "department_id": "148"
    }
  ],
  "product_list": [
    {
      "product_id": "3495743811",
      "sku_id": "3495743812",
      "count": "10",
      "unit_price": "10",
      "cost_amount": "100"
    }
  ],
  "price_contract": "",
  "price_contract_remark": "",
  "receive_remittance_way": "",
  "receive_remittance_remark": "",
  "insurance_remark": "",
  "bank_info": "",
  "order_contract": "",
  "company_name": "中国宝安科技",
  "company_phone": "",
  "company_fax": "",
  "country": "",
  "company_address": "erp的公司地址",
  "opportunity_id": "",
  "shipment_deadline_remark": "",
  "customer_name": "阿嫲",
  "customer_phone": "1829383944",
  "customer_email": "am@am.com",
  "customer_address": "联系人地址",
  "transport_mode": "",
  "shipment_deadline": "",
  "shipment_port": "",
  "target_port": "",
  "more_or_less": "",
  "package_remark": "",
  "marked": "",
  "collection_date": "",
  "status_name": "",
  "collect_amount_rmb": "",
  "collect_amount_usd": "",
  "not_collect_amount_rmb": "",
  "not_collect_amount_usd": "",
  "percentage_rmb": "",
  "percentage_usd": "",
  "create_user": 11858712,
  "remark": "",
  "source_type": "",
  "tax_refund_type": "",
  "capital_account_id": "122",
  "status": 12343455,
  "cost_list": [
    {
      "cost_name": "erp费用名称",
      "percent_type": "0",
      "percent_amount": "200",
      "cost_remark": "erp费用备注",
      "cost": 200
    }
  ],
  "file_list": [
    ""
  ]
}

示例代码

返回响应

成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer 
必需
message
string 
必需
now
string 
必需
data
object 
必需
order_id
integer 
销售订单ID
必需
product_list
array [object {8}] 
销售订单产品明细
可选
示例
{
  "code": 200,
  "message": "success",
  "now": "2025-04-19 15:45:47",
  "data": {
    "order_id": 5223975283,
    "product_list": [
      {
        "unique_id": 5223975284,
        "product_name": "这是一个名称1",
        "product_no": "1",
        "product_model": "sky",
        "product_id": 3563404548,
        "sku_id": 3563404549,
        "count": 3,
        "unit_price": 10
      },
      {
        "unique_id": 5223975285,
        "product_name": "这是一个名称2",
        "product_no": "1",
        "product_model": "sky",
        "product_id": 3563404548,
        "sku_id": 3563404549,
        "count": 2,
        "unit_price": 7
      }
    ]
  }
}
最后修改时间: 2 个月前