Skip to main content

B2B Mobility Card Transaction Data 2.3.5

壳牌B2B出行卡交易数据API——快速入门指南

API版本: 2.3.4 | 身份验证: OAuth 2.0 | 状态: 生产环境

更多

壳牌卡交易数据 API 是一个基于 REST 的 API,允许开发者通过编程方式检索和分析壳牌加油卡的交易数据。该 API 提供对定价交易、费用、基于用量的定价、奖励规则、 例外情况以及卡片使用摘要等数据。

注意: 本指南仅涵盖采用 OAuth 2.0 身份验证的端点(基路径:/transaction-data/v1)。旧版 Basic Auth 端点(/fleetmanagement/v1/transaction)因正在逐步淘汰,故未包含在内。

主要功能

  • 检索定价交易详情(包括电动汽车交易)
  • 访问包含销售明细和费用的燃油交易详情
  • 获取燃油和非燃油(NFR)交易的汇总数据
  • 查询基于交易量的定价和奖励规则
  • 检索费用明细和费用汇总数据
  • 访问卡片和交易异常
  • 分析卡片使用 和支出数据
  • 支持多付款方交易查询

重要通知——OAuth 2.0

重要提示: OAuth 2.0 现已成为标准身份验证方法

  • 新集成: 从一开始就使用 OAuth 2.0
  • 现有集成: 规划向 OAuth 2.0 的迁移<0
  • 旧版方法: 基本认证(Basic Auth)正在逐步淘汰

请联系 Shell 技术支持 以获取您的 OAuth 2.0 凭据(client_id 和 client_secret)。

身份验证

OAuth 2.0(标准身份验证方法)

Shell 卡交易数据 API 使用 OAuth 2.0 客户端凭据流程 进行安全身份验证。

警告: 所有客户均应计划采用 OAuth 2.0 身份验证。这是 Shell 卡交易数据 API 推荐且面向未来的身份验证方法。 旧版身份验证方法正在逐步淘汰。

OAuth 2.0 流程

步骤 1:获取访问令牌

向 OAuth 令牌端点请求访问令牌:

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=您的客户端 ID&client_secret=您的客户端密钥

步骤 2:在 API 请求中使用访问令牌

Authorization: Bearer 
Content-Type: application/json

令牌管理

令牌管理最佳实践:

  • 访问令牌有效期有限(通常为 15 分钟)
  • 实现令牌缓存以避免不必要的令牌请求
  • 在令牌过期前刷新令牌 ,以确保服务不中断
  • 切勿分享您的 client_secret 或将其嵌入客户端代码中

OAuth 2.0 采用策略

为何迁移到 OAuth 2.0?

安全优势:

  • 行业标准的身份验证协议
  • 限时访问令牌可降低安全风险
  • 每次请求均不传输凭据
  • 更好地支持令牌轮换和撤销

运营优势:

  • 提升可扩展性和性能
  • 更强的监控和审计能力
  • 简化的凭证管理
  • 面向未来的集成

迁移路径

如果您目前仍在使用旧版身份验证方法,请遵循以下迁移路径:

  1. Shell 技术支持
  2. 申请 OAuth 2.0 凭据Shell 技术支持
  3. 在您的应用程序中实施 OAuth 令牌管理
  4. 在测试/沙箱环境中进行全面测试
  5. 在过渡期间并行运行认证(OAuth + 传统方式)
  6. 监控并验证 OAuth 集成
  7. 验证通过后切换为仅 OAuth 模式
  8. 迁移成功后停用传统认证

环境

该 API 可在两个环境中使用:

环境 基础 URL 用途
生产环境 https://api.shell.com 正式生产环境
测试(沙箱) https://api-test.shell.com/test 测试和开发环境

提示: 在迁移到生产环境之前,请务必在 测试环境 中测试您的集成。

快速入门

1. 获取 OAuth 凭据

2. 获取访问令牌

首先,获取您的 OAuth 访问令牌:

cURL 示例:

curl -X POST https://api-test.shell.com/test/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=您的客户端 ID&client_secret=您的客户端密钥"

响应:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

3. 发送您的第一个 API 请求

示例:获取定价交易

cURL 示例:

curl -X POST https://api-test.shell.com/test/transaction-data/v1/priced \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "Filters": {
 "ColCoCode": "5",
 "PayerNumber": "DE26667080",
        "InvoiceStatus": "A",
 "IncludeFees": true,
 "FromDate": "2024-12-01 00:00:00",
 "ToDate": "2025-01-20 00:00:00"
    },
    "Page": 1,
    "PageSize": 1
}'

响应示例:

{
  "RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
  "Status": "SUCCESS",
  "Data": [
    {
 "AccountName": "Blue Colour Ltd",
 "AccountId": 29484,
      "AccountNumber": "DE26667080",
 "AccountShortName": "Mathew",
 "Additional1": "GBALLEGO0002452",
 "Additional2": "GBALLEGO0002452",
      "Additional3": "GBALLEGO0002452",
 "Additional4": "GBALLEGO0002452",
 "AllowClearing": "Null",
      "授权码": 300796,
 "交易状态": "Y",
 "驾驶员姓名": "SATTY BHAMRA",
 "CardExpiryPeriod": 2204,
 "CardExpiry": "20220101",
 "CardGroupId": 40000,
 "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
 "发卡行代码": 7002,
 "卡号": "7002053465789891000",
 "解锁码": 9,
      "CardSequenceNumber": 617,
 "CardType": "GB STD FLT NAT SINGLE R9",
 "ColCoCode": "014",
 "UnitDiscountInvoiceCurrency": -0.0051,
      "ColCoExchangeRate": 0.851858,
 "InvoiceCurrencySymbol": "GBP",
 "CorrectionFlag": true,
 "CRMNumber": 10,
 "CustomerCountry": "英国",
 "客户货币代码": "GBP",
 "客户货币符号": "£",
 "按客户货币净额计算的返利": 0,
      "按客户货币计算的实际折扣": -0.22,
 "按客户货币计算的实际单位折扣": -0.0051,
 "发票货币单位价格": 1.1024,
      "发票税费": 0,
 "发票总金额": 57.25,
 "发票净金额": 47.71,
 "客户货币净金额的增值税": 9.54,
 "客户零售单价(含税)": 0,
 "客户零售总值(含税)": 57.52,
 "客户零售净值总额": 47.93,
 "交易类型描述": 9.59,
 "按交易货币计算的净额返利": -0.22,
 "按交易货币计算的实际折扣": -0.22,
 "发卡行至收卡行汇率": 0,
 "卡片": [
 275549
      ],
 "单位折扣(交易货币)": -0.005,
 "交易总金额": 57.25,
 "交易净金额": 47.71,
      "交易税费": 9.54,
 "净额增值税": 9.54,
 "Delco 目录价单位净额": 0,
 "Delco 零售价单位含税额": 1.32888,
      "交易货币单位价格": 1.1074,
 "Delco零售单位净价": 1.1074,
      "Delco零售总值(含税)": 57.52,
 "Delco零售总值(不含税)": 47.93,
 "交易货币符号": "$",
      "DiscountType": 1,
 "DisputeStatus": false,
 "IsShellSite": false,
      "车队ID输入": "YG67OUM",
 "入库商品代码": 23,
 "发布日期": "20210802",
      "发布时间": "14:15:22",
 "产品代码": 30,
 "产品名称": "无铅汽油 - 中等辛烷值",
 "产品组ID": 22,
      "入账货币代码": "GBP",
 "入账站点描述": "壳牌百老汇环站",
 "位置": "壳牌百老汇环站",
 "站点名称": "壳牌百老汇环站",
 "站点代码": 32,
      "入账站点编号": 15,
 "发票货币代码": "GBP",
 "发票日期": "20210802",
 "发票编号": 3201016193,
 "燃油产品": true,
      "VATApplicable": "Y",
 "PayerName": "Colours Services Ltd",
 "PayerNumber": "GB12121212",
 "ParentCustomerNumber": "GB12121212",
      "付款方组": "H312066",
 "付款方组名称": "12162566 - 燃油卡服务",
 "校验位": 6,
 "净发票标识": "Y",
      "DelcoCode": 5,
 "NetworkCode": 3,
 "PurchasedInCountry": "英国",
 "SiteCountry": "英国",
 "增值税国家": "英国",
 "Delco名称": "壳牌英国石油产品有限公司",
 "网络": "壳牌",
 "里程表读数": 0,
      "原始销售项目ID": "Null",
 "车队ID描述": "YG67OUM",
 "上级客户ID": 6494,
 "PIN标识": "Y, N",
 "产品组名称": "费用",
 "购买国家代码": "GB",
 "数量": 43.28,
 "返利率": 0.0022,
 "收据编号": 6803,
      "RefundFlag": "Y",
 "SiteGroupId": 202,
      "站点组名称": "CZ 9100 ECONOMY NETWORK",
 "纬度": 53.83606,
 "经度": -1.61854,
      "DelCoExchangeRate": 0.851858,
 "EuroRebateAmount": -0.258259,
 "NetEuroAmount": 56.01,
 "EuroVATAmount": 11.2,
      "ParentCustomerName": "FUEL CARD SERVICES LTD",
 "IsInvoiced": false,
 "TransactionCurrencyCode": "GBP",
 "CreditDebitCode": "D 或 C",
 "TransactionDate": "20210801",
 "TransactionTime": "12:16:58",
 "TransactionItemId": "H305908971030",
      "TrnIdentifier": "H305908971030",
 "Type": "SALE",
 "TransactionLine": 1,
 "TransactionType": "Purchase",
 "UTCOffset": "Europe/London",
      "增值税类别": "英国标准增值税税率",
 "增值税税率": 0.2,
 "车辆注册号": "YG67OUM",
      "IsCancelled": "Y",
 "ColCoGrossAmount": 57.25,
 "ColCoNetAmount": 47.71,
 "ColCoVATAmount": 9.54,
 "OriginalCurrencySymbol": "$",
 "原始货币代码": "$",
 "原始增值税金额": 0,
 "压印文字": "PARKLANE PROPERTIES LTD",
 "原始汇率": 0,
      "原始交易明细发票日期": "20220202",
 "费用类型ID": 1,
 "行项目描述": true,
 "费用规则描述": "简单费用",
 "频率": 1,
      "费率规则ID": 1,
      "系统录入日期": "20210828",
 "系统录入时间": "20:21:08",
 "是否手动": "Y",
 "原始交易明细ID": "Y",
      "原始交易明细发票编号": 6750802,
 "原始交易明细发票ID": 234,
 ""付款方简称": "FUEL CARD SERVICES LTD",
 "反向计税": "Y",
 "原始总金额": 57.25,
 "原始净金额": 57.25,
      "计量单位": "L",
 "道路类型": "国道",
 "客户国家ISO代码": "DE",
 "电动汽车运营商": "Shell Recharge",
      "EVSerialId": "GBALLEGO0002452",
 "EVChargePointSerial": "GBALLEGO0002452",
 "EVChargePointConnectorType": 5,
      "EVChargePointConnectorTypeDescription": "直流 50 kW",
 "EVChargeDuration": "PT3205S",
 "EVChargeStartDate": "2021-08-01",
 "EVChargeStartTime": "20:08:01",
 "EVChargeEndDate": "2022-08-01",
 "EVChargeEndTime": "20:08:01",
 "HostingCollectingCompanyNumber": 0,
 "TransactionId": 0,
 "FuelOnly": true,
 "EVPrintedNumber": "ZZ2WJ53ZZ5",
 "IsRFID": true
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 5
}

API 端点参考

计价交易

端点 方法 描述
/transaction-data/v1/priced POST 获取计费交易详情(包括电动汽车交易) (OAuth 2.0)
/transaction-data/v1/pricedtransaction POST 获取包含销售项目和费用的燃料交易详情(OAuth 2.0)
/transaction-data/v1/multipayerspricedtransactions POST 获取多个付款方的计价交易详情(OAuth 2.0)

常见用例:

  • 按日期范围检索交易
  • 按交易状态过滤 (已批准、已拒绝等)
  • 按卡片主账号(PAN)或车辆注册号搜索
  • 获取电动汽车充电交易记录
  • 查询涉及多个付款方的交易

交易摘要

端点 方法 描述
/transaction-data/v1/pricedtransactionssummary POST 获取包含销售明细和费用的燃油及非燃油(NFR)计价交易摘要数据(OAuth 2.0)
/transaction-data/v1/cardusagesummary POST 获取某张卡的支出分析和使用摘要(OAuth 2.0)

返回内容:

  • 按期间汇总的交易数据
  • 总交易量和总额
  • 按产品类型和类别细分的明细
  • 卡级支出分析

费用管理

端点 方法 描述
/transaction-data/v1/feessummary POST 获取指定付款人的费用明细汇总数据(OAuth 2.0)

费用信息:

  • 检索交易中适用的费用项目
  • 按期间汇总的所有费用
  • 按类型和类别细分的费用
  • 账户级费用分析

基于交易量的规则

接口 方法 描述
/transaction-data/v1/volumebasedpricing POST 获取指定付款方的逾期费用规则配置(OAuth 2.0)
/transaction-data/v1/volumebasedbonus POST 获取指定付款方的奖励及关联奖励规则配置 (OAuth 2.0)

基于交易量的功能:

  • 访问基于交易量的定价规则
  • 检索奖励计算规则
  • 获取关联奖励配置
  • 查询逾期费用结构

异常

端点 方法 描述
/transaction-data/v1/异常 POST 获取与卡片或交易相关的异常(OAuth 2.0)

异常类型:

  • 交易验证失败
  • 卡片使用异常
  • 授权异常
  • 政策违规警报

常见用例

本节将常见业务场景与相应的 API 端点进行映射,以帮助您快速确定应使用哪些 API 来满足您的具体需求。

用例 1: 每日交易对账

场景: 您需要每天对车队卡的所有交易进行对账,以满足会计核算需求。

推荐 API: /transaction-data/v1/priced

为何选择此 API: 该接口提供全面的交易详情,包括电动汽车 充电交易,支持灵活的日期筛选,并包含已开票和未开票交易。非常适合每日对账,且支持分页处理大型数据集。

关键参数:

  • FromDateToDate - 设置为昨天的日期
  • InvoiceStatus - 所有交易均设为“A”
  • PageSize - 设为100以实现高效数据检索

用例2:发票验证与核对

S场景: 您收到一张发票,需要核验所有交易详情,包括各项费用和收费项目。

推荐 API: /transaction-data/v1/pricedtransaction

为何选择此API: 该API专门设计用于提供详细的燃油交易信息,包括销售项目及所有相关费用。由于其结构与发票完全匹配,因此非常适合用于发票验证。

关键参数:

  • InvoiceNumber - 待验证的具体发票
  • InvoiceDate - 账单中的发票日期
  • IncludeFees - 设置为 true 以查看所有费用项目

用例 3:燃油消耗分析与报告

场景: 您需要分析过去一个月车队整体的燃油消耗模式,以优化路线并降低成本。

推荐 API:

  • /transaction-data/v1/pricedtransactionssummary - 用于 汇总数据

为何选用这些API: 汇总端点按产品、站点组和时间段提供汇总数据,非常适合进行趋势分析,无需处理海量交易数据.

关键参数:

  • FromDateToDate - 设置为最近 30 天
  • ProductCode - 按特定燃油类型筛选
  • ProductGroupName - 按燃油类别分组

用例 4:多车队管理

场景: 您管理多个子账户或付款方,需要检索所有账户的交易数据以生成合并报表。

推荐 API: /transaction-data/v1/multipayerspricedtransactions

为何选择此API: 该API专为通过单次API调用查询多个付款方的交易数据而设计,可显著减少请求次数,并提升多车队场景下的性能。

关键参数:

  • Accounts - 付款人 ID 和编号数组(最多 10 个付款人)
  • InvoiceStatus - “A” 适用于所有交易
  • FromDateToDate - 报告周期

用例 5:异常监控与欺诈检测

场景: 您希望识别异常交易模式,例如大额交易、过量的燃油消费量或使用异常的卡片,以防止欺诈或滥用。

推荐 API: /transaction-data/v1/exceptions

为何选择此 API: 专为识别超出预设阈值的交易而设计,非常适合监控异常情况和潜在欺诈行为。

关键参数:

  • Condition - 设置阈值类型 (ValueGreaterThan、VolumeGreaterThan 等)
  • Value - 定义阈值
  • OutputType - 交易异常选择“Transaction”
  • TransactionsFromDateTransactionsToDate - 监控时间段

用例 6:费用与收费分析

场景: 您需要了解账户中产生的所有费用和收费,以便发现节省成本的机会或验证账单

推荐 API: /transaction-data/v1/feessummary

为何选择此 API: 提供按费用类型、产品组和费用组聚合的费用 信息,便于分析费用结构并识别高成本领域。

关键参数:

  • InvoiceStatus - “I” 表示仅包含已开票费用
  • FeeTypeGroup - 按“卡费”、“账户费用”等进行筛选
  • FromDateToDate - 分析周期

用例 7:单张卡片消费追踪

场景: 某司机请求查询过去 6 个月的交易记录,或者您需要分析特定卡片的消费模式。

推荐 API: /transaction-data/v1/cardusagesummary

为何选择此 API: 提供过去7个月内单张卡片的详细消费分析,按网站和产品分组,非常适合进行卡片级别的报表分析。

关键参数:

  • CardIdPAN - 待分析的具体卡片
  • CardExpiry - 用于额外验证
  • AccountId - 可选的账户筛选条件

用例 8:基于用量的定价资格核查

场景: 您希望核查您的账户是否符合基于用量的定价层级条件,并了解当前消耗量与预设阈值的对比情况。

推荐 API: /transaction-data/v1/volumebasedpricing

为何选择此 API: 显示您的滞纳金规则、分级配置及当前用量,帮助您了解定价结构并规划如何晋升至更优的定价层级。

关键参数:

  • PayerNumber - 您的付款方账户
  • IncludeHistory - 设置为 true 可查看历史计算结果
  • IncludeCurrentPeriodVolume - 设置为 true 可查看按月细分数据

用例 9:奖励与返利追踪

场景: 您已签订基于交易量的 奖金协议,希望追踪您向奖金门槛迈进的进度,并查看此前已获得的奖金。

推荐 API: /transaction-data/v1/volumebasedbonus

为何选择此 API: 提供奖金规则、当前期间消耗量及历史奖金计算的完整详情,助您优化采购以获取最大奖金.

关键参数:

  • PayerNumber - 您的付款方账户
  • IncludeHistory - 设置为 true 可查看过往奖金支付记录
  • IncludeCurrentPeriodVolume - 设置为 true 可追踪当前期间的进度

使用示例

示例 1:获取定价交易(包括 EV)

请求:

POST /transaction-data/v1/priced

{
  "PageSize": 1,
  "Page": 1,
  "Filters": {
    "ColCoCode": "5",
    "ColCoId": 5,
    "InvoiceStatus": "A",
    "PayerNumber": "DE26685263",
    "AccountId": 29484,
    "AccountNumber": "DE26667080",
    "CardPAN": "7002051006629890645",
    "起始日期": "2022-01-01 00:00:00",
    "ToDate": "2022-01-31 00:00:00",
    "IncludeFees": true
  }
}

响应:

{
  "RequestId": "9d2dee33-7803-485a-a2b1-2c7538e597ee",
  "Status": "SUCCESS",
  "Data": [
    {
 "AccountName": "Blue Colour Ltd",
 "AccountId": 29484,
 "AccountNumber": "DE26667080",
      "AccountShortName": "Mathew",
 "Additional1": "GBALLEGO0002452",
 "Additional2": "GBALLEGO0002452",
 "Additional3": "GBALLEGO0002452",
 "Additional4": "GBALLEGO0002452",
 "AllowClearing": "Null",
 "AuthorisationCode": 300796,
 "TransactionStatus": "Y",
 "DriverName": "SATTY BHAMRA",
      "CardExpiryPeriod": 2204,
 "CardExpiry": "20220101",
 "CardGroupId": 40000,
      "CardGroupName": "006240 FIRE BRIGHT SOLUTIONS",
 "IssuerCode": 7002,
 "CardPAN": "7002053465789891000",
 "ReleaseCode": 9,
 "CardSequenceNumber": 617,
 "CardType": "GB STD FLT NAT SINGLE R9",
      "ColCoCode": "014",
 "UnitDiscountInvoiceCurrency": -0.0051,
      "ColCoExchangeRate": 0.851858,
 "InvoiceCurrencySymbol": "GBP",
 "CorrectionFlag": true,
 "CRMNumber": 10,
 "CustomerCountry": "英国",
 "客户货币代码": "GBP",
 "客户货币符号": "£",
 "按客户货币净额计算的返利": 0,
      "按客户货币计算的实际折扣": -0.22,
 "按客户货币计算的实际单位折扣": -0.0051,
 "发票货币单位价格": 1.1024,
 "发票税额": 0,
      "发票总金额": 57.25,
 "发票净金额": 47.71,
 "客户货币净额增值税": 9.54,
 "客户零售单价(含税)": 0,
      "客户零售总值(含税)": 57.52,
 "客户零售总值(不含税)": 47.93,
 "交易类型描述": 9.59,
      "按交易货币净额计算的返利": -0.22,
 "按交易货币计算的实际折扣": -0.22,
 "发货国至收货国汇率": 0,
 "卡号": [
 275549
 ],
 "单位折扣(交易货币)": -0.005,
 "交易总金额": 57.25,
 "交易净金额": 47.71,
 "交易税费": 9.54,
 "净金额增值税": 9.54,
      "DelcoListPriceUnitNet": 0,
 "DelcoRetailPriceUnitGross": 1.32888,
 "UnitPriceInTransactionCurrency": 1.1074,
 "DelcoRetailPriceUnitNet": 1.1074,
 "DelcoRetailValueTotalGross": 57.52,
 "Delco零售净值总额": 47.93,
 "交易货币符号": "$",
 "折扣类型": 1,
 "争议状态": false,
 "是否Shell站点": false,
      "车队ID输入": "YG67OUM",
 "传入产品代码": 23,
 "发布日期": "20210802",
 "发布时间": "14:15:22",
      "产品代码": 30,
 "产品名称": "无铅汽油 - 中等辛烷值",
 "产品组ID": 22,
 "入账货币代码": "GBP",
 "入账站点描述": "壳牌百老汇环路",
 ""地点": "壳牌百老汇环路",
 "站点名称": "壳牌百老汇环路",
 "站点代码": 32,
 "入账站点编号": 15,
 "发票货币代码": "GBP",
      "发票日期": "20210802",
 "发票编号": 3201016193,
 "燃油产品": true,
 "是否适用增值税": "Y",
 "付款方名称": "Colours Services Ltd",
 "付款方编号": "GB12121212",
      "父客户编号": "GB12121212",
 "付款方组": "H312066",
 "付款方组名称": "12162566 - 燃油卡服务",
      "校验位": 6,
 "净额发票标识": "Y",
 "Delco代码": 5,
      "NetworkCode": 3,
 "PurchasedInCountry": "英国",
 "SiteCountry": "英国",
 "VATCountry": "英国",
 "DelcoName": "壳牌英国石油产品有限公司",
 "Network": "壳牌",
 "里程表输入": 0,
 "原始销售项目ID": "Null",
 "车队ID描述": "YG67OUM",
      "父客户ID": 6494,
 "PIN标识": "Y, N",
 "产品组名称": "费用",
 "购买国家代码": "GB",
      "数量": 43.28,
 "返利率": 0.0022,
 "收据编号": 6803,
 "退款标记": "Y",
 "站点组ID": 202,
      "站点组名称": "CZ 9100 经济网络",
      "纬度": 53.83606,
 "经度": -1.61854,
 "DelCo汇率": 0.851858,
 "欧元返利金额": -0.258259,
      "净欧元金额": 56.01,
 "欧元增值税金额": 11.2,
      "ParentCustomerName": "FUEL CARD SERVICES LTD",
 "IsInvoiced": false,
 "TransactionCurrencyCode": "GBP",
      "CreditDebitCode": "D 或 C",
 "TransactionDate": "20210801",
 "TransactionTime": "12:16:58",
 "TransactionItemId": "H305908971030",
      "TrnIdentifier": "H305908971030",
 "Type": "SALE",
 "TransactionLine": 1,
 "TransactionType": "Purchase",
 "UTCOffset": "Europe/London",
 "VATCategory": "英国标准增值税税率",
 "VATRate": 0.2,
 "VehicleRegistration": "YG67OUM",
      "IsCancelled": "Y",
 "ColCoGrossAmount": 57.25,
 "ColCoNetAmount": 47.71,
 "ColCoVATAmount": 9.54,
 "OriginalCurrencySymbol": "$",
 "原始货币代码": "$",
 "原始增值税金额": 0,
 "压印文本": "PARKLANE PROPERTIES LTD",
 "原始汇率": 0,
 "原始交易明细发票日期": "20220202",
 "手续费类型ID": 1,
 "行项目描述": true,
      "FeeRuleDescription": "简单费用",
 "Frequency": 1,
 "FeeRuleId": 1,
 "SystemEntryDate": "20210828",
 "系统录入时间": "20:21:08",
 "是否手动": "Y",
 "原始交易明细ID": "Y",
 "原始交易明细发票编号": 6750802,
 "原始交易明细发票ID": 234,
 "付款方简称": "FUEL CARD SERVICES LTD",
 "ReverseCharge": "Y",
 "OriginalGrossAmount": 57.25,
 "OriginalNetAmount": 57.25,
 "UnitOfMeasure": "L",
      "道路类型": "国道",
 "客户国家ISO代码": "DE",
 "电动汽车运营商": "Shell Recharge",
 "电动汽车充电桩序列号": "GBALLEGO0002452",
 "EVChargePointSerial": "GBALLEGO0002452",
 "EVChargePointConnectorType": 5,
 "EVChargePointConnectorTypeDescription": "直流 50 kW",
 "EVChargeDuration": "PT3205S",
      "EVChargeStartDate": "2021-08-01",
 "EVChargeStartTime": "20:08:01",
 "EVChargeEndDate": "2022-08-01",
 "EVChargeEndTime": "20:08:01",
 "HostingCollectingCompanyNumber": 0,
 "TransactionId": 0,
 "FuelOnly": true,
 "EVPrintedNumber": "ZZ2WJ53ZZ5",
 "IsRFID": true
    }
  ],
  "Page": 3,
  "PageSize": 30,
  "TotalPages": 5
}

示例 2:获取燃料交易详情

请求:

POST /transaction-data/v1/pricedtransaction

{
  "Filters": {
    "ColCoCode": 14,
    "InvoiceStatus": "A",
    "PayerId": 12345,
    "PayerNumber": "NL10042616"
  },
  "Page": 1,
  "PageSize": 50
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "Transactions": [
 {
 "Type": "SalesItem /FeeItem",
          "CardId": 0,
 "CardPAN": "7002051006629891000",
 "CardExpiry": "2026-06-16",
          "交易日期": "2026-06-16",
          "交易时间": "字符串",
 "UTC偏移量": "字符串",
 "车队ID输入": "XYZ1234",
 "里程表读数输入": 12345,
 "驾驶员姓名": "ANDREW GILBERRY",
 "VehicleRegistration": "MV65YLH",
 "InvoiceCurrencyCode": "GBP",
 "发票货币符号": "$",
 "交易货币代码": "GBP",
 "交易货币符号": "$",
 "交易净金额": 0,
 "交易税额": 0,
 "交易总金额": 0,
 "发票净额": 0,
 "发票税额": 0,
          "发票总金额": 0,
 "采购国家": "德国",
 "账户ID": 29484,
 "账号": "GB99215176",
 "账户名称": "MATTHEW ALGIE & COMPANY LIMITED",
 "账户简称": "string",
 "数量": 0,
 "燃料产品": true,
 "交易货币单价": 0,
 "发票货币单价": 0,
 "单位折扣交易货币":0,
 "单位折扣(发票货币)":0,
 "已开票":true,
 "发票编号":"S04500493",
 "发票日期":"字符串",
          "SiteCode": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
          "站点名称": "050001 -\tCHARNOCK RICHARD NTHBOUND MWSA 0755",
 "站点国家": "德国",
 "位置": {
 "纬度": "37.4224764",
 "经度": "122.0842499"
 },
          "卡组名称": "006240 FIRE BRIGHT SOLUTIONS",
 "收据编号": "1234",
 "产品代码": "10 - TMF 费用",
 "产品名称": "无铅汽油 - 高辛烷值",
 "产品组ID": 1,
 "产品组名称": "父产品组",
 "DelCo汇率": 0,
 "ColCo汇率": 0,
 "IsShellSite": true,
 "Network": "100013\tSTEINDORFER",
 "SiteGroupId": 202,
          "站点组名称": "CZ 9100 ECONOMY NETWORK",
 "记账日期": "字符串",
 "发卡行代码": "7002",
 "购买国家代码": "NL",
 "客户国家代码": "NL",
 "客户国家": "荷兰",
 "版本代码": "8",
 "卡组ID": "字符串",
 "卡序列号": "2",
 "校验位": "字符串",
          "车队ID描述": "字符串",
 "增值税税率": "0.20(对应20%)",
 "增值税类别": "1-零税率",
 "净金额增值税": 0,
 "增值税国家": "荷兰",
          "EffectiveDiscountInTrxCurrency": 0,
 "TransactionType": "刷卡购买,否则留空",
 "PINIndicator": "“使用了PIN码”",
 "VATApplicable": "Y",
          "净发票标记": "Y",
 "客户货币代码": "GBP",
 "客户货币符号": "£",
          "按客户货币计算的有效单位折扣": 0,
 "按客户货币计算的有效折扣": 0,
 "按客户货币计算的净金额增值税": 0,
 "DiscountType": "每单位2便士",
 "TransactionStatus": "U",
 "SalesItemId": 18315958002,
 "PayerGroup": "字符串",
          "付款方组名称": "12119008 - 壳牌集团",
 "退款标记": "字符串",
 "原始销售项目ID": "字符串",
 "Delco名称": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
 "Delco代码": "14",
 "付款人编号": "NL10042616",
 "付款人名称": "V.M. LE COMTE",
 "卡片有效期": "1901",
 "授权码": "1011256",
 "交易ID": "io9KVXk1UkW57XWKyeaHHg",
 "交易行号": "1",
 "允许清算": "Y",
          "CRM编号": "字符串",
 "争议状态": "无争议",
 "返利率": 28.279,
 "发卡行至收卡行汇率": 1,
 "净欧元金额": 0,
 "欧元增值税金额": 0,
 "上级客户编号": "字符串",
 "上级客户名称": "字符串",
 "上级客户ID": 0,
 "入站站点编号": "100021",
          "入站站点描述": "HN3 INTI_02-82.02",
          "入账货币代码": "GBP",
 "入账产品代码": "30",
 "借贷代码": "D",
 "更正标志": "Y",
 "附加信息1": "字符串",
          "Additional2": "字符串",
 "Additional3": "字符串",
          "Additional4": "字符串",
 "按客户货币净额计算的返利": -0.735,
 "按交易货币净额计算的返利": "AVEE PTUAZONW CUBFAO COSFS",
 "TrnIdentifier": "字符串",
 "CardType": "字符串",
 "DelcoListPriceUnitNet": 30.5,
 "DelcoRetailPriceUnitNet": 1.921,
 "DelcoRetailPriceUnitGross": 0,
          "Delco零售净值总额": 0,
 "Delco零售总值总额": 0,
 "客户零售总值(含税)": 0,
          "CustomerRetailValueTotalNet": 0,
 "EVPrintedNumber": "3792",
          "IsRFID": true,
 "TokenTypeDescription": "string"
 }
 ]
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 15
}

示例 3:获取定价交易摘要

请求:

POST /transaction-data/v1/pricedtransactionssummary

{
    "Filters": {
 "ColCoCode": 9,
 "PayerId": 12,
 "InvoiceStatus": "A",
 "FromDate": "2024-03-20",
 "ToDate": "2024-09-17",
 "PurchasedInCountryCode": "AT"
    }
}

响应:

{
  "RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
  "Status": "SUCCESS",
  "Data": [
    {
 "ProductId": 1234,
 "ProductCode": "10",
 "ProductName": "柴油 AGO",
 "ProductGroupId": 1,
      "ProductGroupName": "燃料",
 "TotalFuelQuantity": 1250.75,
 "TotalNetAmount": 5420.50,
 "TotalGrossAmount": 6504.60,
      "InvoiceCurrencyCode": "GBP",
 "InvoiceCurrencySymbol": "£",
      "客户零售净值总计": 5420.50,
 "客户零售毛值总计": 6504.60
    }
  ]
}

示例 4:获取定价摘要

请求:

 POST /transaction-data/v1/pricedsummary
 
 {
  "Filters": {
    "ColCoCode": 86,
    "PayerNumber": "GB000000123",
    "CardId": 275549,
    "FromDate": "20240225",
    "ToDate": "20240225",
    "FuelOnly": false
  }
}

响应:

{
    "RequestId": "5f1bded6-416d-4478-ab7f-33905d7b5d4b",
    "Status": "SUCCESS",
    "Data": [
 {
 "CustomerRetailValueTotalGross": 114.13,
 "CustomerRetailValueTotalNet": 95.11,
 "InvoiceCurrencyCode": "EUR",
 "InvoiceCurrencySymbol": "€",
            "ProductCode": "21",
 "ProductGroupId": 3,
 "ProductGroupName": "汽油",
 "产品ID": 21,
 "产品名称": "无铅汽油 - 高辛烷值",
 "站点组ID": 104,
 "站点组名称": "奥地利默认壳牌加油站",
 "燃油总量": 17.0,
 "总毛额": 114.13,
 "总净额": 95.11
 }
    ]
}

示例 5:获取多付款人定价交易

请求:

POST /transaction-data/v1/multipayerspricedtransactions

{
  "ColCoCode": 86,
  "Accounts": [
    {
 "PayerId": 12345,
 "PayerNumber": "GB987654322"
    },
    {
 "PayerId": 12346,
 "PayerNumber": "GB000000124"
    }
  ],
  "InvoiceStatus": "A",
  "FromDate": "20220101",
  "ToDate": "20220131",
  "PageSize": 50,
  "页": 1
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "Transactions": [
        {
 "Type": "SalesItem"
 }
 ],
 "CardId": 275549,
 "CardPAN": "7002051006629891000",
 "CardExpiry": "20250812",
 "交易日期": "20250812",
 "交易时间": "14:30:45",
 "UTC偏移量": "+01:00:00",
 "车队ID(输入)": "XYZ1234",
      "里程表读数输入": 12345,
 "司机姓名": "ANDREW GILBERRY",
 "车辆牌照": "MV65YLH",
 "发票货币代码": "GBP",
 "发票货币符号": "£",
 "交易货币代码": "GBP",
      "交易货币符号": "£",
 "交易净额": 47.71,
 "交易税额": 9.54,
 "交易总金额": 57.25,
      "发票净额": 47.71,
 "发票税额": 9.54,
 "发票总金额": 57.25,
 "购买国家": "德国",
      "账户ID": 29484,
 "账户号码": "GB99215176",
      "账户名称": "MATTHEW ALGIE & COMPANY LIMITED",
 "账户简称": "MATTHEW",
 "数量": 43.28,
 "燃料产品": true,
 "交易货币单位价格": 1.1074,
 "单位价格(发票货币)": 1.1024,
 "单位折扣(交易货币)": -0.005,
 "单位折扣(发票货币)": -0.0051,
 "已开票": true,
 "发票编号": "S04500493",
 "发票日期": "20250815 09:30:00",
 "SiteCode": "050001",
 "SiteName": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
 "SiteCountry": "德国",
 "Location": {
 "Latitude": "53.83606",
 "Longitude": "-1.61854"
 },
 "卡组名称": "006240 FIRE BRIGHT SOLUTIONS",
 "收据编号": "6803",
 "产品代码": "10",
 "产品名称": "无铅汽油 - 高辛烷值",
      "ProductGroupId": 2,
 "ProductGroupName": "所有燃料",
 "DelCoExchangeRate": 0.851858,
      "ColCoExchangeRate": 0.851858,
 "IsShellSite": true,
 "Network": "SHELL",
 "SiteGroupId": 202,
 "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
 "发布日期": "20250812 14:30:45",
 "发行方代码": "7002",
 "购买国家代码": "DE",
 "客户国家代码": "NL",
      "客户国家": "荷兰",
 "版本号": "8",
      "CardGroupId": "40000",
 "CardSequenceNumber": "617",
 "CheckDigit": "6",
 "FleetIDDescription": "YG67OUM",
      "增值税税率": 0.2,
 "增值税类别": "1-标准税率",
 "净金额增值税": 9.54,
 "增值税国家": "荷兰",
      "EffectiveDiscountInTrxCurrency": -0.22,
 "TransactionType": "Purchase",
 "PINIndicator": "PIN Used",
 "VATApplicable": "Y",
      "净发票标记": "N",
 "客户货币代码": "GBP",
 "客户货币符号": "£",
 "按客户货币计算的实际单位折扣": -0.0051,
 "按客户货币计算的实际折扣": -0.22,
 "按客户货币计算的净额增值税": 9.54,
      "DiscountType": "每单位2便士",
 "TransactionStatus": "I",
 "SalesItemId": 18315958002,
 "PayerGroup": "H312066",
 "PayerGroupName": "12119008 - 壳牌集团",
 "RefundFlag": "N",
 "OriginalSalesItemId": null,
 "DelcoName": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
 "DelcoCode": "014",
      "付款人账号": "GB987654322",
 "付款人名称": "V.M. LE COMTE",
 "卡片有效期": "2504",
 "AuthorisationCode": "011256",
 "TransactionId": "io9KVXk1UkW57XWKyeaHHg",
 "TransactionLine": "1",
 "AllowClearing": "Y",
      "CRMNumber": null,
 "DisputeStatus": "无争议",
      "返现率": 28.279,
 "发卡行至收单行汇率": 1,
 "欧元净金额": 56.01,
 "欧元增值税金额": 11.2,
 "父客户编号": "GB12121212",
 "父客户名称": "FUEL CARD SERVICES LTD",
 "父客户ID": 6494,
 "入站站点编号": "100021",
 "入站站点描述": "HN3 INTI_02-82.02",
 "入站货币代码": "GBP",
      "入账产品代码": "30",
 "借贷代码": "D",
 "更正标志": "N",
 "附加信息1": "GBALLEGO0002452",
 "Additional2": null,
 "Additional3": null,
 "Additional4": null,
      "按客户货币净金额计算的返利": -0.735,
 "按交易货币净金额计算的返利": -0.735,
      "交易标识符": "H305908971030",
 "卡类型": "GB STD FLT NAT SINGLE R9",
 "Delco 标价单位净额": 30.5,
      "Delco零售单价(净额)": 1.1074,
 "Delco零售单价(含税)": 1.32888,
      "Delco零售净值总计": 47.93,
 "Delco零售毛值总计": 57.52,
 "客户零售毛值单位": 1.32888,
 "客户零售净值总计": 47.93,
 "EVPrintedNumber": "3792",
 "IsRFID": true,
 "TokenTypeDescription": "车队卡"
    }
  ],
  "Page": 1,
  "PageSize": 20,
  "TotalPages": 15,
  "TotalRecords": 300
}

示例 6:获取基于用量的定价规则

请求:

POST /transaction-data/v1/volumebasedpricing

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "IncludeHistory": true,
  "IncludeCurrentPeriodVolume": true
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "Configuration": [
        {
 "定价账户ID": 123456,
 "定价账户编号": "GB000000123",
 "定价账户简称": "ABCD1234",
 "定价账户全称": "ABCD1234",
 "FeeRuleId": 12345,
 "FeeRuleDescription": "NL/GAGO/D018/UP0.0120>1",
 "FeeRuleDateEffective": "20231223",
 "FeeRuleDateTerminated": "20231223",
 "BonusPaidTo": "1-支付给付款人",
 "BonusPaidToAccountId": 123456,
 "BonusPaidToAccountNumber": "GB000000123",
 "奖金支付账户简称": "12345",
 "奖金支付账户全称": "GB000000123",
 "频率": "3-每周 – 周一",
          "下次计算日期": "20231223",
 "上次计算日期": "20231223",
 "费用规则依据": "3-一次性支付",
 "费用规则货币代码": "GBP",
          "费用规则货币符号": "£",
 "费用规则生效日期": "20231223",
          "费率规则有效至": "20231223",
 "费率规则适用地点": [
 {
 "DelcoId": 866,
              "国家": "英国",
 "国家代码": "UK",
 "燃料网络ID": 100007,
 "网络名称": "VALERO",
 "站点组ID": 100007,
 "站点组名称": "VALERO ENERGY LTD",
 "站点代码": 999493,
 "站点ID": 100007,
 "站点名称": "VALERO ENERGY LTD"
 }
 ],
 "收费规则产品": [
 {
 "产品组ID": 3,
 "产品组名称": "车用汽油",
 "ProductCode": "30 for Diesel AGO",
 "ProductId": "30 for Diesel AGO",
 "ProductName": "Diesel AGO"
 }
 ],
 "FeeRuleTiers": [
 {
 "TierMinimum": 1234,
 "TierMaximum": 1234,
 "Value": 1234.12
 }
 ]
 }
 ],
      "当前期间消耗量": [
 {
 "费用规则ID": 12345,
 "费用规则描述": "NL/GAGO/D018/UP0.0120>1",
 "价格规则ID": 100005,
 "价格规则描述": "PL/GAGO/GMOT/UL0.055",
 "总成交量": 10000.78,
 "下次费用生成日期": "20231223"
 }
 ],
 "历史记录": [
 {
 "起始日期": "20231223",
 "结束日期": "20231223",
 "费用规则ID": 8081,
 "费用规则描述": "PT/P067/D120/P4.0",
 "TotalVolume": 12356.66
 }
 ],
 "Warnings": [
 {
          "Message": "系统正在升级,暂停服务。",
 "Type": "系统停机"
 }
 ]
    }
  ]
}

示例 7:获取基于交易量的奖金规则

请求:

POST /transaction-data/v1/volumebasedbonus

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "IncludeHistory": true,
  "IncludeCurrentPeriodVolume": true
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "Configuration": [
 {
 "PricingAccountId": 123456,
 "PricingAccountNumber": "GB000000123",
 "定价账户简称": "MATTHEW",
 "定价账户全称": "MATTHEW",
 "费用规则ID": 1,
 "费用规则描述": "NL/GAGO/D018/UP0.0120>1",
          "费率规则生效日期": "20231223",
 "费率规则终止日期": "20231223",
 "奖金支付对象": "1-支付给付款人",
          "奖金支付对象账户ID": 123456,
 "奖金支付对象账号": "GB000000123",
 "奖金支付对象账户简称": "12345",
 "奖金支付对象账户全称": "GB000000123",
          "Frequency": "3-每周 – 周一",
 "NextCalculationDate": "20231223",
 "PreviousCalculatedDate": "20231223",
 "FeeRuleBasis": "3-一次性支付",
 "FeeRuleCurrencyCode": "GBP",
 "FeeRuleCurrencySymbol": "£",
 "FeeRuleAvailableFrom": "20231223",
          "费率规则有效至": "20231223",
 "费率规则适用地点": [
 {
 "DelcoId": 866,
              "国家": "英国",
 "国家代码": "UK",
 "燃料网络ID": 100007,
 "网络名称": "VALERO",
 "站点组ID": 100007,
 "站点组名称": "VALERO ENERGY LTD",
 "站点代码": 999493,
 "站点ID": 100007,
 "站点名称": "VALERO ENERGY LTD"
 }
 ],
 "FeeRuleProducts": [
 {
 "ProductGroupID": 3,
 "ProductGroupName": "车用汽油",
 "ProductCode": "30 for Diesel AGO",
 "ProductId": "30 for Diesel AGO",
 "ProductName": "Diesel AGO"
 }
 ],
 "FeeRuleTiers": [
            {
 "层级下限": 1234,
 "层级上限": 1234,
 "数值": 1234.12
 }
 ],
 "关联账户": [
 {
 "关联账户ID": 12345,
 "关联账户号码": "GB000000123",
 "关联账户简称": "账户简称",
 "关联账户全称": "账户全称"
 }
 ]
        }
 ],
 "当前期间消耗量": [
 {
 "费用规则ID": 12345,
 "费用规则描述": "NL/GAGO/D018/UP0.0120>1",
 "Month": 1,
 "Year": 2018,
 "TotalVolume": 10000.78
 }
 ],
      "HistoricalBonusPaid": [
 {
 "PayerId": 12345,
 "PayerNumber": "GB000000123",
 "PayerShortName": "Jorden",
 "PayerFullName": "MATTHEW",
 "AccountId": 123456,
 "AccountNumber": "GB000000123",
          "账户简称": "SALT",
 "账户全称": "ABCD1234",
 "发票账户ID": 12345,
          "发票账户号": "GB000000123",
 "发票账户简称": "DFE1234",
 "发票账户全称": "AZAD PVT LMT",
          "费率规则ID": 12345,
 "费率规则描述": "NL/GAGO/D018/UP0.0120>1",
 "起始日期": "20231223",
 "ToDate": "20231223",
 "BonusPaidTo": "5-支付给关联客户",
 "FeeItemId": 12345,
 "FeeRuleBasis": "2-溢价百分比",
 "费目货币代码": "GBP",
 "费目货币符号": "$",
 "按比例分摊销量": 123.12,
 "总销量": 123.12,
 "费用产品": "1562-壳牌柴油奖金",
          "发票总金额": 123.12,
 "发票净额": 123.12,
 "发票增值税金额": 123.12,
 "费用是否已取消": true,
          "费率项目分级按比例计算的体积": 123.12,
 "费率项目分级总体积": 123.12,
 "分级最低值": 123,
 "分级费率": 123.12
        }
 ]
    }
  ],
  "Warnings": [
    {
 "Message": "系统正在升级,暂不可用。",
 "Type": "系统停机"
    }
  ]
}

