获取产品清单

GetCodeProductList取得授权的产品码列表

接口说明

HTTPS请求方式:POST

url:https://youdali.com/OpenApi/GetCodeProductList

使用调试工具调试该接口
参数说明
参数 类型 长度 必填 参与签名 描述
apiKey string 32 由官方平台提供的apiKey
productType
(选填)
int 4 筛选产品类型
可以不填,不填则查询所有产品类型。 ProductType:1:门票  2:跟团游  4:直通车  16:接驳
productCode string 32 产品码
可以不填,表示查询所有(但要参与参数签名)
label_ids
(选填)
string 50 标签id集合
可以不填,提供产品标签id
keywords
(选填)
string 50 关键字
可以不填,产品标题关键字搜索
date
(选填)
string 10 查询日期,如忽略本参数默认查询当天的价格及库存。
注意:跟团游 销售价及结算价本接口返回均为-1(无效价格)!
1、门票价格日历请通过接口 门票价格日历接口 获取
2、跟团游价格日历请通过接口 跟团游价格日历接口 获取
pageIndex int 4 跳转到第几页,不能大于总页数
pageSize int 4 分页每页显示条数(限制最大为50条)
extendFields
(选填)
string 50 额外需要的字段,使用下面的标识,多个之间用半角英文逗号分隔:
infomation(图文详情)
includes(费用包含)
excludings(不含项目)
rules(使用规则)
cautions(注意事项)
articles(知识库)
images(图片)
full(以上全部数据)
sign string 32

由apiSecret,与参数pageIndex、pageSize生成的待签名字符串,通过MD5签名运算后的值。

签名规则
返回说明

Json格式的Result对象

返回值 描述
Success 本次调用是否成功
ErrorCode 错误代码
Message 失败时为异常信息,成功时为null
Value 以Json格式的List<ApiCodeProductInfo>:
ProductType:
    1:门票
    2:跟团游
    4:直通车
    16:接驳

当产品类型为门票时,DepartName、ArriveName、Schedules均为空值

SalePrice、AgentPrice:
仅门票、直通车、接驳返回有效值。-1为需要其他接口获取跟团游 需通过查询日期库存获取。

1、门票价格日历请通过接口 门票价格日历接口 获取
2、跟团游价格日历请通过接口 跟团游价格日历接口 获取
Tag 如无特别说明,在返回数据带分页的情况下,Tag一般指查询记录的总条数,其它情况为null
            {
                "ErrorCode": 0,
                "Success": true,
                "Message": null,
                "HasException": false,
                "Value": [
                    {
                        "ProductCode":"1007",
                        "ProductName":"崇圣寺三塔门票",
                        "DepartName":null,
                        "ArriveName":null,
                        "Schedule":null,
                        "ProductType":1,
                        "IsNeedIdCard":false, // 是否需要提供身份证号码
                        "IsNeedName":false, // 是否需要提供游客姓名
                        "IsNeedTouristList":true, // 是否需要提供游客清单
                        "HasETicket":false, // 是否包含三方对接票(涉及异步)
                        "SalePrice":121, // 统一销售价,-1为需要其他接口获取
                        "AgentPrice":90, // 分销结算价,-1为需要其他接口获取
                        "Actived":true // 产品上架状态
                        "ChildRule":{ // 携童规则
                            "BringChilds":1, // 每成人可携童数
                            "ChildAge":6 // 携童年龄(含)以下
                        },
                        "RefundSet":2,  // 退款规则(0:无条件退1:未使用随时退2:有条件退)
                        "RefundRule":{ // 退款细则(0:无条件退1:未使用随时退2:有条件退)
                            "LimitDay":false, // 限时可退 true/false
                            "LimitDays":0, // 限时(天): 出行日期,负数为提前,正数为延后
                            "BeforeTimeStr":"23:59", // 限时(时刻)
                            "BeforeTimeTicks":0, // 限时(时刻的ticks表示)
                            "RuleLines":[ // 规则梯次表
                                {
                                    "DateType":2, // 梯次时间类型:1出行日期 2直通车班次
                                    "LimitDays":-1, // 梯次天(出行日期,负数提前,正数延后。!直通车产品无效)
                                    "BeforeTimeStr":"3小时", // 提前时间文本表示
                                    "BeforeTimeTicks":-180, // 提前时间(ticks表示,秒)正数延后,负数提前
                                    "ChargeMode":1, // 手续费模式:0无手续费1百分比2固定金额
                                    "Charge":50, // 手续费设定值(ChargeMode为1百分比表示50%,如果为2则为50元)
                                    "LineDate":"/Date(-62135596800000)/", // 无效(略)
                                    "ChargeAmount":0 // 无效(略)
                                },
                                {
                                    "DateType":2,
                                    "LimitDays":-1,
                                    "BeforeTimeStr":"2小时",
                                    "BeforeTimeTicks":-120,
                                    "ChargeMode":1,
                                    "Charge":70,
                                    "LineDate":"/Date(-62135596800000)/",
                                    "ChargeAmount":0
                                },
                                {
                                    "DateType":2,
                                    "LimitDays":-1,
                                    "BeforeTimeStr":"1小时",
                                    "BeforeTimeTicks":-60,
                                    "ChargeMode":1,
                                    "Charge":90,
                                    "LineDate":"/Date(-62135596800000)/",
                                    "ChargeAmount":0
                                },
                                {
                                    "DateType":2,
                                    "LimitDays":-1,
                                    "BeforeTimeStr":"30分钟",
                                    "BeforeTimeTicks":-30,
                                    "ChargeMode":1,
                                    "Charge":100,
                                    "LineDate":"/Date(-62135596800000)/",
                                    "ChargeAmount":0
                                }
                            ],
                            "ChargeMode":0, // 无效(略)
                            "Charge":0 // 无效(略)
                        },
                        "BackRefundSet":0,  // 返程退款规则(略)
                        "BackRefundRule":null,  // 返程退款细则(略)
                        "Articles":[ // 知识库
                            {
                                "Id":7,
                                "ProductId":934,
                                "ArticleTitle":"大理崇圣寺三塔开闭园时间", // 知识库标题
                                "ArticleType":1, // 知识库类型:1-文本/2-word/3-excel/4-pdf
                                "ArticleFile":"",
                                "ArticleDate":"/Date(1753426279753)/",
                                "UploadUser":1,
                                // 知识库内容(文本类型有效)
                                "ArtileContent":"1、开园时间"09:00-17:30“夏时令适当延长
\n2、景区如遇外事活动临时闭园以公告为准
\n3、如遇特殊事件开闭园时间另有调整时以公告为准" }, { "Id":8, "ProductId":934, "ArticleTitle":"大理崇圣寺三塔景区基础资料", "ArticleType":2, "ArticleFile":"https://xxx.com/upload/ProductArticle/123/xxx.docx", "ArticleDate":"/Date(1753426289103)/", "UploadUser":1, "ArtileContent":"" } ], "CoverPic":"https://xxx.com/upload/images/Product/123.jpg", // 封面(原图) "CoverPicSmall":"https://xxx.com/upload/images/Product/123small.jpg", // 封面(缩略图) "Pics":[ "https://xxx.com/upload/images/Product/123.jpg", // 产品图片 "https://xxx.com/upload/images/Product/123.jpg" // 产品图片 ], "Labels":[ // 产品标签(扩展查询full模式提供) { "Id":42, // 产品标签ID(标签查询时请提供此ID) "Name":"佛教圣地", // 标签文本 "Color":"#32cd32", // 标签颜色 "SortIndex":0 // 排序(正序) }, { "Id":50, "Name":"风景名胜", "Color":"#32cd32", "SortIndex":0 } ] }, ... ], "Tag": 83 }
对象说明

ApiCodeProductInfo对象:

public class ApiCodeProductInfo
{
    /// <summary>
    /// 产品码
    /// </summary>
    public string ProductCode { get; set; }

    /// <summary>
    /// 产品名称
    /// </summary>
    public string ProductName { get; set; }

    /// <summary>
    /// 出发站点
    /// </summary>
    public string DepartName { get; set; }

    /// <summary>
    /// 到达站点
    /// </summary>
    public string ArriveName { get; set; }

    /// <summary>
    /// 班次列表 (直通车班次请从独立接口中获取)
    /// </summary>
    public List<object> Schedules { get; set; }

    /// <summary>
    /// 产品类型
    /// </summary>
    public int ProductType { get; set; }

    /// <summary>
    /// 身份证是否必填
    /// </summary>
    public bool IsNeedIdCard { get; set; }

    /// <summary>
    /// 姓名是否必填
    /// </summary>
    public bool IsNeedName { get; set; }

    /// <summary>
    /// 游客清单是否必填
    /// </summary>
    public bool IsNeedTouristList { get; set; }

    /// <summary>
    /// 是否包含三方对接票(涉及异步)
    /// </summary>
    public bool HasETicket { get; set; }

    /// <summary>
    /// 指导售价 mark:仅门票、直通车、接驳返回有效值,-1为需要其他接口获取
    /// </summary>
    public decimal SalePrice { get; set; }

    /// <summary>
    /// 分销结算价 mark:仅门票、直通车、接驳返回有效值,-1为需要其他接口获取
    /// </summary>
    public decimal AgentPrice { get; set; }

    /// <summary>
    /// 产品上架状态, true为可正常售卖产品,false为产品已下架
    /// </summary>
    public bool Actived { get; set; }

}