Validate Connection Options | BigCommerce Developer Center

Note

Substitute the host and path specific to the shipping provider for your_app.example.com and check_connection_options.

The Send a Test Request feature is not currently supported for this endpoint.

Validate connection options. BigCommerce sends a request to the shipping provider URL to check a merchantʼs connection credentials. The shipping provider sends a response indicating whether a merchant has valid credentials. > #### Note > * Substitute the host and path specific to the shipping provider for `your_app.example.com` and `check_connection_options`. > * The Send a Test Request feature is not currently supported for this endpoint.

Request

Check connection options request.

connection_optionsobjectRequired

Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional.

Response

Check connection options response.

validboolean

Indicates whether or not the connection options are valid.

messageslist of objects

1	import requests
2
3	url = "https://your_app.example.com/check_connection_options"
4
5	payload = {}
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.post(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"valid": true,
3	"messages": [
4	{
5	"text": "adipi",
6	"type": "WARNING"
7	},
8	{
9	"text": "nu",
10	"type": "WARNING"
11	},
12	{
13	"text": "an",
14	"type": "INFO"
15	}
16	]
17	}