Powered by Redocly

Zeno OMS (1.0.0)

Download OpenAPI specification:Download

Zeno OMS Logo

Introduction

This is the Client API documentation for Zeno OMS

API Support: support@stoalogistics.com

Postman

A Postman collection is available here

You will need to update the collection-level variable X-SECRET-KEY with your API Token

Authentication

All requests will require an API Token to be placed in your header under the key x-secret-key

Your API Token is available within the organization owner's account under the Settings > API Key section

Batches

Information regarding your shipment groups

Retrieve a paginated list of batches

Securityx-secret-key
Request
query Parameters
search
string
sortDirection
string
Enum: "ASC" "DESC"
offset
required
number
limit
required
number
sortField
string
Enum: "id" "created_at" "username" "packages_ids" "total_weight" "status" "warehouse" "last_retrieve_by_api"
batchStatuses
Array of strings
dateStart
string
dateEnd
string
Responses
200
get/api/public/batches
Request samples 
/**
 * Requires libcurl
 */

$query = array(
  "search" => "string",
  "sortDirection" => "ASC",
  "offset" => "0",
  "limit" => "0",
  "sortField" => "id",
  "batchStatuses" => "string",
  "dateStart" => "string",
  "dateEnd" => "string"
);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/batches?" . http_build_query($query),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "numberOfAllEntities": 0,
  • "numberOfPages": 0,
  • "currentPage": 0,
  • "data": [
    ],
  • "isBatchesExists": true
}

Retrieve data for a single batch

Securityx-secret-key
Request
path Parameters
id
required
number
Responses
200
get/api/public/batches/{id}
Request samples 
/**
 * Requires libcurl
 */

const id = "YOUR_id_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/batches/" . id,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "data": [
    ],
  • "summary": {
    }
}

Inventory

Manage inventory in your warehouse(s)

Retrieve a paginated list of your inventory

Securityx-secret-key
Request
query Parameters
search
string
offset
required
number
limit
required
number
isBox
boolean
warehousesIds
Array of strings
Responses
200
get/api/public/inventory
Request samples 
/**
 * Requires libcurl
 */

$query = array(
  "search" => "string",
  "offset" => "0",
  "limit" => "0",
  "isBox" => "true",
  "warehousesIds" => "string"
);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/inventory?" . http_build_query($query),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "numberOfAllEntities": 0,
  • "numberOfPages": 0,
  • "currentPage": 0,
  • "data": [
    ],
  • "isProductsExist": true
}

Create inventory

Securityx-secret-key
Request
Request Body schema: application/json
required
sku
required
string
name
required
string
description
string
required
Array of objects (ProductWarehouseDto)
isBox
required
boolean
weight
required
number
height
required
number
length
required
number
width
required
number
isDangerousGood
required
boolean
Responses
200
post/api/public/inventory
Request samples
application/json
{
  • "sku": "string",
  • "name": "string",
  • "description": "string",
  • "productWarehouses": [
    ],
  • "isBox": true,
  • "weight": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "isDangerousGood": true
}

Retrieve inventory data for a specific SKU

Securityx-secret-key
Request
path Parameters
sku
required
string
Responses
200
get/api/public/inventory/{sku}
Request samples 
/**
 * Requires libcurl
 */

const sku = "YOUR_sku_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/inventory/" . sku,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "id": 0,
  • "sku": "string",
  • "name": "string",
  • "description": "string",
  • "isActive": true,
  • "isBox": true,
  • "weight": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "thresholdQuantity": 0,
  • "userThresholdsNotifications": [
    ],
  • "warehouses": [
    ],
  • "isDangerousGood": true
}

Update inventory details

Securityx-secret-key
Request
path Parameters
sku
required
string
Request Body schema: application/json
required
name
string
description
string
required
Array of objects (ProductWarehouseDto)
isBox
required
boolean
weight
required
number
height
required
number
length
required
number
width
required
number
isDangerousGood
required
boolean
Responses
200
put/api/public/inventory/{sku}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "productWarehouses": [
    ],
  • "isBox": true,
  • "weight": 0,
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "isDangerousGood": true
}

