getObject.php

SM JSON Object Export Service

Endpoint: GetObject.php

This service exports specific object data in JSON format.

Parameters:

• user: SM user name for authentication
• password: SM user password for authentication
• object: the type of object to export. Accepted values: address, item, transaction, event, category
• keyvalue: value of the key of the object to export. It can be a single number or a comma-separated list. The field for the key varies depending on the object:
  • address: AddressNr
  • item: ItemNr
  • transaction: BillNumber
  • event: EventNr
  • category: CatNr

Return values of the JSON structure:

• success: true or false
• status: numeric status, see table below for details
• data: JSON structure of the object or error message when failed

Remarks:

• The sm_views must be defined on the server (Database update/Table views or see definitions below)
• The data provided by the script can be imported using the UpdateObject.php script

Status codes:

• 0: Execution of the query ok
• 102: Cannot connect to database
• 103: Authentication failure
• 105: Object name unknown
• 106: No keyvalue specified
• 107: No object found
• 108: Error while executing query
• 110: Other error happened

Examples:

/GetObject.php?object=address&keyvalue=5244&user=user&password=password

Successful response

{
  "success": true,
  "status": 0,
  "data": {
    "AddressNr": "5244",
    "Status": "-1",
    "Name1": "Páleníkkkk",
    "Name2": "Jozef",
    "Title": "",
    "Address1": "1990-05-16",
    "Address2": "11",
    "Address3": "",
    "Address4": "841 07",
    "Address5": "Bratislava20",
    "Address6": "SK",
    "DeliveryAddress1": "Jozef Páleníkkkk11Bratislava20841 07SK",
    "ContactPerson": "",
    "SalutationNr": "2",
    "AddressTypeNr": "15",
    "Phone_d": "+41311234567",
    "Phone_p": null,
    "Fax": null,
    "Modem": null,
    "Radio": null,
    "eMail": "jozef.palenik@adega.ch",
    "URL": null,
    "Photo": null,
    "Bankname": null,
    "BankAccount": null,
    "BankCode": null,
    "IBAN": null,
    "BIC": null,
    "PostAccount": null,
    "AddressInformation": null,
    "CustomerNr": null,
    "MinimalOrder": "0",
    "DeliverInformation": null,
    "Sales": null,
    "ElectronicOrder": "0",
    "Protocol": null,
    "Name1beforeName2": "0",
    "AddressActive": null,
    "CurrencyNr": "0",
    "VAT_free": "0",
    "MaximalAmount": null,
    "DiscountNr": "0",
    "DeliveryDuration": null,
    "DeliveryDays": null,
    "OrderDate": null,
    "ModificationMarks": "0",
    "FDB_Link1": "[]",
    "FDB_Link2": "",
    "LCostAmount": "0",
    "LCostFactor0": "1",
    "LCostFactor1": "1",
    "LCostFactor2": "1",
    "LCostFactor3": "1",
    "LastUpdate": "2024-02-27 15:00:32",
    "ParentNr": "0",
    "BranchNr": "5",
    "AddressGroup": "0",
    "LanguageNr": "1",
    "AddressText": null,
    "AddressAddon": null,
    "AddressDesc": null,
    "Sales_P1": "0",
    "Sales_P2": "0",
    "AddressNumber": "d865dd68-f182-4c47-b780-1ff0a73b8ac0",
    "PurchaseAmount": null,
    "ReturnsAmount": null,
    "CustomerNumber": "0000009430648",
    "ContactInformation": null,
    "Time_Stamp": null,
    "PricelevelNr": null,
    "ControlID": null,
    "VATNr": null,
    "PaymentDeadline": null,
    "OrderInterval": null,
    "OrderDays": null,
    "details": [
      {
        "FieldNr": "17",
        "Fieldvalue": "1990-05-16",
        "languageNr": "1",
        "AliasName": "birthdate"
      },
      {
        "FieldNr": "18",
        "Fieldvalue": "FEMALE",
        "languageNr": "1",
        "AliasName": "sex"
      },
      {
        "FieldNr": "19",
        "Fieldvalue": "UNDEFINED",
        "languageNr": "1",
        "AliasName": "generalmarketing"
      },
      {
        "FieldNr": "20",
        "Fieldvalue": "false",
        "languageNr": "1",
        "AliasName": "terms"
      },
      {
        "FieldNr": "24",
        "Fieldvalue": "jozef.palenik+sp@adega.ch",
        "languageNr": "1",
        "AliasName": "loginemail"
      },
      {
        "FieldNr": "25",
        "Fieldvalue": "false",
        "languageNr": "1",
        "AliasName": "fairtiqenabled"
      },
      {
        "FieldNr": "27",
        "Fieldvalue": "7LHXscqwAAEAAAGMz7PtCjYBnnrYAPz_",
        "languageNr": "1",
        "AliasName": "cardnumber"
      },
      {
        "FieldNr": "28",
        "Fieldvalue": "06",
        "languageNr": "1",
        "AliasName": "cardmonth"
      },
      {
        "FieldNr": "29",
        "Fieldvalue": "25",
        "languageNr": "1",
        "AliasName": "cardyear"
      },
      {
        "FieldNr": "32",
        "Fieldvalue": "7LHXscqwAAEAAAGNrTchT-FZnT6uAH5P",
        "languageNr": "1",
        "AliasName": "merchandid"
      },
      {
        "FieldNr": "35",
        "Fieldvalue": "1022",
        "languageNr": "1",
        "AliasName": "cardaccount"
      },
      {
        "FieldNr": "36",
        "Fieldvalue": "WERBUNG",
        "languageNr": "1",
        "AliasName": "eventmarketing"
      },
      {
        "FieldNr": "37",
        "Fieldvalue": "KEINE_WERBUNG",
        "languageNr": "1",
        "AliasName": "cartransportmarketing"
      },
      {
        "FieldNr": "38",
        "Fieldvalue": "KEINE_WERBUNG",
        "languageNr": "1",
        "AliasName": "constructionmarketing"
      },
      {
        "FieldNr": "39",
        "Fieldvalue": "KEINE_WERBUNG",
        "languageNr": "1",
        "AliasName": "familymarketing"
      },
      {
        "FieldNr": "40",
        "Fieldvalue": "KEINE_WERBUNG",
        "languageNr": "1",
        "AliasName": "holidaymarketing"
      },
      {
        "FieldNr": "41",
        "Fieldvalue": "KEINE_WERBUNG",
        "languageNr": "1",
        "AliasName": "mobilitymarketing"
      }
    ]
  }
}