api-docs v5.116.0
API Docs
Table of contents
Inventory_Supplier
Supplier - Delete
Delete an inventory-supplier's details
DELETE /inventory-suppliers/:id
Headers - Header
Name | Type | Description |
---|---|---|
Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
Name | Type | Description |
---|---|---|
id | string |
id of inventory-supplier |
Examples
Example usage:
curl "https://yourdomain.com/inventory-suppliers/<inventory-supplier-id>" \
-X DELETE \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
Name | Type | Description |
---|---|---|
id | String |
|
createdAt | Date |
|
createdBy | String |
|
warehouse | String |
|
name | String |
|
description | String |
|
picURL | String |
|
String |
||
phone | String |
phone number |
website | String |
url |
address | Address |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
}
Supplier - Find
Get array of inventory-suppliers
GET /inventory-suppliers
Headers - Header
Name | Type | Description |
---|---|---|
Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Examples
Example usage:
curl "https://yourdomain.com/inventory-suppliers" \
-X GET \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
Name | Type | Description |
---|---|---|
inventorySuppliers | Object[] |
array of inventory supplier |
inventorySuppliers.id | String |
|
inventorySuppliers.createdAt | Date |
|
inventorySuppliers.createdBy | String |
|
inventorySuppliers.warehouse | String |
|
inventorySuppliers.name | String |
|
inventorySuppliers.description | String |
|
inventorySuppliers.picURL | String |
|
inventorySuppliers.email | String |
|
inventorySuppliers.phone | String |
phone number |
inventorySuppliers.website | String |
url |
inventorySuppliers.address | Address |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
[
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
},
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
}
]
Supplier - Get
Get an inventory-supplier's details
GET /inventory-suppliers/:id
Headers - Header
Name | Type | Description |
---|---|---|
Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
Name | Type | Description |
---|---|---|
id | string |
id of inventory-supplier |
Examples
Example usage:
curl "https://yourdomain.com/inventory-suppliers/<inventory-supplier-id>" \
-X GET \
-H "Authorization: Bearer <your-api-token>"
Success response
Success response - Success 200
Name | Type | Description |
---|---|---|
id | String |
|
createdAt | Date |
|
createdBy | String |
|
warehouse | String |
|
name | String |
|
description | String |
|
picURL | String |
|
String |
||
phone | String |
phone number |
website | String |
url |
address | Address |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
}
Supplier - Patch
Update an inventory-supplier
PATCH /inventory-suppliers/:id
Headers - Header
Name | Type | Description |
---|---|---|
Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
Name | Type | Description |
---|---|---|
id | string |
id of inventory-supplier |
createdAt | Date |
optional Default value: currentTime |
createdBy | String |
optional |
name | String |
|
description | String |
optional |
picURL | String |
optional |
String |
optional | |
phone | String |
optional phone number |
website | String |
optional url |
address | Address |
optional |
Examples
Example usage:
curl "https://yourdomain.com/inventory-suppliers/<inventory-supplier-id>" \
-X PATCH \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-api-token>" \
-d '{
"name": "Updated Name"
}'
Parameters examples
json
- Request-Example
{
"name": "Updated Name"
}
Success response
Success response - Success 200
Name | Type | Description |
---|---|---|
id | String |
|
createdAt | Date |
|
createdBy | String |
|
warehouse | String |
|
name | String |
|
description | String |
|
picURL | String |
|
String |
||
phone | String |
phone number |
website | String |
url |
address | Address |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
}
Supplier - Post
Create an inventory-supplier
POST /inventory-suppliers
Headers - Header
Name | Type | Description |
---|---|---|
Authorization | string |
key to place the API token to using the grant 'Bearer' |
Header examples
Authorization-Example
{
"Authorization": "Bearer <your-api-token>"
}
Parameters - Parameter
Name | Type | Description |
---|---|---|
createdAt | Date |
optional Default value: currentTime |
createdBy | String |
optional |
warehouse | String |
|
name | String |
|
description | String |
optional |
picURL | String |
optional |
String |
optional | |
phone | String |
optional phone number |
website | String |
optional url |
address | Address |
optional |
Examples
Example usage:
curl "https://yourdomain.com/inventory-suppliers" \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-api-token>" \
-d '{
"warehouse": "facility-id",
"name": "Product 1"
}'
Parameters examples
json
- Request-Example
{
"warehouse": "facility-id",
"name": "Product 1"
}
Success response
Success response - Success 200
Name | Type | Description |
---|---|---|
id | String |
|
createdAt | Date |
|
createdBy | String |
|
warehouse | String |
|
name | String |
|
description | String |
|
picURL | String |
|
String |
||
phone | String |
phone number |
website | String |
url |
address | Address |
Success response example
Success response example - Success-Response:
HTTP/1.1 200 OK
{
"id": "service-id",
"warehouse": "facility-id",
"name": "Product 1"
}