Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
udropship:umarketplace:vendor-api [2018/03/19 10:26] wtsergo [Introduction] |
udropship:umarketplace:vendor-api [2018/03/23 21:29] (current) renata |
===== Introduction ===== | ===== Introduction ===== |
| |
This add-on extend magento Soap API and allow vendors utilize it to pull/update Purchase Orders information and update inventory data. | The Vendor API add-on extends Magento Soap API and allow vendors to utilize it to pull/update Purchase Orders information and update inventory data. |
To get more technical details check:\\ | To get more technical details check:\\ |
- //app\code\community\Unirgy\DropshipApi\etc\wsdl.xml/ - API wsdl definition\\ | - //app\code\community\Unirgy\DropshipApi\etc\wsdl.xml/ - API wsdl definition\\ |
===== 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 calls, vendor 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]] |
| |
'' | '' |
===== 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 Orders, salesOrderUdpoList 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]] |
| |
'' | '' |
===== 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. |
| |
'' | '' |
===== 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 Order, perform **salesOrderUdpoAddComment** API call. Parameters are ''udpoIncrementId'' - Purchase Order increment id, ''- comment'' string parameter. |
| |
'' | '' |
===== 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 |
* 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. |