Shipping APIs
/Carrier
//Update Carrier
The Update Carrier operation enables you to update a carrier account and specifies its usable capabilities. By default, all available services, parcel types, and special services provided by the carrier are accessible. With this API, you can specify only the capabilities (services, parcel types, special services) that should be available for Rate Shop and Create Shipment operations. If a shipment request attempts to use a capability not enabled through this API, an error will be returned.
Security
bearerAuth
It defines the carrier ID, can be get from Get Carriers API
Enum:"FEDEX""UPS""DHLEXP""SPEEDEE""NORATE"
Example:"FEDEX"
- https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmthttps://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}
- Sandbox Server for Carrier Accounthttps://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}
- Sandbox Server for Hub APIhttps://api-sandbox.sendpro360.pitneybowes.com/metadata/api/v1/carrierAccounts/{carrierAccountID}
- Production Server for Carrier Account (uses live data)https://api.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}
- Production Server for Hub API (uses live data)https://api.sendpro360.pitneybowes.com/metadata/api/v1/carrierAccounts/{carrierAccountID}
- Sandbox Server for Canadahttps://api-ppd.shipping360.pitneybowes.com/ca/shipping/api/v1/carrierAccounts/{carrierAccountID}
- Production Server for Canadahttps://api.shipping360.pitneybowes.com/ca/shipping/api/v1/carrierAccounts/{carrierAccountID}
curl -i -X PUT \
'https://api-sandbox.sendpro360.pitneybowes.com/carrieraccountmgmt/api/v1/carrierAccounts/{carrierAccountID}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-PB-Developer-Partner-ID: string' \
-d '{
"accountNumber": "123338",
"carrierID": "FEDEX",
"description": "FedEx Account",
"parameters": {
"username": "abcjsk",
"password": "*******",
"accountAddress": {
"addressLine1": "27 Watervw Dr",
"city": "shelton",
"state": "CT",
"postalCode": "06484",
"countryCode": "US",
"email": "",
"company": "",
"name": "",
"phone": ""
},
"contactAddress": {
"addressLine1": "27 Watervw Dr",
"city": "shelton",
"state": "CT",
"postalCode": "06484",
"countryCode": "US",
"email": "",
"company": "",
"name": "",
"phone": ""
},
"hubID": "1544",
"invoiceAmount": "2121",
"invoiceControlID": "123D",
"invoiceDate": "20201203",
"invoiceNumber": "saas212121",
"hostName": "gppprt2ftp-ext.test.com",
"manifestUserId": "testuser",
"manifestPassword": "testpassword",
"manifestPath": "/in",
"capabilities": {
"services": [
"NDA"
],
"parcelTypes": [
"LTR"
],
"specialServices": [
"INS"
]
}
}
}'Carrier Added Successfully
It defines the carrier ID, can be get from Get Carriers API
Enum:"FEDEX""UPS""DHLEXP"
Example:"FEDEX"
Response
{ "carrierAccountID": "abc3849", "accountNumber": "123338", "carrierID": "FEDEX", "description": "FedEx Account", "carrierAccountType": "Shipping", "provisioningType": "API", "parameters": { "username": "abcjsk", "accountAddress": { "addressLine1": "27 Watervw Dr", "city": "shelton", "state": "CT", "postalCode": "06484", "countryCode": "US", "email": "", "company": "", "name": "", "phone": "" }, "contactAddress": { "addressLine1": "27 Watervw Dr", "city": "shelton", "state": "CT", "postalCode": "06484", "countryCode": "US", "email": "", "company": "", "name": "", "phone": "" }, "hubID": "1544", "invoiceAmount": "2121", "invoiceControlID": "123D", "invoiceDate": "20201203", "invoiceNumber": "saas212121", "capabilities": { "services": [ … ], "parcelTypes": [ … ], "specialServices": [ … ] } }, "permission": { "permissionByEntity": "ORG", "permissionByValue": "12345" } }