Use this postman collection to easy connect to PluggTo;
\nPluggTo API is accessible by the URL https://api.plugg.to
\n\nActualy exists 4 types of resources:\n
Products and Skus is the same, the Skus endpoint was builded to avoid the need to to know the internal id of some sku to view it or updated
\n\nWe recommeded to use the Products endpoint ONLY if you need to search some product by attribute or get all, or if you received a notification with the product resource id and with notication type = product
\n\n\nTo make any request, you will need a valid access token that is sent in the header of the example calls:
\ncurl --request GET \\
\n --url https://api.plugg.to/orders \\
\n --header 'Accept: application/json' \\
\n --header 'Authorization: Bearer {ACCESS_TOKEN}' \\
\n --header 'Content-Type: application/json'
To get a access tokens you have to make authenticate using APP authentication method or Plugin authentication method.\n\n
Check the Authentication Api
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"249752","collectionId":"820b8981-2c8a-4e89-b3ee-6a0949be42c9","publishedId":"T1DpAwbJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-23T12:10:44.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authentication By Password","id":"0ffdb078-6ed6-4c44-8939-3a223dcec029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"grant_type=password&client_id=[client_id]&client_secret=[client_secret]&username=[app_user]&password=[app_password]"},"url":"https://api.plugg.to/oauth/token","description":"Use this method if yor application is connecting to Pluggto and have just one user or you know who your user is.
\nTo get a access_token from plugin authetication method you need 4 credencials.
\nUse this method if you want that your application oppened inside PluggTo
\nWhen create an APP in Pluggto you will register a URL that all users will be redirect when they click your application.
\nIn the URL we will gonna send a parameter called \"pluggtocode\" that you should access an send to our API with your \"client_id\" and \"client_secreat\", passing it as the parameter \"code\". This code is valid only for the first called, or few minutes, and will give as return the user access_token and refresh_token that you should keep in your database.
\nTo get a access_token from plugin authetication method you need 3 credencials.
\nWhen using the ENDPOINT \"users\" will allow you to know the user who is acessing your application.
\nOnce that you have the refresh_token will be possible to authenticate next time by refresh_token method.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"8855bc06-2447-42be-b9ad-e76dcdcee065","id":"8855bc06-2447-42be-b9ad-e76dcdcee065","name":"Authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["oauth","token"],"host":["api","plugg","to"],"query":[],"variable":[]}},"response":[],"_postman_id":"f112b8f7-a457-4423-b398-08f7b690ef2c"},{"name":"Authentication By Refresh Token","id":"e5495a70-1848-448e-bdad-c82c1b8807d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"grant_type=refresh_token&client_id=[client_id]&client_secret=[client_secret]&refresh_token=[refresh_token_keeped]"},"url":"https://api.plugg.to/oauth/token","description":"This is a second part authentiction.\nthis method if you already have been authenticate the API and already have a refresh_token valid
\nTo get a access_token from plugin authetication method you need 3 credencials.
\nIntroduction to authentication
\nPluggto authentication was built folowing Oauth 2.0 Protocol
\n\nTo access the Pluggto Resouces (Products,Orders,Messages) you must in all call the access_token parameter.
\n\n\nTo get a access token you should one of the folowing authentication methods. By (password,authorization_code,refresh_token)
\n\n\nEach \"access_token\" is valid for 1 hour, after is necessary to repet the authentication.
\n\nFor better performace DONT'T generate a new authentication for each call that you make.
\nTo get your keys you must go Pluggtos painel, on top menu , click in your account name, than goes to developer and select if want to create a Plugin click on Create on Plugin tab else on create on App tab.
\n\n\n\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1d66338f-5cf3-4a50-a6d8-82d6486579e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"89044531-0e1a-4f14-8dd1-e97b63047a68","type":"text/javascript","exec":[""]}}],"_postman_id":"8855bc06-2447-42be-b9ad-e76dcdcee065"},{"name":"Notifications/Webhook","item":[],"id":"928798e8-7106-4863-bcf6-df2966e01b31","description":"PluggTo sends notifications to your app or plugin to you easy know when a product or orders was created or modified on PluggTo
\n\nNotifications are send as POST with a Json message to an URL previusly register in PluggTo in the moment that you have created your Application or Plugin
\n\nYou going to receive in the menssage the user_id of the resource owner, the resource type (products or orders), the resource id that has changed and the action (\"created\" or \"updated\")
\n\nThe post will be send in the following format:
\n\n{\"type\":\"PRODUCTS/SKUS/ORDERS\",\"id\":\"PLUGGTO_ID\",\"action\":\"UPDATEORCREATE\",\"user\":1120, \"changes\" : {\"status\" : false,\"stock\" : false,\"price\":false }}
\n\nExemple:
\n{\n \"user\" : 129,\n \"id\" : \"5b9169c309eacd415056aa3a\",\n \"changes\" : {\n \"status\" : false,\n \"stock\" : false,\n \"price\" : false\n },\n \"type\" : \"products\",\n \"action\" : \"updated\"\n}
\nImportant:
\nPluggTo expecteds a 200 code return, to kwnow that your application has received the menssage, if PluggTo do not receive the 200 code, the menssage will to a retry queue
\n\nRetry intervals:
\nMethod to update order.
\nYour system must create a shippiment with status \"invoiced\", when sending invoice data.
\nYour system must create a shippiment with status \"shipping_informed\", when sending shipment data.
\nAttention:The \"shipped\" status is register by Pluggto when we have success to send the information to the MarketPlace, while in case of unsuccess we mark the order with the status \"shipping_error\".
\nIn case of \"invoiced\" or \"shipping_informed\". If you change just the status order withou send the information, this status will not be update on the Marketplace.
\nI case of status \"canceled\", not all Marketplace accept to cancel orders by API check with our team if this update will be reflected on a specific marketplace
\nIf alreay exists one shipment created in the order, is necessary to send the field \"id\" that return from our API, otherwise you will create a new shipment.
\nExemple:
\n{\n\"status\":\"shipping_informed\",\n\"shipments\":\n [{\"id\":\"32132311311\", \n\"shipping_company\":\"Correios\",\n\"shipping_method\":\"PAC\",\n\"track_code\":\"11111\",\n\"track_url\":\"http://correios.com.br\",\n\"status\":\"shipped\",\n\"date_shipped\":\"2016-11-01\",\n\"nfe_key\":\"44444444444444444444444444444\",\n\"nfe_link\":\"http://nfe.com.br/nsaasa\",\n\"nfe_number\":\"12\",\n\"nfe_serie\":\"1\",\n\"nfe_date\":\"2016-11-01\"\n}]\n}
\n{\n\"status\":\"invoice\",\n\"shipments\":\n [{\"id\":\"32132311311\", \n\"status\":\"invoiced\",\n\"nfe_key\":\"44444444444444444444444444444\",\n\"nfe_link\":\"http://nfe.com.br/nsaasa\",\n\"nfe_number\":\"12\",\n\"nfe_serie\":\"1\",\n\"nfe_date\":\"2016-11-01\"\n}]\n}
\n","urlObject":{"protocol":"https","path":["orders","5877efb70280833e402e54bc"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"23b2bd1d1b73fa42506bd4c9f2c3223414d9d3af"}],"variable":[]}},"response":[],"_postman_id":"36f2bd8e-0fec-4cac-a3d1-67c59a3f7642"},{"name":"Get All Orders","id":"ffe237e5-1c77-4032-8ac1-c3bab1093835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"From this endpoint is possible to get all orders from PluggTo.
\n| next | \nInsert the last id found in the previus call | \n
| limit | \nInsert the number or registers to be returned | \n
| created | \nCheck from creation date (ie 2017-01-01to2017-02-01) | \n
| modified | \nCheck from update date. (ie 2017-01-01to2017-02-01) | \n
| sku | \nSearch orders that contains this sku | \n
| channel_id | \nSearch by original channel id (ie 1231) | \n
| channel | \nSearch by channel name (ie. Mercadolivre) | \n
| attribute | \nSearch by attribute code or attribute value field (exact) | \n
| nfe_number | \nSearch by invoice number | \n
| has_nfe | \nSee if has invoice number | \n
| track_code | \nSearch by track code | \n
| shipping_company | \nSearch by shipping company | \n
| external | \nSearch by your application id | \n
| ack | \nShow olders that is or not know (ie. ack=1 or ack=0) | \n
| others | \nyou can search by any other api propriety, like \"receiver_name=Anny or status=active\" | \n
With this method you can get multiple orders labels and PLPs in a single page
\nParameters
\nReturned
\n\n{\n\"urls\": [\n\"https://..../plps.pdf\",\n\"https://..../labels.pdf\"\n]\n}\n","urlObject":{"protocol":"http","path":["labels"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"{{access_token}}"},{"key":"orders","value":"{{pluggto_order_id_1}},{{pluggto_order_id_2}},"}],"variable":[]}},"response":[],"_postman_id":"564c309e-9366-4073-bafa-84d157bc25e9"}],"id":"f09e1eaf-5f82-4232-a59d-e02bb940de42","description":"Order Status
\nStatus Rules
\nDelivery Type
\n\nUse to sell multiple products as a kit, always provide the \"parent\" product sku, if a product has variations, KIT variations will automatically be created, each SKU code of each variation of the KIT is generated dynamically.\n
\n\nAfter the KIT is generated, if the KIT has variations, it will no longer be possible to change the structure of products that make up the KIT.\n
","urlObject":{"protocol":"https","path":["skus","{sku_id}"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"{access_token}"}],"variable":[]}},"response":[],"_postman_id":"40f25a73-5172-4948-a140-fb458a359de7"},{"name":"Update Sku Stock","id":"e824a117-8316-4a34-85a7-2a08cb96028c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"THis method is used to update just the stock of one sku, you can choose between:
\nIncrease: If you send the action \"increase\" will add the quantity send to the product. Ie. If you send 3 as quantity and the product already has 4, the product will ends with 7 of stock. The common use for this action is when you need to return a item to the stock
\nDecrease: If you send the action \"decrease\" will decrease the quantity send to the product. Ie. If you send 1 as quantity and the product has 4, the product will ends with 3 of stock. The common use for this action is when you have a sale.
\nUpdate: If you send the action \"update\" this quantity will overwrite the actual product stock, so if you send 5 not matter how quantity the sku has, will ends with 5, the common use for that is in a stock balance moment.
\nDelete one SKU by sku code
\n","urlObject":{"protocol":"https","path":["skus","{sku_id}"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"{access_token}"}],"variable":[]}},"response":[],"_postman_id":"977de8da-da70-4bb9-bb40-e1dbc62d8794"},{"name":"Get one product (by sku)","id":"698221ae-73f5-4bf0-b16b-50af901d0823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"From this endpoint is possible to get all products from PluggTo.
\n| next | \nInsert the last id found in the previus call | \n
| limit | \nInsert the number or registers to be returned | \n
| created | \nCheck from creation date (ie 2017-01-01to2017-02-01) | \n
| modified | \nCheck from update date. (ie 2017-01-01to2017-02-01) | \n
| available | \nCheck if is available in your app | \n
| all | \nSearch a string (like) in name or description field | \n
| sku | \nSearch by sku (exact) sku in parent or child | \n
| bysku | \nSearch by sku (like) in parent or child | \n
| category | \nSearch by string in category field (like) | \n
| attribute | \nSearch by attribute code or attribute value field (exact) | \n
| id | \nSearch by pluggto id in parent or child | \n
| has_external | \nSee if has your application product id | \n
| quantity | \nSearch by quantity/td>\n |
| quantity | \nSearch by quantity in parent or child | \n
| others | \nyou can search by any other api propriety, like \"brand=MyBrand\" | \n
Method for consulting the freight of a product
","urlObject":{"protocol":"https","path":["shipping"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"{access_token}"},{"key":"postalcode","value":"06543210"},{"key":"country","value":"BRA"},{"key":"skus","value":"{sku}:{quantity}"}],"variable":[]}},"response":[],"_postman_id":"c2e78df6-3777-4ee5-a2ec-59e6cf7c6f3b"},{"name":"Freight (Source)","id":"fddb4227-0a65-4edd-b4a4-c6ac36e97384","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\"destination_postalcode\" : \"05004010\", \n\"country\" : \"BR\", \n\"origin_country\" : \"BR\", \n\"user_id\" : 1793, \n\"products\" : [ \n{ \n\"weight\" : 10, \n\"height\" : 10,\n\"length\" : 10,\n\"width\" : 10, \n\"sku\" : \"parent-000000000001000906\", \n\"quantity\" : \"1\",\n\"crossdocking\":0,\n\"unit_price\":0.00\n}],\n\"origin_city\" : \"SAO PAULO\", \n\"origin_postalcode\" : \"05004015\", \n\"state\" : \"SP\", \n\"origin_state\" : \"SP\"\n} "},"url":"https://yoursite.com/shipping","description":"This API is to partners that provide SHIPPING INFORMATION and should be implemented in the parter side to provide to PluggTo information about the shipping cost.
\n\nAttention: This answer shoud take 0.200 seconds maximum
\n\n\nPluggTo will POST to a URL pre-register with the folling information: \n
\n(be aware that depending the MarketPlace one or other information maybe will be empty)\n\nThe success answer should be:\n
\n\nIn case of error:\n
\n\n[
\n{
\n \"mensage\" : \"Error Mensagem\"
\n}
\n]
From this endpoint is possible to get all messages from PluggTo.
\n| next | \nInsert the last id found in the previus call | \n
| limit | \nInsert the number or registers to be returned | \n
| created | \nCheck from creation date (ie 2017-01-01to2017-02-01) | \n
| modified | \nCheck from update date. (ie 2017-01-01to2017-02-01) | \n
| channel | \nAny channel | \n
| all | \nSearch a string (like) in name or description field | \n
| others | \nyou can search by any other api propriety, like \"brand=MyBrand\" | \n
Create or Update one Stock SKU Point
","urlObject":{"protocol":"https","path":["places","{sku_id}","{code}"],"host":["api","plugg","to"],"query":[{"disabled":true,"key":"access_token","value":"{access_token}"}],"variable":[]}},"response":[{"id":"96bee231-bf37-4393-b22c-5d604c4ff947","name":"View one Stock Point","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.plugg.to/places/{sku_id}/{code}?access_token={access_token}","protocol":"https","host":["api","plugg","to"],"path":["places","{sku_id}","{code}"],"query":[{"key":"access_token","value":"{access_token}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"Place\": {\n\t\t\"code\": \"129\",\n\t\t\"created\": \"2020-07-23T18:57:21.381Z\",\n\t\t\"created_by\": \"NTJhYTI3MTc4MDYyZjNk\",\n\t\t\"handling_time\": 2,\n\t\t\"id\": \"5f19dd911682526c240fd681\",\n\t\t\"inspected\": null,\n\t\t\"modified\": \"2020-07-23T18:57:21.381Z\",\n\t\t\"modified_by\": \"NTJhYTI3MTc4MDYyZjNk\",\n\t\t\"price\": 200,\n\t\t\"price_history\": [\n\t\t],\n\t\t\"priority\": null,\n\t\t\"quantity\": 20,\n\t\t\"reserved\": null,\n\t\t\"reserverdOrders\": [\n\t\t],\n\t\t\"sku\": \"900\",\n\t\t\"special_price\": 9.9,\n\t\t\"specialprice_history\": [\n\t\t],\n\t\t\"stock_history\": [\n\t\t],\n\t\t\"total_stock\": null,\n\t\t\"user_id\": \"129\"\n\t}\n}"}],"_postman_id":"32e457d6-85c4-4afe-9f51-c5ecc22fa990"},{"name":"Create or Update One Stock Point","id":"4cbce533-a707-41c7-aab9-ab162bb124fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Places is special endpoint for stores that have multiple stock points (ie. Physical Store), this feature allow Stores to use special shipping methods (Ie. Pickup Up or Motoboy )
\n\n| sku | \n | SKU code | \n |
| code | \n | Representes one point (ie store id) | \n |
| price | \n | Price of this stock | \n |
| special_price | \n | Specoial Price of this stock | \n |
| handling_time | \n | Time to handle the product | \n |
If and invoice do not existis with this number/serie wil be created else updated
\nIf and invoice do not existis with this number/serie wil be created else updated
\nWith this API is possible to send and get invoices (I.E Fiscal documents) that do not belongs to orders resources. (i.e) Fulfillment invoices.... \n
","_postman_id":"40c0943b-0779-4776-bb8a-fefcb2f557fc"}],"event":[{"listen":"prerequest","script":{"id":"be9b2607-ab3e-4830-bf1a-559ca740e793","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c0017f66-c80c-4c5e-ad5a-7c7022c2e301","type":"text/javascript","exec":[""]}}]}