API documentationsetOrderReturnProductFields
The method allows you to edit the data of selected items (e.g. prices, quantities etc.) of a specific order. Only the fields that you want to edit should be given, the remaining fields can be omitted in the request.
Input parameters
Output data:
A sample request in PHP:
| return_id | int | Order return identifier from the BaseLinker order manager. Field required. |
| order_return_product_id | int | Order return item ID from BaseLinker order manager. Field required. |
| storage | varchar(9) | Type of product source storage (available values: "db" - BaseLinker internal catalog, "shop" - online shop storage, "warehouse" - the connected wholesaler) |
| storage_id | varchar(50) | The identifier of the storage (inventory/shop/warehouse) from which the product comes. |
| product_id | varchar(50) | Product identifier in BaseLinker or shop storage. Blank if the product number is not known |
| variant_id | varchar(30) | Product variant ID. Blank if the variant number is unknown |
| auction_id | varchar(20) | Listing ID number (if the order comes from ebay/allegro) |
| name | varchar(200) | Product name |
| sku | varchar(50) | Product SKU number |
| ean | varchar(32) | Product EAN number |
| location | varchar(50) | Product location |
| warehouse_id | int | Product source warehouse identifier. Only applies to products from BaseLinker inventory. |
| attributes | varchar(350) | The detailed product attributes, e.g. "Colour: blue" (Variant name) |
| price_brutto | float | Single item gross price. |
| tax_rate | float | VAT tax rate e.g. "23", (value from range 0-100, EXCEPTION values: "-1" for "EXPT"/"ZW" exempt from VAT, "-0.02" for "NP" annotation, "-0.03" for "OO" VAT reverse charge) |
| quantity | int | Number of pieces |
| weight | float | Single piece weight |
| status_id | int | Identifier of product return status. The list can be retrieved with getOrderReturnProductStatuses method. |
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: