Inventory API WSDL

 In API/Developers

Operations

Get products
Create products
Create replenishment 

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 API  http://integration.shipedge.com/API/Inventory_2/InventoryAPI.php?wsdl  

Example PHP:   ClientInventoryAPI.php

 

(*) means required data.

access

Paremeter

Type

Description

AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
Example
<access xsi:type="tns:access">
<AccountID xsi:type="xsd:int">210</AccountID>
<Key xsi:type="xsd:string">xxxxxx</Key>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>

 

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

Method: inventoryAccount
variable

Paremeter

Type

Description

KindvarcharType records, could be SKUs or SynSet.
qtyUnderintNumber of record
PageintPagination, number page
Example
<variable xsi:type="tns:variable">
<Kind xsi:type="xsd:string">SKUs</Kind>
<qtyUnder xsi:type="xsd:int">10</qtyUnder>
<Page xsi:type="xsd:int">1</Page>
</variable>

skuList

Paremeter

Type

Description

itemvarcharSpecify a list of SKUs to get details about a products. If empty return all SKUs
Example
<skuList SOAP-ENC:arrayType="xsd:string[2]" xsi:type="SOAP-ENC:Array">
<item xsi:type="xsd:string">test_1</item>
<item xsi:type="xsd:string">test_2</item>
</skuList>

 

supplierList

Paremeter

Type

Description

itemvarcharSpecify a list of SKUs to get details about a products. If empty return all suppliers
Example
<supplierList SOAP-ENC:arrayType="xsd:string[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="xsd:string">supplier_1</item>
</supplierList>

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<tns:inventoryAccount xmlns:tns="http://integration.shipedge.com/API/Inventory/">
<access xsi:type="tns:access">
<AccountID xsi:type="xsd:int">210</AccountID>
<Key xsi:type="xsd:string">xxxxxx</Key>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>
<variable xsi:type="tns:variable">
<Kind xsi:type="xsd:string">SKUs</Kind>
<qtyUnder xsi:type="xsd:int">10</qtyUnder>
<Page xsi:type="xsd:int">1</Page>
</variable>
<skuList SOAP-ENC:arrayType="xsd:string[2]" xsi:type="SOAP-ENC:Array">
<item xsi:type="xsd:string">test_1</item>
<item xsi:type="xsd:string">test_2</item>
</skuList>
<supplierList SOAP-ENC:arrayType="xsd:string[0]" xsi:type="SOAP-ENC:Array"/>
</tns:inventoryAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:inventoryAccountResponse xmlns:ns1="http://integration.shipedge.com/API/Inventory/">
<requestSkus xsi:type="tns:skusResponse">
<access xsi:type="tns:accessResponse">
<AccountID xsi:type="xsd:int">210</AccountID>
<AccessAccount xsi:type="xsd:string">Allow: inventoryAccount</AccessAccount>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
<NumItems xsi:type="xsd:int">2</NumItems>
</access>
<skuResp SOAP-ENC:arrayType="tns:skuArray[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuArray">
<Sku xsi:type="xsd:string">test_2</Sku>
<UPC xsi:type="xsd:string">UPC11</UPC>
<Description xsi:type="xsd:string">Description1</Description>
<Cost xsi:type="xsd:decimal">21.000</Cost>
<Declared xsi:type="xsd:decimal">11.000</Declared>
<Weight xsi:type="xsd:decimal">10.0000</Weight>
<Length xsi:type="xsd:decimal">61.000</Length>
<Width xsi:type="xsd:decimal">71.000</Width>
<Height xsi:type="xsd:decimal">81.000</Height>
<Volume xsi:type="xsd:decimal">0.000</Volume>
<UnitsInStock xsi:type="xsd:int">0</UnitsInStock>
<Discontinued xsi:type="xsd:string">N</Discontinued>
<Kind xsi:type="xsd:string">SKUs</Kind>
<Replenishment SOAP-ENC:arrayType="tns:ReplenishmentDetaill[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:ReplenishmentDetaill">
<ReplenishmentID xsi:type="xsd:string">9910</ReplenishmentID>
<ReplenishmentStatus xsi:type="xsd:string">PENDING</ReplenishmentStatus>
<ExpectedDate xsi:type="xsd:string">2014-01-15 18:01:13</ExpectedDate>
<Comment xsi:type="xsd:string">Replenishment UPLOAD Inventory API_210_2014_01_15_18_01_12.csv</Comment>
<QtyRequest xsi:type="xsd:string">31</QtyRequest>
<QtyRecived xsi:type="xsd:string">0</QtyRecived>
</item>
</Replenishment>
</item>
</skuResp>
</requestSkus>
</ns1:inventoryAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Create Products

–  Returns the number of SKUs create, denied

Method: addInventoryAccount
skuList

Paremeter

Type

Description

Sku(*)varchar A unique item identifier. Alphanumeric Value consisting of only a few characters. The SKU you use in our system should match your provider’s SKU or any way to identify the box. It should match your shopping-carts product-code. You may use SynSets if you cannot make a match.Alpha-numeric value 40 characters long (under 10 is recommended the shorter the better for the warehouse)
UPCfloat Usually a bar-code number associated with your product. This field is optional therefore you can use an additional unique identifier even if it is not the official UPC of the product. Examples include: ISBN in books and other Bar-code (usually a numeric sequence)Alpha-numeric value 50 characters long (usually 15 numbers)
Description(*)int The description of your item is a way for the warehouse people to verify your product matches its SKU. Short Description: 150 characters max. Customs forms will be truncated characters.Alpha-numeric values up to 150 characters long
Cost(*)float The cost or dollar amount to order product from your provider, it will be used to generate purchase orders, and for insurance purposes by the warehouse.Numbers only (up to 6 numbers with 3 decimal points)
Declared(*)float The declared value is the dollar amount you wish to declare for customs and insurance purposes when shipping your orders.Numbers only (up to 6 numbers with 3 decimal points)
Weight(*)float Product weight will be verified and overwritten by warehouse staff at receiving. (Pounds)
 Lenght(*)float The length of your product’s retail package.INCHES – Numbers only
 Widht(*)float The length of your product’s retail package.INCHES – Numbers only
 Height(*)float The length of your product’s retail package.INCHES – Numbers only
 Quantityinteger If grater than 0, create a replenishment.Numbers only (INTEGER without decimal points)
 Suppliervarchar Assign the SKU to your supplier-nick. If you do not have the supplier nickname in shipedge, this will create a nickname for you. You may also manage supplier in bulk inside ‘Procedures’. Please configure your supplier ‘s view for PO automation and forecasting.Alpha-numeric values up to 255 characters long (less than 15 is recommended)
 SynSetfloat (ADVANCED) A way to match SKU codes used in shipedge with the ones you use in your shopping carts and tools. SynSet stands for Synonyms & Sets. You may assign the same SKU to various Synsets (synonyms). For Sets or bundles you may include several SKUs to the same SynSet, just repeat the Synset name for another SKU line-item
ClientOpt1, ClientOpt2,ClientOpt3varchar Optional Product Details (to be used for integration projects).Alpha-numeric values up to 10 characters long
Example
<item xsi:type="tns:skuArray">
<Sku xsi:type="xsd:string">test_8</Sku>
<UPC xsi:type="xsd:string">UPC11</UPC>
<Description xsi:type="xsd:string">Description1</Description>
<Cost xsi:type="xsd:decimal">21</Cost>
<Declared xsi:type="xsd:decimal">11</Declared>
<Weight xsi:type="xsd:decimal">10</Weight>
<Length xsi:type="xsd:decimal">61</Length>
<Width xsi:type="xsd:decimal">71</Width>
<Height xsi:type="xsd:decimal">81</Height>
<Quantity xsi:type="xsd:int">2</Quantity>
<Supplier xsi:type="xsd:string"/>
<SynSet xsi:type="xsd:string"/>
<ClientOpt1 xsi:type="xsd:string"/>
<ClientOpt2 xsi:type="xsd:string"/>
<ClientOpt3 xsi:type="xsd:string"/>
</item>

Request

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<tns:addInventoryAccount xmlns:tns="http://integration.shipedge.com/API/Inventory/">
<access xsi:type="tns:access">
<AccountID xsi:type="xsd:int">210</AccountID>
<Key xsi:type="xsd:string">xxxxx</Key>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>
<skulist SOAP-ENC:arrayType="tns:skuArray[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuArray">
<Sku xsi:type="xsd:string">test_7</Sku>
<UPC xsi:type="xsd:string">UPC1</UPC>
<Description xsi:type="xsd:string">Description1</Description>
<Cost xsi:type="xsd:decimal">21</Cost>
<Declared xsi:type="xsd:decimal"/>
<Weight xsi:type="xsd:decimal">34</Weight>
<Length xsi:type="xsd:decimal">61</Length>
<Width xsi:type="xsd:decimal">71</Width>
<Height xsi:type="xsd:decimal">81</Height>
<Quantity xsi:type="xsd:int">3</Quantity>
<Supplier xsi:type="xsd:string"/>
<SynSet xsi:type="xsd:string"/>
<ClientOpt1 xsi:type="xsd:string"/>
<ClientOpt2 xsi:type="xsd:string"/>
<ClientOpt3 xsi:type="xsd:string"/>
</item>
</skulist>
</tns:addInventoryAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:addInventoryAccountResponse xmlns:ns1="http://integration.shipedge.com/API/Inventory/">
<addrequestskus xsi:type="tns:addSkusResponse">
<access xsi:type="tns:accessResponse">
<AccountID xsi:type="xsd:int">210</AccountID>
<AccessAccount xsi:type="xsd:string">Allow: addInventoryAccount</AccessAccount>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>
<addListSkus xsi:type="tns:listSku">
<allow xsi:type="xsd:string">1</allow>
<denied SOAP-ENC:arrayType="tns:skuRespAddDenied[2]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuRespAddDenied">
<Sku xsi:type="xsd:string">test_4</Sku>
<CommentAPI xsi:type="xsd:string">Sku exist</CommentAPI>
</item>
<item xsi:type="tns:skuRespAddDenied">
<Sku xsi:type="xsd:string">test_7</Sku>
<CommentAPI xsi:type="xsd:string">Field: Declared No numeric</CommentAPI>
</item>
</denied>
<replenishment_id xsi:type="xsd:string">10568</replenishment_id>
</addListSkus>
</addrequestskus>
</ns1:addInventoryAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Create Replenishment

Gets the collection of products. – Returns all the SKUs in your account, along with the values for each attribute in each on (metadata).

Method: replenishmentInventoryAccount
skuList

Paremeter

Type

Description

SkuvarcharSKU must be created before.
QuantityintQuantity of SKU for replenishment.Numbers only (INTEGER without decimal points)
Example
<skuList SOAP-ENC:arrayType="tns:skuReplenishmentArray[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_1</Sku>
<Quantity xsi:type="xsd:int">1</Quantity>
</item>
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_2</Sku>
<Quantity xsi:type="xsd:int">2</Quantity>
</item>
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_3</Sku>
<Quantity xsi:type="xsd:int">3</Quantity>
</item>
</skuList>

 

Request

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<tns:replenishmentInventoryAccount xmlns:tns="http://integration.shipedge.com/API/Inventory/">
<access xsi:type="tns:access">
<AccountID xsi:type="xsd:int">210</AccountID>
<Key xsi:type="xsd:string">xxxx</Key>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>
<skuList SOAP-ENC:arrayType="tns:skuReplenishmentArray[3]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_1</Sku>
<Quantity xsi:type="xsd:int">1</Quantity>
</item>
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_2</Sku>
<Quantity xsi:type="xsd:int">2</Quantity>
</item>
<item xsi:type="tns:skuReplenishmentArray">
<Sku xsi:type="xsd:string">test_3</Sku>
<Quantity xsi:type="xsd:int">3</Quantity>
</item>
</skuList>
</tns:replenishmentInventoryAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://integration.shipedge.com/API/Inventory/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:replenishmentInventoryAccountResponse xmlns:ns1="http://integration.shipedge.com/API/Inventory/">
<replenishmentSkus xsi:type="tns:addSkusResponse">
<access xsi:type="tns:accessResponse">
<AccountID xsi:type="xsd:int">210</AccountID>
<AccessAccount xsi:type="xsd:string">Allow: replenishmentInventoryAccount</AccessAccount>
<Warehouse xsi:type="xsd:string">demo</Warehouse>
</access>
<addListSkus xsi:type="tns:listSku">
<allow xsi:type="xsd:string">2</allow>
<denied SOAP-ENC:arrayType="tns:skuRespAddDenied[1]" xsi:type="SOAP-ENC:Array">
<item xsi:type="tns:skuRespAddDenied">
<Sku xsi:type="xsd:string">test_2222</Sku>
<CommentAPI xsi:type="xsd:string">Sku no exist</CommentAPI>
</item>
</denied>
<replenishment_id xsi:type="xsd:string">10570</replenishment_id>
</addListSkus>
</replenishmentSkus>
</ns1:replenishmentInventoryAccountResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Contact Us

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