This is the Client API documentation for Zeno OMS
API Support: support@stoalogistics.com
A Postman collection is available here
You will need to update the collection-level variable X-SECRET-KEY
with your API Token
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
{- "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
}
{- "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"
}
}
{- "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
}
{- "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
}
{- "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
}
{- "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
}
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
Error when x-secret-key isn't provided or the API Token doesn't exist
{- "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"
}
]
}
{- "message": "Your order has been successfully created"
}
{- "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": [
- { }
]
}
{- "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"
}
{- "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
}