Finds the rates/charges for a given set of lookup criteria.

Request

header Parameters

ShipStation-TransactionID required	string
request-date	string

Request Body schema: application/json

Array

ship_engine_connect_app_id required	string (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}... Stringified UUIDv4. See RFC 4112
rate_request_identifier required	string An optional identifier that the Carrier App can provide in the rate request. Helpful when multiple quotes are requested at once. Another use case would be to compute a hash based on the shipment configuration and use this as the key in a caching strategy within the Carrier App.
external_rate_card_id required	string Indicates which rate card to use when rating the shipment. This will correspond to the external_id used when creating/editing a rate card via the /RateCards endpoint.
required	object (Shipment)
explain	boolean Default: "false" Should the request include rate calculation information in the response

Responses

200

422

Validation Failed

post/rates

Request samples

Payload

application/json

[{"ship_engine_connect_app_id": "string",
"rate_request_identifier": "string",
"external_rate_card_id": "string",
"shipment": {"service_code": "string",
"ship_datetime": "string",
"confirmation": "none",
"insurance_provider": "string",
"advanced_options": {"contains_alcohol": true,
"no_postage": true,
"nonmachinable": true,
"collect_on_delivery": {"payment_amount": {"amount": 0,
"currency": "usd"
},
"payment_type": "any"
},
"bill_duties_to_sender": true,
"saturday_delivery": true,
"property1": null,
"property2": null
},
"is_return_label": "false",
"is_residential": "false",
"packages": "[]",
"customs": {"contents": "merchandise",
"non_delivery": "return_to_sender",
"customs_items": [{"description": "string",
"quantity": 0,
"value": {"currency": "string",
"amount": "string"
},
"country_of_origin": "string",
"harmonized_tariff_code": "string",
"sku": "string",
"sku_description": "string"
}
]
},
"items": [{"sku": "string",
"quantity": 0
}
],
"ship_to": {"postal_code": "string",
"state_province": "string",
"country_code": "string",
"address_metadata": {"property1": null,
"property2": null
},
"name": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": "string",
"company_name": "string",
"address_lines": ["string"
],
"city_locality": "string",
"address_residential_indicator": "yes"
},
"ship_from": {"postal_code": "string",
"state_province": "string",
"country_code": "string",
"address_metadata": {"property1": null,
"property2": null
},
"name": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": "string",
"company_name": "string",
"address_lines": ["string"
],
"city_locality": "string",
"address_residential_indicator": "yes"
},
"international": true,
"next_day": true
},
"explain": "false"
}
]

Response samples

application/json

[{"rate_request_identifier": "string",
"external_rate_card_id": "string",
"rates": [{"expirationDate": "2019-08-24T14:15:22Z",
"service_code": "string",
"package_type": "string",
"zone": "string",
"charges": [{"type": "Signature",
"price": {"currency": "string",
"amount": "string"
}
}
]
}
],
"error": null,
"explanation": ["string"
]
}
]