Skip to main content

Get a setting

GET/client_api/v2/system_configs/{id}

Reads one of our settings that a client may see. The answer's shape depends on the setting.

Path parameters

  • idstringRequired

    The setting's name. A client may read document_descriptions, commercial_invoice_placeholders, broker_optional_channels, bill_of_lading_applicable_shipping_company_ids, export_permit_origin_country_ids, whats_new_client_ui and whats_new_reseller_ui.

Returns

Returns a list.

Errors

  • 401Unauthorized
    The token is missing, expired or invalid. Sign in again.
View as Markdown
GET /client_api/v2/system_configs/{id}
1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/system_configs/document_descriptions" \
2 -H "Authorization: Bearer $API_TOKEN"
Response
[
"Commercial invoice",
"Packing list"
]
API ExplorerSandbox

Pick a call on the right and run it. Every call goes to the sandbox, so nothing is really shipped or charged. The answer appears here.