Package Types

Part of the Inventory API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List package types

GET /admin/api/v1/inventories/package-types

Retrieve a paginated list of package types with filtering and sorting

🔒 Requires a valid Bearer token.

Query parameters

Parameter	Type	Required	Description	Example
include	string	No	Comma-separated list of relationships to include. Available options: company, creator	company
filter[id]	string	No	Comma-separated list of IDs to filter by	architecto
filter[name]	string	No	Filter by package type name	Box
filter[barcode]	string	No	Filter by barcode	PKG
filter[company_id]	string	No	Filter by company IDs	architecto
sort	string	No	Sort field	-created_at

cURL

curl -X GET "https://your-domain.com/admin/api/v1/inventories/package-types?include=company&filter%5Bid%5D=architecto&filter%5Bname%5D=Box&filter%5Bbarcode%5D=PKG&filter%5Bcompany_id%5D=architecto&sort=-created_at" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/package-types?include=company&filter%5Bid%5D=architecto&filter%5Bname%5D=Box&filter%5Bbarcode%5D=PKG&filter%5Bcompany_id%5D=architecto&sort=-created_at", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/package-types?include=company&filter%5Bid%5D=architecto&filter%5Bname%5D=Box&filter%5Bbarcode%5D=PKG&filter%5Bcompany_id%5D=architecto&sort=-created_at', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/package-types?include=company&filter%5Bid%5D=architecto&filter%5Bname%5D=Box&filter%5Bbarcode%5D=PKG&filter%5Bcompany_id%5D=architecto&sort=-created_at"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

{
  "data": [
    {
      "id": null,
      "name": "eius et",
      "sort": 0,
      "barcode": null,
      "height": null,
      "width": null,
      "length": null,
      "base_weight": null,
      "max_weight": null,
      "shipper_package_code": null,
      "package_carrier_type": null,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": null,
      "name": "animi quos",
      "sort": 0,
      "barcode": null,
      "height": null,
      "width": null,
      "length": null,
      "base_weight": null,
      "max_weight": null,
      "shipper_package_code": null,
      "package_carrier_type": null,
      "created_at": null,
      "updated_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

{
  "message": "Unauthenticated."
}

---

Create package type

POST /admin/api/v1/inventories/package-types

Create a new package type

🔒 Requires a valid Bearer token.

Body parameters

Parameter	Type	Required	Description
name	string	Yes	Package type name. Must not be greater than 255 characters.
length	number	Yes	Length. Must be at least 0. Must not be greater than 99999999999.
width	number	Yes	Width. Must be at least 0. Must not be greater than 99999999999.
height	number	Yes	Height. Must be at least 0. Must not be greater than 99999999999.
base_weight	number	Yes	Base package weight. Must be at least 0. Must not be greater than 99999999999.
max_weight	number	Yes	Maximum package weight. Must be at least 0. Must not be greater than 99999999999.
barcode	string	No	Package type barcode. Must not be greater than 255 characters.
company_id	integer	No	Company ID. Must match an existing stored value.

cURL

curl -X POST "https://your-domain.com/admin/api/v1/inventories/package-types" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Box L",
  "length": 40,
  "width": 30,
  "height": 20,
  "base_weight": 1.5,
  "max_weight": 25,
  "barcode": "PKG-TYPE-001",
  "company_id": 1
}'

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/package-types", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Box L",
  "length": 40,
  "width": 30,
  "height": 20,
  "base_weight": 1.5,
  "max_weight": 25,
  "barcode": "PKG-TYPE-001",
  "company_id": 1
}),
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/inventories/package-types', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Box L',
    'length' => 40,
    'width' => 30,
    'height' => 20,
    'base_weight' => 1.5,
    'max_weight' => 25,
    'barcode' => 'PKG-TYPE-001',
    'company_id' => 1,
  ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/package-types"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Box L",
    "length": 40,
    "width": 30,
    "height": 20,
    "base_weight": 1.5,
    "max_weight": 25,
    "barcode": "PKG-TYPE-001",
    "company_id": 1,
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

