Get Root Settings With Warehouse Remarks | CargoExtra Global Logistics USA

Returns root settings. Optional body field warehouse adds shipmentRemarks for the selected warehouse.

Body fields: warehouse optional Mongo ObjectId of a warehouse.

Response fields: same as Get Root Settings, plus shipmentRemarks when a valid warehouse is supplied.

Possible errors:

404: Root not found - root configuration document is missing.
404: Warehouse not found - supplied warehouse id does not exist.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

Returns root settings. Optional body field `warehouse` adds `shipmentRemarks` for the selected warehouse. Body fields: `warehouse` optional Mongo ObjectId of a warehouse. Response fields: same as Get Root Settings, plus `shipmentRemarks` when a valid warehouse is supplied. Possible errors: - 404: Root not found - root configuration document is missing. - 404: Warehouse not found - supplied warehouse id does not exist. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.

warehousestringRequired

Response

key_0integer

key_1string

key_2double

key_3string

key_4boolean

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Returns root settings. Optional body field warehouse adds shipmentRemarks for the selected warehouse.

Body fields: warehouse optional Mongo ObjectId of a warehouse.

Response fields: same as Get Root Settings, plus shipmentRemarks when a valid warehouse is supplied.

Possible errors:

404: Root not found - root configuration document is missing.
404: Warehouse not found - supplied warehouse id does not exist.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

$	curl -X POST http://localhost:9000/api/v1/root-mini \
>	-H "Content-Type: application/json" \
>	-d '{
>	"warehouse": "64f1a2b3c4d5e6f7890abcde"
>	}'

1	{
2	"key_0": 12345,
3	"key_1": "RootConfigAlpha",
4	"key_2": 9876.54321,
5	"key_3": "Shipment remarks for warehouse 64f1a2b3c4d5e6f7890abcde: Handle with care, fragile items included.",
6	"key_4": true
7	}