Overview
The SyncInventory API endpoint allows you to synchronize inventory data. This document provides details on how to use the API, including the necessary parameters and filters.
Note: For more detailed information, you can also check the attached PDF.
API URL
scentnsecret.itserver.biz/admin/indexyii.php?r=api/SyncInventory
Get Started
1: Obtain an API Key
Ensure you have the API key required for authentication.
Your API key is:
759B619B8B03B4E5A7B0FBE4A059CC0D470FE6A431DCCFE2ED2C3C0AF0804540
2: Set Up Request Headers
Include the API key in your request headers to authenticate your requests.
- Authorization:
Bearer 759B619B8B03B4E5A7B0FBE4A059CC0D470FE6A431DCCFE2ED2C3C0AF0804540 - Auth Type: Basic Auth
- Username:
admin - Password:
759B619B8B03B4E5A7B0FBE4A059CC0D470FE6A431DCCFE2ED2C3C0AF0804540 - Content-Type:
application/json
Parameters
The following filters can be applied when making a request to the SyncInventory endpoint:
SKU Code Filter
- Description: Filter the inventory synchronization by SKU code.
- Parameter Name:
Skucode - Type:
String - Required:
No
Godown ID Filter
- Description: Filter the inventory synchronization by Godown ID.
- Parameter Name:
Godownid - Type:
Integer - Required:
No
Example Request
Here is an example of how to make a request to the SyncInventory endpoint with filters:
Request
GET scentnsecret.itserver.biz.local/admin/indexyii.php?r=api/SyncInventory&Godownid=9763&Godownid='PTFB04'
Authorization: Bearer 759B619B8B03B4E5A7B0FBE4A059CC0D470FE6A431DCCFE2ED2C3C0AF0804540
Content-Type: application/json
[
{
"products_id": "9032",
"productDescription": "SNS Coupon",
"SkuCode": "PTFB04",
"Stock": "-42893.0",
"Godowns": [
{
"Godown": "Karachi Warehouse",
"Godownid": "97637",
"Stock": "-42893"
}
]
},
{
"products_id": "9410",
"productDescription": "SNS Small Flyers (10 x 14)",
"SkuCode": "PFLY12",
"Stock": "-41594.0",
"Godowns": [
{
"Godown": "Karachi Warehouse",
"Godownid": "97637",
"Stock": "-41594"
}
]
}
]
A successful response will return the synchronized inventory data.
Error Handling
In case of an error, the API will return an error message with details.
Example Error Response
{
"status": "error",
"message": "Invalid API key."
}
Additional Resources
Do you still have questions?
Check out our community forum, as there’s a good chance our community has an answer for you. Visit our developer forum to review topics, ask questions, and learn from others.
