接入指南
调用接口
创建门店信息
接口交互流程图

上传门店照片
示例代码
//实例请求对象
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
//初始化请求对象实例
AlipayOfflineMaterialImageUploadRequest request = new AlipayOfflineMaterialImageUploadRequest();
//AppAuthToken的值获取方式查看第三方应用授权
request.putOtherTextParam("app_auth_token", AppAuthToken);
//图片格式
request.setImageType(imgType);
//图片名称
request.setImageName(imgName);
//图片二进制内容获取方式示例:imgContent = new FileItem("C:/Downloads/ooop6069/测试图片.jpg")
//Windows请填写绝对路径,不支持相对路径;Linux支持相对路径
request.setImageContent(imgContent);
//初始化返回对象实例并获取返回信息
AlipayOfflineMaterialImageUploadResponse response = alipayClient.execute(request);
//输出返回信息,开发者自行处理,此处打印实例为方便调试查看
System.out.print(response.getBody());
创建门店信息
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopApiCreate {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
AlipayOfflineMarketShopCreateModel data = new AlipayOfflineMarketShopCreateModel();
data.setMainImage("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setIsvUid("2088001969784501");
data.setContactNumber("13612344321,021-12336754");
data.setProvinceCode("110000");
data.setImplementId("HU002,HT002");
data.setOpRole("ISV");
data.setBizVersion("2.0");
data.setLicenceExpires("2020-10-20");
data.setBranchShopName("万塘路店");
data.setNotifyMobile("13867498729");
data.setNoSmoking("T");
data.setBox("T");
data.setBusinessCertificateExpires("2020-03-20");
data.setIsOperatingOnline("T");
data.setStoreId("hz001");
data.setValueAdded("免费茶水、免费糖果");
data.setRequestId("2015123235324534");
data.setBrandLogo("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setLicence("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setLicenceName("来伊份上海分公司");
data.setAddress("万塘路18号黄龙时代广场");
data.setLatitude("30.548828");
data.setWifi("T");
data.setBrandName("肯德基");
data.setDistrictCode("140521");
data.setParking("F");
data.setBusinessCertificate("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setAuthLetter("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setOtherAuthorization("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setCityCode("140500");
data.setLicenceCode("H001232");
data.setCategoryId("2015050700000018");
data.setBusinessTime("周一-周五 09:00-20:00,周六-周日 10:00-22:00");
data.setLongitude("114.266418");
data.setAuditImages("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,4Q8Pp00AT7eo9NoAJkMR3AAAACMAAUYT");
data.setOperateNotifyUrl("http://abc.com");
data.setOnlineUrl("http://www.******.com/shop/21831830");
data.setMainShopName("海底捞");
try {
AlipayOfflineMarketShopCreateResponseModel response = api.create(data);
} catch (ApiException e) {
AlipayOfflineMarketShopCreateDefaultResponse errorObject = (AlipayOfflineMarketShopCreateDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
查询门店类目配置
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopCategoryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopCategoryApiQuery {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopCategoryApi api = new AlipayOfflineMarketShopCategoryApi();
String categoryId = "2015050700000000";
String opRole = "ISV";
try {
AlipayOfflineMarketShopCategoryQueryResponseModel response = api.query(categoryId, opRole);
} catch (ApiException e) {
AlipayOfflineMarketShopCategoryQueryDefaultResponse errorObject = (AlipayOfflineMarketShopCategoryQueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
接口调用说明
修改门店信息
接口交互流程

示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopApiModify {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
AlipayOfflineMarketShopModifyModel data = new AlipayOfflineMarketShopModifyModel();
data.setMainImage("4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED");
data.setContactNumber("13534567652,021-76391728");
data.setProvinceCode("520000");
data.setImplementId("UO001,TY002");
data.setOpRole("ISV、PROVIDER");
data.setBizVersion("2.0");
data.setLicenceExpires("2020-10-20");
data.setBranchShopName("万塘路店");
data.setNotifyMobile("13827197382");
data.setNoSmoking("T");
data.setBox("T");
data.setAvgPrice("56.73");
data.setBusinessCertificateExpires("2020-03-20");
data.setIsOperatingOnline("F");
data.setStoreId("hz001");
data.setValueAdded("免费茶水");
data.setRequestId("20151234321423");
data.setBrandLogo("4G8gtQGKT7Ga1lS2_CkMBAAAACMAAQED");
data.setLicence("En00j29-TGyXNVEPXIssFQAAACMAAQED");
data.setLicenceName("杭州市西湖区万塘路支小宝美甲店");
data.setAddress("万塘路18号黄龙时代广场");
data.setLatitude("27.296891");
data.setWifi("F");
data.setBrandName("海底捞");
data.setShopId("2015052100077000000000120773");
data.setDistrictCode("522401");
data.setParking("F");
data.setBusinessCertificate("AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC");
data.setAuthLetter("AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC");
data.setOtherAuthorization("1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC");
data.setCityCode("522400");
data.setLicenceCode("HZ001");
data.setBusinessTime("周一-周五 09:00-20:00,周六-周日 10:00-22:00");
data.setLongitude("105.291027");
data.setAuditImages("02hkCZKaRgmLyirx4If6nAAAACMAAQED");
data.setOperateNotifyUrl("http://example.com/gateway.do");
data.setOnlineUrl("http://www.******.com/shop/21831830");
data.setMainShopName("肯德基");
try {
AlipayOfflineMarketShopModifyResponseModel response = api.modify(data);
} catch (ApiException e) {
AlipayOfflineMarketShopModifyDefaultResponse errorObject = (AlipayOfflineMarketShopModifyDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
参数说明
"avg_price":"#EMPTY#"
表示将平均消费设置为空。目前门店接口支持将参数值设置为空的参数见下表格,其它参数暂不支持。参数名 | 参数说明 |
---|---|
notify_mobile | 门店店长电话号码 |
implement_id | 机具号 |
branch_shop_name | 分店名称 |
value_added | 门店其它服务 |
avg_price | 人均消费价格 |
查询单个门店信息
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopApiQuerydetail {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
String shopId = "2015052100077000000000120773";
String opRole = "MERCHANT或PROVIDER";
try {
AlipayOfflineMarketShopQuerydetailResponseModel response = api.querydetail(shopId, opRole);
} catch (ApiException e) {
AlipayOfflineMarketShopQuerydetailDefaultResponse errorObject = (AlipayOfflineMarketShopQuerydetailDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
查询商户的门店编号列表
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopApiBatchquery {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopApi api = new AlipayOfflineMarketShopApi();
AlipayOfflineMarketShopBatchqueryModel data = new AlipayOfflineMarketShopBatchqueryModel();
data.setPageNo("1");
data.setBizChannel("POS、ALL");
try {
AlipayOfflineMarketShopBatchqueryResponseModel response = api.batchquery(data);
} catch (ApiException e) {
AlipayOfflineMarketShopBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketShopBatchqueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
门店摘要信息批量查询
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketShopSummaryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketShopSummaryApiBatchquery {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketShopSummaryApi api = new AlipayOfflineMarketShopSummaryApi();
AlipayOfflineMarketShopSummaryBatchqueryModel data = new AlipayOfflineMarketShopSummaryBatchqueryModel();
data.setDistrictCode("120104");
data.setShopStatus("PAUSED");
data.setPageNo(1);
data.setPageSize(20);
data.setRelatedPartnerId("2088001969784501");
data.setBizChannel("POS、ALL");
data.setCityCode("120100");
data.setProvinceCode("120000");
data.setOpRole("ISV、PROVIDER");
data.setQueryType("BRAND_RELATION");
data.setBrandName("麦当劳");
data.setShopId("2015062100077000000000120773");
try {
AlipayOfflineMarketShopSummaryBatchqueryResponseModel response = api.batchquery(data);
} catch (ApiException e) {
AlipayOfflineMarketShopSummaryBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketShopSummaryBatchqueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
业务流水批量查询
示例代码
package com.java.sdk.demo;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOfflineMarketApplyorderApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class AlipayOfflineMarketApplyorderApiBatchquery {
public static void main(String[] args) throws ApiException {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// 初始化alipay参数(全局设置一次)
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey("<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->");
alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->");
defaultClient.setAlipayConfig(alipayConfig);
AlipayOfflineMarketApplyorderApi api = new AlipayOfflineMarketApplyorderApi();
AlipayOfflineMarketApplyorderBatchqueryModel data = new AlipayOfflineMarketApplyorderBatchqueryModel();
data.setBizType("SHOP");
data.setPageNo(1);
data.setPageSize(20);
List<String> requestIds = new ArrayList<String>();
requestIds.add("2015123235324534,2015123235324535");
data.setRequestIds(requestIds);
data.setStartTime("2015-10-27 10:51:57");
data.setAction("CREATE_SHOP");
List<String> applyIds = new ArrayList<String>();
applyIds.add("2015052100077000000000120773,2015052100077000000000120774");
data.setApplyIds(applyIds);
data.setBizId("2015052100077000000000120774");
data.setOpRole("ISV");
data.setOpId("2088001969784501");
data.setStatus("FAIL");
data.setEndTime("2015-10-29 10:51:57");
try {
AlipayOfflineMarketApplyorderBatchqueryResponseModel response = api.batchquery(data);
} catch (ApiException e) {
AlipayOfflineMarketApplyorderBatchqueryDefaultResponse errorObject = (AlipayOfflineMarketApplyorderBatchqueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
门店参数展示说明及注意点
品牌
品牌 Logo

门店名称
