Skip to content

Latest commit

 

History

History
470 lines (371 loc) · 17.5 KB

AntMerchantExpandShopApi.md

File metadata and controls

470 lines (371 loc) · 17.5 KB

AlipaySDKNet.OpenAPI.Api.AntMerchantExpandShopApi

All URIs are relative to https://openapi.alipay.com

Method HTTP request Description
Close PATCH /v3/ant/merchant/shop/close 蚂蚁店铺关闭
Consult POST /v3/ant/merchant/expand/shop/consult 蚂蚁店铺创建咨询
Create POST /v3/ant/merchant/shop 蚂蚁店铺创建
Modify PATCH /v3/ant/merchant/shop 修改蚂蚁店铺
Query GET /v3/ant/merchant/shop 店铺查询接口

Close

Object Close (AntMerchantExpandShopCloseModel antMerchantExpandShopCloseModel = null)

蚂蚁店铺关闭

通过shop_id,关闭蚂蚁店铺。

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class CloseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AntMerchantExpandShopApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var antMerchantExpandShopCloseModel = new AntMerchantExpandShopCloseModel(); // AntMerchantExpandShopCloseModel |  (optional) 

            try
            {
                // 蚂蚁店铺关闭
                Object result = apiInstance.Close(antMerchantExpandShopCloseModel);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AntMerchantExpandShopApi.Close: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
antMerchantExpandShopCloseModel AntMerchantExpandShopCloseModel [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 common response -
0 请求失败 -

[Back to top] [Back to API list] [Back to README]

Consult

AntMerchantExpandShopConsultResponseModel Consult (AntMerchantExpandShopConsultModel antMerchantExpandShopConsultModel = null)

蚂蚁店铺创建咨询

蚂蚁店铺创建咨询

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class ConsultExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AntMerchantExpandShopApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var antMerchantExpandShopConsultModel = new AntMerchantExpandShopConsultModel(); // AntMerchantExpandShopConsultModel |  (optional) 

            try
            {
                // 蚂蚁店铺创建咨询
                AntMerchantExpandShopConsultResponseModel result = apiInstance.Consult(antMerchantExpandShopConsultModel);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AntMerchantExpandShopApi.Consult: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
antMerchantExpandShopConsultModel AntMerchantExpandShopConsultModel [optional]

Return type

AntMerchantExpandShopConsultResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 common response -
0 请求失败 -

[Back to top] [Back to API list] [Back to README]

Create

AntMerchantExpandShopCreateResponseModel Create (AntMerchantExpandShopCreateModel antMerchantExpandShopCreateModel = null)

蚂蚁店铺创建

创建蚂蚁店铺

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class CreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AntMerchantExpandShopApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var antMerchantExpandShopCreateModel = new AntMerchantExpandShopCreateModel(); // AntMerchantExpandShopCreateModel |  (optional) 

            try
            {
                // 蚂蚁店铺创建
                AntMerchantExpandShopCreateResponseModel result = apiInstance.Create(antMerchantExpandShopCreateModel);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AntMerchantExpandShopApi.Create: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
antMerchantExpandShopCreateModel AntMerchantExpandShopCreateModel [optional]

Return type

AntMerchantExpandShopCreateResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 common response -
0 请求失败 -

[Back to top] [Back to API list] [Back to README]

Modify

AntMerchantExpandShopModifyResponseModel Modify (AntMerchantExpandShopModifyModel antMerchantExpandShopModifyModel = null)

修改蚂蚁店铺

修改蚂蚁店铺,按信息项修改。若无特殊说明,如果某项存在但是没填写,则不会覆盖掉原来的值

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class ModifyExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AntMerchantExpandShopApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var antMerchantExpandShopModifyModel = new AntMerchantExpandShopModifyModel(); // AntMerchantExpandShopModifyModel |  (optional) 

            try
            {
                // 修改蚂蚁店铺
                AntMerchantExpandShopModifyResponseModel result = apiInstance.Modify(antMerchantExpandShopModifyModel);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AntMerchantExpandShopApi.Modify: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
antMerchantExpandShopModifyModel AntMerchantExpandShopModifyModel [optional]

Return type

AntMerchantExpandShopModifyResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 common response -
0 请求失败 -

[Back to top] [Back to API list] [Back to README]

Query

AntMerchantExpandShopQueryResponseModel Query (string shopId = null, string storeId = null, string ipRoleId = null, string addressVersion = null, string needRecommend = null, string needIndustryInfo = null, string needIndustryLicense = null)

店铺查询接口

用于服务商或商户查询其自己的店铺信息

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class QueryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AntMerchantExpandShopApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var shopId = 2018011900502000000005124744;  // string | 蚂蚁店铺id (optional) 
            var storeId = NO0001;  // string | 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 (optional) 
            var ipRoleId = 2088301155943087;  // string | 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid (optional) 
            var addressVersion = 2022Q2;  // string | 行政区划版本,当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本),其中空值默认为:2020Q1版本( address_version=''或null),想要查看版本是2022年2季度版本则传入:(address_version='2022Q2'),想要获取最新版本则传入:(address_version ='UPTODATE') (optional) 
            var needRecommend = 0;  // string | 门店不置信时,是否需要返回shop_recommend_info (optional) 
            var needIndustryInfo = 1;  // string | need_industry_info=0时不返回行业信息;need_industry_info=1时返回不需要审核的行业信息、审核通过的行业信息 (optional) 
            var needIndustryLicense = 1;  // string | need_industry_license=0时不返回行业资质;need_industry_license=1时返回审核通过的行业资质 (optional) 

            try
            {
                // 店铺查询接口
                AntMerchantExpandShopQueryResponseModel result = apiInstance.Query(shopId, storeId, ipRoleId, addressVersion, needRecommend, needIndustryInfo, needIndustryLicense);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AntMerchantExpandShopApi.Query: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
shopId string 蚂蚁店铺id [optional]
storeId string 门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号 [optional]
ipRoleId string 商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid [optional]
addressVersion string 行政区划版本,当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本),其中空值默认为:2020Q1版本( address_version=''或null),想要查看版本是2022年2季度版本则传入:(address_version='2022Q2'),想要获取最新版本则传入:(address_version ='UPTODATE') [optional]
needRecommend string 门店不置信时,是否需要返回shop_recommend_info [optional]
needIndustryInfo string need_industry_info=0时不返回行业信息;need_industry_info=1时返回不需要审核的行业信息、审核通过的行业信息 [optional]
needIndustryLicense string need_industry_license=0时不返回行业资质;need_industry_license=1时返回审核通过的行业资质 [optional]

Return type

AntMerchantExpandShopQueryResponseModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 common response -
0 请求失败 -

[Back to top] [Back to API list] [Back to README]