courier_code

varchar(20)

Courier code

The method returns the data in JSON format.

status	varchar(30)	SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
multi_packages	bool	Does the courier support multiple shipments (0/1).
fields	array	An array with a list of fields to create a shipment containing the fields listed below.
| - id	varchar(50)	The field ID
| - name	varchar(50)	The field name
| - type	varchar(10)	Field type (available select, checkbox, text, date)
| - desc	text	Additional field description
| - options	array	List of available options (appears for select, checkbox). The key to each element is the option id (varchar) The value is the option name (varchar)
| - show_field	array	List of additional fields that are available for the selected option. The key for each element is (varchar) - id of the option for which additional fields (varchar) are to be available The value is the list of fields that are available for this option (array)
| - value	varchar(50)	Default value for a field
| - function	varchar(20)	If this value is not empty, it means that the field has dynamic options and in order to download the current options for a particular order, you should retrieve with the getCourierServices" request
package_fields	array	An array with a list of fields to create packages containing the fields listed below. The completed list of these fields must be provided to the createPackage method under the packages key as an array of objects.
| - id	varchar(50)	The field ID
| - name	varchar(50)	The field name
| - type	varchar(10)	Field type (available select, checkbox, text)

Input data:
{ "courier_code": "pkwid" } Output data:
{ "status": "SUCCESS", "multi_packages": false, "fields": [ { "id": "courier", "name": "Courier", "type": "select", "desc": "", "options": { "2": "KEX", "4": "GLS", "5": "FedEx", "6": "InPost Paczkomaty", "8": "DHL", "10": "FedEx Lotniczy", "11": "Paczka w ruchu", "12": "InPost Kurier", "13": "Delta city", "30": "UPS Express Saver", "31": "UPS Standard" } }, { "id": "package_type", "name": "Type", "type": "select", "options": { "paczka": "parcel", "paleta": "palette", "koperta": "envelope" }, "show_field": { "paleta": [ "before_delivery_notification" ] } }, { "id": "pickup_date", "name": "Dispatch date", "type": "date", "desc": "Order pickup for specific day", "value": 1487085753 }, { "id": "cod", "name": "Cash on delivery", "type": "text" }, { "id": "insurance", "name": "Insurance", "type": "text" }, { "id": "package_description", "name": "Content description", "type": "text" }, { "id": "before_delivery_notification", "name": "Notification before delivery", "type": "checkbox", "desc": "Available only for DHL Palette", "options": { "1": "Yes" } } ], "package_fields": [ { "id": "weight", "name": "Weight", "type": "text" }, { "id": "size_length", "name": "Length", "type": "text" }, { "id": "size_width", "name": "Width", "type": "text" }, { "id": "size_height", "name": "Height", "type": "text" }, { "id": "size_custom", "name": "Custom", "type": "checkbox", "options": { "1": "Unusual shape" }, "default": "0" } ] } A sample request in PHP:
<?php $methodParams = '{ "courier_code": "pkwid" }'; $apiParams = [ "method" => "getCourierFields", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);