getRequestParcelPickupFields
The method allows you to retrieve additional fields for a parcel pickup request.
Input parameters
Output data:
A sample request in PHP:
courier_code | varchar(20) | Courier code |
Output data
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 |
fields | array | An array with a list of additional fields to request parcel pickup 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) |
| - value | varchar(50) | Default value for a field |
Sample
Input data:Output data:
A sample request in PHP: