ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

UserFinance

用户财务信息

API	Description
GET api/UserFinance/QueryFinanceStatement?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询用户财务流水
GET api/UserFinance/QueryMyUnitPrice?lang={lang}	查询用户主要运费单价

API

Description

GET api/UserFinance/QueryFinanceStatement?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}

查询用户财务流水

GET api/UserFinance/QueryMyUnitPrice?lang={lang}

查询用户主要运费单价

GZPDA

GZ PDA 操作

API	Description
POST api/GZPDA/CargoMeasure	包裹体积重量测量
GET api/GZPDA/Cargo?cargoBarcode={cargoBarcode}	用包裹号或快递单号读取包裹信息
POST api/GZPDA/CargoCombine/CargoCombineRequestList	获取合包申请列表 id_Status: 12：待合包 13：已合包，
POST api/GZPDA/CargoCombine/CargoCombineRequest?id={id}	根据id获取合包申请
POST api/GZPDA/CargoCombine/Combine	合包，将合包申请中的一部分包裹合成一个
POST api/GZPDA/CargoCombine/Finish?id_Request={id_Request}	完成合包，剩余包裹返回原状态
GET api/GZPDA/CargoPacking/BatchListToPack	获取待装柜批次列表
GET api/GZPDA/CargoPacking/BatchInfo?soNo={soNo}&orderBarcode={orderBarcode}&whCode={whCode}&floor={floor}&preparationCategory={preparationCategory}&id_User={id_User}&prepSubCategory={prepSubCategory}	获取整个货柜(批次)备货清单信息
POST api/GZPDA/CargoPacking/Pack?cargoBarcode={cargoBarcode}&id_batch={id_batch}&type={type}&floor={floor}&preparationCategory={preparationCategory}	扫包号或快递单号备货
POST api/GZPDA/CargoPacking/OrderPack?orderBarcode={orderBarcode}&cnt={cnt}&id_batch={id_batch}&floor={floor}&deliveryOption={deliveryOption}&id_User={id_User}	输入订单号备货
GET api/GZPDA/TransportBatch?orderBarcode={orderBarcode}&cargoBarcode={cargoBarcode}	根据运单号或者包裹号或者快递单号，查询运输批次
POST api/GZPDA/PackBag	装袋（相同运单）
POST api/GZPDA/PackMixedBag	装袋（不同运单混装）
POST api/GZPDA/PackPallet?palletBarcode={palletBarcode}&id_TransportBatch={id_TransportBatch}&cargoBarcode={cargoBarcode}	打板(相同运单) IsMix = false
POST api/GZPDA/PackTransferMixedPallet?palletBarcode={palletBarcode}&id_TransportBatch={id_TransportBatch}&cargoBarcode={cargoBarcode}&id_TransferVendor={id_TransferVendor}	打板(转运) IsMix = true
POST api/GZPDA/PackMixedPallet?palletBarcode={palletBarcode}&id_TransportBatch={id_TransportBatch}&cargoBarcode={cargoBarcode}	打板(不同运单混装) IsMix = true
GET api/GZPDA/Bag?bagBarcode={bagBarcode}	Query bag info
GET api/GZPDA/Pallet?PalletBarcode={PalletBarcode}	Query pallet info
GET api/GZPDA/GetOrder?cargoBarcode={cargoBarcode}	根据包裹号或快递单号查运单
POST api/GZPDA/CargoInbound?TrackingNo={TrackingNo}&WHCode={WHCode}	包裹入库
POST api/GZPDA/BatchCargoInbound?cargoFrom={cargoFrom}&cargoTo={cargoTo}&WHCode={WHCode}	扫开始包号和结束包号批量入库
POST api/GZPDA/BatchCargoInboundByTrackingNo?trackingNo={trackingNo}&cnt={cnt}&WHCode={WHCode}	扫快递单号批量入库
GET api/GZPDA/CargoInspection/QueryRequest?id_User={id_User}&CargoBarcode={CargoBarcode}&WHCode={WHCode}	查询待验货的验货申请
POST api/GZPDA/CargoInspection/UploadImage?id_Request={id_Request}&resultNotes={resultNotes}&AgreeToInsure={AgreeToInsure}	上传验货图片
POST api/GZPDA/CargoInspection/UploadImage?cargoBarcode={cargoBarcode}	上传任一包裹图片
GET api/GZPDA/CargoReturn/QueryRequest?id_User={id_User}&CargoBarcode={CargoBarcode}&TrackingNo={TrackingNo}&WHCode={WHCode}	查询待处理的退货申请
POST api/GZPDA/CargoReturn/Return?id_Request={id_Request}&tsptVendor={tsptVendor}&trackingNo={trackingNo}&costCNY={costCNY}&volume={volume}&weight={weight}	退货
POST api/GZPDA/InputCargoUser?trackingNo={trackingNo}&id_User={id_User}	录入客户编号
GET api/GZPDA/Inventory?cargoBarcode={cargoBarcode}&whCode={whCode}	货物盘点
GET api/GZPDA/BatchInventoryCheck?cargoBarcode={cargoBarcode}&whCode={whCode}	大货批量货物盘点，某一扫包号与库位，批量盘点该包号所属用户下该库位的所有包裹。第一步：系统检查。若检查出异常，结束盘点。若系统未检查出异常，返回所有包裹信息待人工确认。
POST api/GZPDA/BatchInventoryCheckManualConfirm	大货批量货物盘点。第二步：若系统未检查出异常，人工确认
GET api/GZPDA/QueryCargoByWHCode?WHCode={WHCode}	根据库位列出包裹
GET api/GZPDA/SpotCheck?cargoBarcode={cargoBarcode}	抽查包裹是否有违禁品

