Skip to navigation
CargoExtra Gateway API Copyroot-mini

Get Root Settings With Warehouse Remarks

View as Markdown

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

OK
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