Error Code

• This section provides a mapping between v2 and v3 API error codes and their corresponding reasons.
• How error reasons are presented:
  • In v2 API, the reason field contains an Error Code representing the issue.
  • In v3 API, the reason field contains a Description instead of a numeric code.

Error Code	Description	Message
1	RESOURCE_DUPLICATED	Duplicate
2	SHIPMENT_INTERNAL	Error from internal shipment API
3	RESOURCE_NOT_FOUND	Resource not found
4	CREDIT_NOT_ENOUGH	Insufficient credits
5	COLLECT_NOT_ACCEPT	Invalid LineCd or B/L; unable to retrieve
6	VERIFY_FAIL	Validation failed
7	CONTRACT_NOT_FOUND	Contract not found
8	UNAUTHORIZED	Authentication failed
9	RESOURCE_FULL	Exceeded resource limit
10	TRADLINX_CREDIT_INTERNAL	Error checking Tradlinx credit balance
11	INVALID_REQUEST	Invalid user request
12	CONTRACT_EXPIRED	Contract has expired
13	DISAGREE_SHIPGO_USER_TERM	User terms not agreed to
14	UNSUPPORTED_FEATURE	Feature not supported in current plan
1000	UNKNOWN	Undefined error

Example Response

V2 API Example

{
	"api_version": "v2",
	"transaction_time": "2024-11-14T04:40:30.790634",
	"content": {
	"success": [],
	"fail": [
		{
			"data": {
				"line_cd": "HMM",
				"bl_no": "BL123456789"
			},
			"reason": "5"
		}
	],
		"total_count": 1,
		"success_count": 0,
		"fail_count": 1
	}
}

V3 API Example

{
	"api_version": "v3",
	"transaction_time": "2024-11-14T04:40:30.790634",
	"content": {
		"success": [],
		"fail": [
			{
				"data": {
					"line_cd": "HMM",
					"bl_no": "BL123456789"
				},
				"reason": "COLLECT_NOT_ACCEPT"
			}
		],
		"total_count": 1,
		"success_count": 0,
		"fail_count": 1
		}
}

Summary

• v2 API: Use Error Code code for reason (e.g. "5").
• v3 API: Use Description for the reason (e.g. "COLLECT_NOT_ACCEPT").
• The two APIs provide the same error information in different ways.