AddressBook

地址薄

API	Description
POST api/AddressBook/Add	添加地址薄
GET api/AddressBook/Query?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}&InfoType={InfoType}	查询地址薄
DELETE api/AddressBook/Delete?SN={SN}	删除地址薄
POST api/AddressBook/Validate?SN={SN}	用Google API验证地址簿的地址
POST api/AddressBook/ValidateAddress?address={address}	用Google API验证地址
POST api/AddressBook/AddressValidTask	创建验证地址任务
GET api/AddressBook/AddressValidTask?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询验证地址任务
POST api/AddressBook/CheckAddressValidTask	查询验证地址任务
GET api/AddressBook/ExportFormattedAddress?id={id}&lang={lang}	下载验证地址文件

ImportShipment

中-澳进口物流基本信息

API	Description
GET api/ImportShipment/GetShipmentTypes?lang={lang}	Get shipment types
GET api/ImportShipment/GetShipmentPorts?PType={PType}	Get shipment Ports by type
GET api/ImportShipment/GetInfoStatus?iType={iType}	Get shipment Ports by type
GET api/ImportShipment/GetCurrency	Get Available Currency
GET api/ImportShipment/GetBranches	Get Available company branches
GET api/ImportShipment/GetCargoHandleType?lang={lang}	Get Available Cargo Handle Type

UserLogin

User Login V2

API	Description
POST api/UserLogin/Login	用户登录
GET api/UserLogin/Logout	Customer Logout
POST api/UserLogin/ForgetPassword?email={email}	Forget password. Send reset key by email.
POST api/UserLogin/ResetPassword	Reset login password
POST api/UserLogin/ChangePassword	Change login password
POST api/UserLogin/EMailSignupVerification	Check Sign Up Info and Send Email Verification
POST api/UserLogin/SMSSignupVerification	Check Sign Up Info and Send SMS Verification
POST api/UserLogin/SendEmailVerification?email={email}	Send verification link to the email address
POST api/UserLogin/SendSMSVerification?phone={phone}	Send SMS verification code to verify phone number
GET api/UserLogin/VerifyEmailCode?code={code}	Verify the code to email address
GET api/UserLogin/VerifySMSCode?phone={phone}&code={code}	Verify the SMS Verification code
GET api/UserLogin/VerifySMSCodeWithUserId?phone={phone}&code={code}	Verify the SMS Verification code
GET api/UserLogin/CheckEmailVerified	Check if email is verified
POST api/UserLogin/SignUp
POST api/UserLogin/PhoneSignUp
GET api/UserLogin/WeChatLogin?code={code}&sharecode={sharecode}&lang={lang}&type={type}	Login/SignUp by Wechat
POST api/UserLogin/SigninByGoogle	Signin by Google
GET api/UserLogin/ProxyGSI	Proxy for GSI
GET api/UserLogin/GetBalance?award={award}
POST api/UserLogin/SetLanguage?lang={lang}
GET api/UserLogin/GetEmailByCode?code={code}	Get email address by verification code
GET api/UserLogin/CheckResetKey?code={code}
POST api/UserLogin/Settings
POST api/UserLogin/SaveFreshchatKey?strKey={strKey}
GET api/UserLogin/GetFreshchatKey
GET api/UserLogin/CheckAccountStatus	CheckAccountStatus