Orders

Manage order data

Insert a new order

Securityx-secret-key
Request
Request Body schema: application/json
required
externalId
string

External order ID

warehouseId
number

Fulfillment Warehouse ID

required
Array of objects (OrderItemDto)

Array of order items

shippingMethod
required
string

Shipping method. Valid values: standard, expedited

Enum: "standard" "expedited"
required
Array of objects (OrderAddressDto)

Array of addresses for order

required
Array of objects (AdditionalDataDto)

Array of additional data for order

Responses
200
400

Error when names of order addresses are not unique or product with sku not found or address name used in order item doesn't exist in list of order addresses

403

Error when x-secret-key isn't provided or the API Token doesn't exist

post/api/public/orders
Request samples
application/json
{
  • "externalId": "string",
  • "warehouseId": 0,
  • "orderItems": [
    ],
  • "shippingMethod": "standard",
  • "orderAddresses": [
    ],
  • "orderAdditionalData": [
    ]
}
Response samples
application/json
{
  • "message": "Your order has been successfully created"
}

Get order details by external id

Securityx-secret-key
Request
path Parameters
externalId
required
string
Responses
200
get/api/public/orders/external/{externalId}
Request samples 
/**
 * Requires libcurl
 */

const externalId = "YOUR_externalId_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/orders/external/" . externalId,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "summary": {
    },
  • "orderItems": [
    ],
  • "packages": [
    ]
}

Search for a list of countries with codes that can be used in an order

Securityx-secret-key
Request
query Parameters
search
string

Name of country to search, field is required

Example: search=United States
Responses
200
get/api/public/orders/ref-countries
Request samples 
/**
 * Requires libcurl
 */

$query = array(
  "search" => "string"
);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/orders/ref-countries?" . http_build_query($query),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "data": [
    ]
}

Packages

Manage package data

Set the tracking number for the given package

Securityx-secret-key
Request
path Parameters
id
required
number
trackingNumber
required
string
Responses
200
post/api/public/packages/{id}/tracking/{trackingNumber}
Request samples 
/**
 * Requires libcurl
 */

const id = "YOUR_id_PARAMETER";
const trackingNumber = "YOUR_trackingNumber_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/packages/" . id . "/tracking/" . trackingNumber,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}

Retrieve package data for the given id

Securityx-secret-key
Request
path Parameters
id
required
number
Responses
200
get/api/public/packages/{id}
Request samples 
/**
 * Requires libcurl
 */

const id = "YOUR_id_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/packages/" . id,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "id": 0,
  • "totalWeight": 0,
  • "trackingNumber": "string",
  • "order": {
    },
  • "items": [
    ],
  • "warehouse": {
    },
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Warehouses

Retrieve a paginated list of warehouses

Securityx-secret-key
Request
query Parameters
search
string
sortDirection
string
Enum: "ASC" "DESC"
offset
required
number
limit
required
number
sortField
string
Enum: "name" "address" "shipping_zones"
shippingClassFilter
string
Enum: "standard" "expedited"
productIds
Array of strings
Responses
200
get/api/public/warehouses
Request samples 
/**
 * Requires libcurl
 */

$query = array(
  "search" => "string",
  "sortDirection" => "ASC",
  "offset" => "0",
  "limit" => "0",
  "sortField" => "name",
  "shippingClassFilter" => "standard",
  "productIds" => "string"
);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/warehouses?" . http_build_query($query),
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "numberOfAllEntities": 0,
  • "numberOfPages": 0,
  • "currentPage": 0,
  • "data": [
    ],
  • "isWarehousesExist": true
}

Retrieve data for a single warehouse

Securityx-secret-key
Request
path Parameters
id
required
number
Responses
200
get/api/public/warehouses/{id}
Request samples 
/**
 * Requires libcurl
 */

const id = "YOUR_id_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "x-secret-key: YOUR_API_KEY_HERE"
  ],
  CURLOPT_URL => "https://api.zeno-oms.com/api/public/warehouses/" . id,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": "string",
  • "numberOfProducts": 0,
  • "generalQuantity": 0,
  • "currentUserPermission": "string"
}