API Reference
API Reference

FAX Big Regions

get
https://api.freightos.com/fd_external_apis/fax/big_regions

Retrieves FAX Big Regions Rates. Weekly/Daily and default from_date depend on the permissions level. Weekly Returns Sundays data only, and Daily Returns Everyday data

Query Params
date

Date string with format (YYYY-MM-DD). Default depends on permissions level granted.

date

Date string with format (YYYY-MM-DD). Default is today's date.

string
required

List of FAX Big Regions (obtained from the scope API), separated by "|".

string
required

List of FAX Big Regions (obtained from the scope API), separated by "|".

string

List of weight breaks to filter on (obtained from the scope API), separated by a comma, case-insensitive. Default is all supported weight breaks.

string
enum

Index Version, weekly or daily (case-insensitive), default is in the permissions level.

Allowed:
Headers
string
required

API Key for permissions

string
required

SECRET KEY provided for access

Response

Updated 10 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago