CCITU.ThirdPlatform.OpenApi 1.0.0

一、TikTok组件配置-基础配置

依赖包

Install-Package DocumentFormat.OpenXml 3.0.1
Install-Package Microsoft.Web.Infrastructure 1.0.0
Install-Package Newtonsoft.Json 13.0.3

配置：放入Web.config文件里

    
    
    
    
    
    
    <add key="TikTokShop.BaseUrl" value="https://open-api-sandbox.tiktokglobalshop.com" />
    
    <add key="TikTokShop.AuthUrl" value="https://auth-sandbox.tiktok-shops.com" />
    
    <add key="TikTokShop.Version" value="202309" />
    
    <add key="TikTokShop.TokenXml" value="D:\TikTok\CCITU.ThirdPlatform.OpenApi\TikTokShop\Xml\Token.xml" />
    
    <add key="TikTokShop.app_key" value="6baehm2472c0o" />
    
    <add key="TikTokShop.app_secret" value="7144562719dc823f79819668c067472c538c3a1a" />

使用说明：

1. TikTokShop.BaseUrl：获取基础Api接口地址
2. TikTokShop.AuthUrl：获取授权需要添加的接口地址
3. TikTokShop.Version：配置版本号
4. TikTokShop.TokenXml：获取/读取Token授权后保存/读取的位置
5. TikTokShop.app_key：TikTok 合作伙伴中心应用页面中的应用密钥
6. TikTokShop.app_secret：合作伙伴中心应用页中的应用机密

二、TikTok组件配置-获取店铺令牌（Token）

使用场景：

用于获取授权，接口授权。

方法：

/// <summary>
/// 获取店铺Token
/// </summary>
public class TokenApi
{

    /// <summary>
    /// 获取访问令牌Token
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<TikTokAccessTokenResponse> GetToken(TikTokAccessTokenQuery request);

    /// <summary>
    /// 刷新访问令牌Token
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<TikTokAccessTokenRefreshResponse> GetRefreshToken(TikTokAccessTokenRefreshQuery request);

}

接口请求对象：

/// <summary>
/// TikTok的访问令牌请求响应对象
/// </summary>
public class TikTokAccessTokenQuery
{
    /// <summary>
    /// 用户在商铺获得的身份验证代码
    /// </summary>
    public string auth_code { get; set; }
}

官网参考地址：

访问令牌：https://partner.tiktokshop.com/docv2/page/64f199619495ef0281851e1c

三、TikTok组件配置-刷新访问令牌（Token）

使用场景：

用于获取授权，接口授权。

方法：

/// <summary>
/// 获取店铺Token
/// </summary>
public class TokenApi
{

    /// <summary>
    /// 获取访问令牌Token
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<TikTokAccessTokenResponse> GetToken(TikTokAccessTokenQuery request);

    /// <summary>
    /// 刷新访问令牌Token
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<TikTokAccessTokenRefreshResponse> GetRefreshToken(TikTokAccessTokenRefreshQuery request);

}

接口请求对象：

/// <summary>
/// 刷新TikTok的访问令牌请求响应对象
/// </summary>
public class TikTokAccessTokenRefreshQuery
{

    /// <summary>
    /// 刷新token
    /// </summary>
    public string refresh_token { get; set; }
}

官网参考地址：

刷新访问令牌Token：https://partner.tiktokshop.com/docv2/page/64f199619495ef0281851e1c

四、TikTok组件配置-获取授权商铺

使用场景：

用于获取授权店铺信息

方法：

/// <summary>
/// 查询商铺
/// </summary>
public class AuthorizationApi
{

    /// <summary>
    /// 查询商铺授权
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<shop> GetAuthorization();

}

接口请求对象：

官网参考地址：

获取授权商铺：https://partner.tiktokshop.com/docv2/page/6507ead7b99d5302be949ba9?external_id=6507ead7b99d5302be949ba9

五、TikTok组件配置-获取产品列表

使用场景：

用于获取产品列表。

方法：

/// <summary>
/// 获取产品列表
/// </summary>
public class ProductsApi
{

    /// <summary>
    /// 获取产品列表
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<List<WMSProductsDto>> GetSearchProducts(SearchProductsQuery request);

    /// <summary>
    /// 根据产品id获取产品详情
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<GetProductResponse> GetProducts(GetProductQuery request);

}

接口请求对象：

/// <summary>
/// 获取产品列表请求数据 
/// </summary>
public class SearchProductsQuery
{
    /// <summary>
    /// 店铺授权
    /// </summary>
    public string shop_cipher { get; set; }

    /// <summary>
    /// 列表分页
    /// “page_size”代表返回列表分页，即每页产品的品牌数量。每个页面最多可以检索 100 条产品记录。
    /// </summary>
    public int page_size { get; set; }


    /// <summary>
    /// 分页标记
    /// 分页标记是用于分页的游标。第一页不需要它。令牌在上一个分页查询中返回，以确定当前位置。
    /// </summary>
    public string page_token { get; set; }

    /// <summary>
    /// 产品状态，用作产品搜索的过滤标准。包括
    /// 全部、草稿、待定、失败、激活、SELLER_DEACTIVATED、PLATFORM_DEACTIVATED、冻结、已删除
    /// </summary>
    public string status { get; set; }

    /// <summary>
    /// 卖家 SKU，用于商品搜索的筛选条件。通过此字段，您可以搜索包含这些卖家 SKU 的所有商品。
    /// </summary>
    public List<string> seller_skus { get; set; }

    /// <summary>
    /// 字段“create_time_ge”和“create_time_le”共同构成了产品创建时间的筛选条件。如果您只填写“create_time_le”，而“create_time_ge”为空，
    /// 那么我们会默认将店铺最早时间设置为“create_time_ge”字段。如果只填写“create_time_ge”，而“create_time_le”为空，那么我们将默认将当前时间设置为“create_time_le”字段。
    /// 时间搜索条件使用 GMT （UTC+00：00） 中的 Unix 时间戳。
    /// </summary>
    public int create_time_ge { get; set; }

    /// <summary>
    /// 请参阅“create_time_ge”的说明
    /// </summary>
    public int create_time_le { get; set; }

    /// <summary>
    /// 字段“update_time_ge”和“update_time_le”共同构成产品更新时间的过滤条件。如果您只填写“update_time_le”，
    /// 而“update_time_ge”为空，那么我们会默认将商店的最早时间设置为“update_time_ge”字段。
    /// 如果只填写“update_time_ge”，而“update_time_le”为空，那么我们将默认将当前时间设置为“update_time_le”字段。
    /// </summary>
    public int update_time_ge { get; set; }

    /// <summary>
    /// 请参阅“update_time_ge”的说明。
    /// </summary>
    public int update_time_le { get; set; }

}

接口返回对象：

/// <summary>
/// WMS仓储产品模型对象
/// </summary>
public class WMSProductsDto
{
    /// <summary>
    /// 商品ID
    /// </summary>
    public string ProductId { get; set; }

    /// <summary>
    /// 所属平台
    /// TikTok Shop = 10
    /// </summary>
    public string OwnerPlatform { get; set; }

    /// <summary>
    /// 所属店铺ID
    /// </summary>
    public string OwnerShopId { get; set; }

    /// <summary>
    /// 	商品SKU
    /// </summary>
    public string ProductSku { get; set; }

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

    /// <summary>
    /// 销售单价币种
    /// </summary>
    public string currency { get; set; }

    /// <summary>
    /// 销售单价
    /// </summary>
    public decimal SalesPrice { get; set; }

    /// <summary>
    /// 税前单价
    /// </summary>
    public decimal TaxExclusivePrice { get; set; }

    /// <summary>
    /// 状态
    /// </summary>
    public string Status { get; set; }

    /// <summary>
    /// 销售区域
    /// </summary>
    public List<string> SalesRegions { get; set; }

    /// <summary>
    /// 长
    /// </summary>
    public decimal Length { get; set; }

    /// <summary>
    /// 宽
    /// </summary>
    public decimal Width { get; set; }

    /// <summary>
    /// 高
    /// </summary>
    public decimal Height { get; set; }

    /// <summary>
    /// 尺寸单位
    /// </summary>
    public string MeasureUnit { get; set; }

    /// <summary>
    /// 毛重
    /// </summary>
    public decimal GrossWeight { get; set; }

    /// <summary>
    /// 重量单位
    /// </summary>
    public string WeightUnit { get; set; }



}

官网参考地址：

产品列表：https://partner.tiktokshop.com/docv2/page/65854ffb8f559302d8a6acda?external_id=65854ffb8f559302d8a6acda#Back%20To%20Top

六、TikTok组件配置-获取产品详情

使用场景：

用于获取产品详情。

方法：

/// <summary>
/// 获取产品列表
/// </summary>
public class ProductsApi
{

    /// <summary>
    /// 获取产品列表
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<List<WMSProductsDto>> GetSearchProducts(SearchProductsQuery request);

    /// <summary>
    /// 根据产品id获取产品详情
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<GetProductResponse> GetProducts(GetProductQuery request);

}

接口请求对象：

/// <summary>
/// 获取产品详情请求数据 
/// </summary>
public class GetProductQuery
{
    /// <summary>
    /// 店铺授权
    /// </summary>
    public string shop_cipher { get; set; }

    /// <summary>
    /// 产品id
    /// </summary>
    public string product_id { get; set; }

    /// <summary>
    /// “return_under_review_version”参数可用于获取正在审核产品的快照信息。
    /// - 如果 “return_under_review_version” 参数设置为 false，则会检索已经通过且处于 “已激活” 状态的产品的快照信息。
    /// - 如果 “return_under_review_version” 参数设置为 true，它将检索已获批但仍在审核中的产品的快照信息。
    /// - 如果 “return_under_review_version” 参数没有提供任何值，则默认为 false。
    /// </summary>
    public bool return_under_review_version { get; set; }
}

官网参考地址：

产品详情：https://partner.tiktokshop.com/docv2/page/6509d85b4a0bb702c057fdda?external_id=6509d85b4a0bb702c057fdda

七、TikTok组件配置-获取订单列表

使用场景：

用于获取订单列表。

方法：

/// <summary>
/// 获取订单列表
/// </summary>
public class OrdersApi
{

    /// <summary>
    /// 获取订单列表
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<List<WMSOrderDto>> GetOrderList(GetOrderListQuery request);
}

接口请求对象：

/// <summary>
/// 获取订单请求数据(请求查询参数)
/// </summary>
public class GetOrderListQuery
{

    /// <summary>
    /// 店铺授权
    /// </summary>
    public string shop_cipher { get; set; }

    /// <summary>
    /// 使用此字段可以指定在单个页面中获取的最大订单数。必须是 1-100。
    /// </summary>
    public int page_size { get; set; }

    /// <summary>
    /// 可用值：ASC;DESC（默认）
    /// </summary>
    public string sort_order { get; set; }

    /// <summary>
    /// 此字段值将在响应数据中返回，您可以使用它来搜索下一页上的数据。您不需要在第一次搜索时使用它。
    /// </summary>
    public string page_token { get; set; }

    /// <summary>
    /// create_time，update_time
    /// </summary>
    public string sort_field { get; set; }


    /***请求正文参数**/

    /// <summary>
    /// 使用此字段可获取处于特定状态的订单 - 未付款：订单已下达，但付款尚未完成。
    /// - ON_HOLD（目前ON_HOLD状态仅在英国市场可用）：付款已完成，但订单允许买家在未经卖家批准的情况下取消订单。不允许卖家在ON_HOLD状态下配送订单。
    /// - PARTIALLY_SHIPPING：订单中的一件或多件（但不是全部）商品已发货。
    /// - AWAITING_SHIPMENT：订单已准备好发货，但订单中没有商品已发货。
    /// - AWAITING_COLLECTION：卖家安排了发货，但包裹仍在等待将包裹交给承运人。
    /// - IN_TRANSIT：包裹已由承运人领取。
    /// - 已送达：包裹已交付给买家。
    /// - COMPLETED：订单已完成。订单不再允许发起退货或退款。
    /// - 已取消：订单已取消。
    /// </summary>
    public string order_status { get; set; }

