Difference between revisions of "Get Item by External Id"
From MyMobileWorkers API
(→Response Parameters) |
(→Example curl request) |
||
| (One intermediate revision by one user not shown) | |||
| Line 15: | Line 15: | ||
|- | |- | ||
! | ! | ||
| − | | | + | | external_id || required |
|- | |- | ||
! Response | ! Response | ||
| Line 69: | Line 69: | ||
== Example curl request == | == Example curl request == | ||
| − | curl "http:// | + | curl "http://api.mymobileworkers.com:8080/api/1/items/item/external/?api_key=darrenwebapi&external_id=ss303" |
Latest revision as of 12:43, 14 November 2016
Contents |
[edit] Summary
| Item by External Id | ||
|---|---|---|
| URL | http://:base_url/:api_path/:version/items/item/external?api_key=YOUR_KEY&external_id=EXTERNAL_ID | |
| Type | GET | |
| Params: | api_key | required |
| external_id | required | |
| Response | JSON | |
The Get Item By External Id method returns the item corresponding to the external id provided.
[edit] Response Parameters
| Field | Description |
|---|---|
| name | Item name |
| category | Contains both category name and id for item |
| notes | Item notes |
| price | Item price |
| external_id | Item external id |
| product_code | Item product code |
[edit] Example response
{ "name":"darrenItem", "category":{ "external_id":"", "name":"Test1" }, "notes":"notes", "external_id":"ss303", "product_code":"productCodeTest", "price":2.5 }
