Reference Data

Meet the next generation of supply chain data consistency. With Shipwell's cutting-edge reference data standards, your data stays consistent across APIs and integrations. For example, with the Shipwell Charge Codes Standard, you may use the same charge codes across Shipwell APIs and Shipwell will also handle normalizing and ensuring charge code consistency across integrations and service providers. Say goodbye to mismatched data and hello to seamless connectivity.

Shipwell is the standard that brings everything together—effortlessly. It's not just smart. It's scalable. Unify your supply chain, get powerful data, and get the capabilities you need with Shipwell.

Spreadsheet

The following spreadsheet file contains a quick view of the reference data that you may view in a tabular format.

API Endpoints

The {{baseUrl}} in the URL formats below indicates that this should be replaced with the "base URL" of the environment and API. The {{baseUrl}} = {{scheme}}://{{environmentHost}}/{{basePath}}.

For example:

• https://sandbox-api.shipwell.com/v2 as the {{baseUrl}} for a sandbox endpoint is constructed using the following information:
  • {{scheme}} = "https" (aka HTTP protocol or scheme) is "https"
  • {{environmentHost}} = "sandbox-api.shipwell.com" is dependent on the environment [i.e. "sandbox-api.shipwell.com" (sandbox), "api.shipwell.com" (production), etc.]
  • {{basePath}} = "/v2" is dependent on the endpoint, but is typically "/v2" or "" (no base path for next generation endpoints like Orders )

Reference Data Endpoints

The following is a table that links to the API Reference details (that notes the request and response details for each API endpoint) on each reference data endpoint in the Type column, provides the URL Endpoint Template, and a Description of the reference data.

Shipwell Charge Codes Standard

Shipwell has a Shipwell Charge Codes Standard that ensures that charge codes are consistent across the platform and in integrations. The Shipwell Charge Codes Standard is available as reference data.

Versions

Over time different charge codes will be added and Shipwell will version this data in case other systems have breaking changes if/when new charge codes are introduced. For most systems additive changes are not breaking, but for some typed programming languages or hardcoded charge codes it is useful to have a static list at a point in time.

• If your API or user token has a set version of the API then this is utilized as the version even when you do not specify the version. Typically, this is a company-level setting in your account.
• If you do not have a set version of the API set as a fallback version, then the version defaults to the latest version (note: versions/version numbers are dates)
• If you specify the X-Shipwell-Version request header when making a request, that will override the API version utilized in the request
• Learn more about Shipwell API versioning here .

Specifying Version Header

If you make an API call to GET /reference-data/charge-codes (see API reference), by default the latest version of the Shipwell Charge Codes Standard will be returned unless your account, API token, or API key is set to a particular API version in your company settings. You may override or specify a different version of the charge codes standard by passing the X-Shipwell-Version request header.

curl --location --request GET 'https://sandbox-api.shipwell.com/reference-data/charge-codes/' \
--header 'Content-Type: application/json' \
--header 'Authorization: YOUR_AUTHORIZATION_HEADER' \
--header 'X-Shipwell-Version: 2024-06-11'

import requests

base_path = ""
host = "sandbox-api.shipwell.com"
target_url = "https://" + host + base_path + "/reference-data/charge-codes/" 
shipwell_version = "2024-06-11"

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_AUTHORIZATION_HEADER",
    "X-Shipwell-Version": shipwell_version
}

response = requests.get(target_url, headers=headers)
data = response.json()
print(data)

import java.io.IOException;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

OkHttpClient client = new OkHttpClient();

String basePath = "";
String host = "sandbox-api.shipwell.com";
String targetUrl = "https://" +
  host +
  base_path +
  "/reference-data/charge-codes/";
  
String shipwellVersion = "2024-06-11";

Request request = new Request.Builder()
    .url(targetUrl)
    .header("Content-Type", "application/json")
    .header("Authorization", "YOUR_AUTHORIZATION_HEADER")
    .header("X-Shipwell-Version", shipwellVersion)
    .build();

try (Response response = client.newCall(request).execute()) {
    if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
    response.body().string();
}