Fxiaoke Developer Manual Fxiaoke Developer Manual
  • APL Development Manual
  • PWC Development Manual
  • OpenAPI Documentation
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start
  • API Authorization
  • API Basics
  • OpenAPI
  • SSO Integration
  • Client Development
  • FAQ
  • OpenApi Version V1 (opens new window)
  • 简体中文
  • English
  • Quick Start

  • API Authorization

  • API Basics

  • OpenAPI

    • CRM Object API

    • CRM Common API

    • Address Book API

    • Other API

      • Task Todo API

      • Attendance Field Work API

      • Collaborative Approval API

      • Enterprise Connect API

      • Message API

      • Material Management API

      • Network Disk API

      • Marketing API

      • File Service

      • ERP API

        • ERP External Data Push API
        • BI API

        • Offline API

    • SSO Integration

    • Client Development

    • FAQ

    Table of Contents

    ERP External Data Push API

    # Description

    ERP provides external data push interfaces.

    # Request Specification

    Method: POST + application/json

    Endpoint: https://${Cloud Domain}/cgi/crm/erp/syncdata/objdata/push?thirdTraceId=${Random String}

    Headers: Refer to Common Parameters

    # Request Parameters

    Parameter Type Required Description
    data Map Yes Dataset
      objAPIName String No ERP object API name
      dataCenterId String No Data center ID (Can be found in CRM admin console - Connector - Connection Objects - Generate API push interface)
      id String No When id is provided, the data body follows standard ERP integration platform format. When omitted, indicates non-standard format requiring push interface function configuration
      masterFieldVal Map No Master object data
      detailFieldVals Map No Detail object data list
      directSync Boolean No Whether to sync in real-time
      destObjectApiName String No Target object API name (Required for real-time sync)

    # Request Example

    {
      "data": {
        "detailFieldVals": {
          "erpSalesOrderProductObj": [
            {
              "number": "04270002-0001",
              "product_id": "000",
              "product_price": "100",
              "sales_price": "100"
            }
          ]
        },
        "directSync": false,
        "destObjectApiName": "erpSalesOrderProductObj",
        "objAPIName": "erpSalesOrderObj",
        "dataCenterId": "63f82854a8bd974420925e83",
        "masterFieldVal": {
          "number": "04270002",
          "order_account_id": "042700001",
          "order_origin_price": "100",
          "sales_order_discount_price": "100",
          "receiver_phone": "1900901091021"
        },
        "id": "111"
      }
    }
    

    # Response Parameters

    Parameter Type Description
    traceId string Unique request ID
    errorDescription string Error description
    errorMessage string Error message
    errorCode Int Error codes

    # Response Example

    {
      "traceId": "E-O.827xxxxxx",
      "errorDescription": "success",
      "errorMessage": "OK",
      "errorCode": 0
    }
    

    # Notes

    • Do not use the message field in the response for logical judgments as errorMessage may change;
    Generate File Preview URL
    BI Table Join API

    ← Generate File Preview URL BI Table Join API→

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式