Inventory API WSDL
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 (*) | int | Your AccountID. |
| Key (*) | varchar | Your API Key. |
| Warehouse (*) | varchar | This 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> | ||
Operations
- Get products
- Create products
- Create replenishment
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 |
| Kind | varchar | Type records, could be SKUs or SynSet. |
| qtyUnder | int | Number of record |
| Page | int | Pagination, 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 |
| item | varchar | Specify 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 |
| item | varchar | Specify 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/" > <SOAP-ENV:Body> <tns:inventoryAccount > <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 > <SOAP-ENV:Body> <ns1:inventoryAccountResponse > <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) |
| UPC | float | 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 |
| Quantity | integer | If grater than 0, create a replenishment.Numbers only (INTEGER without decimal points) |
| Supplier | varchar | 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) |
| SynSet | float | (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,ClientOpt3 | varchar | 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/" > <SOAP-ENV:Body> <tns:addInventoryAccount > <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 > <SOAP-ENV:Body> <ns1:addInventoryAccountResponse > <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 |
| Sku | varchar | SKU must be created before. |
| Quantity | int | Quantity 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/" > <SOAP-ENV:Body> <tns:replenishmentInventoryAccount > <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 > <SOAP-ENV:Body> <ns1:replenishmentInventoryAccountResponse > <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>