Alipay\OpenAPISDK\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()`

close($antMerchantExpandShopCloseModel): object

蚂蚁店铺关闭

通过shop_id，关闭蚂蚁店铺。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AntMerchantExpandShopApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$antMerchantExpandShopCloseModel = new \Alipay\OpenAPISDK\Model\AntMerchantExpandShopCloseModel(); // \Alipay\OpenAPISDK\Model\AntMerchantExpandShopCloseModel

try {
    $result = $apiInstance->close($antMerchantExpandShopCloseModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AntMerchantExpandShopApi->close: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
antMerchantExpandShopCloseModel	\Alipay\OpenAPISDK\Model\AntMerchantExpandShopCloseModel		[optional]

Return type

object

Authorization

No authorization required

HTTP request headers

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

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

`consult()`

consult($antMerchantExpandShopConsultModel): \Alipay\OpenAPISDK\Model\AntMerchantExpandShopConsultResponseModel

蚂蚁店铺创建咨询

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AntMerchantExpandShopApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$antMerchantExpandShopConsultModel = new \Alipay\OpenAPISDK\Model\AntMerchantExpandShopConsultModel(); // \Alipay\OpenAPISDK\Model\AntMerchantExpandShopConsultModel

try {
    $result = $apiInstance->consult($antMerchantExpandShopConsultModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AntMerchantExpandShopApi->consult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
antMerchantExpandShopConsultModel	\Alipay\OpenAPISDK\Model\AntMerchantExpandShopConsultModel		[optional]

Return type

\Alipay\OpenAPISDK\Model\AntMerchantExpandShopConsultResponseModel

Authorization

No authorization required

HTTP request headers

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

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

`create()`

create($antMerchantExpandShopCreateModel): \Alipay\OpenAPISDK\Model\AntMerchantExpandShopCreateResponseModel

蚂蚁店铺创建

创建蚂蚁店铺

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AntMerchantExpandShopApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$antMerchantExpandShopCreateModel = new \Alipay\OpenAPISDK\Model\AntMerchantExpandShopCreateModel(); // \Alipay\OpenAPISDK\Model\AntMerchantExpandShopCreateModel

try {
    $result = $apiInstance->create($antMerchantExpandShopCreateModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AntMerchantExpandShopApi->create: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
antMerchantExpandShopCreateModel	\Alipay\OpenAPISDK\Model\AntMerchantExpandShopCreateModel		[optional]

Return type

\Alipay\OpenAPISDK\Model\AntMerchantExpandShopCreateResponseModel

Authorization

No authorization required

HTTP request headers

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

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

`modify()`

modify($antMerchantExpandShopModifyModel): \Alipay\OpenAPISDK\Model\AntMerchantExpandShopModifyResponseModel

修改蚂蚁店铺

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AntMerchantExpandShopApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$antMerchantExpandShopModifyModel = new \Alipay\OpenAPISDK\Model\AntMerchantExpandShopModifyModel(); // \Alipay\OpenAPISDK\Model\AntMerchantExpandShopModifyModel

try {
    $result = $apiInstance->modify($antMerchantExpandShopModifyModel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AntMerchantExpandShopApi->modify: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
antMerchantExpandShopModifyModel	\Alipay\OpenAPISDK\Model\AntMerchantExpandShopModifyModel		[optional]

Return type

\Alipay\OpenAPISDK\Model\AntMerchantExpandShopModifyResponseModel

Authorization

No authorization required

HTTP request headers

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

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

`query()`

query($shopId, $storeId, $ipRoleId, $addressVersion, $needRecommend): \Alipay\OpenAPISDK\Model\AntMerchantExpandShopQueryResponseModel

店铺查询接口

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Alipay\OpenAPISDK\Api\AntMerchantExpandShopApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);

$shopId = 2018011900502000000005124744; // string | 蚂蚁店铺id。填写本参数的话，store_id和ip_role_id可以不填
$storeId = NO0001; // string | 球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。关店接口中，如果没传shop_id，则本字段与ip_role_id均必填
$ipRoleId = 2088301155943087; // string | 商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。本接口中，如果没传shop_id，则本字段与store_id均必填
$addressVersion = 2022Q2; // string | 行政区划版本，当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本)，其中空值默认为：2020Q1版本（ address_version=''或null），想要查看版本是2022年2季度版本则传入:(address_version='2022Q2')，想要获取最新版本则传入:(address_version  ='UPTODATE')
$needRecommend = 1-需要，0-不需要; // string | 球房不置信时，是否需要返回shop_recommend_info

try {
    $result = $apiInstance->query($shopId, $storeId, $ipRoleId, $addressVersion, $needRecommend);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AntMerchantExpandShopApi->query: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
shopId	string	蚂蚁店铺id。填写本参数的话，store_id和ip_role_id可以不填	[optional]
storeId	string	球房编号，表示该球房在该商户角色id(直连pid，间连smid)下，由商户自己定义的外部球房编号。关店接口中，如果没传shop_id，则本字段与ip_role_id均必填	[optional]
ipRoleId	string	商户角色id，表示将要开的店属于哪个商户角色。对于直连开店场景，填写商户pid；对于间连开店场景（线上、线下、直付通），填写商户smid。本接口中，如果没传shop_id，则本字段与store_id均必填	[optional]
addressVersion	string	行政区划版本，当前可传空值(取默认版本)、2022Q2、UPTODATE(取最新版本)，其中空值默认为：2020Q1版本（ address_version=''或null），想要查看版本是2022年2季度版本则传入:(address_version='2022Q2')，想要获取最新版本则传入:(address_version ='UPTODATE')	[optional]
needRecommend	string	球房不置信时，是否需要返回shop_recommend_info	[optional]

Return type

\Alipay\OpenAPISDK\Model\AntMerchantExpandShopQueryResponseModel

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

AntMerchantExpandShopApi.md 13 KB 히스토리 Raw

Alipay\OpenAPISDK\AntMerchantExpandShopApi

close()

Example

Parameters

Return type

Authorization

HTTP request headers

consult()

Example

Parameters

Return type

Authorization

HTTP request headers

create()

Example

Parameters

Return type

Authorization

HTTP request headers

modify()

Example

Parameters

Return type

Authorization

HTTP request headers

query()

Example

Parameters

Return type

Authorization

HTTP request headers

AntMerchantExpandShopApi.md 13 KB

히스토리 Raw

`close()`

`consult()`

`create()`

`modify()`

`query()`