{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "items", "description": "", "item": [ { "id": "581a94f4-25c4-4cbb-bfa0-a4713694b154", "name": "Delete Items", "request": { "name": "Delete Items", "description": { "content": "Deletes a batch of items in Vinted. Items are deleted asynchronously. Deleting item is only available for items that are successfully listed. Items that have the status `IN_PROGRESS` cannot be deleted.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "12952686-b2b5-461f-b496-16787604bcf4", "name": "Request accepted. Deletions will be processed in the background. If items were not recognised as items that belong to your account the deletions will silently fail.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_id\": \"\",\n \"accepted\": \"\"\n },\n {\n \"item_id\": \"\",\n \"accepted\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "362d3dad-6b1a-499e-898f-14512e6ad27b", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65586965-efcf-424f-9361-289c8007b3d5", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "563897f7-dafa-412e-8e2a-28e4dd3128d7", "name": "The item is not found.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "111b5eb8-1adc-469c-98b7-de8cd68cef01", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba028c36-c9ec-401b-9f46-2e53f356188e", "name": "Get Items", "request": { "name": "Get Items", "description": { "content": "Lists items that were created in VPI.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9e2d7c09-be6a-41d9-99d0-b0f308532690", "name": "The items.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_id\": \"\",\n \"item_reference\": \"\",\n \"marketplace_item_id\": \"\",\n \"status\": \"ACTIVE\",\n \"errors\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\",\n \"marketplace_item_id\": \"\",\n \"status\": \"DELETED\",\n \"errors\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eff28750-8d03-46b0-ba0a-1873050a329b", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5dbf939-a22f-4300-a8f8-2a383d1738dc", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d7b6d37-bad3-41b9-9a02-3f1109334f00", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ae1f78f-ff94-47e6-8347-8f7507946947", "name": "Create Items", "request": { "name": "Create Items", "description": { "content": "Creates a batch of items in Vinted. Items are validated and uploaded asynchronously. The response contains the identifier for each item. This identifier is used to further interact with the item, make sure to store it on your end as well.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9fd8d44e-6734-4c58-aabc-98668ff828f3", "name": "Request accepted, items will be uploaded asynchronously. Receiving the item ID does not mean the item is listed.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0a4b14-98ba-40f3-9f2f-6dbf455ae5c7", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50aef08a-8610-4601-bfcc-d419135c8a90", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4010e66-ded5-4f2a-9137-fb451f279521", "name": "Adding these items would exceed the maximum number of items allowed for this account, please reduce the number of active items before creating more.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"slots\": \"\",\n \"active_items\": \"\",\n \"attempted_batch_size\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3454eba0-1ff5-4bfa-9da2-69f7e703f23f", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_reference\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4a8bb9b-abf9-49ab-9473-dc130071ba5e", "name": "Update Items", "request": { "name": "Update Items", "description": { "content": "Updates a batch of items in Vinted. Items are validated and updated asynchronously. Updating item is only available for items that are successfully listed. Items that have the status `IN_PROGRESS` cannot be updated.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_id\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "18dc118d-68eb-47c9-a8ef-647088b8b954", "name": "Request accepted. Updates will be processed in the background. If items were not recognized as items that belong to your account the Updates will silently fail.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_id\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_NOT_FOUND\"\n },\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_SOLD\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee9dd482-f0fe-48d4-a8d1-12540b3e8c88", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_id\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a94753c-1139-4296-8f8a-2e231e3df1b7", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_id\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ad6ce49-4c15-4258-a072-b0b4ad1e4a06", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"brand\": \"\",\n \"catalog_id\": \"\",\n \"currency\": \"GBP\",\n \"description\": \"\",\n \"is_draft\": \"\",\n \"item_id\": \"\",\n \"package_size_id\": \"\",\n \"photo_urls\": [\n \"\"\n ],\n \"price\": \"\",\n \"status_id\": \"\",\n \"title\": \"\",\n \"color_ids\": [\n \"\",\n \"\"\n ],\n \"is_unisex\": \"\",\n \"isbn\": \"\",\n \"item_attributes\": [\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"item_attribute_id\": \"\",\n \"item_attribute_option_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"measurement_length\": \"\",\n \"measurement_width\": \"\",\n \"size_id\": \"\",\n \"video_game_rating_id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "03a550b0-ccdd-41a5-810c-890dcce781c7", "name": "Get Item Status", "request": { "name": "Get Item Status", "description": { "content": "Retrieves the current status of an item on Vinted by its ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The item ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4db988a9-2d03-48c6-b724-9e2655bbbdae", "name": "Successfully retrieved the item status.", "originalRequest": { "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"DELETE_INTERNAL_ERROR\",\n \"marketplace_item_id\": \"\",\n \"errors\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "484411ec-7660-40f7-a9a3-10266c04cbc0", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b24cce2-7324-4a0e-a396-6de7e87673da", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe50995-50b5-42e4-a300-d99e4c2862d3", "name": "The item could not be found.", "originalRequest": { "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8110300-7e5d-445c-bca7-b1db1484393d", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "imported", "description": "", "item": [ { "id": "8b840840-3531-4996-8ce8-ded6c20588ee", "name": "Get Imported Items", "request": { "name": "Get Imported Items", "description": { "content": "Returns a list of items that were imported. VPI can import items that were added to Vinted in other ways than through VPI.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items", "imported" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6386ed5c-737c-4b85-8f22-7782806a7c04", "name": "The imported items list.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "imported" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"SOLD\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"DELETED\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75094d92-5d65-4df2-a307-767109ecca78", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "imported" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac27e651-90df-4dd4-99e6-11e4a2851d80", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "imported" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bfce155-adfd-46b5-8bf7-123b140f1ea2", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "imported" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only items after the item with this ID. Used for paging.", "type": "text/plain" }, "key": "after_item_id", "value": "" }, { "disabled": false, "description": { "content": "The maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "item-references", "description": "", "item": [ { "id": "26dbc755-a0a9-4e56-a3ba-c9ca2a0b895c", "name": "Update Item References", "request": { "name": "Update Item References", "description": { "content": "Sets the item references for the items in the request.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items", "item-references" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "db1d593a-7c58-4a2f-909b-4ad09b561fdb", "name": "Item references set successfully.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "item-references" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_REFERENCE_HAS_RESERVED_PREFIX\"\n },\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_REFERENCE_ALREADY_IN_USE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea072b0-9c86-471d-b7a3-766b820a025a", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "item-references" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10cbd6cf-c10c-489e-90e9-e8f677f39bf8", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "item-references" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38a810bd-4f56-4f22-9777-6d074e48fa48", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "item-references" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"item_id\": \"\",\n \"item_reference\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "ontologies", "description": "", "item": [ { "id": "d142380f-11f3-4756-8e1f-75f824be7799", "name": "Get Ontologies", "request": { "name": "Get Ontologies", "description": { "content": "Gets the ontologies required to create valid Vinted items. For many fields the valid values depend on the category of the item. Therefore it's recommended to first map your category tree to Vinted's category tree before you map other product properties. Note that gender is encoded in the root categories at Vinted, but the category trees aren't equal for the Women, Men and Kids. This means your category mapping should take gender into account as well. Brands are omitted from the response due to the large number of brands available on Vinted. You can send any brand name when creating or updating an item which will automatically be mapped to a supported brand or VPI will leave the brand unassigned if its not recognised.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ontologies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9992d848-d176-4464-a0d1-90ca32de70bf", "name": "Successfully retrieved ontologies.", "originalRequest": { "url": { "path": [ "api", "v1", "ontologies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": {\n \"country\": \"AT\",\n \"currency\": \"GBP\",\n \"last_updated_on\": \"\"\n },\n \"enumerations\": {\n \"catalogs\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"catalogs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"disabled_fields\": [\n \"package_size_id\",\n \"size_id\"\n ],\n \"item_attribute_ids\": [\n \"\",\n \"\"\n ],\n \"size_group_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"catalogs\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"disabled_fields\": [\n \"status_id\",\n \"status_id\"\n ],\n \"item_attribute_ids\": [\n \"\",\n \"\"\n ],\n \"size_group_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"size_groups\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"sizes\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"sizes\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ]\n }\n ],\n \"statuses\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\"\n }\n ],\n \"package_sizes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"weight_description\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"weight_description\": \"\"\n }\n ],\n \"colors\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ],\n \"item_attributes\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"is_required\": \"\",\n \"selection_type\": \"MULTIPLE\",\n \"selection_limit\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"is_required\": \"\",\n \"selection_type\": \"SINGLE\",\n \"selection_limit\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"title\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\"\n }\n ]\n }\n ]\n },\n \"validation_rules\": {\n \"max_photos\": \"\",\n \"min_price\": \"\",\n \"max_price\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb6b6978-9f4a-4360-84ca-46a4ca0ddee0", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "ontologies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "490f896e-c6f0-43df-acdc-0537fe86926f", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "ontologies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4547ce51-06cd-4877-a186-17f1e2595a76", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "ontologies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "orders", "description": "", "item": [ { "id": "d4555165-1d4c-45b9-a6c4-b334d6a635cb", "name": "Get Orders", "request": { "name": "Get Orders", "description": { "content": "Returns a list of orders. Use the `after-id` query parameter to iterate over the results.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only orders created after the order with this ID.", "type": "text/plain" }, "key": "after-id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c7b57938-005e-4ab5-8b1d-6c54c487d311", "name": "The orders list.", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only orders created after the order with this ID.", "type": "text/plain" }, "key": "after-id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"orders\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"RETURN_INITIATED\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"LOST\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1d0c47-cfa9-4224-8fd4-5f5123883802", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only orders created after the order with this ID.", "type": "text/plain" }, "key": "after-id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a3ad5b-9250-4385-99f6-942f4405aeb6", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only orders created after the order with this ID.", "type": "text/plain" }, "key": "after-id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3eb03c-c6ed-49f2-8917-0843e9d0de52", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "If set, returns only orders created after the order with this ID.", "type": "text/plain" }, "key": "after-id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "c29ba560-dad2-4e95-b2a9-426cc3d40448", "name": "Get Order", "request": { "name": "Get Order", "description": { "content": "Returns the order with the given ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7a003fc3-6da6-4d74-bc47-50b6239f0c88", "name": "The order.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"READY_TO_BE_SHIPPED\",\n \"amount\": \"\",\n \"currency\": \"GBP\",\n \"items\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"price\": \"\",\n \"item_reference\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"price\": \"\",\n \"item_reference\": \"\"\n }\n ],\n \"billing_address\": {\n \"name\": \"\",\n \"line_1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"UR\",\n \"line_2\": \"\",\n \"state\": \"\"\n },\n \"delivery_address\": {\n \"name\": \"\",\n \"line_1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"TX\",\n \"line_2\": \"\",\n \"state\": \"\"\n },\n \"buyer\": \"consectetur tempor\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b31e63d5-7077-4223-b82c-c492a0a1e90f", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcf074c7-c2af-466f-b3f0-35e49fbf60f7", "name": "User is not authorized to use this endpoint.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2523133-3cdd-4b72-a862-1117a99d24c1", "name": "Order not found.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38be539c-b701-447b-823b-f81482455db9", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "cancel", "description": "", "item": [ { "id": "9e7a6415-2a77-4363-ae27-0d4b30b97c47", "name": "Cancel Order", "request": { "name": "Cancel Order", "description": { "content": "Cancels the order with the given ID asynchronously.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason_explanation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cd6c2ef1-c387-48d7-9cbc-4781ef43a667", "name": "Order will be cancelled asynchronously.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason_explanation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "add07221-5b77-47c9-a5fa-1d8905d13173", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason_explanation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac3afec-ce24-4a7b-9754-276bf9594309", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cancellation_reason_explanation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "shipment", "description": "", "item": [ { "id": "ed944030-644a-4f6e-bbfc-ba5b4053514b", "name": "Get Order Shipment", "request": { "name": "Get Order Shipment", "description": { "content": "Returns the shipment for the order with the given ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":id", "shipment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The order ID", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9c368c70-1e78-44c6-b06f-515b22b9d759", "name": "The shipment.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"carrier\": {\n \"name\": \"\"\n },\n \"tracking_code\": \"\",\n \"price_ex_vat\": \"\",\n \"vat_amount\": \"\",\n \"currency\": \"GBP\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95256c64-b534-4127-9059-d09bbdf22018", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd374685-b31c-4c16-b2d7-dae634045047", "name": "Shipment not found. This can be because the shipment does not (yet) exist.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2cbb1c69-09f0-4ac1-8317-f8e400cca9e3", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "shipment-label", "description": "", "item": [ { "id": "c4889c81-c948-4a38-b5ce-298fb86916e3", "name": "Get Order Shipment Label", "request": { "name": "Get Order Shipment Label", "description": { "content": "Retrieves the shipment label shipment label by order ID.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", ":id", "shipment-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The order ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1c2f9fd3-ffe0-4648-9a48-8194278df544", "name": "Successfully retrieved the order shipment label.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/pdf" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "616303e2-3275-4482-aae2-5353d96dd824", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afce2fc8-7f6e-42f7-b5c8-9dd6bf28016e", "name": "The shipment label could not be found. Will also be returned for orders containing items that are not managed via Vinted Pro Integrations.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"LABEL_CREATION_FAILED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6628adf-e4cf-4022-ac80-bd9f65397390", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", ":id", "shipment-label" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "1d25b0ca-9137-445c-9ac2-511a6900b4c5", "name": "Get Webhooks", "request": { "name": "Get Webhooks", "description": { "content": "Lists your registered webhooks.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "80a24318-36f2-4b88-8a32-371df6db5915", "name": "Successfully retrieved the webhooks.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"event_types\": [\n \"CANCEL_ORDER_FAILURE\",\n \"DELETE_ITEM_FAILURE\"\n ],\n \"url\": \"http://+`\"\n },\n {\n \"id\": \"\",\n \"event_types\": [\n \"ORDER_CREATED\",\n \"UPDATE_ITEM_FAILURE\"\n ],\n \"url\": \"http://m\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e335f57-4a7a-42b4-afb4-32b7f32d245b", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da59e67-47a1-425c-a21f-3fbcae67672c", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2c00887-dc4d-46bb-b4bc-444c9220dd03", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abdbd6ab-aece-4665-a2ae-a67b8c57285c", "name": "Create Webhook", "request": { "name": "Create Webhook", "description": { "content": "Add a webhook to be called when events happen in Vinted.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "867c7f76-bac9-44b1-b4a2-43ae84141a01", "name": "The webhook was successfully created.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"webhook\": {\n \"id\": \"\",\n \"event_types\": [\n \"CANCEL_ORDER_FAILURE\",\n \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"https://&$'DNglU,\"\n },\n \"signing_key\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8a87bd3-541e-4f9d-baac-9e065b7cee6d", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eb9fae8-6a04-4e10-bcb2-46d6c2a2ea93", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16a3c365-cf76-462d-8014-9ea2cfc48275", "name": "The request could not be processed.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"ONLY_HTTPS_URLS_ALLOWED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a9462e3-11fd-4869-8d80-edf956e32da3", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "0bb5b589-2c71-4b90-96dc-250d05d64a46", "name": "Delete Webhook", "request": { "name": "Delete Webhook", "description": { "content": "Deletes a webhook.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The webhook ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e7743106-517d-4fe1-85ba-fc4237d693f3", "name": "Successfully deleted the webhook.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d04de20-e47a-4666-8bb6-8686186171f4", "name": "The webhook has already been deleted.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Modified", "code": 304, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "145918bb-4956-4cee-832c-1fc7b0d9bed8", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f791af-f03c-409a-baab-1d1d7a129d88", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8d91b85-7bf1-4ebf-b863-d7672efef564", "name": "The webhook could not be found.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31a30762-8c2f-4652-82dc-e17d12b63ba5", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f582681-7273-4029-bc90-a7d4cb9c8c31", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Updates a webhook's URL and/or subscribed event types.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The webhook ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "94167e3e-0931-4a88-bd5d-4da6912f4b37", "name": "Successfully updated webhook.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70a4ef60-cf62-476c-86e1-e225fee5efcf", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4b52de-253b-4a5e-87ab-6c131929b93c", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fd6baba-3b8d-4d1f-ab8b-eb764d106a8f", "name": "The webhook could not be found.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5282f0ae-97cf-4d8e-b0e3-ac8a5839cf25", "name": "The request could not be processed.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"ONLY_HTTPS_URLS_ALLOWED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45577ece-37ba-47a5-8600-eb270bdbb1d3", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://$.R\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "delivery-results", "description": "", "item": [ { "id": "dcbe2417-8de2-4953-965c-541de17a9ccf", "name": "Get Webhook Delivery Results", "request": { "name": "Get Webhook Delivery Results", "description": { "content": "Gets the 100 latest delivery results (attempts, failures and successes) for a webhook.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhooks", ":id", "delivery-results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) The webhook ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bf4a2d06-99a6-4218-bbea-d5d9504167fe", "name": "Successfully retrieved the delivery results.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "delivery-results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"created_at\": \"\",\n \"event_type\": \"DELETE_ITEM_FAILURE\",\n \"success\": \"\",\n \"error_msg\": \"\",\n \"http_status_code\": \"\"\n },\n {\n \"created_at\": \"\",\n \"event_type\": \"ORDER_CANCELLED\",\n \"success\": \"\",\n \"error_msg\": \"\",\n \"http_status_code\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da9c4e7e-8cc9-4282-934d-fd7c98538221", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "delivery-results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6778870-2add-4c26-a94c-1b5a87a1e7a0", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "delivery-results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2703fd4b-2181-46a4-af2f-6f618980d6c4", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "api", "v1", "webhooks", ":id", "delivery-results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "v2", "description": "", "item": [ { "name": "item-price-suggestions", "description": "", "item": [ { "id": "e2d567b1-43c9-4d01-9af1-94397e4cd92b", "name": "Get maximum price suggestion for an item.", "request": { "name": "Get maximum price suggestion for an item.", "description": { "content": "Returns the maximum suggested price for an item based on category, brand and condition, benchmarked against historical sold prices.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "item-price-suggestions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree.", "type": "text/plain" }, "key": "catalog_id", "value": "" }, { "disabled": false, "description": { "content": "The brand ID of the item.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "The condition (status) ID of the item. Use the ontologies endpoint to get the statuses.", "type": "text/plain" }, "key": "status_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "756afbed-98c7-4553-829f-ec7b15f32471", "name": "Successfully retrieved maximum price suggestion.", "originalRequest": { "url": { "path": [ "api", "v2", "item-price-suggestions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree.", "type": "text/plain" }, "key": "catalog_id", "value": "" }, { "disabled": false, "description": { "content": "The brand ID of the item.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "The condition (status) ID of the item. Use the ontologies endpoint to get the statuses.", "type": "text/plain" }, "key": "status_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"GBP\",\n \"maximum\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f144a44-58a5-40cd-830a-bd8953a0a789", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v2", "item-price-suggestions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree.", "type": "text/plain" }, "key": "catalog_id", "value": "" }, { "disabled": false, "description": { "content": "The brand ID of the item.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "The condition (status) ID of the item. Use the ontologies endpoint to get the statuses.", "type": "text/plain" }, "key": "status_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"REAUTHORISATION_REQUIRED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c90908c8-96e6-4f2b-aa01-1f46c9532571", "name": "No price suggestion available for the given combination.", "originalRequest": { "url": { "path": [ "api", "v2", "item-price-suggestions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree.", "type": "text/plain" }, "key": "catalog_id", "value": "" }, { "disabled": false, "description": { "content": "The brand ID of the item.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "The condition (status) ID of the item. Use the ontologies endpoint to get the statuses.", "type": "text/plain" }, "key": "status_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8127669b-933f-4735-bcda-26e523497877", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v2", "item-price-suggestions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree.", "type": "text/plain" }, "key": "catalog_id", "value": "" }, { "disabled": false, "description": { "content": "The brand ID of the item.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "The condition (status) ID of the item. Use the ontologies endpoint to get the statuses.", "type": "text/plain" }, "key": "status_id", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "dev", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "triggers", "description": "", "item": [ { "name": "item-sold", "description": "", "item": [ { "name": "{itemID}", "description": "", "item": [ { "id": "f64e587b-dec3-4164-a30d-38f727727501", "name": "Triggers the sale of an item", "request": { "name": "Triggers the sale of an item", "description": { "content": "Use this endpoint to simulate making a sale. Only available in dev mode.", "type": "text/plain" }, "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "itemID", "disabled": false, "description": { "content": "(Required) The item ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Vpi-Access-Key" }, { "key": "value", "value": "{{accessKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0830ea88-b58d-4477-a955-9383c4095cda", "name": "The item sale was successfully triggered.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2b00f14-e700-4adb-bdb4-7b9242a8d236", "name": "A validation error occured.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"field\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c7cbd2a-5e08-4647-8045-dbe5201e04f9", "name": "The request had invalid authentication.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92c2c4a6-8e93-4f4f-bf0f-0b2147d13044", "name": "The item is not found.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14918a40-1b61-497b-a6d8-37132a675dac", "name": "The item is already sold.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7bb393b7-b280-4e49-9951-184f05b9e563", "name": "An unexpected error occured.", "originalRequest": { "url": { "path": [ "dev", "v1", "triggers", "item-sold", ":itemID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) Signature header. Reference script in documentation.", "type": "text/plain" }, "key": "X-Vpi-Hmac-Sha256", "value": "" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Vpi-Access-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "console.log(\"Setting X-Vpi-Hmac-Sha256 in pre-request script...\")", "pm.request.headers.remove('X-Vpi-Hmac-Sha256');", "const timestamp = Math.floor(Date.now() / 1000);", "const method = pm.request.method;", "const pathWithQuery = pm.variables.replaceIn(pm.request.url.getPathWithQuery());", "const accessKey = pm.variables.get(\"accessKey\");", "const body = pm.variables.replaceIn(pm.request.body.toString());", "const signingKey = pm.variables.get(\"signingKey\");", "const payload = [timestamp, method, pathWithQuery, accessKey, body];", "const payloadString = payload.join(\".\");", "const signature = CryptoJS.HmacSHA256(payloadString, signingKey).toString(CryptoJS.enc.Hex);", "pm.request.headers.add({", " key: \"X-Vpi-Hmac-Sha256\",", " value: `t=${timestamp},v1=${signature}`", "});" ] } } ], "variable": [ { "key": "baseUrl", "value": "/" } ], "info": { "_postman_id": "3efea48a-17f8-4df6-b696-204f21458d1b", "name": "Vinted Pro Integrations documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } }