Base URL
https://{tenant}.logzi.com/api/shipping/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. The shipping API enables managing shipping methods for the webshop and orders, calculating shipping costs, and retrieving shipping types.
/api/shipping/get
Retrieve a single shipping method.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Shipping method identifier | |
shipping_default | int | Default shipping method (0/1) | |
shipping_webname | string | Name shown in the webshop | |
language_id | int | Language identifier |
Example request
GET /api/shipping/get?id=1&language_id=1
X-API-KEY: {your_api_key}/api/shipping/get_all
Retrieve all shipping methods.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Filter by identifier |
Example request
GET /api/shipping/get_all
X-API-KEY: {your_api_key}/api/shipping/get_receipt_cost
Calculate the shipping cost for a given list of products.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Shipping method identifier | |
product_list | array | List of products used to calculate the cost |
Example request
GET /api/shipping/get_receipt_cost?id=1
X-API-KEY: {your_api_key}/api/shipping/get_type
Retrieve a partner's shipping type.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
partner_id | int | Partner identifier | |
shipping_type_name | string | Shipping type name | |
language_id | int | Language identifier |
Example request
GET /api/shipping/get_type?partner_id=1&language_id=1
X-API-KEY: {your_api_key}/api/shipping/list
Retrieve the list of shipping methods in a given language.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
language_id | int | Language identifier |
Example request
GET /api/shipping/list?language_id=1
X-API-KEY: {your_api_key}/api/shipping/save
Create or update a shipping method.
POST fields — data object
The data object should contain the shipping method's details (name, webshop name, rates, shipping type).
Example request
POST /api/shipping/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 1 } }/api/shipping/delete
Delete a shipping method by identifier.
POST fields
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the shipping method to delete |
Example request
POST /api/shipping/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "id": 1 }Create your account now,
pay later!