{
  "data": {
    "id": null,
    "name": "architecto eius",
    "sort": 0,
    "barcode": null,
    "height": null,
    "width": null,
    "length": null,
    "base_weight": null,
    "max_weight": null,
    "shipper_package_code": null,
    "package_carrier_type": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Package type created successfully."
}

Error response — 401

{
  "message": "Unauthenticated."
}

---

Show package type

GET /admin/api/v1/inventories/package-types/{id}

Retrieve a specific package type by ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The package type ID

Query parameters

Parameter	Type	Required	Description	Example
include	string	No	Comma-separated list of relationships to include. Available options: company, creator	company

cURL

curl -X GET "https://your-domain.com/admin/api/v1/inventories/package-types/{id}?include=company" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/package-types/{id}?include=company", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/inventories/package-types/{id}?include=company', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/package-types/{id}?include=company"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

{
  "data": {
    "id": null,
    "name": "aut adipisci",
    "sort": 0,
    "barcode": null,
    "height": null,
    "width": null,
    "length": null,
    "base_weight": null,
    "max_weight": null,
    "shipper_package_code": null,
    "package_carrier_type": null,
    "created_at": null,
    "updated_at": null
  }
}

Error response — 401

{
  "message": "Unauthenticated."
}

---

Update package type

PUT /admin/api/v1/inventories/package-types/{id}

Update an existing package type

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The package type ID

Body parameters

Parameter	Type	Required	Description
name	string	No	Package type name. Must not be greater than 255 characters.
length	number	No	Length. Must be at least 0. Must not be greater than 99999999999.
width	number	No	Width. Must be at least 0. Must not be greater than 99999999999.
height	number	No	Height. Must be at least 0. Must not be greater than 99999999999.
base_weight	number	No	Base package weight. Must be at least 0. Must not be greater than 99999999999.
max_weight	number	No	Maximum package weight. Must be at least 0. Must not be greater than 99999999999.
barcode	string	No	Package type barcode. Must not be greater than 255 characters.
company_id	integer	No	Company ID. Must match an existing stored value.

cURL

curl -X PUT "https://your-domain.com/admin/api/v1/inventories/package-types/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Box L",
  "length": 40,
  "width": 30,
  "height": 20,
  "base_weight": 1.5,
  "max_weight": 25,
  "barcode": "PKG-TYPE-001",
  "company_id": 1
}'

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/package-types/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "Box L",
  "length": 40,
  "width": 30,
  "height": 20,
  "base_weight": 1.5,
  "max_weight": 25,
  "barcode": "PKG-TYPE-001",
  "company_id": 1
}),
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/inventories/package-types/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'name' => 'Box L',
    'length' => 40,
    'width' => 30,
    'height' => 20,
    'base_weight' => 1.5,
    'max_weight' => 25,
    'barcode' => 'PKG-TYPE-001',
    'company_id' => 1,
  ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/package-types/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "name": "Box L",
    "length": 40,
    "width": 30,
    "height": 20,
    "base_weight": 1.5,
    "max_weight": 25,
    "barcode": "PKG-TYPE-001",
    "company_id": 1,
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

{
  "data": {
    "id": null,
    "name": "architecto eius",
    "sort": 0,
    "barcode": null,
    "height": null,
    "width": null,
    "length": null,
    "base_weight": null,
    "max_weight": null,
    "shipper_package_code": null,
    "package_carrier_type": null,
    "created_at": null,
    "updated_at": null
  },
  "message": "Package type updated successfully."
}

Error response — 401

{
  "message": "Unauthenticated."
}

---

Delete package type

DELETE /admin/api/v1/inventories/package-types/{id}

Delete a package type

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
id	integer	Yes	The package type ID

cURL

curl -X DELETE "https://your-domain.com/admin/api/v1/inventories/package-types/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch("https://your-domain.com/admin/api/v1/inventories/package-types/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/inventories/package-types/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

Python

import requests

url = "https://your-domain.com/admin/api/v1/inventories/package-types/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

{
  "message": "Package type deleted successfully."
}

Error response — 401

{
  "message": "Unauthenticated."
}

---