示例 8:获取费用摘要

请求:

POST /transaction-data/v1/feessummary

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "CardId": 275549,
  "InvoiceStatus": "I",
  "FromDate": "20240101",
  "ToDate": "20240131",
  "FeeTypeGroup": "Card Charges"
}

响应:

{
  "RequestId": "2b0cbe11-f109-4c43-9201-49af0370df1c",
  "Status": "SUCCESS",
  "Data": [
    {
 "FeeTypeGroup": "卡费",
 "FeeTypeId": 1,
 "FeeType": "卡年费",
 "ProductId": 1234,
      "ProductCode": "FEE",
 "ProductName": "卡费",
 "TotalFeeAmount": 125.00,
 "InvoiceCurrencyCode": "GBP",
 "InvoiceCurrencySymbol": "£"
    }
  ]
}

示例 9:获取交易异常

请求:

POST /transaction-data/v1/exceptions

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "TransactionsFromDate": "20231223",
  "TransactionsToDate": "20240131",
  "Value": 100,
  "Condition": 5,
  "OutputType": "Transaction"
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "CardsExceptions": [
 {
 "AccountId": 29484,
 "CardId": 1234,
          "PAN": "ABCD1234",
 "DriverName": "ANDREW GILBERRY",
 "VRN": "34235",
 "PayerId": 123455,
 "PayerNumber": "GB000000123",
 "AccountNumber": "GB99215176",
 "AccountShortName": "MATTHEW",
          "付款人简称": "MATTHEW",
 "日期": 2,
 "周": 2,
 "月": 5,
 "年": 2017,
 "TotalTransactions": 4,
 "TotalSalesItems": 4,
 "TotalQuantity": 261,
 "TotalAmount": 100.21,
 "CurrencyCode": "GBP",
 "货币符号": "$"
 }
 ],
 "交易异常": [
 {
 "销售项目ID": 18315958002,
 "卡号": 1234,
          "商品ID": 2,
 "交易GUID": "ABCD1234",
 "交易日期": "20231223",
 "客户发票总金额(含税)": 123.12,
 "CardPAN": "7002051006629891000",
 "CardExpiry": "20311223 12:12:12",
 "TransactionTime": "12:12:12",
 "UTCOffset": "+12:12:12",
 "车队ID": "XYZ1234",
 "里程表读数": 1234,
          "DriverName": "SALT",
 "VehicleRegistration": "MV65YLH",
 "InvoiceCurrencyCode": "GBP",
 "InvoiceCurrencySymbol": "$",
 "TransactionCurrencyCode": "GBP",
 "交易货币符号": "£",
 "交易净额": 123.12,
 "交易税额": 123.12,
 "交易总金额": 123.12,
          "发票净额": 123.12,
 "发票税额": 123.12,
 "发票总金额": 123.1,
          "采购国家": "法国",
 "账户ID": 1234,
 "账号": "GB99215176",
 "账户名称": "MATTHEW ALGIE & COMPANY LIMITED",
 "账户简称": "MATTHEW ALGIE & COMPANY LIMITED",
 "数量": 123.12,
 "燃料产品": true,
 "交易货币单价": 123.12,
          "单位价格(发票货币)": 123.12,
 "单位折扣(交易货币)": 123.12,
 "单位折扣(发票货币)": 123.12,
 "已开票": true,
          "发票编号": "S04500493",
 "发票日期": "20231223",
 "SiteCode": "50001",
 "SiteName": "CHARNOCK RICHARD NTHBOUND MWSA 0755",
 "SiteCountry": "德国",
          "Location": {
 "Lat": "37.4224764",
 "Lng": "122.0842499"
          },
 "卡组名称": "006240 FIRE BRIGHT SOLUTIONS",
 "收据编号": "1234",
 "产品代码": "TMF 费用",
 "产品名称": "无铅汽油 - 高辛烷值",
          "产品组ID": 1234,
 "产品组名称": "父产品组",
 "DelCo汇率": 123.12,
 "ColCo汇率": 123.12,
          "IsShellSite": true,
 "Network": "Shell PH",
 "SiteGroupId": 202,
 "SiteGroupName": "CZ 9100 ECONOMY NETWORK",
 "发布日期": "20231223 12:12:12",
 "发行方代码": "7077 = CRT",
 "购买国家代码": "NL",
 "客户国家代码": "NL",
 "客户国家": "荷兰",
          "ReleaseCode": "8 for 702188",
 "CardGroupId": "200",
 "CardSequenceNumber": "2",
 "CheckDigit": "GHE1234",
          "车队ID描述": "示例描述",
 "增值税税率": 0.2,
 "增值税类别": "3-免税",
 "净金额增值税": 12.21,
 "增值税国家": "荷兰",
          "EffectiveDiscountInTrxCurrency": 0,
 "TransactionType": "刷卡购买,否则留空",
 "PINIndicator": "Y",
 "VATApplicable": "Y",
 "NetInvoiceIndicator": "是",
 "客户货币代码": "GBP",
 "客户货币符号": "£",
 "客户货币中的有效单位折扣": 123.12,
 "客户货币中的有效折扣": 123.12,
          "客户货币净金额的增值税": 123.12,
 "折扣类型": "3-百分比",
 "交易状态": "U",
 "付款方组": "12119008",
 "退款标志": "N",
 "原始销售项目ID": "1231",
 "Delco名称": "SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV",
          "DelcoCode": "NL10042616",
 "PayerName": "V.M. LE COMTE",
 "CardExpiryPeriod": "1901",
 ""AuthorisationCode": "11256",
 "TransactionId": "io9KVXk1UkW57XWKyeaHHg",
 "TransactionLine": "1",
 "AllowClearing": "Y",
          "CRMNumber": "ABCD1234",
 "DisputeStatus": "6\t退款至网站",
          "返现率": 28.279,
 "发卡行与收单行汇率": 1,
 "净欧元金额": 37.93,
 "欧元返现金额": 0,
          "欧元增值税金额": 7.96,
 "父客户编号": "DRG1234"
 }
 ]
    }
  ]
}