    /// <summary>
    /// 用于选择在指定时间之后（或在指定时间）创建的订单的日期。只有指定时间之后下的订单才会被退回。Unix 时间戳。
    /// create_time_ge表示大于或等于create_time
    /// </summary>
    public int? create_time_ge { get; set; }

    /// <summary>
    /// 用于选择在指定时间之前（或在指定时间）创建的订单的日期。Unix 时间戳。
    /// create_time_lt代表不到create_time
    /// </summary>
    public int? create_time_lt { get; set; }

    /// <summary>
    /// 用于选择在指定时间之后（或在指定时间）上次更新的订单的日期。更新定义为订单状态的任何更改，包括创建新订单。包括 Tiktok 和卖家所做的更新。Unix 时间戳。
    /// update_time_ge表示大于或等于update_time
    /// </summary>
    public int? update_time_ge { get; set; }

    /// <summary>
    /// 用于选择在指定时间之前（或指定时间）最后更新的订单的日期。更新被定义为订单状态的任何更改，包括创建新订单。包括 Tiktok 和卖家进行的更新。Unix 时间戳。
    /// update_time_lt代表不到update_time
    /// </summary>
    public int? update_time_lt { get; set; }

    /// <summary>	
    /// 交货方式。
    /// - TIKTOK：Tiktok提供的运输服务。卖家应从 Tiktok 获取运输标签。
    /// - 卖方：卖方提供运输服务，包括代表卖方通过第三方履行提供商提供运输服务。
    /// </summary>
    public string shipping_type { get; set; }

    /// <summary>
    /// 买家 UID
    /// </summary>
    public string buyer_user_id { get; set; }

    /// <summary>
    /// 使用此字段可检索订单，该订单已从买方发起取消请求。
    /// </summary>
    public bool? is_buyer_request_cancel { get; set; }
}

官网参考地址：

订单列表：https://partner.tiktokshop.com/docv2/page/650aa8094a0bb702c06df242?external_id=650aa8094a0bb702c06df242

八、TikTok组件配置-获取运输提供商

使用场景：

用于获取运输提供商。

方法：

/// <summary>
/// 获取运输提供商
/// </summary>
public class LogisticsApi
{

    /// <summary>
    /// 获取运输提供商
    /// </summary>
    /// <param name="request"></param>
    /// <returns></returns>
    public ResponseParameters<GetShippingProvidersResponse> GetShippingProviders(GetShippingProvidersQuery request);
}

接口请求对象：

/// <summary>
/// 获取运输提供商请求参数
/// </summary>
public class GetShippingProvidersQuery
{
    /// <summary>
    /// 店铺授权
    /// </summary>
    public string shop_cipher { get; set; }

    /// <summary>
    /// 送货选项Id
    /// 特定的交付选项标识符，用于获取交付提供程序列表。
    /// </summary>
    public string delivery_option_id { get; set; }

}

官网参考地址：

运输提供商：https://partner.tiktokshop.com/docv2/page/650aa48d4a0bb702c06d85cd?external_id=650aa48d4a0bb702c06d85cd

九、TikTok组件配置-获取批量运送包裹

使用场景：

用于获取批量运送包裹。

方法：

/// <summary>
/// 批量运送包裹
/// </summary>
public class FulfillmentApi
{

    /// <summary>
    /// 查询批量运送包裹
    /// </summary>
    /// <returns></returns>
    public ResponseParameters<BatchShipPackagesResponse> GetBatchShipPackages(BatchShipPackagesQuery request);
}

接口请求对象：

/// <summary>
/// 批量运送包裹请求参数
/// </summary>
public class BatchShipPackagesQuery
{
    /// <summary>
    /// 店铺授权
    /// </summary>
    public string shop_cipher { get; set; }

    /// <summary>
    /// 包
    /// </summary>
    public List<packages> packages { get; set; }
}

官网参考地址：

批量运送包裹：https://partner.tiktokshop.com/docv2/page/650aa3ebbace3e02b75d8bd4?external_id=650aa3ebbace3e02b75d8bd4