Method list

Test your request

Changelog

Returns a list of available shipping templates (delivery schemas) for all connected marketplace integrations. Use the returned template IDs when setting the shipping_template parameter in the addInventoryProduct method.





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
shipping_templates	array	A flat list of shipping template objects. Each object contains the fields listed below.
| - source	text	Integration source identifier in the format "[type]_[account_id]" (e.g. "allegro_123", "ebay_456", "amazon_0", "shopee_101"). For integrations where templates are shared across all accounts (e.g. Amazon), the account_id is 0 (e.g. "amazon_0").
| - site	mixed	Marketplace site code (e.g. "us", "de", "pl") for integrations that organize templates per site (eBay, Amazon). null for integrations without per-site templates (Allegro, most new marketplaces).
| - id	text	Shipping template identifier. This value should be used when setting the shipping_template in addInventoryProduct.
| - name	text	Human-readable name of the shipping template.

Input data:
{} Output data:
{ "status": "SUCCESS", "shipping_templates": [ { "source": "allegro_123", "site": null, "id": "456", "name": "Kurier Allegro - standard" }, { "source": "allegro_123", "site": null, "id": "789", "name": "Paczkomaty InPost" }, { "source": "ebay_456", "site": "us", "id": "112", "name": "Standard Shipping US" }, { "source": "ebay_456", "site": "de", "id": "113", "name": "DHL Paket" }, { "source": "amazon_0", "site": "us", "id": "78", "name": "Amazon Standard Shipping" }, { "source": "shopee_101", "site": null, "id": "55", "name": "Free Shipping" } ] } A sample request in PHP:
<?php $methodParams = '{}'; $apiParams = [ "method" => "getInventoryShippingTemplates", "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);