User Tools

Site Tools


udropship:umarketplace:vendor-api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
udropship:umarketplace:vendor-api [2018/03/20 19:08]
renata
udropship:umarketplace:vendor-api [2018/03/23 21:29]
renata
Line 10: Line 10:
 ===== Authentication ===== ===== Authentication =====
  
-In order to perform API operations vendor need authentication. ​System use authentication by vendor email/​apiKey. Before ​doing actual API calls vendor need to get authentication token by doing **login** soap call with  ''​username'',​ ''​api key''​ parameters. Response of that POST will be 32 bit token that need to be used for further API calls in sessionId ​request parameter to prove vendor identity. More information ​you can get here [[http://​devdocs.magento.com/​guides/​m1x/​api/​soap/​introduction.html]]+In order to perform API operations vendor need authentication. ​The system ​ authenticates the vendor ​by their email/​apiKey. Before ​performing an actual API callsvendor need to get authentication token by  **login** soap call with  ''​username'',​ ''​api key''​ parameters. Response of that POST will be 32 bit token that need to be used for further API calls. When in SessionId, ​request parameter to prove vendor identity. More information ​is avaialble ​here [[http://​devdocs.magento.com/​guides/​m1x/​api/​soap/​introduction.html]]
  
 ''​ ''​
Line 32: Line 32:
 ===== Get list of Vendor Purchase Orders (possible to filter) ===== ===== Get list of Vendor Purchase Orders (possible to filter) =====
  
-In order to get list of Purchase Orders ​need to perform ​salesOrderUdpoList API call. It expect ''​filter''​ or ''​complex_filter''​ as parameter. More details on how to construct such filter check [[http://​devdocs.magento.com/​guides/​m1x/​api/​soap/​sales/​salesOrderShipment/​sales_order_shipment.list.html]]+In order to get list of Purchase OrderssalesOrderUdpoList API call will have to be performed. It expect ''​filter''​ or ''​complex_filter''​ as parameter. More details on how to construct such filter check [[http://​devdocs.magento.com/​guides/​m1x/​api/​soap/​sales/​salesOrderShipment/​sales_order_shipment.list.html]]
  
 ''​ ''​
Line 68: Line 68:
 ===== Get Single Purchase Order Info ===== ===== Get Single Purchase Order Info =====
  
-In order to get single Purchase Order information ​need to perform ​**salesOrderUdpoInfo** API call. Parameter could be either Purchase Order entity id or it's increment id.+In order to get single Purchase Order information**salesOrderUdpoInfo** API call will have to be performed. Parameter could be either Purchase Order entity id or it's increment id.
  
 ''​ ''​
Line 111: Line 111:
 ===== Add comment to Purchase Order ===== ===== Add comment to Purchase Order =====
  
-In order to add comment to Purchase Order perform **salesOrderUdpoAddComment** API call. Parameters are ''​udpoIncrementId''​ - Purchase Order increment id, ''​- comment''​ string parameter. ​+In order to add comment to Purchase Orderperform **salesOrderUdpoAddComment** API call. Parameters are ''​udpoIncrementId''​ - Purchase Order increment id, ''​- comment''​ string parameter. ​
  
 ''​ ''​
Line 171: Line 171:
 ===== Perform Inventory update ===== ===== Perform Inventory update =====
  
-Vendor ​can use **salesUdstockUpdate** API calls to update ​his products inventory (products offers when multivendor add-on used). Request payload expect **items** parameter which should be array of arrays (later one contain single offer data details). Each offer detail can have following parameters:+Vendors ​can use **salesUdstockUpdate** API calls to update ​ther products inventory (products offers when multivendor add-on used). Request payload expect **items** parameter which should be array of arrays (later one contain single offer data details). Each offer detail can have following parameters:
   * sku   * sku
   * priority   * priority
Line 191: Line 191:
   * specialToDate   * specialToDate
  
-But only **sku** or **vendor_sku** are required. When not using multivendor ​add-on it's possible to use only this keys in offer details array **sku**, **vendor_sku**,​ **stock_qty**,​ **stock_qty_add**+But only **sku** or **vendor_sku** are required. When Multivendor ​add-on ​is not used, it's possible to use only this keys in offer details array **sku**, **vendor_sku**,​ **stock_qty**,​ **stock_qty_add**
  
 Response of API call will contain string information of how many items were updated and errors list at the end if any. Response of API call will contain string information of how many items were updated and errors list at the end if any.
udropship/umarketplace/vendor-api.txt · Last modified: 2018/03/23 21:29 by renata