1. Puarchase order

API URL

post {HTTP(S)host} /api/{version}/purchase

1.1. Query Puarchase order list

1.1.1. SERVICE_TYPE

QUERY_PURCHASE_ORDER_LIST

1.1.2. Request

Params	Require	DataType	Sample
purchaseNumber	N	String	P210819125115	Purchase number with a maximum of 50 characters
customNumber	N	String	210819125115	reference number
status	N	String	NEW	Purchase order status
updateTimeFrom	N	String	2021-08-31	Update time （ Begin of range ）
updateTimeTo	N	String	2021-08-31	Update time （ End of range ）
page	Y	Number	1	Page number, default 1
pageSize	Y	Number	100	Number of records per page. no more than 200;

1.1.3. Reponse

Params	Require	DataType	Sample
errorCode	Y	String	“DATA_INPUT_ERROR”	Error Code](commons/errors.md#_Error Code)
errorMsg	Y	String	“The input of Params is incorrect”	Business Error Messages
state	Y	String	success	Response State
total	Y	Number	100	Total num
result	Y	List		See PurchaseOrder

PurchaseOrder（Purchase Order ）

Params	Require	DataType	Sample
purchaseNumber	Y	String	P210819125115	Purchase number
asnNumber	Y	String	A210819125116	Inbound order number
customNumber	Y	String	custom Reference number	Reference number
warehouseName	Y	String	Purchase warehouse	Purchase warehouse
transferWarehouseName	Y	String	transfer warehouse	transfer warehouse
purchaseType	Y	String	TRANSFER	TRANSFER：海外warehousePurchase DIRECT：国内warehousePurchase
supplierName	Y	String	supplier	supplier
settlementType	Y	String	DELIVERY_ON_CASH	Billing method: DELIVERY_ON_CASH, FIXED_ACCOUNT_PERIOD,DYNAMIC_ACCOUNT_PERIOD,
prepayRate	Y	Decimal	30	Prepaid Percentage 30 means 30%
purchasePriceUnit	Y	String	CNY	Currency
paymentType	Y	Enum	CASH	PAYMENT METHODS: CASH,TRANSFER
shippingCost	Y	Decimal	1.0	carriage
transportMode	Y	Enum	SELF	Shipping method: SELF, EXPRESS, LOGISTICS, DELIVERY
buyerTitle	Y	String	张三	Buyer's letterhead
companyName	Y	String	Zhang San Co., Ltd	The company looks up
transportParty	Y	String	SUPPLIER	Transporting Contractor: SUPPLIER, PURCHASER
createTime	Y	String	2021-08-01 00:00:00	Creation time
updateTime	Y	String	2021-08-01 00:00:00	Update time
orderTime	N	String	2021-08-01 00:00:00	Time when the order was placed
preReceiveTime	Y	String	2021-08-02 00:00:00	Estimated arrival date
status	Y	String	NEW	Purchase order status
purchaseMode	Y	String	STANDARD	Purchase model: EASYWAY,STANDARD
remark	Y	String	Description	Description
skuList	Y	List		See PurchaseOrderSku

PurchaseOrderSku Purchase Order details

Params	Require	Date type	Sample	Description
sku	Y	String	SKU001	sku
title	Y	String	This a good title	The title of the product
purchasePrice	Y	Decimal	998	Purchase price
purchaseQuantity	Y	Number	1	Purchase quantity
packSpecification	Y	Number	5	Packing rate
taxRate	Y	Decimal	0.1	Purchase taxRate

1.2. Create/update Purchase order

1.2.1. SERVICE_TYPE

CREATE_PURCHASE_ORDER

1.2.2. Request

Params	Require	DataType	Sample	Description
purchaseNumber	N	String	PO223412451	Purchase order number, if it is an updated purchase order request(isUpdate=true), it is required, otherwise do not fill it in
isUpdate	N	Boolean	false	Update the purchase order. Default false
purchaseType	Y	String	DIRECT/TRANSFER	Purchase order type
customNumber	N	String	Xxxx111	Reference number
warehouseName	Y	String	abc	Purchase Warehouse name
transferWarehouseName	N	String	transferWarehouse name(Required when purchaseType=TRANSFER)	transferWarehouse name
purchaserName	Y	String	purchaser	purchaser
purchaseDate	Y	String	2022-01-01	Creation time
preReceiveTime	N	String	2022-01-01	Estimated time of arrival
purchasePriceUnit	Y	String	CNY	Monetary unit
shippingCost	N	BigDecimal	100.00	Carriage
companyName	N	String	Xxx111	The company looks up
buyerTitle	N	String	Xxx111	Buyer's letterhead
transportParty	Y	String	SUPPLIER	Transport principal
transportMode	Y	String	SELF	Shipping method
trackingNumber	N	String	Xxx111	Tracking number
remark	N	String	Xxx111	Description
supplierName	Y	String	supplier 名称	supplier name
paymentType	Y	String	CASH	Payment method
settlementType	Y	String	DELIVERY_ON_CASH	Billing method
prepayRate	N	BigDecimal	15	Prepaid percentage
effectiveNode	N	String	RECEIVE	When the selected settlement method is a non-delivery withdrawal method is DELIVERY_ON_CASH ，*Params is require，Node effect type
accountPeriodList	N	String	[{"days":"1","percent":50},{"days":"2","percent":35}]	When the selected settlement method is dynamic billing period is DYNAMIC_ACCOUNT_PERIOD Params is require。Percent+The upfront percentage needs to be 100
accountPeriodOpt	N	String	MONTHLY	When the selected billing method is a fixed billing period : FIXED_ACCOUNT_PERIOD ，*Params is require。
billingDate	N	Long	20	When the selected billing method is a fixed billing period : FIXED_ACCOUNT_PERIOD , *Params is require。
skuList	Y	List< PurchaseOrderSku>		Purchase details
purchaseExtVO	N	purchaseExtVO		1688 Extended Fields，see purchaseExtVO

PurchaseOrderSku(Purchase details)

Params	Require	DataType	Sample	Description
sku	Y	String	S90	sku
purchasePrice	Y	BigDecimal	100.00	Purchase price of the product
purchasePriceUnit	Y	String	CNY	Purchase Monetary unit
purchaseQuantity	Y	Long	100	Purchase quantity
remark	N	String	This is remark!	Purchase Description
taxRate	Y	BigDecimal	0	Purchase taxRate

purchaseExtVO(1688 ext info)

Params	Require	DataType	Sample	Description
open1688AccountName	Y	String	1688 order number	1688 order number
open1688Address	Y	String	1688 Receiving address	1688 Receiving address
open1688BuyerMsg	N	String	Buyer's message	Buyer's message
open1688OrderType	Y	String	general	1688 order type，1688 order type
open1688TradeType	N	String	FXASSURE	Trading Methods，1688 trade types

1.2.3. Response

Params	Require	DataType	Sample
errorCode	Y	String	“DATA_INPUT_ERROR”	Error Code](commons/errors.md#_Error Code)
errorMsg	Y	String	“The input of Params is incorrect”	Business Error Messages
state	Y	String	success	Response State
total	Y	Number	100	Total num
result	Y	List		See PurchaseOrder