Shipping Types API

Manage shipping types — retrieve, create, update, and delete

Base URL

https://{tenant}.logzi.com/api/shipping_type/

Every request returns a JSON response. On success result.code == 1, on failure result.code == 0.

GET /api/shipping_type/get

Retrieve a single shipping type by ID.

Query Parameters

ParameterTypeRequiredDescription
idintUnique identifier of the shipping type

Example Request

GET /api/shipping_type/get?id=1
X-API-KEY: {your_api_key}
GET /api/shipping_type/list

Paginated retrieval of the shipping type list with filtering options.

Query Parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionarrayArray of filter conditions

Example Request

GET /api/shipping_type/list?list_offset=0
X-API-KEY: {your_api_key}
POST /api/shipping_type/save

Create or update a shipping type. For a new record use data[id] = 0.

POST Fields — data object

FieldTypeRequiredDescription
idint0 = new shipping type, >0 = update
namestringName of the shipping type (e.g. "Futárszolgálat")
shipping_type_codestringShort identifier code for the shipping type

Example Request

POST /api/shipping_type/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "name": "Futárszolgálat"
  }
}
POST /api/shipping_type/delete

Delete a shipping type by ID.

POST Fields — data object

FieldTypeRequiredDescription
idintIdentifier of the shipping type to delete

Example Request

POST /api/shipping_type/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 1 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!