Migrating from Supplier Direct Connect to SAGE Connect

Back

11672

Issue:

Suppliers currently utilizing Supplier Direct Connect services to update their information in SAGE should immediately begin migrating to the latest SAGE Connect services.  SAGE Direct Connect will be sunset in the near future.

Solution:

Migration to SAGE Connect for users already using Supplier Direct Connect should be a relatively simple task.  In general the services follow the same general structure, use JSON formatted data, and have the same general data structure.  The services differ in the endpoint used, the authentication scheme, and some of the data structures.

This article is not intended to be a comprehensive guide on implementation or migration to SAGE Connect for supplier services. You will need to refer to the document of the service(s) you wish to implement for full details.  The following is intended to point out the differences from the legacy service to jump start your migration.

Differences:

1.  Endpoint – The endpoint changes from https://www.promoplace.com/ws/ws.dll/SITK to https://www.promoplace.com/ws/ws.dll/ConnectAPI. 

2.  Service IDs –  SAGE Connect uses numeric service IDs for each service instead of names.  The following list are the service IDs that correspond to the various services (see full documentation for more info).

Service ID
Category List 101
Theme List 102
Inventory Update 106
Product Data Download 108
Product Data Update 109
Order Forms 501
Order Status Update 502
Order Status Requestors 503
Credit Card Transaction 801
Distributor Verification 901


3. Authentication – Legacy services originally utilized a username and password for authentication, and a later revision added support for using an Account ID and token.  SAGE Connect uses Account ID and authentication key exclusively.

Example showing SAGE Connect authentication:

{
    "serviceId": 101,
    "apiVer": 110,
    "auth": {
        "acctId": USER ACCT NUMBER,
        "key": "USER AUTHENTICATION KEY"
    }
}


4. Data Structures – SAGE Connect includes changes in some of the data structures. For example, the JSON data structure for the order status update is slightly different.  The data will need to be reformatted into the new structure.  See the following examples for how the new CustomerRec object is handled.  Refer to complete documentation for more information.

SAGE Connect Order Status Update example:
{
    "serviceId": 502,
    "apiVer": 110,
    "auth": {
        "acctId": USER ACCT NUMBER,
        "key": "USER AUTHENTICATION KEY"
    },
    "sageNum": 50000,
    "statusPackets": [{
        "timeStamp": "2016-07-29T17:10:41Z",
        "internalId": 123456,
        "customer":
          {
            "acctNum":"1000",
            "company": "ABC Distributors",
            "phone": "214.631.6000"
          },
        "orderNum": "123456",
        "poNum": "12345PO",
        "expectedShipDate": "2016-08-10",
        "statusId": "20"
    }]
}


Supplier Direct Connect Order Status Update example:

{
"Request": "OrderStatusUpdate",
"APIVer": "220",
"Auth": {
  "AcctID":USER ACCT NUMBER,
  "Token" : "TOKEN"
},
"SAGENum": 50000,
"StatusPackets": [
  {
    "TimeStamp":"2016-07-29T17:10:41Z",
    "InternalID":123456,
    "CustNum":1000,
    "CustName":"Joe Smith",
    "CustPhone":"214.631.6000",
    "OrderNum":"123456",
    "PONum":"12345PO",
    "ExpectedShipDate":"2016-08-10",
    "StatusID":"20"
  }
]
}

5. Capitalization – All of the fields in SAGE Connect use camelCase.  If your application or environment is case sensitive, you will need to change the case on the field names to match camelCase.

Users should migrate to using SAGE Direct Connect as soon as possible and conversion should require minimal effort.  For more information and documentation on SAGE Direct Connect please log in to http://www.sagemember.com and click on Developer APIs in the menu, then select SAGE Connect.

You may utilize the Developer Test Bench under the Developer APIs menu to test various requests and see the service response.  Please call us at 214.631.6000 opt 3 or email SAGE Support at support@sageworld.com with any questions.

Type: Info Publish Date: 7/6/2022 12:12:14 PM
Applies To: Other Last Updated: 9/25/2023 2:02:10 PM
Platform: All Expiration Date: