post

/shipping/carrier/connection

Creates a Carrier Connection.

Carrier connections refer to specific settings required to connect to a specific shipping carrier. Each carrier requires your app to supply a unique set of properties/fields to establish a connection with that carrier.

Notes:

  • There is no GET with this resource. It has PUT, POST and DELETE.

    • PUT is used to update. The connection can be updated via API.
  • Connections created here do not enable the shipping method. To enable the carrier for a shipping zone, use the Shipping Methods API.

  • The Carrier Connection resource returns a 204 for both succesful and unsuccesful attempts to connect. If a field is missing, it will return a 400.

Australia Post

Sample Request – PUT or POST

{
	"carrier_id" : "auspost",
	"connection" : {
		"auth_key" : "yourAusPostAuthKey",
		"test_mode" : false
	}
}

Sample Request – DELETE

{
	"carrier_id" : "auspost"
}

Australia Post Connection Object – Properties

Australia Post PUT or POST requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) DELETE requests require only a carrier_id.

Property Type Description
auth_key string Australia Post authorization key.
test_mode boolean Whether or not to use Australia Post test-mode settings. Acceptable values are true or false.

Endicia

USPS is connected through Endicia.

Sample Request – PUT or POST

{	"carrier_id" : "endicia",
	"connection": {
		"account_id" : "yourEndiciaAccountId",
		"pass_phrase" : "yourEndiciaPassphrase"
	}
}

Sample Request – DELETE

{
	"carrier_id" : "endicia"
}

Endicia Connection Object – Properties

Endicia PUT or POST requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) DELETE requests require only a carrier_id.

Property Type Description
account_id string Endicia account ID.
passphrase string Endicia passphrase.

FedEx

Sample Request – PUT or POST

{
	"carrier_id" : "fedex",
	"connection" : {
		"key" : "yourFedexKey",
		"password" : "yourFedexPassword",
		"account_number" : "yourFedexAccountNumber",
		"meter_number" : "yourFedexMeterNumber"
	}
}

Sample Request – DELETE

{
	"carrier_id" : "fedex"
}

FedEx Connection Object – Properties

FedEx PUT or POST requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) DELETE requests require only a carrier_id.

Property Type Description
key string FedEx account ID.
password string FedEx passphrase.
account_number string FedEx account number.
meter_number string FedEx meter number.

Royal Mail

Sample Request - PUT or POST

{
    "carrier_id" : "royalmail",
    "connection" : {
        
    }
}

Sample Request - DELETE

{
    "carrier_id" : "royalmail"
}

Royal Mail Connection Object - Properties

Royal Mail has no connection object properties.

Zoom2U

Sample Request – PUT or POST

{
	"carrier_id" : "zoom2u",
	"connection" : {
		"auth_key" : "yourZoom2uAuthKey",
		"test_mode" : false
	}
}

Sample Request – DELETE

{
	"carrier_id" : "zoom2u"
}

Zoom2U Connection Object – Properties

Zoom2U PUT or POST requests require all of the following properties. (These requests won’t be fulfilled unless these properties are valid.) DELETE requests require only a carrier_id.

Property Type Description
auth_key string Zoom2U authorization key.
test_mode boolean Whether or not to use Zoom2U test-mode settings. Acceptable values are true or false.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
carrier_id
string
connection
object

connection object varies by carrier

Responses

Returns if request was succesful

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token