示例 10:获取卡片使用摘要

请求:

POST /transaction-data/v1/cardusagesummary

{
  "ColCoId": 1,
  "ColCoCode": 86,
  "PayerId": 12345,
  "PayerNumber": "GB000000123",
  "AccountId": 1234,
  "AccountNumber": "GB000000123",
  "CardId": 1234,
  "PAN": "7882861007636000020",
  "CardExpiry": "20311223"
}

响应:

{
  "RequestId": "eb621f45-a543-4d9a-a934-2f223b263c42",
  "Status": "SUCCESS",
  "Data": [
    {
 "UsageSummary": [
 {
 "Date": "20170930",
 "ProductId": 1,
          "ProductCode": "2",
 "ProductName": "柴油 AGO",
 "IsFuelProduct": true,
 "SiteGroupId": 1234,
          "站点组名称": "UK 9500 高速公路网络",
 "总销量": 123.12,
 "总毛额": 123.12,
          "TotalNet": 123.12,
 "CurrencyCode": "GBP",
 "CurrencySymbol": "£",
 "ProductGroupId": 1234,
 "ProductGroupName": "汽油"
        }
 ]
    }
  ]
}

错误处理

常见错误代码

HTTP状态码 错误代码 描述 解决方案
200 不适用 状态:成功 不适用
200 E0001 验证错误 检查请求参数
401 E0003 未授权 验证 OAuth 令牌是否有效
403 E0003 禁止访问 检查用户 权限
404 E0005 资源未找到 请验证端点 URL 及资源是否存在
500 E0002 未知错误 / 内部服务器错误 联系支持

