Skip to main content
All CollectionsCargoCONNECT Schedule & Rate API
Common Scenarios and Explanations for Schedule & Rate API
Common Scenarios and Explanations for Schedule & Rate API
CustomerSuccess Crew avatar
Written by CustomerSuccess Crew
Updated over 10 months ago

"Null" Response in "Charges," "OCDC," and "Handling Codes" Fields

When the Schedule & Rate API response displays "null" under the "charges," "ocdc," and "handling codes" fields, it indicates that the airline API did not provide any values for these fields. In such cases, our response leaves these fields empty as no information was retrieved.

Interpreting "allInRate" and "netRate" for Selling Rates

Fuel and Security Surcharges Provided:

'allInRate': Net rate + fuel surcharges + security surcharges

'netRate': Represents the selling rate

No Fuel and Security Surcharges Provided:

'allInRate': Becomes the selling rate.

'netRate': Set to 0, as no specific selling rate is provided.

For accurate interpretation, consider the information from the "charges" array, where fuel and security surcharges are detailed.

"Minimum Rate" Field Returns "False" Despite Cargo Details

If the "minimum rate" field returns "false" even when cargo details are provided, it indicates that we could not determine whether the received rate is the minimum or not. In such cases, refer to the specific rate provided in the response for further clarification.

Confirming Receipt of All Rate Responses in Schedule & Rate API

Verifying the Status of Rate Responses

To ensure that you have received all the rate responses in the Schedule & Rate API, closely monitor the status in the API responses. Follow these steps to confirm the completeness of your request:

1. Check the Response Status:

Examine the "status" parameter in the API response.

2. "STARTED" Status:

If the status is "STARTED," it indicates that the processing of your request is ongoing.

Recall your request by including the "id" found in the response. This ensures that you retrieve the complete set of rate responses.

3. "COMPLETED" Status:

When the status is "COMPLETED," it signifies that the API has finished processing your request, and all rate responses are available.

At this point, you have received all the results, and no further action is required.

If you encounter any issues or have additional questions, please reach out to our dedicated support channel at support+rapidAPI@cargoai.co.

Did this answer your question?