User Tools

Site Tools


udropship:umarketplace:m2: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
Next revision Both sides next revision
udropship:umarketplace:m2:vendor-api [2018/03/23 21:53]
renata
udropship:umarketplace:m2:vendor-api [2019/10/23 19:22]
wtsergo [Authentication]
Line 1: Line 1:
-====== uMarketplace Vendor API Add-on======+====== uMarketplace Vendor API Add-on ======
      
 ===== Introduction ===== ===== Introduction =====
Line 15: Line 15:
  
 '' ''
-Example:\\ +Example: 
-POST  http://magento222.loc/index.php/rest/V1/integration/admin/token\\+'' 
 +<code> 
 +POST  http://magento.loc/index.php/rest/V1/integration/admin/token\\
 {"username":"<vendor email>","password":"<vendor password>"}\\ {"username":"<vendor email>","password":"<vendor password>"}\\
-\\ +</code> 
-RESPONSE\\+'' 
 +RESPONSE
 "xxxxxxxxx 32 bit token xxxxxxxxx" "xxxxxxxxx 32 bit token xxxxxxxxx"
- 
 '' ''
  
Line 29: Line 31:
  
 '' ''
-Example:\\ +Example: 
-GET  http://magento222.loc/index.php/rest/V1/udpos?searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=created_at&searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=2016-07-01+00%3A00%3A00&searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bcondition_type%5D=gt\\ +'' 
-\\+<code> 
 +GET  http://magento.loc/index.php/rest/V1/udpos?searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bfield%5D=created_at&searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bvalue%5D=2016-07-01+00%3A00%3A00&searchCriteria%5Bfilter_groups%5D%5B0%5D%5Bfilters%5D%5B0%5D%5Bcondition_type%5D=gt 
 +</code> 
 +''
 RESPONSE RESPONSE