最佳实践

1. 采用 OAuth 2.0 身份验证

重要提示: 所有客户都应迁移至 OAuth 2.0 身份验证。实施正确的令牌 管理:

  • 缓存访问令牌并在过期前重复使用
  • 在令牌过期前进行刷新(建议提前60秒)
  • 安全存储客户端凭据(使用环境变量或密钥管理器)
  • 切勿在客户端代码中记录或暴露访问令牌

2. 使用请求 ID

始终包含唯一的 RequestId(GUID 格式),以确保端到端可追溯性

3. 实现分页

对于大型事务数据集,请使用分页以避免超时:

  • 设置适当的 PageSize
  • 按顺序或并行处理页面
  • 在响应中处理 (建议:50-100条记录)
  • 按顺序或并行处理各页
  • 处理响应中的TotalPages和TotalRecords

4. 合理使用日期过滤器

查询交易数据时:

  • 限制日期范围以避免结果集过大
  • 一致地使用 FromDate 和 ToDate 过滤器
  • 为获得更佳性能,可考虑按月或按周进行查询

5. 在沙箱环境中测试

在迁移至生产环境前,务必先在测试/沙箱环境中测试集成

6. 缓存参考数据

缓存基于交易量的定价规则和奖金规则,以最大限度减少 API 调用:

  • 这些规则更新频率较低
  • 定期刷新缓存(例如每天一次)
  • 仅在需要时使用 IncludeHistory 参数

SDK 与代码示例

Shell 提供官方 SDK 和全面的代码示例,以加速您与交易数据 API 的集成。

可用的 SDK 语言

  • Python - 功能齐全的 SDK,支持 OAuth 2.0 支持
  • TypeScript - 带完整类型定义的类型安全 SDK
  • Java - 企业级 SDK
  • C#/.NET - 完整的 .NET 集成
  • PHP - 易于易用的 PHP 库
  • Ruby - 用于无缝集成的 Ruby gem

查看官方 SDK 及文档

支持与资源

技术支持

文档

获取帮助

联系支持团队时,请提供:

  1. 您的 client_id(切勿透露您的 client_secret 或访问令牌)
  2. API 响应中的 RequestId
  3. 请求的时间戳
  4. 环境(生产/测试)

最后更新时间: 2026年6月16日
文档版本: 1.0
API 版本: 2.3.4

关于我们

壳牌开发者门户致力于协助合作伙伴接入壳牌API,并将创意转化为可投入生产的解决方案。

壳牌徽标

联系方式

登录您的账户

向 AI 助手咨询有关 Shell API 和 API 产品的问题