Please note: It is your responsibility to properly set up all translation features, perform testing, and request support from ShipEdge in a timely manner. It is your responsibility to test and verify the integration between ShipEdge and any 3rd party selling channel. We strongly recommend frequent testing of any integration, specially when changes occur on your selling channel (e.g. SKU renaming, shipping method variations, permissions and credentials). ShipEdge is not responsible for translation issues, omitted orders, or any other issues related to communication with any 3rd party selling channel. Support for channel automation requires at least 24 hours for investigation before any action can be taken (hourly development charges may apply). The warehouse is not responsible for any omission, duplication or error in your orders coming through this system, and you agree not to get the warehouse involved in integration issues, nor will they make any exception or procedure changes due to the use of this feature.
Base
- http://<integration>.shipedge.com/API/Rest/v2/Inventory
Ping
Ping to check the system status.
Parameters
Example request
{
"account_id": 1,
"key": "123456789",
"warehouse": "ncx"
}
Example response
{
"status": "successful",
"result": "pong!"
}
Get products
Gets the collection of products. Returns all the SKUs in your account, along with the values for each attribute in each on (metadata).
Example request
{
"account_id": 1,
"key": "123456789",
"warehouse": "ncx",
"page": 2
}
Example response
{
"status": "successful",
"products": [{
"product_id": "1",
"account_id": "1",
"sku": "010-0-S",
"upc": "N/A",
"description": "The Santa BatHat - Small 13-15.5-Santa-Bat Ears",
"harmonization_code": null,
"quantity_in_warehouse": null,
"quantity_available": "0",
"quantity_hurt": "0",
"quantity_shipped": "0",
"cost": "13.50",
"retail": "13.50",
"discontinued": "N",
"discontinued_date": null,
"created_date": "2019-01-04 11:19:54",
"updated_date": "2019-09-20 13:53:24",
"weight": "0.1000",
"width": "0.100",
"height": "0.100",
"length": "0.100",
"distribution_center": {
"id": "1",
"name": "NCS"
},
"supplier": {
"id": "1189",
"name": "Z"
},
"package_type": {
"id": null,
"name": null
},
"attributes": []
}, {
"product_id": "2",
"account_id": "1",
"sku": "111-01950",
"upc": null,
"description": "111-01950 test desc",
"harmonization_code": null,
"quantity_in_warehouse": null,
"quantity_available": "-10000",
"quantity_hurt": "0",
"quantity_shipped": "0",
"cost": "25.00",
"retail": "50.00",
"discontinued": "N",
"discontinued_date": null,
"created_date": "2019-08-01 11:43:36",
"updated_date": "2019-11-07 17:41:26",
"weight": "1.0000",
"width": "1.000",
"height": "1.000",
"length": "1.000",
"distribution_center": {
"id": "1",
"name": "NCX"
},
"supplier": {
"id": null,
"name": null
},
"package_type": {
"id": null,
"name": null
},
"attributes": []
}],
"page_size": 100,
"page": "1",
"total_pages": 2
}
Get total products
Gets the total of products. Returns the number of SKUs for your account. e.g. If you have 10 skus and 3 units of each, it will return: 10.
Example request
{
"account_id": 1,
"key": "123456789",
"warehouse": "ncx",
"from_date": "2019-01-28 18:34:18",
"to_date": "2019-01-28 18:34:18"
}
Example response
{
"status": "successful",
"products": {
"total": "133"
}
}
Get product
Gets the detail information about a specific product.
Example request
{
"account_id": 1,
"key": "123456789",
"warehouse": "ncx",
"product_id": "123"
}
Example response
{
"status": "successful",
"product": {
"product_id": "123",
"account_id": "1",
"sku": "010-0-S",
"upc": "N/A",
"description": "The Santa BatHat - Small 13-15.5-Santa-Bat Ears",
"harmonization_code": null,
"quantity_in_warehouse": "0",
"quantity_available": "0",
"quantity_hurt": "0",
"quantity_shipped": "0",
"cost": "13.50",
"retail": "13.50",
"discontinued": "N",
"discontinued_date": null,
"created_date": "2019-01-04 11:19:54",
"updated_date": "2019-09-20 13:53:24",
"weight": "0.1000",
"width": "0.100",
"height": "0.100",
"length": "0.100",
"distribution_center": {
"id": "1",
"name": "NCX"
},
"supplier": {
"id": "1189",
"name": "Z"
},
"package_type": {
"id": null,
"name": null
},
"attributes": []
}
}
Get sku
Gets the detail information about a specific product. Same as get_products above but only for one SKU.
Example request
{
"account_id": 1,
"key": "123456789",
"warehouse": "ncx",
"sku": "010-0-S"
}
Example response
{
"status": "successful",
"product": {
"product_id": "123",
"account_id": "1",
"sku": "010-0-S",
"upc": "N/A",
"description": "The Santa BatHat - Small 13-15.5-Santa-Bat Ears",
"harmonization_code": null,
"quantity_in_warehouse": "0",
"quantity_available": "0",
"quantity_hurt": "0",
"quantity_shipped": "0",
"cost": "13.50",
"retail": "13.50",
"discontinued": "N",
"discontinued_date": null,
"created_date": "2019-01-04 11:19:54",
"updated_date": "2019-09-20 13:53:24",
"weight": "0.1000",
"width": "0.100",
"height": "0.100",
"length": "0.100",
"distribution_center": {
"id": "1",
"name": "NCX"
},
"supplier": {
"id": "1189",
"name": "Z"
},
"package_type": {
"id": null,
"name": null
},
"attributes": []
}
}
Create products
Add new products to your inventory.
Example request
{
"account_id": 1,
"key": "123abc",
"warehouse": "ncx",
"products": [{
"sku": "sku0001",
"description": "test item 1",
"width": 1,
"length": 1,
"height": 1,
"weight": 1,
"cost": 10,
"retail": 11
}, {
"sku": "sku0002",
"description": "test item 2",
"width": 1,
"length": 1,
"height": 1,
"weight": 1,
"cost": 10,
"retail": 11
}]
}
Example response
{
"status": "successful",
"result": [{
"product_id": 1,
"sku": "sku0001",
"message": "successful"
}, {
"product_id": 2,
"sku": "sku0002",
"message": "successful"
}]
}
Add/Edit attributes
Add new attribute to products
{
"account_id": 1,
"key": "abc",
"warehouse": "ncx",
"products": [{
"product_id": "43",
"attribute_name": "cost",
"attribute_value": "1"
}, {
"product_id": "2",
"attribute_name": "price",
"attribute_value": "2"
}]
}
Example response
{
"status": "partially success",
"result": {
"saved": [{
"product_id": "43",
"attribute_name": "cost",
"attribute_value": "1",
"comment": "updated"
}],
"errors": [{
"product_id": "2",
"attribute_name": "price",
"attribute_value": "2",
"error": "product_id doesn't exist."
}]
}
}
Delete attribute
Delete an attribute.
Example request
{
"account_id": 1,
"key": "123",
"warehouse": "ncx",
"product_id": "3",
"attribute_name": "cost"
}
Example response
{
"status": "success",
"result": "product attribute was deleted"
}