-{"items":[{"billing_address_id":14,"created_at":"2018-03-02 18:33:51","customer_id":2,"email_sent":0,"entity_id":1,"increment_id":"000000012-1","order_id":12,"udropship_status":9,"shipping_address_id":13,"store_id":1,"total_qty":4,"total_weight":0,"updated_at":"2018-03-12 09:05:41","items":[{"entity_id":1,"name":"Push It Messenger Bag","parent_id":1,"price":56.81,"product_id":14,"row_total":170.43,"sku":"24-WB04","order_item_id":12,"qty":3},{"entity_id":2,"name":"Fusion Backpack","parent_id":1,"price":69.98,"product_id":6,"row_total":69.98,"sku":"24-MB02","order_item_id":13,"qty":1}],"comments":[{"is_customer_notified":null,"parent_id":1,"comment":"[vendor1 changed PO status from 'Ready to Ship' to 'Acknowledged']","is_visible_on_front":null,"created_at":"2018-03-12 09:05:41","entity_id":3},{"is_customer_notified":null,"parent_id":1,"comment":"vendor1: Test API Comment with status change","is_visible_on_front":null,"created_at":"2018-03-12 09:05:41","entity_id":4},{"is_customer_notified":null,"parent_id":1,"comment":"vendor1: Test API Comment","is_visible_on_front":null,"created_at":"2018-03-12 09:05:16","entity_id":2},{"is_customer_notified":null,"parent_id":1,"comment":"[vendor1 changed PO status from 'Pending' to 'Ready to Ship']","is_visible_on_front":null,"created_at":"2018-03-02 18:34:08","entity_id":1}]},{"billing_address_id":16,"created_at":"2018-03-12 08:47:24","customer_id":2,"email_sent":0,"entity_id":2,"increment_id":"000000013-1","order_id":13,"udropship_status":0,"shipping_address_id":15,"store_id":1,"total_qty":6,"total_weight":4,"updated_at":"2018-03-12 08:47:24","items":[{"entity_id":3,"name":"Orestes Yoga Pant ","parent_id":2,"price":82.74,"product_id":859,"row_total":82.74,"sku":"MP10-32-Blue","weight":1,"order_item_id":14,"qty":1},{"entity_id":4,"name":"Orestes Yoga Pant -32-Blue","parent_id":2,"price":0,"product_id":848,"sku":"MP10-32-Blue","weight":1,"order_item_id":15,"qty":1},{"entity_id":5,"name":"Helios Endurance Tank","parent_id":2,"price":25.88,"product_id":681,"row_total":25.88,"sku":"MT04-S-Blue","weight":1,"order_item_id":16,"qty":1},{"entity_id":6,"name":"Helios Endurance Tank-S-Blue","parent_id":2,"price":0,"product_id":677,"sku":"MT04-S-Blue","weight":1,"order_item_id":17,"qty":1},{"entity_id":7,"name":"Inez Full Zip Jacket","parent_id":2,"price":59.22,"product_id":1305,"row_total":59.22,"sku":"WJ07-M-Red","weight":1,"order_item_id":18,"qty":1},{"entity_id":8,"name":"Inez Full Zip Jacket-M-Red","parent_id":2,"price":0,"product_id":1298,"sku":"WJ07-M-Red","weight":1,"order_item_id":19,"qty":1},{"entity_id":9,"name":"Maxima Drawstring Short","parent_id":2,"price":27.19,"product_id":1940,"row_total":27.19,"sku":"WSH02-29-Yellow","weight":1,"order_item_id":20,"qty":1},{"entity_id":10,"name":"Maxima Drawstring Short-29-Yellow","parent_id":2,"price":0,"product_id":1930,"sku":"WSH02-29-Yellow","weight":1,"order_item_id":21,"qty":1},{"entity_id":11,"name":"Savvy Shoulder Tote","parent_id":2,"price":35.25,"product_id":10,"row_total":35.25,"sku":"24-WB05","order_item_id":22,"qty":1},{"entity_id":12,"name":"Compete Track Tote","parent_id":2,"price":39.5,"product_id":9,"row_total":39.5,"sku":"24-WB02","order_item_id":23,"qty":1}],"comments":[]},{"billing_address_id":18,"created_at":"2018-03-12 08:47:25","customer_id":2,"email_sent":0,"entity_id":3,"increment_id":"000000014-1","order_id":14,"udropship_status":0,"shipping_address_id":17,"store_id":1,"total_qty":4,"total_weight":0,"updated_at":"2018-03-12 08:47:25","items":[{"entity_id":13,"name":"Push It Messenger Bag","parent_id":3,"price":56.81,"product_id":14,"row_total":56.81,"sku":"24-WB04","order_item_id":24,"qty":1},{"entity_id":14,"name":"Overnight Duffle","parent_id":3,"price":37.39,"product_id":13,"row_total":37.39,"sku":"24-WB07","order_item_id":25,"qty":1},{"entity_id":15,"name":"Driven Backpack","parent_id":3,"price":31.39,"product_id":12,"row_total":31.39,"sku":"24-WB03","order_item_id":26,"qty":1},{"entity_id":16,"name":"Endeavor Daytrip Backpack","parent_id":3,"price":29.11,"product_id":11,"row_total":29.11,"sku":"24-WB06","order_item_id":27,"qty":1}],"comments":[]},{"billing_address_id":20,"created_at":"2018-03-12 08:47:29","customer_id":2,"email_sent":0,"entity_id":4,"increment_id":"000000015-1","order_id":15,"udropship_status":0,"shipping_address_id":19,"store_id":1,"total_qty":4,"total_weight":0,"updated_at":"2018-03-12 08:47:29","items":[{"entity_id":17,"name":"Push It Messenger Bag","parent_id":4,"price":56.81,"product_id":14,"row_total":56.81,"sku":"24-WB04","order_item_id":28,"qty":1},{"entity_id":18,"name":"Overnight Duffle","parent_id":4,"price":37.39,"product_id":13,"row_total":37.39,"sku":"24-WB07","order_item_id":29,"qty":1},{"entity_id":19,"name":"Driven Backpack","parent_id":4,"price":31.39,"product_id":12,"row_total":31.39,"sku":"24-WB03","order_item_id":30,"qty":1},{"entity_id":20,"name":"Endeavor Daytrip Backpack","parent_id":4,"price":29.11,"product_id":11,"row_total":29.11,"sku":"24-WB06","order_item_id":31,"qty":1}],"comments":[]}],"search_criteria":{"filter_groups":[]},"total_count":4} 
 '' ''
 +
 +<code>
 +
 +{
 +"items": [{
 +    "billing_address_id": 14,
 +    "created_at": "2018-03-02 18:33:51",
 +    "customer_id": 2,
 +    "email_sent": 0,
 +    "entity_id": 1,
 +    "increment_id": "000000012-1",
 +    "order_id": 12,
 +    "udropship_status": 9,
 +    "shipping_address_id": 13,
 +    "store_id": 1,
 +    "total_qty": 4,
 +    "total_weight": 0,
 +    "updated_at": "2018-03-12 09:05:41",
 +    "items": [{
 +        "entity_id": 1,
 +        "name": "Push It Messenger Bag",
 +        "parent_id": 1,
 +        "price": 56.81,
 +        "product_id": 14,
 +        "row_total": 170.43,
 +        "sku": "24-WB04",
 +        "order_item_id": 12,
 +        "qty": 3
 +    }, {
 +        "entity_id": 2,
 +        "name": "Fusion Backpack",
 +        "parent_id": 1,
 +        "price": 69.98,
 +        "product_id": 6,
 +        "row_total": 69.98,
 +        "sku": "24-MB02",
 +        "order_item_id": 13,
 +        "qty": 1
 +    }],
 +    "comments": [{
 +        "is_customer_notified": null,
 +        "parent_id": 1,
 +        "comment": "[vendor1 changed PO status from 'Ready to Ship' to 'Acknowledged']",
 +        "is_visible_on_front": null,
 +        "created_at": "2018-03-12 09:05:41",
 +        "entity_id": 3
 +    }, {
 +        "is_customer_notified": null,
 +        "parent_id": 1,
 +        "comment": "vendor1: Test API Comment with status change",
 +        "is_visible_on_front": null,
 +        "created_at": "2018-03-12 09:05:41",
 +        "entity_id": 4
 +    }, {
 +        "is_customer_notified": null,
 +        "parent_id": 1,
 +        "comment": "vendor1: Test API Comment",
 +        "is_visible_on_front": null,
 +        "created_at": "2018-03-12 09:05:16",
 +        "entity_id": 2
 +    }, {
 +        "is_customer_notified": null,
 +        "parent_id": 1,
 +        "comment": "[vendor1 changed PO status from 'Pending' to 'Ready to Ship']",
 +        "is_visible_on_front": null,
 +        "created_at": "2018-03-02 18:34:08",
 +        "entity_id": 1
 +    }]
 +}, {
 +    "billing_address_id": 16,
 +    "created_at": "2018-03-12 08:47:24",
 +    "customer_id": 2,
 +    "email_sent": 0,
 +    "entity_id": 2,
 +    "increment_id": "000000013-1",
 +    "order_id": 13,
 +    "udropship_status": 0,
 +    "shipping_address_id": 15,
 +    "store_id": 1,
 +    "total_qty": 6,
 +    "total_weight": 4,
 +    "updated_at": "2018-03-12 08:47:24",
 +    "items": [{
 +        "entity_id": 3,
 +        "name": "Orestes Yoga Pant ",
 +        "parent_id": 2,
 +        "price": 82.74,
 +        "product_id": 859,
 +        "row_total": 82.74,
 +        "sku": "MP10-32-Blue",
 +        "weight": 1,
 +        "order_item_id": 14,
 +        "qty": 1
 +    }, {
 +        "entity_id": 4,
 +        "name": "Orestes Yoga Pant -32-Blue",
 +        "parent_id": 2,
 +        "price": 0,
 +        "product_id": 848,
 +        "sku": "MP10-32-Blue",
 +        "weight": 1,
 +        "order_item_id": 15,
 +        "qty": 1
 +    }, {
 +        "entity_id": 5,
 +        "name": "Helios Endurance Tank",
 +        "parent_id": 2,
 +        "price": 25.88,
 +        "product_id": 681,
 +        "row_total": 25.88,
 +        "sku": "MT04-S-Blue",
 +        "weight": 1,
 +        "order_item_id": 16,
 +        "qty": 1
 +    }, {
 +        "entity_id": 6,
 +        "name": "Helios Endurance Tank-S-Blue",
 +        "parent_id": 2,
 +        "price": 0,
 +        "product_id": 677,
 +        "sku": "MT04-S-Blue",
 +        "weight": 1,
 +        "order_item_id": 17,
 +        "qty": 1
 +    }, {
 +        "entity_id": 7,
 +        "name": "Inez Full Zip Jacket",
 +        "parent_id": 2,
 +        "price": 59.22,
 +        "product_id": 1305,
 +        "row_total": 59.22,
 +        "sku": "WJ07-M-Red",
 +        "weight": 1,
 +        "order_item_id": 18,
 +        "qty": 1
 +    }, {
 +        "entity_id": 8,
 +        "name": "Inez Full Zip Jacket-M-Red",
 +        "parent_id": 2,
 +        "price": 0,
 +        "product_id": 1298,
 +        "sku": "WJ07-M-Red",
 +        "weight": 1,
 +        "order_item_id": 19,
 +        "qty": 1
 +    }, {
 +        "entity_id": 9,
 +        "name": "Maxima Drawstring Short",
 +        "parent_id": 2,
 +        "price": 27.19,
 +        "product_id": 1940,
 +        "row_total": 27.19,
 +        "sku": "WSH02-29-Yellow",
 +        "weight": 1,
 +        "order_item_id": 20,
 +        "qty": 1
 +    }, {
 +        "entity_id": 10,
 +        "name": "Maxima Drawstring Short-29-Yellow",
 +        "parent_id": 2,
 +        "price": 0,
 +        "product_id": 1930,
 +        "sku": "WSH02-29-Yellow",
 +        "weight": 1,
 +        "order_item_id": 21,
 +        "qty": 1
 +    }, {
 +        "entity_id": 11,
 +        "name": "Savvy Shoulder Tote",
 +        "parent_id": 2,
 +        "price": 35.25,
 +        "product_id": 10,
 +        "row_total": 35.25,
 +        "sku": "24-WB05",
 +        "order_item_id": 22,
 +        "qty": 1
 +    }, {
 +        "entity_id": 12,
 +        "name": "Compete Track Tote",
 +        "parent_id": 2,
 +        "price": 39.5,
 +        "product_id": 9,
 +        "row_total": 39.5,
 +        "sku": "24-WB02",
 +        "order_item_id": 23,
 +        "qty": 1
 +    }],
 +    "comments": []
 +}, {
 +    "billing_address_id": 18,
 +    "created_at": "2018-03-12 08:47:25",
 +    "customer_id": 2,
 +    "email_sent": 0,
 +    "entity_id": 3,
 +    "increment_id": "000000014-1",
 +    "order_id": 14,
 +    "udropship_status": 0,
 +    "shipping_address_id": 17,
 +    "store_id": 1,
 +    "total_qty": 4,
 +    "total_weight": 0,
 +    "updated_at": "2018-03-12 08:47:25",
 +    "items": [{
 +        "entity_id": 13,
 +        "name": "Push It Messenger Bag",
 +        "parent_id": 3,
 +        "price": 56.81,
 +        "product_id": 14,
 +        "row_total": 56.81,
 +        "sku": "24-WB04",
 +        "order_item_id": 24,
 +        "qty": 1
 +    }, {
 +        "entity_id": 14,
 +        "name": "Overnight Duffle",
 +        "parent_id": 3,
 +        "price": 37.39,
 +        "product_id": 13,
 +        "row_total": 37.39,
 +        "sku": "24-WB07",
 +        "order_item_id": 25,
 +        "qty": 1
 +    }, {
 +        "entity_id": 15,
 +        "name": "Driven Backpack",
 +        "parent_id": 3,
 +        "price": 31.39,
 +        "product_id": 12,
 +        "row_total": 31.39,
 +        "sku": "24-WB03",
 +        "order_item_id": 26,
 +        "qty": 1
 +    }, {
 +        "entity_id": 16,
 +        "name": "Endeavor Daytrip Backpack",
 +        "parent_id": 3,
 +        "price": 29.11,
 +        "product_id": 11,
 +        "row_total": 29.11,
 +        "sku": "24-WB06",
 +        "order_item_id": 27,
 +        "qty": 1
 +    }],
 +    "comments": []
 +}, {
 +    "billing_address_id": 20,
 +    "created_at": "2018-03-12 08:47:29",
 +    "customer_id": 2,
 +    "email_sent": 0,
 +    "entity_id": 4,
 +    "increment_id": "000000015-1",
 +    "order_id": 15,
 +    "udropship_status": 0,
 +    "shipping_address_id": 19,
 +    "store_id": 1,
 +    "total_qty": 4,
 +    "total_weight": 0,
 +    "updated_at": "2018-03-12 08:47:29",
 +    "items": [{
 +        "entity_id": 17,
 +        "name": "Push It Messenger Bag",
 +        "parent_id": 4,
 +        "price": 56.81,
 +        "product_id": 14,
 +        "row_total": 56.81,
 +        "sku": "24-WB04",
 +        "order_item_id": 28,
 +        "qty": 1
 +    }, {
 +        "entity_id": 18,
 +        "name": "Overnight Duffle",
 +        "parent_id": 4,
 +        "price": 37.39,
 +        "product_id": 13,
 +        "row_total": 37.39,
 +        "sku": "24-WB07",
 +        "order_item_id": 29,
 +        "qty": 1
 +    }, {
 +        "entity_id": 19,
 +        "name": "Driven Backpack",
 +        "parent_id": 4,
 +        "price": 31.39,
 +        "product_id": 12,
 +        "row_total": 31.39,
 +        "sku": "24-WB03",
 +        "order_item_id": 30,
 +        "qty": 1
 +    }, {
 +        "entity_id": 20,
 +        "name": "Endeavor Daytrip Backpack",
 +        "parent_id": 4,
 +        "price": 29.11,
 +        "product_id": 11,
 +        "row_total": 29.11,
 +        "sku": "24-WB06",
 +        "order_item_id": 31,
 +        "qty": 1
 +    }],
 +    "comments": []
 +}], 
 +"search_criteria": {"filter_groups": []}, 
 +"total_count": 4
 +}
 +
 +</code>
  
 ===== Get Single Purchase Order Info ===== ===== Get Single Purchase Order Info =====
  
-In order to get list of single Purchase Order information perform ///V1/udpo/:id// GET API call. :id parameter could be either Purchase Order entity id or it's increment id.+In order to get single Purchase Order information perform ///V1/udpo/:id// GET API call. :id parameter could be either Purchase Order entity id or it's increment id.
  
 '' ''
udropship/umarketplace/m2/vendor-api.txt · by wtsergo