Skip to content

Material Document Data

This interface is applicable for data integration API, read Api Access Process first

Scenario

  • ODM inventory transfer, and ODM HUB information are required during calculation of ETA Accuracy
  • Such as: converting defective products into good products & ODM HUB GR, etc.

Request address

  • API
EnvironmentURL
Testhttps://api-cn-t.lenovo.com/uat/v1.0/supply_chain/scc/open_platform/data/sync/odm/material_doc
Prodhttps://api-cn.lenovo.com/v1.0/supply_chain/scc/open_platform/data/sync/odm/material_doc
  • FTP
EnvironmentPartner directoryLenovo directoryFile name
Test/Planning/SCC/{appName}/odm/material_doc//Planning/SCC/{appName}/odm/material_doc/feedback/material_doc_{crud}_{yyyyMMddHHmmss}_
Prod/Planning/SCC/{appName}/odm/material_doc//Planning/SCC/{appName}/odm/material_doc/feedback/material_doc_{crud}_{yyyyMMddHHmmss}_

Sample:/Planning/SCC/LCFC/odm/material_doc/material_doc_update_20220928123000_001

FrequencyTimeData amount
Daily or Real time00:00:00Daily version of data(Incremental)

Request data description

ParamKeyTypeRequiredLengthDescriptionExample
uidString32Unique id
odmYStringY40ODM nameLCFC
buYStringY50business unitISG
moving_track_numberYStringY50moving track number6901027745
odm_pnStringY1000ODM part numberBLXSB18C53808
odm_pn_descStringY1000ODM part number descriptionXXXX
lenovo_pnString100Lenovo part numberSB18C53808
material_typeStringY10DB/DS/BS/RBDS
mfg_pnString1000Manufacturing part numberXXX
qtyNumberY13,3moving quantity100
movement_dateDateYmovement date2022-08-01 00:00:00
movement_typeStringY10movement type:BTG/HUB IN/HUB OUT/GTB/V_GTB/V_BTG/V_TSF_IN/V_TSF_OUT
commodityStringY50commodity
odm_descString500ODM descriptionGOLD WIN TRADING (HK) LIMITED
versionStringY14version in format yyyyMMddHHmmss20220809070623
comment1String100reserved field
comment2String100reserved field
comment3String100reserved field

Response data description

ParamTypeDescription
codeString0: success, others:failed
msgStringthe detail message, especially useful on failure

Request sample

json
{
  "batch_id": "90497",
  "batch_size": 1,
  "seq_id": "1",
  "seq_size": 1,
  "data": [
    {
      "odm": "odm_1",
      "bu": "ISG",
      "moving_track_number": "6901027745",
      "odm_pn": "HG21100014",
      "odm_pn_desc": "ODM 物料描述",
      "lenovo_pn": "HG21100014",
      "material_type": "DB",
      "mfg_pn": "HG21100014",
      "qty": "10",
      "movement_date": "2022-09-15",
      "movement_type": "BTG",
      "commodity": "commodity",
      "odm_desc": "GOLDWINTRADING(HK)LIMITED",
      "version": "20220809070600",
      "comment1": "",
      "comment2": "",
      "comment3": ""
    }
  ]
}

Successful response sample

json
{
  "code": "0",
  "msg": "request success"
}

Failed response sample

json
{
    "code": "E00V00",
    "msg": "data verification failed!",
    "result": [{
        "row": {
            "odm": "LCFC",
            ...
        },
        "verify": [{
            "type": "value length exceed",
            "fields": "version"
        }]
    }]
}