API documentation
Method list
Test your request
Changelog


setOrderReturnProductFields
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
return_idintOrder return identifier from the BaseLinker order manager. Field required.
order_return_product_idintOrder return item ID from BaseLinker order manager. Field required.
storagevarchar(9)Type of product source storage (available values: "db" - BaseLinker internal catalog, "shop" - online shop storage, "warehouse" - the connected wholesaler)
storage_idvarchar(50)The identifier of the storage (inventory/shop/warehouse) from which the product comes.
product_idvarchar(50)Product identifier in BaseLinker or shop storage. Blank if the product number is not known
variant_idvarchar(30)Product variant ID. Blank if the variant number is unknown
auction_idvarchar(20)Listing ID number (if the order comes from ebay/allegro)
namevarchar(200)Product name
skuvarchar(50)Product SKU number
eanvarchar(32)Product EAN number
locationvarchar(50)Product location
warehouse_idintProduct source warehouse identifier. Only applies to products from BaseLinker inventory.
attributesvarchar(350)The detailed product attributes, e.g. "Colour: blue" (Variant name)
price_bruttofloatSingle item gross price.
tax_ratefloatVAT 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)
quantityintNumber of pieces
weightfloatSingle piece weight



Output data
The method returns the data in JSON format.
statusvarchar(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: