FAX Big Regions API

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from_date

date

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

to_date

date

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

origins

string

required

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

destinations

string

required

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

weight_breaks

string

required

List of weight breaks to filter on (obtained from the scope API), separated by a comma, case-insensitive.
Default is all supported weight breaks.
Supported values: 100-300kg, 100-1000kg, 100-3000kg, 300-500kg, 300-1000kg, 300-3000kg, 500-1000kg, 1000-3000kg, 3000-10000kg.

version

string

enum

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

Allowed:

Headers

apikey

string

required

API Key for permissions

secret-key

string

required

SECRET KEY provided for access

Response

200

Success

Language

Loading…

Response

Click Try It! to start a request and see the response here!