# 发货单 API

# 审核发货

接口地址:/api/open/v2/salesOutOrder/audit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "reason": "",
    "result": true
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutAuditParamRequestParameter	salesOutAuditParamRequestParameter	body	true	RequestParameter«SaleOutOrderAuditParam»	RequestParameter«SaleOutOrderAuditParam»
body			false	SaleOutOrderAuditParam	SaleOutOrderAuditParam
code	单号编码		true	string
reason	审核未通过原因原因，未审核通过则为必填		false	string
result	审核结果		true	boolean

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 自动创建发货单+出库单

接口地址:/api/open/v2/salesOutOrder/autoCreate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "comments": "",
    "deliveryCompany": "",
    "deliveryOrderNumber": "",
    "deliveryTime": 0,
    "number": "",
    "records": [
      {
        "batchNumber": "",
        "comment": "",
        "itemCode": "",
        "locationCode": "",
        "orderCode": "",
        "quantity": 0,
        "warehouseCode": ""
      }
    ]
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
parameter	parameter	body	true	RequestParameter«AutoSaleOutParam»	RequestParameter«AutoSaleOutParam»
body			false	AutoSaleOutParam	AutoSaleOutParam
comments	发货备注		false	string
deliveryCompany	物流公司		false	string
deliveryOrderNumber	物流单号		false	string
deliveryTime	发货日期		false	integer
number	发货编号		true	string
records	发货明细		true	array	SaleOutDetail
batchNumber	批次编码		false	string
comment	发货单行备注		false	string
itemCode	产品编码		true	string
locationCode	库位编码		false	string
orderCode	订单编码		true	string
quantity	出库数量(基本数量)		false	number
warehouseCode	仓库编码		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建发货记录

接口地址:/api/open/v2/salesOutOrder/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "comments": "",
    "deliveryCompany": "",
    "deliveryOrderNumber": "",
    "deliveryTime": 0,
    "number": "",
    "records": [
      {
        "comment": "",
        "id": 0,
        "itemCode": "",
        "orderCode": "",
        "quantity": 0,
        "warehouseBinCode": "",
        "warehouseCode": ""
      }
    ],
    "salesOutOrderId": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutCreateParamRequestParameter	salesOutCreateParamRequestParameter	body	true	RequestParameter«SalesOutOrderParams»	RequestParameter«SalesOutOrderParams»
body			false	SalesOutOrderParams	SalesOutOrderParams
comments	备注		false	string
deliveryCompany	物流公司		false	string
deliveryOrderNumber	物流单号		false	string
deliveryTime	发货日期		false	integer
number	发货编号		true	string
records	订单明细		true	array	SalesOutOrderDetail
comment	行备注		false	string
id			false	integer
itemCode	产品编码		true	string
orderCode	订单编码		true	string
quantity	出库数量		false	number
warehouseBinCode	仓库库位编码		false	string
warehouseCode	仓库编码		false	string
salesOutOrderId	发货单Id		false	integer

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建或修改发货记录

接口地址:/api/open/v2/salesOutOrder/createOrUpdate

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "comments": "",
    "deliveryCompany": "",
    "deliveryOrderNumber": "",
    "deliveryTime": 0,
    "number": "",
    "records": [
      {
        "comment": "",
        "id": 0,
        "itemCode": "",
        "orderCode": "",
        "quantity": 0,
        "warehouseBinCode": "",
        "warehouseCode": ""
      }
    ],
    "salesOutOrderId": 0
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutCreateParamRequestParameter	salesOutCreateParamRequestParameter	body	true	RequestParameter«SalesOutOrderParams»	RequestParameter«SalesOutOrderParams»
body			false	SalesOutOrderParams	SalesOutOrderParams
comments	备注		false	string
deliveryCompany	物流公司		false	string
deliveryOrderNumber	物流单号		false	string
deliveryTime	发货日期		false	integer
number	发货编号		true	string
records	订单明细		true	array	SalesOutOrderDetail
comment	行备注		false	string
id			false	integer
itemCode	产品编码		true	string
orderCode	订单编码		true	string
quantity	出库数量		false	number
warehouseBinCode	仓库库位编码		false	string
warehouseCode	仓库编码		false	string
salesOutOrderId	发货单Id		false	integer

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除发货

接口地址:/api/open/v2/salesOutOrder/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutDeleteParamRequestParameter	salesOutDeleteParamRequestParameter	body	true	RequestParameter«SaleOutOrderDeleteParam»	RequestParameter«SaleOutOrderDeleteParam»
body			false	SaleOutOrderDeleteParam	SaleOutOrderDeleteParam
code	单号编码		true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 作废发货

接口地址:/api/open/v2/salesOutOrder/prohibit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "reason": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutprohibitParamRequestParameter	salesOutprohibitParamRequestParameter	body	true	RequestParameter«SalesOutOrderProhibitParams»	RequestParameter«SalesOutOrderProhibitParams»
body			false	SalesOutOrderProhibitParams	SalesOutOrderProhibitParams
code	单号编码		true	string
reason	原因		true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询发货列表

接口地址:/api/open/v2/salesOutOrder/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": [],
    "codeLike": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    }
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
salesOutqueryParamRequestParameter	salesOutqueryParamRequestParameter	body	true	RequestParameter«SalesOutOrderQueryParam»	RequestParameter«SalesOutOrderQueryParam»
body			false	SalesOutOrderQueryParam	SalesOutOrderQueryParam
code	按订单编码完全匹配		false	array	string
codeLike	按订单编码模糊匹配		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«DeliveryDetailBatchInfo»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«DeliveryDetailBatchInfo»	ListPagingResponseData«DeliveryDetailBatchInfo»
length		integer(int32)
list		array	DeliveryDetailBatchInfo
batchId	发货单id	integer
comment	备注	string
customerName	客户名称	string
deleteReason	删除原因	string
deliveryCompany		string
deliveryCompanyId		string
deliveryOrderId		string
deliveryTime		string
isMergeBatch	是否是合并发货	integer
itemDtos		array	BaseItemDto
allowProduction		integer
allowPurchase		integer
allowSale		integer
attributes		object
category		string
categoryId		integer
code		string
comments		string
costPrice		number
cost_price		number
defectiveRate		number
hasProcurementInspection		boolean
id		string
imageUrl		string
itemId		string
name		string
overStock		boolean
price		number
rootItemId		string
shelfLife		integer
taxRate		number
tax_rate		number
type		string
unit		string
useStockBatch		integer
logisticsNumber	发货单号	string
outBatchMoney	出库金额	number
outInventoryProcess		array	string
processStatus	发货单状态	integer
recordStatus	记录状态	integer
records	发货单行	array	DeliveryDetailRecordInfo
baseCurrencyTotalTaxPrice	本位币含税总额	number
comment	发货单行备注	string
currency	币种	integer
customerOrderNumber	单号	string
customerRequestDeadLine	客户指定交期	string
deadLine	交期	string
discount	折扣	number
discountPrice	折扣价	number
exchangeRate	汇率	number
excludeTaxPrice	含税单价	number
hasSpecialPrice	是否包含特价	boolean
id	发货单行id	integer
isAudited	是否已审核	integer
isDeleted	是否已删除	integer
itemCode	物料code	string
itemId	物料Id	string
itemName	物料名字	string
lastPrice	最新单价	number
noTaxDiscountPrice	不含税折扣价	number
noTaxSpecialPrice	不含税特价	number
orderId	订单id	integer
orderNumber	订单编号	string
orderProductId	订单产品id	integer
originPrice	特价或折扣价	number
outBatchId		integer
outQuantity	出库数量	number
price	单价	number
processStatus	发货单流程状态	integer
quantity	计划发货数量	number
recordStatus	发货单行状态有效=0；作废=1；删除=2	integer
returnQuantity	退货数量	number
saleUnit	销售单位转换率信息	UnitScale	UnitScale
baseToUnitRatio	基本单位:业务单位	number
baseUnitId	基本单位id	integer
unitId	单位id	integer
unitName	单位名称	string
unitToBaseRatio	业务单位:基本单位	number
specialPrice	特价	number
taxPrice	含税单价	number
taxRate	税率	number
totalDiscountNoTaxPrice	产品折扣时候的去税合计	number
totalDiscountTaxPrice	产品折扣时候的价税合计	number
totalNoTaxPrice	去税合计	number
totalPriceWithTax	价税合计	number
totalSpecialNoTaxPrice	特价时候的去税合计	number
totalSpecialTaxPrice	特价时候的价税合计	number
totalTaxPrice	含税总额	number
updateTime	更新时间	string
warehouseId	仓库id	integer
warehouseName	仓库命	string
updateTime	更新时间	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"batchId": 0,
				"comment": "",
				"customerName": "",
				"deleteReason": "",
				"deliveryCompany": "",
				"deliveryCompanyId": "",
				"deliveryOrderId": "",
				"deliveryTime": "",
				"isMergeBatch": 0,
				"itemDtos": [
					{
						"allowProduction": 0,
						"allowPurchase": 0,
						"allowSale": 0,
						"attributes": {},
						"category": "",
						"categoryId": 0,
						"code": "",
						"comments": "",
						"costPrice": 0,
						"cost_price": 0,
						"defectiveRate": 0,
						"hasProcurementInspection": true,
						"id": "",
						"imageUrl": "",
						"itemId": "",
						"name": "",
						"overStock": true,
						"price": 0,
						"rootItemId": "",
						"shelfLife": 0,
						"taxRate": 0,
						"tax_rate": 0,
						"type": "",
						"unit": "",
						"useStockBatch": 0
					}
				],
				"logisticsNumber": "",
				"outBatchMoney": 0,
				"outInventoryProcess": [],
				"processStatus": 0,
				"recordStatus": 0,
				"records": [
					{
						"baseCurrencyTotalTaxPrice": 0,
						"comment": "",
						"currency": 0,
						"customerOrderNumber": "",
						"customerRequestDeadLine": "",
						"deadLine": "",
						"discount": 0,
						"discountPrice": 0,
						"exchangeRate": 0,
						"excludeTaxPrice": 0,
						"hasSpecialPrice": true,
						"id": 0,
						"isAudited": 0,
						"isDeleted": 0,
						"itemCode": "",
						"itemId": "",
						"itemName": "",
						"lastPrice": 0,
						"noTaxDiscountPrice": 0,
						"noTaxSpecialPrice": 0,
						"orderId": 0,
						"orderNumber": "",
						"orderProductId": 0,
						"originPrice": 0,
						"outBatchId": 0,
						"outQuantity": 0,
						"price": 0,
						"processStatus": 0,
						"quantity": 0,
						"recordStatus": 0,
						"returnQuantity": 0,
						"saleUnit": {
							"baseToUnitRatio": 0,
							"baseUnitId": 0,
							"unitId": 0,
							"unitName": "",
							"unitToBaseRatio": 0
						},
						"specialPrice": 0,
						"taxPrice": 0,
						"taxRate": 0,
						"totalDiscountNoTaxPrice": 0,
						"totalDiscountTaxPrice": 0,
						"totalNoTaxPrice": 0,
						"totalPriceWithTax": 0,
						"totalSpecialNoTaxPrice": 0,
						"totalSpecialTaxPrice": 0,
						"totalTaxPrice": 0,
						"updateTime": "",
						"warehouseId": 0,
						"warehouseName": ""
					}
				],
				"updateTime": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

← 订单 API 退货单 API →