Validate Connection

This method is called to validate the connection information for a given order source.

Request

Request Body schema: application/json

transaction_id required	string <guid> A randomly generated transaction ID, used to correlate the request and response
required	object The authorization information necessary to fulfill this request.

Responses

200

The connection is valid

400

A response to indicate that there was either a module level client error or an external client error.

401

A response to indicate that the request failed to authenticate with the shipping provider.

404

A response to indicate that the module does not implement this endpoint.

429

A response indicates that the shipping service provider has denied a request due to too many requests.

500

A response indicating a server level error with the module.

520

A response indicating a server level error with the external world.

post/validate_connection

Request samples

Payload

application/json

{"transaction_id": "string",
"auth": {"order_source_api_code": "string",
"username": "string",
"password": "string",
"access_token": "string",
"api_key": "string",
"url": "string",
"connection_context": {"property1": "string",
"property2": "string"
},
"connection_name": "string"
}
}

Response samples

application/json

{"detailed_errors": [{"standardized_error_code": "external_client_error",
"external_error_code": "SYS_0001",
"message": "This is a made up error message",
"external_http_status_code": 400,
"raw_external_context": "{transaction_id:'fake_transaction_id', error_code:'SYS_0001', error_message:'This is a made up error message' "
},
{"standardized_error_code": "validation",
"message": "This error represents a validation failure within the module."
}
]
}