Inventory API RESTful

 In API/Developers

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.

 

API
AccountID123
Key1233456789
Warehouse123
Api basehttp://integration.shipedge.com/API/Rest/Inventory

Operations

 

Ping

Ping to check the system status.

GET /ping

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx"
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.

 

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).

see example

GET /getProducts

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"page": 2, 
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
page (*)intPagination, number of page.

 

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.

GET /getTotalProducts

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.

 

Get SKU

Gets the detail information about a specific product.  Same as getProducts above but only for one SKU.

GET /getSKU

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"sku": "sku1"
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
sku (*)varcharSpecify sku to get details about a product.

 

Create Products

Add new products to your inventory.

POST /createProducts

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse": "ncx",
"products": [
{
"sku": "sku1",
"description": "test item 1",
"width": 1.0,
"length": 1.0,
"height": 1.0,
"weight": 1.0,
"cost": 10.0,
"retail": 11.0
},
{
"sku": "sku2",
"description": "test item 2",
"width": 1.0,
"length": 1.0,
"height": 1.0,
"weight": 1.0,
"cost": 10.0,
"retail": 11.0
}

]
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
product_id (*)integerSpecify a product_id to get details about a product.
products (*)arrayCollection of products, each item contents:sku (*)
descript.on (*)
width (*)
length (*)
height (*)
weight (*)
cost (*)
retail (*)
Contact Us

Send us an email and we'll get back to you, ASAP.