GET v1/shipment/getSettings

Settings used to determine visibility and module settings for Shipments

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ShipmentSettingsModel

Name	Description	Type	Additional information
ShowCOCDocuments	Indicates whether COC Documents should be shown or not	boolean	None.
ShowBOL		boolean	None.
ShowPackingSlip		boolean	None.
BOLTemplate		string	None.
PackingSlipTemplate		string	None.
ShowPickList		boolean	None.
RequireTrailerFieldsToComplete		boolean	None.
ShowShipTime		boolean	None.
IsManager		boolean	None.
RequireZone		boolean	None.
Tabs		Collection of ModuleTabModel	None.

Response Formats

application/json, text/json

Sample:

{
  "showCOCDocuments": true,
  "showBOL": true,
  "showPackingSlip": true,
  "bolTemplate": "sample string 4",
  "packingSlipTemplate": "sample string 5",
  "showPickList": true,
  "requireTrailerFieldsToComplete": true,
  "showShipTime": true,
  "isManager": true,
  "requireZone": true,
  "tabs": [
    {
      "tabName": "sample string 1",
      "isVisible": true,
      "isIntegrationControlled": true
    },
    {
      "tabName": "sample string 1",
      "isVisible": true,
      "isIntegrationControlled": true
    }
  ]
}