setOrderFields
The method allows you to edit selected fields (e.g. address data, notes, etc.) of a specific order. Only the fields that you want to edit should be given, other fields can be omitted in the request.
Input parameters
Output data:
A sample request in PHP:
order_id | int | Order identifier from the BaseLinker order manager. Field required. Other fields are optional. |
admin_comments | varchar(200) | Seller comments |
user_comments | varchar(510) | Buyer comments |
payment_method | varchar(30) | Payment method |
payment_method_cod | bool | Flag indicating whether the type of payment is COD (cash on delivery) |
varchar(150) | Buyer e-mail address | |
phone | varchar(100) | Buyer phone number |
user_login | varchar(30) | Buyer login |
delivery_method | varchar(30) | Delivery method name |
delivery_price | float | Gross delivery price |
delivery_fullname | varchar(100) | Delivery address - name and surname |
delivery_company | varchar(100) | Delivery address - company |
delivery_address | varchar(156) | Delivery address - street and number |
delivery_postcode | varchar(100) | Delivery address - postcode |
delivery_city | varchar(100) | Delivery address - city |
delivery_state | varchar(100) | Delivery address - state/province |
delivery_country_code | char(2) | Delivery address - country code (two-letter, e.g. EN) |
delivery_point_id | varchar(40) | Pick-up point delivery - pick-up point identifier |
delivery_point_name | varchar(100) | Pick-up point delivery - pick-up point name |
delivery_point_address | varchar(100) | Pick-up point delivery - pick-up point address |
delivery_point_postcode | varchar(100) | Pick-up point delivery - pick-up point postcode |
delivery_point_city | varchar(100) | Pick-up point delivery - pick-up point city |
invoice_fullname | varchar(100) | Billing details - name and surname |
invoice_company | varchar(100) | Billing details - company |
invoice_nip | varchar(100) | Billing details - Vat Reg. no./tax number |
invoice_address | varchar(100) | Billing details - street and house number |
invoice_postcode | varchar(100) | Billing details - postcode |
invoice_city | varchar(100) | Billing details - city |
invoice_state | varchar(100) | Billing details - state/province |
invoice_country_code | char(2) | Billing details - country code (two-letter, e.g. EN) |
want_invoice | bool | Flag indicating whether the customer wants an invoice (1 - yes, 0 - no) |
extra_field_1 | varchar(50) | Value of the "extra field 1". - the seller can store any information there |
extra_field_2 | varchar(50) | Value of the "extra field 2". - the seller can store any information there |
custom_extra_fields | array | A list containing order custom extra fields, where the key is the extra field ID and value is an extra field content for given extra field. The list of extra fields can be retrieved with getOrderExtraFields method. In case of removing a field the empty string is expected. In case of file the following format is expected: { "title": "file.pdf" (varchar(40) - the file name) "file": "data:4AAQSkZJRgABA[...]" (binary - the file body limited to 2MB) } |
pick_state | int | Flag indicating the status of the order products collection (1 - all products have been collected, 0 - not all products have been collected) |
pack_state | int | Flag indicating the status of the order products packing (1 - all products have been packed, 0 - not all products have been packed) |
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 |
Sample
Input data:Output data:
A sample request in PHP: