Coverage Rate
https://bioderma.naos.clicksend.com.mx/api/v1/coverageRate
Method: POST
Method Objective:
The service checks if the destination address is covered by the courier service and provides the shipping cost based on the address, package dimensions, and weight.
Headers
Accept
Content-Type
Authorization
application/json
application/json
Bearer {ACCESS_TOKEN}
Body RAW
Request:
Field | Type | Description |
---|---|---|
[origin] country | String | Origin country |
[origin] postal_code | String | Origin postal code |
[origin] province | String | Origin province |
[origin] city | String | Origin city |
[origin] name | String | Origin Name |
[origin] address1 | String | Origin address, limit 45 characters |
[origin] address2 | String | Origin address, limit 45 characters |
[origin] phone | String | Origin phone |
[origin] email | String | Origin email |
[origin] company_name | String | Origin company name |
[destination] country | String | Customer's country |
[destination] postal_code * | String | Customer's postal code |
[destination] province * | String | Customer's province |
[destination] city * | String | Customer's city |
[destination] name | String | Customer's name |
[destination] address1 * | String | Customer's address |
[destination] address2 | String | Customer's address |
[destination] phone | String | Customer's phone |
[destination] email | String | Customer's email |
[items] name * | String | Name of the product |
[items] sku * | String | SKU of the product |
[items] quantity * | Number | Quantity of the product |
[items] grams | Number | Weight of the product in grams |
[items] price * | Number | Price of the product |
[items] height | Number | Height of the package, min: 1, max: 9999999 |
[items] width | Number | Width of the package, min: 1, max: 9999999 |
[items] length | Number | Length of the package, min: 1, max: 9999999 |
[items] product_id | String | ID product |
[discount_codes] code | String | Discount code |
[discount_codes] amount | Number | Discount amount |
[discount_codes] type | String | Discount type |
Response:
200 OK
Field | Type | Description |
---|---|---|
status_rate | string | Status rate response of the request |
carrier | String | Name of the courier |
carrier_service | String | A unique code associated with the courier |
carrier_description | String | Description of the courier |
price_rate | String | Price of the courier |
delivery_days | String | Parcel delivery days |
Validation errors, token is required for the request.
401 Error
Field | Type | Description |
---|---|---|
error | string | Name of the field and message, mandatory in the request |
code | String | Error code in the request |