Update Defaults

This operation updates the values set for Defaults.

SecuritybearerAuth

Request

path Parameters

defaultID

required

string

This is unique identifier assigned to Defaults while its creation using CreateDefaults API.

Request Body schema: application/json

name	string Name of the Default.
defaultID	string A unique identifier to be assigned to the Default.
	object (sendingOptions) Sending Options will include carrier and its account details, sender details, and parcel details.

Responses

200

Defaults (i.e., default values) have been updated successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/defaults/{defaultID}

Request samples

application/json

{"name": "FedEx-Defaults",
"defaultID": "0d4f3c51-059b-4c28-a83b-a8defa2962cc",
"sendingOptions": {"carrier": "FedEx",
"service": "2DA",
"carrierAccounts": {"USPS": "JYKEb4VQvoVx!",
"FEDEX": "WRF4VFUUJDx!"
},
"labelSize": "DOC_4X6",
"labelType": "SHIPPING_LABEL",
"labelFormat": "PDF",
"fromAddress": {"name": "Sender Name",
"addressLine1": "3010 Summer Street",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"company": "PB",
"email": "testuser@gmail.com",
"phone": "416 123-4567",
"cityTown": "OTTAWA",
"stateProvince": "ON",
"postalCode": "K1A0B2",
"inductionPostalCode": "06905",
"countryCode": "CA",
"residential": true
},
"parcel": {"length": 2,
"width": 1,
"height": 1,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 2,
"packageValue": 2
}
}
}

Response samples

application/json

[{"errorCode": "validation_error",
"errorDescription": "Error while getting rates for carrier with carrierAccount eRMnRx4mzPP.",
"additionalCode": "string",
"additionalInfo": "string",
"additionalParameters": ["string"
]
}
]