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

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"numberOfAllEntities": 0,
"numberOfPages": 0,
"currentPage": 0,
"data": [{"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"firstName": "string",
"lastName": "string",
"warehouseName": "string",
"totalPackages": 0,
"totalWeight": 0,
"status": "string",
"lastRetrieveByApi": "2019-08-24T14:15:22Z"
}
],
"isBatchesExists": true
}

Retrieve data for a single batch

Securityx-secret-key

Request

path Parameters

required

number

Responses

200

get/api/public/batches/{id}

Request samples

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"data": [{"id": 0,
"totalWeight": 0,
"quantity": 0,
"address": { },
"warehouse": { },
"shippingClass": "string",
"box": { },
"packageItems": ["string"
],
"orderId": 0
}
],
"summary": {"id": 0,
"status": "string",
"numberOfPackages": 0,
"numberOfItems": 0,
"totalWeight": 0,
"lastRetrieveByApi": "2019-08-24T14:15:22Z"
}
}

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

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"numberOfAllEntities": 0,
"numberOfPages": 0,
"currentPage": 0,
"data": [{"id": 0,
"sku": "string",
"name": "string",
"description": "string",
"isActive": true,
"isBox": true,
"weight": 0,
"height": 0,
"length": 0,
"width": 0,
"thresholdQuantity": 0,
"userThresholdsNotifications": ["string"
],
"warehouses": [{"id": 0,
"name": "string",
"address": "string",
"availableQuantity": 0,
"onHoldQuantity": 0,
"allocatedQuantity": 0
}
],
"isDangerousGood": true
}
],
"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": [{"id": 0,
"availableQuantity": 0,
"onHoldQuantity": 0,
"thresholdQuantity": 0
}
],
"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

PHP
curl
Node.js
Python
C#

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": ["string"
],
"warehouses": [{"id": 0,
"name": "string",
"address": "string",
"availableQuantity": 0,
"onHoldQuantity": 0,
"allocatedQuantity": 0
}
],
"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": [{"id": 0,
"availableQuantity": 0,
"onHoldQuantity": 0,
"thresholdQuantity": 0
}
],
"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": [{"sku": "K2879S100",
"quantity": "5",
"addressName": "first_address",
"additionalData": [{"name": "Tax",
"value": "10430"
}
]
}
],
"shippingMethod": "standard",
"orderAddresses": [{"name": "first_address",
"addressLineOne": "first line address",
"addressLineTwo": "second line address",
"addressLineThree": "third line address",
"city": "Los Angeles",
"administrativeArea": "California",
"postalCode": "90002",
"email": "writeMe@gmail.com",
"phoneNumber": "+1-209-688-8534",
"countryCode": "US"
}
],
"orderAdditionalData": [{"name": "Tax",
"value": "10430"
}
]
}

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

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"summary": {"id": 0,
"status": "received",
"createdAt": "2019-08-24T14:15:22Z",
"shippingZones": [{"id": 0,
"name": "string"
}
],
"shippingClass": {"id": 0,
"name": "string",
"type": "string"
},
"totalUniqSkus": 0,
"totalNumberOfItems": 0,
"numberOfPackages": 0,
"batchesIds": ["string"
]
},
"orderItems": [{ }
],
"packages": [{ }
]
}

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

Securityx-secret-key

Request

query Parameters

string

Name of country to search, field is required

Example: search=United States

Responses

200

get/api/public/orders/ref-countries

Request samples

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"data": [{"id": 0,
"name": "string",
"code": "string"
}
]
}

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

PHP
curl
Node.js
Python
C#

Retrieve package data for the given id

Securityx-secret-key

Request

path Parameters

required

number

Responses

200

get/api/public/packages/{id}

Request samples

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"id": 0,
"totalWeight": 0,
"trackingNumber": "string",
"order": {"id": 0,
"externalId": "string"
},
"items": ["string"
],
"warehouse": {"id": 0,
"address": "string",
"name": "string",
"phoneNumber": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"address": {"id": 0,
"name": "string",
"addressLineOne": "string",
"addressLineTwo": "string",
"addressLineThree": "string",
"city": "string",
"administrativeArea": "string",
"postalCode": "string",
"email": "string",
"phoneNumber": "string"
},
"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

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"numberOfAllEntities": 0,
"numberOfPages": 0,
"currentPage": 0,
"data": [{"id": 0,
"name": "string",
"address": "string",
"phoneNumber": "string",
"currentUserPermission": "string",
"shippingZones": [{"id": 0,
"name": "string"
}
],
"shippingMethods": [{"id": 0,
"name": "string",
"type": "string"
}
]
}
],
"isWarehousesExist": true
}

Retrieve data for a single warehouse

Securityx-secret-key

Request

path Parameters

required

number

Responses

200

get/api/public/warehouses/{id}

Request samples

PHP
curl
Node.js
Python
C#

Response samples

application/json

{"id": 0,
"name": "string",
"address": "string",
"numberOfProducts": 0,
"generalQuantity": 0,
"currentUserPermission": "string"
}

Zeno OMS (1.0.0)

Introduction

Postman

Authentication

Batches

Retrieve a paginated list of batches

query Parameters

Retrieve data for a single batch

path Parameters

Inventory

Retrieve a paginated list of your inventory

query Parameters

Create inventory

Request Body schema: application/jsonrequired

Retrieve inventory data for a specific SKU

path Parameters

Update inventory details

path Parameters

Request Body schema: application/jsonrequired

Orders

Insert a new order

Request Body schema: application/jsonrequired

Get order details by external id

path Parameters

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

query Parameters

Packages

Set the tracking number for the given package

path Parameters

Retrieve package data for the given id

path Parameters

Warehouses

Retrieve a paginated list of warehouses

query Parameters

Retrieve data for a single warehouse

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required