UserImportOrder

User/Website import order control V2

API	Description
POST api/UserImportOrder/CreateCargoNotice	包裹到货预报
GET api/UserImportOrder/QueryCargoNotice?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询包裹到货预报
DELETE api/UserImportOrder/CancelCargoNotice?id_Notice={id_Notice}	取消包裹到货预报
GET api/UserImportOrder/QueryCargoDetail?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}&OrderSN={OrderSN}	查询包裹详情
POST api/UserImportOrder/RequestCargoCombine	包裹合并申请
GET api/UserImportOrder/QueryCargoCombineRequest?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询合并申请
DELETE api/UserImportOrder/CancelCargoCombineRequest?id_Request={id_Request}	取消合并申请
POST api/UserImportOrder/RequestCargoHandle	包裹仓务处理申请
GET api/UserImportOrder/QueryCargoHandleRequest?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}&id_types={id_types}	查询仓务处理申请
DELETE api/UserImportOrder/CancelCargoHandleRequest?id_Request={id_Request}	取消包裹仓务处理申请
POST api/UserImportOrder/RequestCargoInspection	包裹拆包验货申请
GET api/UserImportOrder/QueryCargoInspectionRequest?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询拆包验货申请
DELETE api/UserImportOrder/CancelCargoInspectionRequest?id_Request={id_Request}	取消拆包验货申请
GET api/UserImportOrder/QueryCNProvince	查询中国的省份
POST api/UserImportOrder/CheckParcelReturnPrice	查询包裹退运运费
POST api/UserImportOrder/RequestCargoReturnV2	包裹退运申请V2
GET api/UserImportOrder/QueryCargoReturnRequest?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询包裹退运申请
DELETE api/UserImportOrder/CancelCargoReturnRequest?id_Request={id_Request}	取消包裹退运申请
POST api/UserImportOrder/RequestCargoAbandon	用户申请弃货(或申明不是用户自己的货)
POST api/UserImportOrder/CheckFreightPrice	查询运费
POST api/UserImportOrder/CreateShipmentOrder	创建运单
POST api/UserImportOrder/CreateShipmentOrder3	Create an Order with incoming OrderId and CargoList from 3rd party
POST api/UserImportOrder/ModifyShipmentOrder	修改运单
POST api/UserImportOrder/ConfirmShipmentOrder?OrderSN={OrderSN}&lang={lang}	运单确认装柜发货
GET api/UserImportOrder/QueryShipmentOrder?id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询运单
DELETE api/UserImportOrder/CancelShipmentOrder?id_Order={id_Order}	取消运单
GET api/UserImportOrder/OrderTrack?OrderID={OrderID}&lang={lang}	查询运单物流轨迹
POST api/UserImportOrder/RateShipmentOrder	运单评价评分
GET api/UserImportOrder/ContainerTrack?OrderID={OrderID}	查询货柜物流轨迹
POST api/UserImportOrder/ClaimCargo?CargoSN={CargoSN}&TrackingNo={TrackingNo}	认领包裹
GET api/UserImportOrder/GetRecentContact?name={name}&phone={phone}&InfoType={InfoType}	读取最近联系人
GET api/UserImportOrder/GetPackingList?orderid={orderid}&id_User={id_User}	读取 Packing List
POST api/UserImportOrder/AddPackingList	补交PackingList
POST api/UserImportOrder/SaveCargoPackingList	预填写包裹箱单 PackingList
GET api/UserImportOrder/GetCargoPackingList?CargoSNs={CargoSNs}	读取包裹箱单 PackingList
GET api/UserImportOrder/GetCustomerStastics?id_User={id_User}
GET api/UserImportOrder/GetPickupLocations?id={id}&lang={lang}	获得自提点列表
GET api/UserImportOrder/QueryProductInfoByJANCode?JANCode={JANCode}	No documentation available.
POST api/UserImportOrder/ConfirmInboundOrder	入仓单确认发货

PickupDepot

自提点 Self Pickup Depot

API	Description
GET api/PickupDepot/QueryShipmentOrder?id_Status={id_Status}&id_SubStatus={id_SubStatus}&keyword={keyword}&StartDate={StartDate}&EndDate={EndDate}&lang={lang}

Jieztech

API	Description
POST api/Jieztech/PackageDimension	芥舟数字清关包裹数据推送仓库接口（临时） https://api.stscargo.com.au/api/Jieztech/PackageDimension
POST api/Jieztech/KSSortingRequest	快手一分八称重测量分捡
POST api/Jieztech/KSSortingPhoto?Barcode={Barcode}	快手一分八图片上传

Attachment

Attachment upload and download.

API	Description
GET api/Attachment/GetAttachmentTypeList	Get file attachment type list
POST api/Attachment/FileUpload?id_AttachmentType={id_AttachmentType}&uploadType={uploadType}&id_Order={id_Order}&Notes={Notes}&identificationName={identificationName}&identificationNumber={identificationNumber}	Upload file attachment
GET api/Attachment/GetOrderAttachmentList?id_Order={id_Order}&orderType={orderType}	Get attachment list of shipment order
GET api/Attachment/SearchMyAttachment?QueryAll={QueryAll}&id_User={id_User}&id_ContactRef={id_ContactRef}&id_AttachmentType={id_AttachmentType}	Search my uploaded file attachments.
DELETE api/Attachment/DeleteFileAttachment?GUID={GUID}
DELETE api/Attachment/DeleteFileAttachmentById?id={id}

ServiceTicket

站内信，客服、投诉、理赔管理

API	Description
POST api/ServiceTicket/Create	创建服务工单
POST api/ServiceTicket/Append	补充追加信息
GET api/ServiceTicket/Query?ClearRead={ClearRead}&IncludeComunication={IncludeComunication}&id={id}&id_User={id_User}&UniqueID={UniqueID}&id_Order={id_Order}&id_Branch={id_Branch}&id_OrderType={id_OrderType}&id_InfoType={id_InfoType}&id_Staff={id_Staff}&StartDate={StartDate}&EndDate={EndDate}&DateType={DateType}&id_Status={id_Status}&StatusType={StatusType}&id_Status_exclude={id_Status_exclude}&id_SubStatus={id_SubStatus}&id_PickupLocation={id_PickupLocation}&keyword={keyword}&pageNum={pageNum}&pageSize={pageSize}&sortBy={sortBy}&order={order}&lang={lang}	查询服务工单
DELETE api/ServiceTicket/Cancel?id_Ticket={id_Ticket}	取消服务工单
PUT api/ServiceTicket/CloseAndRating?id_Ticket={id_Ticket}&RatingVal={RatingVal}	工单服务质量评分
POST api/ServiceTicket/FileUpload?id_Ticket={id_Ticket}&Notes={Notes}	上传文件附件
GET api/ServiceTicket/QueryInternalMessage	查询站内信
PUT api/ServiceTicket/InternalMsgMarkRead?id_Msg={id_Msg}&IsRead={IsRead}	站内信标记是否已读

GZStreamline

GZ 流水线操作

API	Description
GET GZStreamline/CargoMeasure/Beidai	beidai流水线测体积重量
POST GZStreamline/CargoMeasure/Beidai	beidai流水线测体积重量
GET GZStreamline/CargoMeasure/Wogang	wogang流水线测体积重量
POST GZStreamline/CargoMeasure/Wogang	wogang流水线测体积重量
POST GZStreamline/CargoMeasure/Hongshun	鸿顺捷流水线测体积重量
POST GZStreamline/CargoMeasure/Mojia	墨家流水线测体积重量