ShipStation API / Connector Upgrade Guidelines (May 2024)

First published on: 05/13/2024/3:52 pm

Overview

ShipStation is currently undergoing an upgrade aimed at accommodating larger ShipStation order IDs, thereby ensuring sustained service quality and scalability. As part of this enhancement, the system will transition from utilizing 32-bit to 64-bit architecture. 

Presently, when orders are generated via ShipStation's API, the system returns a ShipStation Order ID in the form of a 32-bit integer. Integration workflows facilitated by Saltbox store these ShipStation Order IDs SAP B1 / ERP. However, this arrangement is slated to be altered effective May 30th, with ShipStation Order IDs transitioning to 64-bit integers, allowing for up to 20 numeric values.

Saltbox workflows may be impacted by this upgrade, particularly those that involve the storage of ShipStation Order IDs in ERP databases like SAP B1 or other ERPs. 

This document provides guidance on upgrading the Saltbox ShipStation integration to ensure seamless compatibility between Saltbox and ShipStation and to eliminate any potential workflow disruption.

The modifications to ShipStation's API will affect the functionality of the following starter workflows:  

1. SAP B1 AR Invoice to ShipStation Order 

2. SAP B1 Delivery to ShipStation Order 

3. SAP B1 Order to ShipStation Order 

4. SAP B1 Pick List to ShipStation Order 

5. ShipStation Order to SAP B1 Order 

6. SAP B1 Pick List to ShipStation Order 

This change will take effect on May 30th, 2024, and will affect all Saltbox customers with a live ShipStation integration. Failure to upgrade customer environments before this date may result in failed workflows. 

Projects in implementation will also need to be upgraded.  

NOTE: if your customer is in the Vision33 Public Cloud (MTE) please make sure Dan Love is aware of the planned upgrade.  

Solution

If Saltbox ShipStation integration workflows are currently storing ShipStation Order IDs in SAP B1 or other ERP systems, it's imperative to adjust the data size of the User Defined Fields (UDFs).

For SAP B1 starter workflows, Saltbox employs the UDFs U_V33SB_ShipStationOrderId and V33SB_ShipStationLineId on the marketing documents.

If these UDFs are configured as alphanumeric, their size should be increased to 50 characters.

Conversely, if configured as numeric, the size should be increased to 25 digits. 

To prevent potential integration and data issues, it's necessary to schedule SAP B1 downtime to implement these changes.

Note: For SAP B1 HANA customers, it's advisable to restart the service layer to ensure the changes take effect. Please create a TOTALCare support ticket for assistance with restarting the service. 

Test Workflow(s)

It is recommended to perform thorough testing and monitoring of all workflows running on the Saltbox integration project subsequent to the UDFs data size upgrades. In the event of any concerns or issues, please do not hesitate to contact the Saltbox Product Success team promptly.

Estimates

It is important to note that below estimates may vary significantly depending on each customer's and number of UDFs utilized by workflow.

Previous

Next