跳到主要内容

cs.real-space-allocations.client.list

分页查询按客户SO分类的现舱分配记录列表

  • 请求路由: cs.real-space-allocations.client.list
  • 交互模型: Request Stream
  • 访问限制: 无

请求​

RSocket.rs({
"route" : "cs.real-space-allocations.client.list",
"args" : {
"search" : "搜索参数",
"pg" : "分页参数"
}
});

请求参数​

名称类型必须说明
searchObject否搜索参数
search.containerTypeString否柜型代码。
search.etdFromString否预计开船时间下限。
search.etdToString否预计开船时间上限。
search.customsReleaseCutoffFromString否海关放行截止时间下限。
search.customsReleaseCutoffToString否海关放行截止时间上限。
search.weekString否业务周次。
search.polIdString否起运港 ID。
search.podIdString否目的港 ID。
search.carrierIdString否船公司 ID。
search.vesselString否船名。
search.voyageNoString否航次号。
search.statusString[]否状态列表。普通库存查询按 SO 原始状态过滤;分配列表按拆分后的实时状态过滤。
  • ACTIVE - 可正常使用。
  • CHANGING_VESSEL - 改船中,库存锁定。
  • PENDING - 待分配
  • ALLOCATED - 已分配
  • RESERVED - 已预占
  • INVALID - 已失效
  • search.selectJobIdsString[]否需要作为自身分配排除的工作单 ID 列表。
    search.inventoryIdsString[]否指定库存 ID 列表。
    search.itemTypeString否目标分配来源类型。
  • FORECAST_INVENTORY - 来源于预报单的库存
  • INVENTORY - 库存
  • PEER - 同行舱位(仅保存于业务单据,不进入系统库存)
  • search.forecastIdsString[]否允许使用的预报单 ID 列表。
    search.excludeForecastIdsString[]否需要排除的预报单 ID 列表。
    search.tagsString[]否必须匹配的标签列表。
    search.excludeTagsString[]否需要排除的标签列表。
    search.hasTagsBoolean否是否仅查询包含标签的库存。
    search.sourceIdString否库存来源id可以为订舱请求id
    search.bookingNoString否订舱参考号,同一租户内唯一。
    search.contractNoString否订舱合约号。
    search.legalEntityIdsString[]否法人主体id
    search.customerIdString否客户id
    search.keywordString否模糊匹配关键字
    search.fromString否查询起始时间,时间样式为RFC3339格式,如:2019-04-18T00:13:39.649Z
    search.toString否查询终止时间,时间样式为RFC3339格式,如:2019-04-19T00:13:39.649Z
    pgObject否分页参数
    pg.pageNumber否页码,首页从0开始
    pg.sizeNumber否每页记录,默认为10
    pg.sortString[]否排序字段清单,默认为升序,需要指定降序时在字段名后面添加desc并用分号隔开。
    例如:["id", "crDate;desc"]

    返回​

    分配记录列表

    [ ]

    返回属性​

    名称类型说明
    bookingOrderIdString订舱单 ID
    realInventoryIdString现舱库存 ID
    clientIdString客户信息(往来单位id)
    clientObject客户信息(往来单位)
    client.countryString国家
    client.countryEnString国家(英文)
    client.abbreviationString名称缩写
    client.addressString地址(中文)
    client.addressEnString地址(英文)
    client.contactPersonsObject[]联系人信息列表,支持多个联系人
    client.contactPersons.[].usernameString用户标识
    client.contactPersons.[].nameString用户名称
    client.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    client.contactPersons.[].mobileString用户手机号
    client.contactPersons.[].emailString用户邮箱
    client.contactPersons.[].positionString职位
    client.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • client.bankAccountsObject[]银行账户列表,支持多个账户
    client.bankAccounts.[].accountNameString开户名称
    client.bankAccounts.[].bankNameString银行名称
    client.bankAccounts.[].bankCodeString联行号
    client.bankAccounts.[].bankAccountString银行账号
    client.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • client.bankAccounts.[].swiftCodeStringSWIFT CODE
    client.bankAccounts.[].addressString地址
    client.bankAccounts.[].isDefaultBoolean是否默认
    client.invoiceInfoObject开票信息
    client.invoiceInfo.companyNameString公司名称
    client.invoiceInfo.taxIdentificationNumberString纳税识别号
    client.invoiceInfo.companyAddressString公司地址
    client.invoiceInfo.phoneString电话
    client.invoiceInfo.bankAccountString银行账号
    client.invoiceInfo.contactString联系人
    client.invoiceInfo.emailString邮箱
    client.extraPropsObject扩展信息
    client.relatedCustomersObject[]关联客户列表
    client.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    client.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    client.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    client.relatedCustomers.[].nameString名称(中文)
    client.relatedCustomers.[].nameEnString名称(英文)
    client.unitIdString往来单位唯一ID,主键
    client.nameString名称(中文)
    client.nameEnString名称(英文)
    soNoStringSO单号
    weekString业务周次
    carrierString船公司(往来单位id)
    carrierInfoObject船公司信息
    carrierInfo.countryString国家
    carrierInfo.countryEnString国家(英文)
    carrierInfo.abbreviationString名称缩写
    carrierInfo.addressString地址(中文)
    carrierInfo.addressEnString地址(英文)
    carrierInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    carrierInfo.contactPersons.[].usernameString用户标识
    carrierInfo.contactPersons.[].nameString用户名称
    carrierInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    carrierInfo.contactPersons.[].mobileString用户手机号
    carrierInfo.contactPersons.[].emailString用户邮箱
    carrierInfo.contactPersons.[].positionString职位
    carrierInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • carrierInfo.bankAccountsObject[]银行账户列表,支持多个账户
    carrierInfo.bankAccounts.[].accountNameString开户名称
    carrierInfo.bankAccounts.[].bankNameString银行名称
    carrierInfo.bankAccounts.[].bankCodeString联行号
    carrierInfo.bankAccounts.[].bankAccountString银行账号
    carrierInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • carrierInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    carrierInfo.bankAccounts.[].addressString地址
    carrierInfo.bankAccounts.[].isDefaultBoolean是否默认
    carrierInfo.invoiceInfoObject开票信息
    carrierInfo.invoiceInfo.companyNameString公司名称
    carrierInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    carrierInfo.invoiceInfo.companyAddressString公司地址
    carrierInfo.invoiceInfo.phoneString电话
    carrierInfo.invoiceInfo.bankAccountString银行账号
    carrierInfo.invoiceInfo.contactString联系人
    carrierInfo.invoiceInfo.emailString邮箱
    carrierInfo.extraPropsObject扩展信息
    carrierInfo.relatedCustomersObject[]关联客户列表
    carrierInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    carrierInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    carrierInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    carrierInfo.relatedCustomers.[].nameString名称(中文)
    carrierInfo.relatedCustomers.[].nameEnString名称(英文)
    carrierInfo.unitIdString往来单位唯一ID,主键
    carrierInfo.nameString名称(中文)
    carrierInfo.nameEnString名称(英文)
    polString起运港(往来单位id)
    polInfoObject起运港信息
    polInfo.countryString国家
    polInfo.countryEnString国家(英文)
    polInfo.abbreviationString名称缩写
    polInfo.addressString地址(中文)
    polInfo.addressEnString地址(英文)
    polInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    polInfo.contactPersons.[].usernameString用户标识
    polInfo.contactPersons.[].nameString用户名称
    polInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    polInfo.contactPersons.[].mobileString用户手机号
    polInfo.contactPersons.[].emailString用户邮箱
    polInfo.contactPersons.[].positionString职位
    polInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • polInfo.bankAccountsObject[]银行账户列表,支持多个账户
    polInfo.bankAccounts.[].accountNameString开户名称
    polInfo.bankAccounts.[].bankNameString银行名称
    polInfo.bankAccounts.[].bankCodeString联行号
    polInfo.bankAccounts.[].bankAccountString银行账号
    polInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • polInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    polInfo.bankAccounts.[].addressString地址
    polInfo.bankAccounts.[].isDefaultBoolean是否默认
    polInfo.invoiceInfoObject开票信息
    polInfo.invoiceInfo.companyNameString公司名称
    polInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    polInfo.invoiceInfo.companyAddressString公司地址
    polInfo.invoiceInfo.phoneString电话
    polInfo.invoiceInfo.bankAccountString银行账号
    polInfo.invoiceInfo.contactString联系人
    polInfo.invoiceInfo.emailString邮箱
    polInfo.extraPropsObject扩展信息
    polInfo.relatedCustomersObject[]关联客户列表
    polInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    polInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    polInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    polInfo.relatedCustomers.[].nameString名称(中文)
    polInfo.relatedCustomers.[].nameEnString名称(英文)
    polInfo.unitIdString往来单位唯一ID,主键
    polInfo.nameString名称(中文)
    polInfo.nameEnString名称(英文)
    podString目的港(往来单位id)
    podInfoObject目的港信息
    podInfo.countryString国家
    podInfo.countryEnString国家(英文)
    podInfo.abbreviationString名称缩写
    podInfo.addressString地址(中文)
    podInfo.addressEnString地址(英文)
    podInfo.contactPersonsObject[]联系人信息列表,支持多个联系人
    podInfo.contactPersons.[].usernameString用户标识
    podInfo.contactPersons.[].nameString用户名称
    podInfo.contactPersons.[].nameEnString英文称呼,用于外部联系人的英文通知;缺失时不自动翻译姓名。
    podInfo.contactPersons.[].mobileString用户手机号
    podInfo.contactPersons.[].emailString用户邮箱
    podInfo.contactPersons.[].positionString职位
    podInfo.contactPersons.[].contactRolesString[]联系人承担的职责,支持多选;未指定时为空集合
  • PRIMARY - 主联系人,承担往来单位的主要业务对接职责。
  • EMAIL_NOTIFICATION - 邮件通知人,作为业务邮件通知的联系对象。
  • BILLING - 账单联系人,承担账单接收和账务沟通职责。
  • podInfo.bankAccountsObject[]银行账户列表,支持多个账户
    podInfo.bankAccounts.[].accountNameString开户名称
    podInfo.bankAccounts.[].bankNameString银行名称
    podInfo.bankAccounts.[].bankCodeString联行号
    podInfo.bankAccounts.[].bankAccountString银行账号
    podInfo.bankAccounts.[].currencyString币制
  • CNY - 人民币
  • USD - 美元
  • EUR - 欧元
  • HKD - 港币
  • JPY - 日元
  • GBP - 英镑
  • AUD - 澳大利亚元
  • CAD - 加拿大元
  • SGD - 新加坡元
  • KRW - 韩元
  • DKK - 丹麦克朗
  • NOK - 挪威克朗
  • SEK - 瑞典克朗
  • name - 获取币种名称
  • symbol - 获取币种符号
  • code - 返回币种代码
  • podInfo.bankAccounts.[].swiftCodeStringSWIFT CODE
    podInfo.bankAccounts.[].addressString地址
    podInfo.bankAccounts.[].isDefaultBoolean是否默认
    podInfo.invoiceInfoObject开票信息
    podInfo.invoiceInfo.companyNameString公司名称
    podInfo.invoiceInfo.taxIdentificationNumberString纳税识别号
    podInfo.invoiceInfo.companyAddressString公司地址
    podInfo.invoiceInfo.phoneString电话
    podInfo.invoiceInfo.bankAccountString银行账号
    podInfo.invoiceInfo.contactString联系人
    podInfo.invoiceInfo.emailString邮箱
    podInfo.extraPropsObject扩展信息
    podInfo.relatedCustomersObject[]关联客户列表
    podInfo.relatedCustomers.[].tagsString[]该客户赋予当前往来单位的角色标签列表(如 shipper, consignee, importBuyer 等)
    podInfo.relatedCustomers.[].extraPropsObject专属定制扩展属性 (Key 为 tag 比如 "shipper", Value 为特定定制的 Unit 实例)
    podInfo.relatedCustomers.[].unitIdString往来单位唯一ID,主键
    podInfo.relatedCustomers.[].nameString名称(中文)
    podInfo.relatedCustomers.[].nameEnString名称(英文)
    podInfo.unitIdString往来单位唯一ID,主键
    podInfo.nameString名称(中文)
    podInfo.nameEnString名称(英文)
    routeInfoIdString航线信息(基础数据id)
    routeInfoObject航线信息(基础数据)
    routeInfo.itemIdString数据项唯一标识
    routeInfo.nameString数据项名称(中文)
    routeInfo.nameEnString数据项名称(英文)
    routeInfo.extendedPropertiesObject扩展属性
    用于存储一些额外的、非结构化的数据
    etdString预计开船时间
    itemsObject[]分配明细
    items.[].typeString箱型类型
    items.[].nameString箱型名称
    items.[].nameEnString箱型英文名称
    items.[].sourceInfosObject[]来源信息
    items.[].sourceInfos.[].sourceTypeString来源类型:CONTRACT / PROCUREMENT / MARKET
    items.[].sourceInfos.[].sourceIdString来源 ID(合约号/采购单号)
    items.[].countNumber分配数量
    items.[].pickedCountNumber已提柜数量
    crDateString创建时间

    下载结果模型定义