# Table of Contents - [API Documentation](#api-documentation) - [Unknown](#unknown) - [Unknown](#unknown) --- # API Documentation [NAV ![](https://pro-docs.svc.vinted.com/images/navbar-cad8cdcb.png)](https://pro-docs.svc.vinted.com/#) ![](https://pro-docs.svc.vinted.com/images/logo-e6be01c8.png) * [Vinted Pro Integrations](https://pro-docs.svc.vinted.com/#vinted-pro-integrations) * [Features](https://pro-docs.svc.vinted.com/#features) * [Overview](https://pro-docs.svc.vinted.com/#overview) * [Allowlist](https://pro-docs.svc.vinted.com/#allowlist) * [Slot system](https://pro-docs.svc.vinted.com/#slot-system) * [Getting started](https://pro-docs.svc.vinted.com/#getting-started) * [Steps for making requests](https://pro-docs.svc.vinted.com/#steps-for-making-requests) * [Registering a webhook example](https://pro-docs.svc.vinted.com/#registering-a-webhook-example) * [Listing an item example](https://pro-docs.svc.vinted.com/#listing-an-item-example) * [Environments](https://pro-docs.svc.vinted.com/#environments) * [Dev mode](https://pro-docs.svc.vinted.com/#dev-mode) * [Authentication](https://pro-docs.svc.vinted.com/#authentication) * [Access key](https://pro-docs.svc.vinted.com/#access-key) * [Request signing](https://pro-docs.svc.vinted.com/#request-signing) * [Webhooks](https://pro-docs.svc.vinted.com/#webhooks) * [Validating webhooks](https://pro-docs.svc.vinted.com/#validating-webhooks) * [Downloads](https://pro-docs.svc.vinted.com/#downloads) * [OpenAPI](https://pro-docs.svc.vinted.com/#openapi) * [Postman collection](https://pro-docs.svc.vinted.com/#postman-collection) * [Import](https://pro-docs.svc.vinted.com/#import) * [Items API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-items-api) * [DeleteItems](https://pro-docs.svc.vinted.com/#deleteitems) * [GetItems](https://pro-docs.svc.vinted.com/#getitems) * [CreateItems](https://pro-docs.svc.vinted.com/#createitems) * [UpdateItems](https://pro-docs.svc.vinted.com/#updateitems) * [GetItemStatus](https://pro-docs.svc.vinted.com/#getitemstatus) * [GetImportedItems](https://pro-docs.svc.vinted.com/#getimporteditems) * [UpdateItemReferences](https://pro-docs.svc.vinted.com/#updateitemreferences) * [ValidateItems](https://pro-docs.svc.vinted.com/#validateitems) * [GetOntologies](https://pro-docs.svc.vinted.com/#getontologies) * [GetItemPriceSuggestions](https://pro-docs.svc.vinted.com/#getitempricesuggestions) * [Orders API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-orders-api) * [GetOrders](https://pro-docs.svc.vinted.com/#getorders) * [GetOrder](https://pro-docs.svc.vinted.com/#getorder) * [CancelOrder](https://pro-docs.svc.vinted.com/#cancelorder) * [GetOrderShipment](https://pro-docs.svc.vinted.com/#getordershipment) * [GetOrderShipmentLabel](https://pro-docs.svc.vinted.com/#getordershipmentlabel) * [RelistOrders](https://pro-docs.svc.vinted.com/#relistorders) * [Webhooks API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-webhooks-api) * [GetWebhooks](https://pro-docs.svc.vinted.com/#getwebhooks) * [CreateWebhook](https://pro-docs.svc.vinted.com/#createwebhook) * [DeleteWebhook](https://pro-docs.svc.vinted.com/#deletewebhook) * [UpdateWebhook](https://pro-docs.svc.vinted.com/#updatewebhook) * [GetWebhookDeliveryResults](https://pro-docs.svc.vinted.com/#getwebhookdeliveryresults) * [Dev mode API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-dev-mode-api) * [TriggerItemSold](https://pro-docs.svc.vinted.com/#triggeritemsold) * [Schemas](https://pro-docs.svc.vinted.com/#schemas) * [Address](https://pro-docs.svc.vinted.com/#tocS_Address) * [CancelOrderFailureEventData](https://pro-docs.svc.vinted.com/#tocS_CancelOrderFailureEventData) * [Catalog](https://pro-docs.svc.vinted.com/#tocS_Catalog) * [Color](https://pro-docs.svc.vinted.com/#tocS_Color) * [CompleteItemToCreate](https://pro-docs.svc.vinted.com/#tocS_CompleteItemToCreate) * [CreateItemFailureEventData](https://pro-docs.svc.vinted.com/#tocS_CreateItemFailureEventData) * [CreateItemSuccessEventData](https://pro-docs.svc.vinted.com/#tocS_CreateItemSuccessEventData) * [CreateItemValidationError](https://pro-docs.svc.vinted.com/#tocS_CreateItemValidationError) * [CreateItems](https://pro-docs.svc.vinted.com/#tocS_CreateItems) * [CreateItemsResponse](https://pro-docs.svc.vinted.com/#tocS_CreateItemsResponse) * [CreateItemsValidationErrorResponse](https://pro-docs.svc.vinted.com/#tocS_CreateItemsValidationErrorResponse) * [CreateUpdateWebhook](https://pro-docs.svc.vinted.com/#tocS_CreateUpdateWebhook) * [CreateWebhookError](https://pro-docs.svc.vinted.com/#tocS_CreateWebhookError) * [CreateWebhookResponse](https://pro-docs.svc.vinted.com/#tocS_CreateWebhookResponse) * [Currency](https://pro-docs.svc.vinted.com/#tocS_Currency) * [DeleteItemFailureEventData](https://pro-docs.svc.vinted.com/#tocS_DeleteItemFailureEventData) * [DeleteItemSuccessEventData](https://pro-docs.svc.vinted.com/#tocS_DeleteItemSuccessEventData) * [DeleteItems](https://pro-docs.svc.vinted.com/#tocS_DeleteItems) * [DeleteItemsResponse](https://pro-docs.svc.vinted.com/#tocS_DeleteItemsResponse) * [DeleteItemsResponseItem](https://pro-docs.svc.vinted.com/#tocS_DeleteItemsResponseItem) * [GetImportedItemsResponse](https://pro-docs.svc.vinted.com/#tocS_GetImportedItemsResponse) * [GetItemPriceSuggestionsResponse](https://pro-docs.svc.vinted.com/#tocS_GetItemPriceSuggestionsResponse) * [GetItemStatusResponse](https://pro-docs.svc.vinted.com/#tocS_GetItemStatusResponse) * [GetItemsResponse](https://pro-docs.svc.vinted.com/#tocS_GetItemsResponse) * [GetItemsResponseItem](https://pro-docs.svc.vinted.com/#tocS_GetItemsResponseItem) * [GetOntologiesResponse](https://pro-docs.svc.vinted.com/#tocS_GetOntologiesResponse) * [GetOrderResponse](https://pro-docs.svc.vinted.com/#tocS_GetOrderResponse) * [GetOrderShipmentLabelNotFoundResponse](https://pro-docs.svc.vinted.com/#tocS_GetOrderShipmentLabelNotFoundResponse) * [GetOrderShipmentResponse](https://pro-docs.svc.vinted.com/#tocS_GetOrderShipmentResponse) * [GetOrdersResponse](https://pro-docs.svc.vinted.com/#tocS_GetOrdersResponse) * [GetWebhooksResponse](https://pro-docs.svc.vinted.com/#tocS_GetWebhooksResponse) * [ImportedItem](https://pro-docs.svc.vinted.com/#tocS_ImportedItem) * [ItemAttribute](https://pro-docs.svc.vinted.com/#tocS_ItemAttribute) * [ItemAttributeInput](https://pro-docs.svc.vinted.com/#tocS_ItemAttributeInput) * [ItemAttributeOption](https://pro-docs.svc.vinted.com/#tocS_ItemAttributeOption) * [ItemDeletedEventData](https://pro-docs.svc.vinted.com/#tocS_ItemDeletedEventData) * [ItemIDAndReference](https://pro-docs.svc.vinted.com/#tocS_ItemIDAndReference) * [ItemIDAndReferenceWithErrors](https://pro-docs.svc.vinted.com/#tocS_ItemIDAndReferenceWithErrors) * [ItemIsDraft](https://pro-docs.svc.vinted.com/#tocS_ItemIsDraft) * [ItemProperties](https://pro-docs.svc.vinted.com/#tocS_ItemProperties) * [ItemPublishedEventData](https://pro-docs.svc.vinted.com/#tocS_ItemPublishedEventData) * [ItemReference](https://pro-docs.svc.vinted.com/#tocS_ItemReference) * [ItemSoldEventData](https://pro-docs.svc.vinted.com/#tocS_ItemSoldEventData) * [ItemStatus](https://pro-docs.svc.vinted.com/#tocS_ItemStatus) * [ItemToUpdate](https://pro-docs.svc.vinted.com/#tocS_ItemToUpdate) * [ItemToValidate](https://pro-docs.svc.vinted.com/#tocS_ItemToValidate) * [ItemUpdatedEventData](https://pro-docs.svc.vinted.com/#tocS_ItemUpdatedEventData) * [ItemValidationError](https://pro-docs.svc.vinted.com/#tocS_ItemValidationError) * [ItemValidationResult](https://pro-docs.svc.vinted.com/#tocS_ItemValidationResult) * [OrderCancelledEventData](https://pro-docs.svc.vinted.com/#tocS_OrderCancelledEventData) * [OrderCreatedEventData](https://pro-docs.svc.vinted.com/#tocS_OrderCreatedEventData) * [OrderItem](https://pro-docs.svc.vinted.com/#tocS_OrderItem) * [OrderListElement](https://pro-docs.svc.vinted.com/#tocS_OrderListElement) * [OrderStatus](https://pro-docs.svc.vinted.com/#tocS_OrderStatus) * [PackageSize](https://pro-docs.svc.vinted.com/#tocS_PackageSize) * [Price](https://pro-docs.svc.vinted.com/#tocS_Price) * [RelistOrdersResponse](https://pro-docs.svc.vinted.com/#tocS_RelistOrdersResponse) * [RelistOrdersResponseItem](https://pro-docs.svc.vinted.com/#tocS_RelistOrdersResponseItem) * [ShipmentLabelCreatedEventData](https://pro-docs.svc.vinted.com/#tocS_ShipmentLabelCreatedEventData) * [Size](https://pro-docs.svc.vinted.com/#tocS_Size) * [SizeGroup](https://pro-docs.svc.vinted.com/#tocS_SizeGroup) * [Status](https://pro-docs.svc.vinted.com/#tocS_Status) * [UnauthorizedError](https://pro-docs.svc.vinted.com/#tocS_UnauthorizedError) * [UpdateItemFailureEventData](https://pro-docs.svc.vinted.com/#tocS_UpdateItemFailureEventData) * [UpdateItemReferencesResponse](https://pro-docs.svc.vinted.com/#tocS_UpdateItemReferencesResponse) * [UpdateItemReferencesResponseItem](https://pro-docs.svc.vinted.com/#tocS_UpdateItemReferencesResponseItem) * [UpdateItemSuccessEventData](https://pro-docs.svc.vinted.com/#tocS_UpdateItemSuccessEventData) * [UpdateItems](https://pro-docs.svc.vinted.com/#tocS_UpdateItems) * [UpdateItemsResponse](https://pro-docs.svc.vinted.com/#tocS_UpdateItemsResponse) * [UpdateItemsResponseItem](https://pro-docs.svc.vinted.com/#tocS_UpdateItemsResponseItem) * [UpdateWebhookError](https://pro-docs.svc.vinted.com/#tocS_UpdateWebhookError) * [ValidateItems](https://pro-docs.svc.vinted.com/#tocS_ValidateItems) * [ValidateItemsResponse](https://pro-docs.svc.vinted.com/#tocS_ValidateItemsResponse) * [ValidationError](https://pro-docs.svc.vinted.com/#tocS_ValidationError) * [ValidationRules](https://pro-docs.svc.vinted.com/#tocS_ValidationRules) * [VintedAuthenticationErrorEventData](https://pro-docs.svc.vinted.com/#tocS_VintedAuthenticationErrorEventData) * [Webhook](https://pro-docs.svc.vinted.com/#tocS_Webhook) * [WebhookDeliveryResult](https://pro-docs.svc.vinted.com/#tocS_WebhookDeliveryResult) * [WebhookEventData](https://pro-docs.svc.vinted.com/#tocS_WebhookEventData) * [WebhookEventType](https://pro-docs.svc.vinted.com/#tocS_WebhookEventType) Vinted Pro Integrations ======================= Vinted Pro Integrations documentation version v0.327.1. Features ======== Overview -------- The Vinted Pro Integrations API is actively being developed. The following features are already implemented: * **Item management**: The [items API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-items-api) is finished and allows you to keep your inventory in sync with Vinted. Using the [`GetOntologies` endpoint](https://pro-docs.svc.vinted.com/#getontologies) you can create a mapping between your items and Vinted items. * **Webhooks**: You can register webhooks using the [webhooks API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-webhooks-api) . This enables you to be notified about item changes when they happen on Vinted. Alternatively, you can poll the [`GetItemStatus` endpoint](https://pro-docs.svc.vinted.com/#getitemstatus) . * **Order management**: The [orders API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-orders-api) can be used for getting information about sold items and their shipment labels. Allowlist --------- Vinted Pro Integrations is currently only available for a select few businesses. If you wish to be added to this allowlist please [apply](https://www.vinted.fr/pro/integrations) . If your business account is not allowlisted, you won't be able to get into [Vinted Pro Integrations Portal](https://pro-portal.svc.vinted.com/) nor use Vinted Pro Integrations API. Slot system ----------- For security purposes, each API user is allocated a specific number of item slots. Initially, this allocation is set to 500 active items per API user. After a period of 30 days, you may contact our Account Management team and they will assess your performance. If the business performance appears favorable, we have the flexibility to increase the number of available slots. Note that when calling the [`CreateItems` endpoint](https://pro-docs.svc.vinted.com/#createitems) with a request body that exceeds your available slots, your entire request will be rejected. Getting started =============== The sections below describe how to use the Vinted Pro Integrations API in detail. The following is a quick start guide to start making Vinted Pro Integrations API calls. Steps for making requests ------------------------- 1. [Register for Vinted Pro](https://www.vinted.com/pro) . 2. Ensure you are [allowlisted](https://pro-docs.svc.vinted.com/#allowlist) to use Vinted Pro Integrations. 3. Log into [Vinted Pro Integrations Portal](https://pro-portal.svc.vinted.com/) . 4. Generate an access token. 5. Split the access token into an access key and signing key. 6. Add the access key in the `X-Vpi-Access-Key` header. 7. [Generate a request signature](https://pro-docs.svc.vinted.com/#request-signing) and send it in the `X-Vpi-Hmac-Sha256` header. Registering a webhook example ----------------------------- curl -X POST https://pro.svc.vinted.com/api/v1/webhooks \ --H 'Content-Type: application/json' \ --H 'X-Vpi-Access-Key: foo' \ --H 'X-Vpi-Hmac-Sha256: t=1704067200,v1=cf3872ca3c2537690aaee0eb4b00c9a2d5591389d1932cd282aa6414869efa19' \ --d '{ "event_types": ["CREATE_ITEM_SUCCESS"], "url": "https://example.com" }' For this example a webhook `https://example.com` will be registered for when a product is successfully added on the test environment. The request URL is `POST https://pro.svc.vinted.com/api/v1/webhooks` ([`CreateWebhook` endpoint](https://pro-docs.svc.vinted.com/#createwebhook) ) and has the following request body: `{ "event_types": ["CREATE_ITEM_SUCCESS"], "url": "https://example.com" }`. Since it's a JSON request body, the `Content-Type` header is set to `application/json`. For this example the following access token will be used: `foo,bar`. First split it into the access key (`foo`) and signing key (`bar`). The `X-Vpi-Access-Key` header will be set to `foo`. The next step is [generating the request signature](https://pro-docs.svc.vinted.com/#request-signing) . If this request was made on January 1st 2024 at midnight the following timestamp will be generated: `1704067200`. The timestamp is used together with the [other signing fields](https://pro-docs.svc.vinted.com/#request-signing) to create the following signing payload: `1704067200.POST./api/v1/webhooks.foo.{ "event_types": ["CREATE_ITEM_SUCCESS"], "url": "https://example.com" }`. The signing key will be used to generate a SHA256 HMAC hash: `cf3872ca3c2537690aaee0eb4b00c9a2d5591389d1932cd282aa6414869efa19`. The final `X-Vpi-Hmac-Sha256` header will be the following: `t=1704067200,v1=cf3872ca3c2537690aaee0eb4b00c9a2d5591389d1932cd282aa6414869efa19`. Listing an item example ----------------------- For this example the request siging is skipped, since it is explained it detail in the previous example. In this example an item will be listed. The request URL is `POST https://pro.svc.vinted.com/api/v1/items` ([`CreateItems` endpoint](https://pro-docs.svc.vinted.com/#createitems) ), but the request body requires IDs (i.a. `catalog_id` and `color_ids`). To get the available options for such field, you'll need to fetch the ontologies via the [`GetOntologies` endpoint](https://pro-docs.svc.vinted.com/#getontologies) . This response is quite large and is unlikely to change much over time, so feel free to cache the result. Using the ontologies, you should be able to generate a valid request body for listing an item. If you've registered a webhook you will be informed about your listing status via the registered URL. You can also check the status via the [`GetItemStatus` endpoint](https://pro-docs.svc.vinted.com/#getitemstatus) . However, it is recommended to register a webhook to get the fastest feedback. If a webhook gets called you should [validate whether it came from Vinted](https://pro-docs.svc.vinted.com/#validate-webhooks) . Environments ============ Vinted Pro Integrations can be accessed in two environments. * **Production environment**: Accessible via the `https://pro.svc.vinted.com` host. * **Dev mode environment**: Accessible via the `https://pro-public-sandbox.svc.vinted.com` host. All the endpoints defined in this documentation are accessible on either environment. Each environment requires their own access token. Vinted Pro Integrations Portal has a toggle to switch between dev mode and production. In either mode you can generate their respective access tokens. Dev mode -------- Dev mode enables you to test your integration in an isolated environment. This environment doesn't have a front-end. You can interact with it using Vinted Pro Integrations API or specific endpoints that change state for dev mode listed below. The data is guaranteed to be available for at least a week. ### Magic item descriptions The `description` of the [`CreateItems` endpoint](https://pro-docs.svc.vinted.com/#createitems) can be used to trigger specific behaviour for asynchronous actions on Vinted Pro Integrations. These are called magic item descriptions. The `description` must exactly match the magic item description in order to trigger the behaviour. * `CreateItems:FAILURE`: Triggers the `CREATE_ITEM_FAILURE` webhook for the [`CreateItems` endpoint](https://pro-docs.svc.vinted.com/#createitems) . ### Endpoints While magic descriptions trigger behaviour for asynchronous operations, there are dev mode specific endpoint to trigger events. These endpoints only work on dev mode and are defined in the [dev mode API](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-dev-mode-api) . Authentication ============== In order to authenticate yourself, you'll need to have a access token. Access tokens can be generated on [Vinted Pro Integrations Portal](https://pro-portal.svc.vinted.com/) . Only Pro members can access the portal and generate access tokens. If you haven't already you can [register for Vinted Pro](https://www.vinted.com/pro) . Only right after creating the access token it can be copied. Afterwards the tokens will be obfuscated due to security purposes. Make sure to save access tokens securely after creation. Access tokens are strings containing an access key and a signing key, separated by a comma like so: `{access key},{signing key}` Access key ---------- The access key must be sent with every request in the `X-Vpi-Access-Key` header. Request signing --------------- All requests need to be signed with HMAC using the signing key. You can do this like this: 1. Generate a signing payload by joining the following values in the listed order together with a `.`: 1. The current timestamp (UNIX seconds integer, e.g. `1704067200`). 2. The request method (capitalised, e.g. `POST`). 3. The path including query parameters (e.g. `/foo?bar=baz`). 4. The access key. 5. The request body (empty bodies are passed as an empty string). 2. Compute HMAC with SHA256 hash function. Use the previously created payload and sign it with the signing key. 3. The resulting signature header is composed like this: `t={timestamp from step 1},v1={hash from step 2}`. 4. Send the signature header in the `X-Vpi-Hmac-Sha256` header. The timestamp will be checked whether it's recent enough. Too old (or too far in the future) timestamps will be rejected. Webhooks ======== The [webhooks api](https://pro-docs.svc.vinted.com/#vinted-pro-integrations-documentation-webhooks-api) can be used to get callbacks about events happening on Vinted. They're the fastest way of staying notified about changes on Vinted and it's highly recommended to use them. If you're selling your items on multiple platforms webhooks can keep your stock in sync, reducing the chance of double sales significantly. When you register a webhook for an event, e.g. `ITEM_SOLD`, Vinted Pro Integrations will call that URL when that item gets sold. The request bodies of webhooks are documented under [`WebhookEventData`](https://pro-docs.svc.vinted.com/#tocS_WebhookEventData) . Validating webhooks ------------------- Upon registering a webhook via the [`CreateWebhook` endpoint](https://pro-docs.svc.vinted.com/#createwebhook) you'll get a `signing_key` in the response body. Whenever a callback comes in on the registered URL it'll have a signature signed by that `signing_key` in the `X-Vpi-Webhook-Hmac-Sha256` response header. This could be used to verify that the request came from Vinted using the following steps: 1. Extract the timestamp and the signature from the `X-Vpi-Webhook-Hmac-Sha256` request header. It will look like this `t=TIMESTAMP,v1=SIGNATURE`. 2. Join the timestamp and the the response body together with a `.` inbetween to form a signing payload like this: `TIMESTAMP.RESPONSE_BODY`. 3. Compute HMAC with SHA256 hash function. Use the previously created payload and sign it with the `signing_key` from the [`CreateWebhook` endpoint](https://pro-docs.svc.vinted.com/#createwebhook) response. 4. Compare the signature from step 1 against the one from step 3. They should match if the request is coming from Vinted. Downloads ========= OpenAPI ------- This documentation is based on an [OpenAPI](https://www.openapis.org/) definition. You can use this definition to generate a client for your programming language of choice (e.g. [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) ) or import it in your API platform (e.g. [Postman](https://www.postman.com/) ). [Download OpenAPI definition](https://pro-docs.svc.vinted.com/downloads/api.yml) Postman collection ------------------ When using [Postman](https://www.postman.com/) , you can import the Postman collection to have quick access to all requests of Vinted Pro Integrations API. Ensure that you have the `accessKey` and `signingKey` environment variables set in order to authenticate and sign requests automatically. [Download Postman collection](https://pro-docs.svc.vinted.com/downloads/postman-collection.json) Import ====== Vinted Pro Integrations can import items that were added to your Vinted account that weren't listed via Vinted Pro Integrations. This allows you to manage those items via Vinted Pro Integrations. If you're interested in importing your items, please get in touch with your account manager. Once the import is complete, you get the imported items via [`GetImportedItems`](https://pro-docs.svc.vinted.com/#getimporteditems) and set their item references via [`UpdateItemReferences`](https://pro-docs.svc.vinted.com/#updateitemreferences) . Items API ========= DeleteItems ----------- > Code samples # You can also use wget curl -X DELETE /api/v1/items \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `DELETE /api/v1/items` 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. > Body parameter { "item_ids": [\ "497f6eca-6276-4993-bfeb-53cbbbba6f08"\ ] } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [DeleteItems](https://pro-docs.svc.vinted.com/#schemadeleteitems) | true | The request body for deleting items. | | » item\_ids | body | \[string\] | true | An array of item identifiers. When the items were created in VPI, you received an identifier for each item. Use that identifier to delete the item. At most 100 items can be deleted in a single request. | > Example responses > > 202 Response { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | [Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3) | 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. | [DeleteItemsResponse](https://pro-docs.svc.vinted.com/#schemadeleteitemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The item is not found. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | GetItems -------- > Code samples # You can also use wget curl -X GET /api/v1/items \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/items` Lists items that were created in VPI. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | after\_item\_id | query | string(uuid) | false | If set, returns only items after the item with this ID. Used for paging. | | limit | query | integer(int64) | false | The maximum number of items to return. | > Example responses > > 200 Response { "items": [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string",\ "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ],\ "marketplace_item_id": 0,\ "status": "IN_PROGRESS"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The items. | [GetItemsResponse](https://pro-docs.svc.vinted.com/#schemagetitemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | CreateItems ----------- > Code samples # You can also use wget curl -X POST /api/v1/items \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /api/v1/items` 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. > Body parameter { "items": [\ {\ "brand": "string",\ "catalog_id": 0,\ "color_ids": [\ 0\ ],\ "currency": "EUR",\ "description": "string",\ "is_unisex": true,\ "isbn": "string",\ "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ],\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "measurement_length": 0,\ "measurement_width": 0,\ "package_size_id": 0,\ "photo_urls": [\ "http://example.com"\ ],\ "price": 1,\ "size_id": 0,\ "status_id": 0,\ "title": "string",\ "video_game_rating_id": 0,\ "item_reference": "string",\ "is_draft": true\ }\ ] } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [CreateItems](https://pro-docs.svc.vinted.com/#schemacreateitems) | true | The request body for creating items. | | » items | body | \[allOf\] | true | An array of items to create. At most 100 items can be created in a single request. | | »» _anonymous_ | body | [ItemProperties](https://pro-docs.svc.vinted.com/#schemaitemproperties) | false | none | | »»» brand | body | string | true | The item brand. | | »»» catalog\_id | body | integer(int) | true | The ID of item catalog. This must be a leaf catalog. Use the ontologies endpoint to get the catalog tree. | | »»» color\_ids | body | \[integer\] | false | The item colors IDs. Use the ontologies endpoint to get the colors. | | »»» currency | body | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | The currency used for prices. | | »»» description | body | string | true | The item description. Must be between 5 and 2000 characters. | | »»» is\_unisex | body | boolean | false | A boolean indicating if item is unisex. | | »»» isbn | body | string | false | The ISBN of the book. Applicable to book catalogs only. | | »»» item\_attributes | body | \[[ItemAttributeInput](https://pro-docs.svc.vinted.com/#schemaitemattributeinput)
\] | false | The item attributes. | | »»»» item\_attribute\_id | body | string | false | The item attribute ID. | | »»»» item\_attribute\_option\_ids | body | \[integer\] | false | The item attribute option IDs. | | »»» manufacturer | body | string | false | Manufacturer credentials. E.g. "Mattel (USA)". | | »»» manufacturer\_labelling | body | string | false | Labelling and marketing information. This should be general information on product safety and compliance such as safety warnings and instructions of use or safety marks/logo/certifications related to the product. | | »»» measurement\_length | body | integer(int) | false | The item measurement length. | | »»» measurement\_width | body | integer(int) | false | The item measurement width. | | »»» package\_size\_id | body | integer(int) | true | The ID of item package size. Use the ontologies endpoint to get the package sizes. | | »»» photo\_urls | body | \[string\] | true | The URLs of the item photos. Must be publicly accessible. At least one photo is required. The maximum size of a photo is 5MB. | | »»» price | body | number(float) | true | The item price. | | »»» size\_id | body | integer(int) | false | The ID of item size. This is required for catalogs that have a size group (i.e. a non-empty size\_group\_ids array). Use the ontologies endpoint to get the size groups. | | »»» status\_id | body | integer(int) | true | The ID of item status (condition). Use the ontologies endpoint to get the statuses. | | »»» title | body | string | true | The item title. Must be between 5 and 100 characters. | | »»» video\_game\_rating\_id | body | integer(int) | false | The video game content rating ID. Applicable to video game catalogs only. | | »» _anonymous_ | body | [ItemReference](https://pro-docs.svc.vinted.com/#schemaitemreference) | false | none | | »»» item\_reference | body | string | true | The item reference for the integrator to identify the item. | | »» _anonymous_ | body | [ItemIsDraft](https://pro-docs.svc.vinted.com/#schemaitemisdraft) | false | none | | »»» is\_draft | body | boolean | true | A boolean indicating whether the item is a draft. | #### Enumerated Values | Parameter | Value | | --- | --- | | »»» currency | EUR | | »»» currency | GBP | > Example responses > > 202 Response { "items": [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | [Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3) | Request accepted, items will be uploaded asynchronously. Receiving the item ID does not mean the item is listed. | [CreateItemsResponse](https://pro-docs.svc.vinted.com/#schemacreateitemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 409 | [Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8) | Adding these items would exceed the maximum number of items allowed for this account, please reduce the number of active items before creating more. | Inline | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | ### Response Schema Status Code **409** | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » active\_items | integer(int64) | true | none | Number of active items for this account. | | » attempted\_batch\_size | integer(int64) | true | none | Number of items in the request. | | » slots | integer(int64) | true | none | Maximum number of items allowed for this account. | UpdateItems ----------- > Code samples # You can also use wget curl -X PUT /api/v1/items \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `PUT /api/v1/items` 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. > Body parameter { "items": [\ {\ "brand": "string",\ "catalog_id": 0,\ "color_ids": [\ 0\ ],\ "currency": "EUR",\ "description": "string",\ "is_unisex": true,\ "isbn": "string",\ "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ],\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "measurement_length": 0,\ "measurement_width": 0,\ "package_size_id": 0,\ "photo_urls": [\ "http://example.com"\ ],\ "price": 1,\ "size_id": 0,\ "status_id": 0,\ "title": "string",\ "video_game_rating_id": 0,\ "is_draft": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c"\ }\ ] } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [UpdateItems](https://pro-docs.svc.vinted.com/#schemaupdateitems) | true | The request body for updating items. | | » items | body | \[allOf\] | true | An array of items to update. When the items were created in VPI, you received an identifier for each item. Use that identifier to update the item. At most 100 items can be updated in a single request. | | »» _anonymous_ | body | [ItemProperties](https://pro-docs.svc.vinted.com/#schemaitemproperties) | false | none | | »»» brand | body | string | true | The item brand. | | »»» catalog\_id | body | integer(int) | true | The ID of item catalog. This must be a leaf catalog. Use the ontologies endpoint to get the catalog tree. | | »»» color\_ids | body | \[integer\] | false | The item colors IDs. Use the ontologies endpoint to get the colors. | | »»» currency | body | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | The currency used for prices. | | »»» description | body | string | true | The item description. Must be between 5 and 2000 characters. | | »»» is\_unisex | body | boolean | false | A boolean indicating if item is unisex. | | »»» isbn | body | string | false | The ISBN of the book. Applicable to book catalogs only. | | »»» item\_attributes | body | \[[ItemAttributeInput](https://pro-docs.svc.vinted.com/#schemaitemattributeinput)
\] | false | The item attributes. | | »»»» item\_attribute\_id | body | string | false | The item attribute ID. | | »»»» item\_attribute\_option\_ids | body | \[integer\] | false | The item attribute option IDs. | | »»» manufacturer | body | string | false | Manufacturer credentials. E.g. "Mattel (USA)". | | »»» manufacturer\_labelling | body | string | false | Labelling and marketing information. This should be general information on product safety and compliance such as safety warnings and instructions of use or safety marks/logo/certifications related to the product. | | »»» measurement\_length | body | integer(int) | false | The item measurement length. | | »»» measurement\_width | body | integer(int) | false | The item measurement width. | | »»» package\_size\_id | body | integer(int) | true | The ID of item package size. Use the ontologies endpoint to get the package sizes. | | »»» photo\_urls | body | \[string\] | true | The URLs of the item photos. Must be publicly accessible. At least one photo is required. The maximum size of a photo is 5MB. | | »»» price | body | number(float) | true | The item price. | | »»» size\_id | body | integer(int) | false | The ID of item size. This is required for catalogs that have a size group (i.e. a non-empty size\_group\_ids array). Use the ontologies endpoint to get the size groups. | | »»» status\_id | body | integer(int) | true | The ID of item status (condition). Use the ontologies endpoint to get the statuses. | | »»» title | body | string | true | The item title. Must be between 5 and 100 characters. | | »»» video\_game\_rating\_id | body | integer(int) | false | The video game content rating ID. Applicable to video game catalogs only. | | »» _anonymous_ | body | [ItemIsDraft](https://pro-docs.svc.vinted.com/#schemaitemisdraft) | false | none | | »»» is\_draft | body | boolean | true | A boolean indicating whether the item is a draft. | | »» _anonymous_ | body | object | false | none | | »»» item\_id | body | string(uuid) | true | The item ID. | #### Enumerated Values | Parameter | Value | | --- | --- | | »»» currency | EUR | | »»» currency | GBP | > Example responses > > 202 Response { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "reason": "ITEM_NOT_FOUND"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | [Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3) | 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. | [UpdateItemsResponse](https://pro-docs.svc.vinted.com/#schemaupdateitemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | GetItemStatus ------------- > Code samples # You can also use wget curl -X GET /api/v1/items/{id}/status \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/items/{id}/status` Retrieves the current status of an item on Vinted by its ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | string(uuid) | true | The item ID. | > Example responses > > 200 Response { "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "marketplace_item_id": 0, "status": "IN_PROGRESS" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved the item status. | [GetItemStatusResponse](https://pro-docs.svc.vinted.com/#schemagetitemstatusresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The item could not be found. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | GetImportedItems ---------------- > Code samples # You can also use wget curl -X GET /api/v1/items/imported \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/items/imported` Returns a list of items that were imported. VPI can import items that were added to Vinted in other ways than through VPI. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | after\_item\_id | query | string(uuid) | false | If set, returns only items after the item with this ID. Used for paging. | | limit | query | integer(int64) | false | The maximum number of items to return. | > Example responses > > 200 Response { "items": [\ {\ "description": "string",\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "status": "IN_PROGRESS",\ "title": "string",\ "url": "http://example.com"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The imported items list. | [GetImportedItemsResponse](https://pro-docs.svc.vinted.com/#schemagetimporteditemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | UpdateItemReferences -------------------- > Code samples # You can also use wget curl -X PUT /api/v1/items/item-references \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `PUT /api/v1/items/item-references` Sets the item references for the items in the request. > Body parameter [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string"\ }\ ] ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference) | true | The request body for setting item references. | > Example responses > > 200 Response { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "reason": "ITEM_NOT_FOUND"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Item references set successfully. | [UpdateItemReferencesResponse](https://pro-docs.svc.vinted.com/#schemaupdateitemreferencesresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | ValidateItems ------------- > Code samples # You can also use wget curl -X POST /api/v1/items/validate \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /api/v1/items/validate` Validates a batch of items without creating them. Returns per-item validation results so integrators can check items before uploading. This endpoint has no side effects. > Body parameter { "items": [\ {\ "description": "string",\ "item_reference": "string",\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "price": 0.1,\ "title": "string"\ }\ ] } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [ValidateItems](https://pro-docs.svc.vinted.com/#schemavalidateitems) | true | The request body for validating items. | | » items | body | \[[ItemToValidate](https://pro-docs.svc.vinted.com/#schemaitemtovalidate)
\] | true | An array of items to validate. At most 100 items can be validated in a single request. | | »» description | body | string | false | The item description. | | »» item\_reference | body | string | true | The item reference for the integrator to identify the item in the response. | | »» manufacturer | body | string | false | Manufacturer credentials. | | »» manufacturer\_labelling | body | string | false | Labelling and marketing information. | | »» price | body | number(float) | false | The item price. Omitted price is treated as missing (blank); a submitted price is range-checked. | | »» title | body | string | false | The item title. | > Example responses > > 200 Response { "items": [\ {\ "errors": [\ {\ "code": "string",\ "field": "string",\ "message": "string"\ }\ ],\ "item_reference": "string",\ "valid": true\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Per-item validation results. | [ValidateItemsResponse](https://pro-docs.svc.vinted.com/#schemavalidateitemsresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occurred. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | GetOntologies ------------- > Code samples # You can also use wget curl -X GET /api/v1/ontologies \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/ontologies` 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. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | > Example responses > > 200 Response { "enumerations": { "catalogs": [\ {\ "catalogs": [\ {}\ ],\ "disabled_fields": [\ "brand"\ ],\ "id": 0,\ "item_attribute_ids": [\ "string"\ ],\ "size_group_ids": [\ 0\ ],\ "title": "string"\ }\ ], "colors": [\ {\ "id": 0,\ "title": "string"\ }\ ], "item_attributes": [\ {\ "id": "string",\ "is_required": true,\ "options": [\ {\ "id": 0,\ "title": "string"\ }\ ],\ "selection_limit": 0,\ "selection_type": "SINGLE",\ "title": "string"\ }\ ], "package_sizes": [\ {\ "id": 0,\ "title": "string",\ "weight_description": "string"\ }\ ], "size_groups": [\ {\ "description": "string",\ "id": 0,\ "sizes": [\ {\ "id": 0,\ "title": "string"\ }\ ],\ "title": "string"\ }\ ], "statuses": [\ {\ "description": "string",\ "id": 0,\ "title": "string"\ }\ ] }, "validation_rules": { "max_photos": 0, "max_price": 0.1, "min_price": 0.1 }, "version": { "country": "AT", "currency": "EUR", "last_updated_on": "2019-08-24T14:15:22Z" } } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved ontologies. | [GetOntologiesResponse](https://pro-docs.svc.vinted.com/#schemagetontologiesresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | GetItemPriceSuggestions ----------------------- > Code samples # You can also use wget curl -X GET /api/v2/item-price-suggestions?catalog_id=0 \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v2/item-price-suggestions` _Get maximum price suggestion for an item._ Returns the maximum suggested price for an item based on category, brand and condition, benchmarked against historical sold prices. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | catalog\_id | query | integer(int64) | true | The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree. | | brand\_id | query | integer(int64) | false | The brand ID of the item. | | status\_id | query | integer(int64) | false | The condition (status) ID of the item. Use the ontologies endpoint to get the statuses. | > Example responses > > 200 Response { "currency": "EUR", "maximum": 0.01 } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved maximum price suggestion. | [GetItemPriceSuggestionsResponse](https://pro-docs.svc.vinted.com/#schemagetitempricesuggestionsresponse) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | No price suggestion available for the given combination. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | Orders API ========== GetOrders --------- > Code samples # You can also use wget curl -X GET /api/v1/orders \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/orders` Returns a list of orders. Use the `after-id` query parameter to iterate over the results. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | after-id | query | integer(int64) | false | If set, returns only orders created after the order with this ID. | > Example responses > > 200 Response { "orders": [\ {\ "created_at": "2019-08-24T14:15:22Z",\ "id": 0,\ "status": "CREATED"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The orders list. | [GetOrdersResponse](https://pro-docs.svc.vinted.com/#schemagetordersresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | GetOrder -------- > Code samples # You can also use wget curl -X GET /api/v1/orders/{id} \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/orders/{id}` Returns the order with the given ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | integer(int64) | true | The order ID | > Example responses > > 200 Response { "amount": 0.01, "billing_address": { "city": "string", "country_code": "string", "line_1": "string", "line_2": "string", "name": "John Doe", "postal_code": "string", "state": "string" }, "created_at": "2019-08-24T14:15:22Z", "currency": "EUR", "delivery_address": { "city": "string", "country_code": "string", "line_1": "string", "line_2": "string", "name": "John Doe", "postal_code": "string", "state": "string" }, "id": 0, "items": [\ {\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "item_reference": "string",\ "price": 0.01,\ "title": "White Hilfiger t-shirt"\ }\ ], "status": "CREATED" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The order. | [GetOrderResponse](https://pro-docs.svc.vinted.com/#schemagetorderresponse) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 403 | [Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3) | User is not authorized to use this endpoint. | None | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Order not found. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | CancelOrder ----------- > Code samples # You can also use wget curl -X POST /api/v1/orders/{id}/cancel \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /api/v1/orders/{id}/cancel` Cancels the order with the given ID asynchronously. > Body parameter { "cancellation_reason_explanation": "string" } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | integer(int64) | true | The order ID | | body | body | object | true | none | | » cancellation\_reason\_explanation | body | string | true | Explanation for the cancellation | > Example responses > > 401 Response { "error": "INVALID_HMAC_SIGNATURE" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Order will be cancelled asynchronously. | None | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | GetOrderShipment ---------------- > Code samples # You can also use wget curl -X GET /api/v1/orders/{id}/shipment \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/orders/{id}/shipment` Returns the shipment for the order with the given ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | integer(int64) | true | The order ID | > Example responses > > 200 Response { "carrier": { "name": "Vinted Go" }, "currency": "EUR", "price_ex_vat": 0.01, "tracking_code": "string", "vat_amount": 0.01 } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The shipment. | [GetOrderShipmentResponse](https://pro-docs.svc.vinted.com/#schemagetordershipmentresponse) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Shipment not found. This can be because the shipment does not (yet) exist. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | GetOrderShipmentLabel --------------------- > Code samples # You can also use wget curl -X GET /api/v1/orders/{id}/shipment-label \ -H 'Accept: application/pdf' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/orders/{id}/shipment-label` Retrieves the shipment label shipment label by order ID. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | integer(int64) | true | The order ID. | > Example responses > > 200 Response > > 401 Response { "error": "INVALID_HMAC_SIGNATURE" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved the order shipment label. | string | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The shipment label could not be found. Will also be returned for orders containing items that are not managed via Vinted Pro Integrations. | [GetOrderShipmentLabelNotFoundResponse](https://pro-docs.svc.vinted.com/#schemagetordershipmentlabelnotfoundresponse) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | RelistOrders ------------ > Code samples # You can also use wget curl -X POST /api/v1/orders/relist \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /api/v1/orders/relist` Relists one or more cancelled escrow orders by proxying to Core's transaction reupload. Each order is validated and, if eligible, relisted asynchronously. Reupload is order-scoped: every revoked item in the order is relisted. > Body parameter { "order_ids": [\ 0\ ] } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | object | true | The escrow order IDs to relist. | | » order\_ids | body | \[integer\] | true | The Core escrow order IDs to relist. | > Example responses > > 202 Response { "orders": [\ {\ "accepted": true,\ "order_id": 0,\ "reason": "ORDER_NOT_FOUND"\ }\ ] } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 202 | [Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3) | Relist requests accepted for processing. | [RelistOrdersResponse](https://pro-docs.svc.vinted.com/#schemarelistordersresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occurred. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occurred. | None | Webhooks API ============ GetWebhooks ----------- > Code samples # You can also use wget curl -X GET /api/v1/webhooks \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/webhooks` Lists your registered webhooks. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | > Example responses > > 200 Response [\ {\ "event_types": [\ "CREATE_ITEM_SUCCESS"\ ],\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "url": "string"\ }\ ] ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved the webhooks. | [GetWebhooksResponse](https://pro-docs.svc.vinted.com/#schemagetwebhooksresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | CreateWebhook ------------- > Code samples # You can also use wget curl -X POST /api/v1/webhooks \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /api/v1/webhooks` Add a webhook to be called when events happen in Vinted. > Body parameter { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "url": "stringstr" } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | body | body | [CreateUpdateWebhook](https://pro-docs.svc.vinted.com/#schemacreateupdatewebhook) | true | The request body for creating or updating webhooks. | | » event\_types | body | \[[WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype)
\] | true | The event types that the webhook should subscribe to. At least one event type is required. | | » url | body | string(url) | true | The URL to POST the webhook to when the event occurs. Must be between 9 and 255 characters and start with http:// or https://. | #### Detailed descriptions **» event\_types**: The event types that the webhook should subscribe to. At least one event type is required. * `CREATE_ITEM_SUCCESS`: Triggered when an item is successfully created. * `CREATE_ITEM_FAILURE`: Triggered when an item creation fails. * `UPDATE_ITEM_SUCCESS`: Triggered when a requested item update succeeds. * `UPDATE_ITEM_FAILURE`: Triggered when a requested item update fails. * `DELETE_ITEM_SUCCESS`: Triggered when the requested deletion of an item succeeds. * `DELETE_ITEM_FAILURE`: Triggered when the requested deletion of an item fails. * `ITEM_DELETED`: Triggered when an item is deleted outside of VPI. * `ITEM_SOLD`: Triggered when an item is sold. * `ITEM_UPDATED`: Triggered when an item is updated outside of VPI. * `ORDER_CREATED`: Triggered when an escrow order is created for one or more items. Note that this excludes manually completed orders. * `CANCEL_ORDER_FAILURE`: Triggered when an order cancellation via VPI fails. * `SHIPMENT_LABEL_CREATED`: Triggered when a shipment label is created for an order. * `ITEM_PUBLISHED`: Triggered when an item is published and visible on the marketplace. * `ORDER_CANCELLED`: Triggered when an order is cancelled due to a transaction cancellation. Includes the cancellation status code and description. * `VINTED_AUTHENTICATION_ERROR`: Triggered when authentication with the Vinted Marketplace fails for this integration. Re-authenticate to restore access. #### Enumerated Values | Parameter | Value | | --- | --- | | » event\_types | CREATE\_ITEM\_SUCCESS | | » event\_types | CREATE\_ITEM\_FAILURE | | » event\_types | UPDATE\_ITEM\_SUCCESS | | » event\_types | UPDATE\_ITEM\_FAILURE | | » event\_types | DELETE\_ITEM\_SUCCESS | | » event\_types | DELETE\_ITEM\_FAILURE | | » event\_types | ITEM\_DELETED | | » event\_types | ITEM\_SOLD | | » event\_types | ITEM\_UPDATED | | » event\_types | ORDER\_CREATED | | » event\_types | CANCEL\_ORDER\_FAILURE | | » event\_types | SHIPMENT\_LABEL\_CREATED | | » event\_types | ITEM\_PUBLISHED | | » event\_types | ORDER\_CANCELLED | | » event\_types | VINTED\_AUTHENTICATION\_ERROR | > Example responses > > 201 Response { "signing_key": "string", "webhook": { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string" } } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | The webhook was successfully created. | [CreateWebhookResponse](https://pro-docs.svc.vinted.com/#schemacreatewebhookresponse) | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 422 | [Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3) | The request could not be processed. | [CreateWebhookError](https://pro-docs.svc.vinted.com/#schemacreatewebhookerror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | DeleteWebhook ------------- > Code samples # You can also use wget curl -X DELETE /api/v1/webhooks/{id} \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `DELETE /api/v1/webhooks/{id}` Deletes a webhook. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | string(uuid) | true | The webhook ID. | > Example responses > > 400 Response { "field": "string", "message": "string" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully deleted the webhook. | None | | 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | The webhook has already been deleted. | None | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The webhook could not be found. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | UpdateWebhook ------------- > Code samples # You can also use wget curl -X PUT /api/v1/webhooks/{id} \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `PUT /api/v1/webhooks/{id}` Updates a webhook's URL and/or subscribed event types. > Body parameter { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "url": "stringstr" } ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | string(uuid) | true | The webhook ID. | | body | body | [CreateUpdateWebhook](https://pro-docs.svc.vinted.com/#schemacreateupdatewebhook) | true | The request body for creating or updating webhooks. | | » event\_types | body | \[[WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype)
\] | true | The event types that the webhook should subscribe to. At least one event type is required. | | » url | body | string(url) | true | The URL to POST the webhook to when the event occurs. Must be between 9 and 255 characters and start with http:// or https://. | #### Detailed descriptions **» event\_types**: The event types that the webhook should subscribe to. At least one event type is required. * `CREATE_ITEM_SUCCESS`: Triggered when an item is successfully created. * `CREATE_ITEM_FAILURE`: Triggered when an item creation fails. * `UPDATE_ITEM_SUCCESS`: Triggered when a requested item update succeeds. * `UPDATE_ITEM_FAILURE`: Triggered when a requested item update fails. * `DELETE_ITEM_SUCCESS`: Triggered when the requested deletion of an item succeeds. * `DELETE_ITEM_FAILURE`: Triggered when the requested deletion of an item fails. * `ITEM_DELETED`: Triggered when an item is deleted outside of VPI. * `ITEM_SOLD`: Triggered when an item is sold. * `ITEM_UPDATED`: Triggered when an item is updated outside of VPI. * `ORDER_CREATED`: Triggered when an escrow order is created for one or more items. Note that this excludes manually completed orders. * `CANCEL_ORDER_FAILURE`: Triggered when an order cancellation via VPI fails. * `SHIPMENT_LABEL_CREATED`: Triggered when a shipment label is created for an order. * `ITEM_PUBLISHED`: Triggered when an item is published and visible on the marketplace. * `ORDER_CANCELLED`: Triggered when an order is cancelled due to a transaction cancellation. Includes the cancellation status code and description. * `VINTED_AUTHENTICATION_ERROR`: Triggered when authentication with the Vinted Marketplace fails for this integration. Re-authenticate to restore access. #### Enumerated Values | Parameter | Value | | --- | --- | | » event\_types | CREATE\_ITEM\_SUCCESS | | » event\_types | CREATE\_ITEM\_FAILURE | | » event\_types | UPDATE\_ITEM\_SUCCESS | | » event\_types | UPDATE\_ITEM\_FAILURE | | » event\_types | DELETE\_ITEM\_SUCCESS | | » event\_types | DELETE\_ITEM\_FAILURE | | » event\_types | ITEM\_DELETED | | » event\_types | ITEM\_SOLD | | » event\_types | ITEM\_UPDATED | | » event\_types | ORDER\_CREATED | | » event\_types | CANCEL\_ORDER\_FAILURE | | » event\_types | SHIPMENT\_LABEL\_CREATED | | » event\_types | ITEM\_PUBLISHED | | » event\_types | ORDER\_CANCELLED | | » event\_types | VINTED\_AUTHENTICATION\_ERROR | > Example responses > > 400 Response { "field": "string", "message": "string" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully updated webhook. | None | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The webhook could not be found. | None | | 422 | [Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3) | The request could not be processed. | [UpdateWebhookError](https://pro-docs.svc.vinted.com/#schemaupdatewebhookerror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | GetWebhookDeliveryResults ------------------------- > Code samples # You can also use wget curl -X GET /api/v1/webhooks/{id}/delivery-results \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `GET /api/v1/webhooks/{id}/delivery-results` Gets the 100 latest delivery results (attempts, failures and successes) for a webhook. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | id | path | string(uuid) | true | The webhook ID. | > Example responses > > 200 Response [\ {\ "created_at": "2019-08-24T14:15:22Z",\ "error_msg": "string",\ "event_type": "CREATE_ITEM_SUCCESS",\ "http_status_code": 0,\ "success": true\ }\ ] ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Successfully retrieved the delivery results. | Inline | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | User is not authorized to use API. | [UnauthorizedError](https://pro-docs.svc.vinted.com/#schemaunauthorizederror) | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | ### Response Schema Status Code **200** | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | \[[WebhookDeliveryResult](https://pro-docs.svc.vinted.com/#schemawebhookdeliveryresult)
\] | false | none | none | | » created\_at | string(date-time) | true | none | The date and time when the delivery result was created. | | » error\_msg | string | false | none | The error message if the delivery was not successful. | | » event\_type | [WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype) | true | none | The event type of the webhook. | | » http\_status\_code | integer(int) | false | none | The HTTP status code of the response that Vinted received from the webhook endpoint. If a response was received at all. | | » success | boolean | true | none | A boolean indicating if the delivery was successful. | #### Enumerated Values | Property | Value | | --- | --- | | event\_type | CREATE\_ITEM\_SUCCESS | | event\_type | CREATE\_ITEM\_FAILURE | | event\_type | UPDATE\_ITEM\_SUCCESS | | event\_type | UPDATE\_ITEM\_FAILURE | | event\_type | DELETE\_ITEM\_SUCCESS | | event\_type | DELETE\_ITEM\_FAILURE | | event\_type | ITEM\_DELETED | | event\_type | ITEM\_SOLD | | event\_type | ITEM\_UPDATED | | event\_type | ORDER\_CREATED | | event\_type | CANCEL\_ORDER\_FAILURE | | event\_type | SHIPMENT\_LABEL\_CREATED | | event\_type | ITEM\_PUBLISHED | | event\_type | ORDER\_CANCELLED | | event\_type | VINTED\_AUTHENTICATION\_ERROR | Dev mode API ============ TriggerItemSold --------------- > Code samples # You can also use wget curl -X POST /dev/v1/triggers/item-sold/{itemID} \ -H 'Accept: application/json' \ -H 'X-Vpi-Hmac-Sha256: string' \ -H 'X-Vpi-Access-Key: API_KEY' `POST /dev/v1/triggers/item-sold/{itemID}` _Triggers the sale of an item_ Use this endpoint to simulate making a sale. Only available in dev mode. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | X-Vpi-Hmac-Sha256 | header | string | true | Signature header. Reference script in documentation. | | itemID | path | string(uuid) | true | The item ID. | > Example responses > > 400 Response { "field": "string", "message": "string" } ### Responses | Status | Meaning | Description | Schema | | --- | --- | --- | --- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | The item sale was successfully triggered. | None | | 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | A validation error occured. | [ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror) | | 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | The request had invalid authentication. | None | | 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | The item is not found. | None | | 409 | [Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8) | The item is already sold. | None | | 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | An unexpected error occured. | None | Schemas ======= Address ------- { "city": "string", "country_code": "string", "line_1": "string", "line_2": "string", "name": "John Doe", "postal_code": "string", "state": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | city | string | true | none | none | | country\_code | string | true | none | ISO 3166 alpha-2 country code. | | line\_1 | string | true | none | none | | line\_2 | string | false | none | none | | name | string | true | none | Name of the addressee. | | postal\_code | string | true | none | none | | state | string | false | none | none | CancelOrderFailureEventData --------------------------- { "error": "string", "order_id": 0 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | error | string | true | none | The error message. | | order\_id | integer(int64) | true | none | The order ID. | Catalog ------- { "catalogs": [\ {\ "catalogs": [],\ "disabled_fields": [\ "brand"\ ],\ "id": 0,\ "item_attribute_ids": [\ "string"\ ],\ "size_group_ids": [\ 0\ ],\ "title": "string"\ }\ ], "disabled_fields": [\ "brand"\ ], "id": 0, "item_attribute_ids": [\ "string"\ ], "size_group_ids": [\ 0\ ], "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | catalogs | \[[Catalog](https://pro-docs.svc.vinted.com/#schemacatalog)
\] | false | none | The child catalogs. Empty for leaf catalogs. | | disabled\_fields | \[string\] | false | none | Fields that are disabled for this catalog. Empty for non-leaf catalogs. Disabled fields will be ignored on an item when the catalog is set to this catalog. | | id | integer | true | none | The catalog ID. | | item\_attribute\_ids | \[string\] | false | none | The IDs of the item attributes associated with this catalog. | | size\_group\_ids | \[integer\] | false | none | Only the provided size groups are valid for this catalog. Empty for non-leaf catalogs. | | title | string | true | none | The catalog title. | Color ----- { "id": 0, "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | integer | true | none | The color ID. | | title | string | true | none | The color title. | CompleteItemToCreate -------------------- { "brand": "string", "catalog_id": 0, "color_ids": [\ 0\ ], "currency": "EUR", "description": "string", "is_unisex": true, "isbn": "string", "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ], "manufacturer": "string", "manufacturer_labelling": "string", "measurement_length": 0, "measurement_width": 0, "package_size_id": 0, "photo_urls": [\ "http://example.com"\ ], "price": 1, "size_id": 0, "status_id": 0, "title": "string", "video_game_rating_id": 0, "item_reference": "string", "is_draft": true } ### Properties allOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemProperties](https://pro-docs.svc.vinted.com/#schemaitemproperties) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemReference](https://pro-docs.svc.vinted.com/#schemaitemreference) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemIsDraft](https://pro-docs.svc.vinted.com/#schemaitemisdraft) | false | none | none | CreateItemFailureEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string", "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "message": "string" } ### Properties _None_ CreateItemSuccessEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ CreateItemValidationError ------------------------- { "field": "string", "message": "string" } ### Properties _None_ CreateItems ----------- { "items": [\ {\ "brand": "string",\ "catalog_id": 0,\ "color_ids": [\ 0\ ],\ "currency": "EUR",\ "description": "string",\ "is_unisex": true,\ "isbn": "string",\ "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ],\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "measurement_length": 0,\ "measurement_width": 0,\ "package_size_id": 0,\ "photo_urls": [\ "http://example.com"\ ],\ "price": 1,\ "size_id": 0,\ "status_id": 0,\ "title": "string",\ "video_game_rating_id": 0,\ "item_reference": "string",\ "is_draft": true\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[CompleteItemToCreate](https://pro-docs.svc.vinted.com/#schemacompleteitemtocreate)
\] | true | none | An array of items to create. At most 100 items can be created in a single request. | CreateItemsResponse ------------------- { "items": [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference)
\] | true | none | none | CreateItemsValidationErrorResponse ---------------------------------- [\ {\ "field": "string",\ "message": "string"\ }\ ] ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | \[[CreateItemValidationError](https://pro-docs.svc.vinted.com/#schemacreateitemvalidationerror)
\] | false | none | none | CreateUpdateWebhook ------------------- { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "url": "stringstr" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | event\_types | \[[WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype)
\] | true | none | The event types that the webhook should subscribe to. At least one event type is required.

\- `CREATE_ITEM_SUCCESS`: Triggered when an item is successfully created.
\- `CREATE_ITEM_FAILURE`: Triggered when an item creation fails.
\- `UPDATE_ITEM_SUCCESS`: Triggered when a requested item update succeeds.
\- `UPDATE_ITEM_FAILURE`: Triggered when a requested item update fails.
\- `DELETE_ITEM_SUCCESS`: Triggered when the requested deletion of an item succeeds.
\- `DELETE_ITEM_FAILURE`: Triggered when the requested deletion of an item fails.
\- `ITEM_DELETED`: Triggered when an item is deleted outside of VPI.
\- `ITEM_SOLD`: Triggered when an item is sold.
\- `ITEM_UPDATED`: Triggered when an item is updated outside of VPI.
\- `ORDER_CREATED`: Triggered when an escrow order is created for one or more items. Note that this excludes manually completed orders.
\- `CANCEL_ORDER_FAILURE`: Triggered when an order cancellation via VPI fails.
\- `SHIPMENT_LABEL_CREATED`: Triggered when a shipment label is created for an order.
\- `ITEM_PUBLISHED`: Triggered when an item is published and visible on the marketplace.
\- `ORDER_CANCELLED`: Triggered when an order is cancelled due to a transaction cancellation. Includes the cancellation status code and description.
\- `VINTED_AUTHENTICATION_ERROR`: Triggered when authentication with the Vinted Marketplace fails for this integration. Re-authenticate to restore access. | | url | string(url) | true | none | The URL to POST the webhook to when the event occurs. Must be between 9 and 255 characters and start with http:// or https://. | CreateWebhookError ------------------ { "error": "MAX_WEBHOOKS_EXCEEDED" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | error | string | true | none | none | #### Enumerated Values | Property | Value | | --- | --- | | error | MAX\_WEBHOOKS\_EXCEEDED | | error | ONLY\_HTTPS\_URLS\_ALLOWED | CreateWebhookResponse --------------------- { "signing_key": "string", "webhook": { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string" } } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | signing\_key | string | true | none | none | | webhook | [Webhook](https://pro-docs.svc.vinted.com/#schemawebhook) | true | none | none | Currency -------- "EUR" The currency used for prices. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | string | false | none | The currency used for prices. | #### Enumerated Values | Property | Value | | --- | --- | | _anonymous_ | EUR | | _anonymous_ | GBP | DeleteItemFailureEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ DeleteItemSuccessEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ DeleteItems ----------- { "item_ids": [\ "497f6eca-6276-4993-bfeb-53cbbbba6f08"\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | item\_ids | \[string\] | true | none | An array of item identifiers. When the items were created in VPI, you received an identifier for each item. Use that identifier to delete the item. At most 100 items can be deleted in a single request. | DeleteItemsResponse ------------------- { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[DeleteItemsResponseItem](https://pro-docs.svc.vinted.com/#schemadeleteitemsresponseitem)
\] | true | none | none | DeleteItemsResponseItem ----------------------- { "accepted": true, "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | accepted | boolean | true | none | A boolean indicating if the deletion request for the item was accepted. Examples of reasons for an item deletion not to be accepted are than you do not own the item, the item was already deleted or the item was already sold. | | item\_id | string(uuid) | true | none | none | GetImportedItemsResponse ------------------------ { "items": [\ {\ "description": "string",\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "status": "IN_PROGRESS",\ "title": "string",\ "url": "http://example.com"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ImportedItem](https://pro-docs.svc.vinted.com/#schemaimporteditem)
\] | true | none | none | GetItemPriceSuggestionsResponse ------------------------------- { "currency": "EUR", "maximum": 0.01 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | currency | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | none | The currency used for prices. | | maximum | number(float) | true | none | Upper bound of the suggested price range. | GetItemStatusResponse --------------------- { "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "marketplace_item_id": 0, "status": "IN_PROGRESS" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | errors | \[[ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror)
\] | false | none | none | | marketplace\_item\_id | integer(int64) | true | none | The public integer item ID as used in the website URLs for Vinted. Note that VPI does not accept this ID on any of its endpoints, only the UUID. However, VPI provides this ID because it can be useful to cross-reference with the Vinted website. | | status | [ItemStatus](https://pro-docs.svc.vinted.com/#schemaitemstatus) | true | none | The item status. | GetItemsResponse ---------------- { "items": [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string",\ "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ],\ "marketplace_item_id": 0,\ "status": "IN_PROGRESS"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[GetItemsResponseItem](https://pro-docs.svc.vinted.com/#schemagetitemsresponseitem)
\] | true | none | none | GetItemsResponseItem -------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string", "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "marketplace_item_id": 0, "status": "IN_PROGRESS" } ### Properties allOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [GetItemStatusResponse](https://pro-docs.svc.vinted.com/#schemagetitemstatusresponse) | false | none | none | GetOntologiesResponse --------------------- { "enumerations": { "catalogs": [\ {\ "catalogs": [\ {}\ ],\ "disabled_fields": [\ "brand"\ ],\ "id": 0,\ "item_attribute_ids": [\ "string"\ ],\ "size_group_ids": [\ 0\ ],\ "title": "string"\ }\ ], "colors": [\ {\ "id": 0,\ "title": "string"\ }\ ], "item_attributes": [\ {\ "id": "string",\ "is_required": true,\ "options": [\ {\ "id": 0,\ "title": "string"\ }\ ],\ "selection_limit": 0,\ "selection_type": "SINGLE",\ "title": "string"\ }\ ], "package_sizes": [\ {\ "id": 0,\ "title": "string",\ "weight_description": "string"\ }\ ], "size_groups": [\ {\ "description": "string",\ "id": 0,\ "sizes": [\ {\ "id": 0,\ "title": "string"\ }\ ],\ "title": "string"\ }\ ], "statuses": [\ {\ "description": "string",\ "id": 0,\ "title": "string"\ }\ ] }, "validation_rules": { "max_photos": 0, "max_price": 0.1, "min_price": 0.1 }, "version": { "country": "AT", "currency": "EUR", "last_updated_on": "2019-08-24T14:15:22Z" } } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | enumerations | object | true | none | Ontologies enumerations. Only values from these enumerations are valid for sending as item data. However, not all values from these enumerations are valid for all items. The Catalog object dictates some subsets of valid values. | | » catalogs | \[[Catalog](https://pro-docs.svc.vinted.com/#schemacatalog)
\] | true | none | none | | » colors | \[[Color](https://pro-docs.svc.vinted.com/#schemacolor)
\] | true | none | none | | » item\_attributes | \[[ItemAttribute](https://pro-docs.svc.vinted.com/#schemaitemattribute)
\] | true | none | none | | » package\_sizes | \[[PackageSize](https://pro-docs.svc.vinted.com/#schemapackagesize)
\] | true | none | \[The size of the package that the item will be shipped in.\] | | » size\_groups | \[[SizeGroup](https://pro-docs.svc.vinted.com/#schemasizegroup)
\] | true | none | none | | » statuses | \[[Status](https://pro-docs.svc.vinted.com/#schemastatus)
\] | true | none | \[Condition of an item/product.\] | | validation\_rules | [ValidationRules](https://pro-docs.svc.vinted.com/#schemavalidationrules) | true | none | none | | version | object | true | none | Although most of the ontologies data is static, it does vary based on country and currency, therefore the ontologies are versioned using those properties + a date-time reference to when it was last updated. | | » country | string | true | none | none | | » currency | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | none | The currency used for prices. | | » last\_updated\_on | string(date-time) | true | none | none | #### Enumerated Values | Property | Value | | --- | --- | | country | AT | | country | BE | | country | DE | | country | ES | | country | FR | | country | IT | | country | LU | | country | NL | | country | PT | | country | UK | GetOrderResponse ---------------- { "amount": 0.01, "billing_address": { "city": "string", "country_code": "string", "line_1": "string", "line_2": "string", "name": "John Doe", "postal_code": "string", "state": "string" }, "created_at": "2019-08-24T14:15:22Z", "currency": "EUR", "delivery_address": { "city": "string", "country_code": "string", "line_1": "string", "line_2": "string", "name": "John Doe", "postal_code": "string", "state": "string" }, "id": 0, "items": [\ {\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "item_reference": "string",\ "price": 0.01,\ "title": "White Hilfiger t-shirt"\ }\ ], "status": "CREATED" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | amount | number(float) | true | none | The amount you will receive for this order. | | billing\_address | [Address](https://pro-docs.svc.vinted.com/#schemaaddress) | true | none | none | | created\_at | string(date-time) | true | none | none | | currency | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | none | The currency used for prices. | | delivery\_address | [Address](https://pro-docs.svc.vinted.com/#schemaaddress) | true | none | none | | id | integer | true | none | none | | items | \[[OrderItem](https://pro-docs.svc.vinted.com/#schemaorderitem)
\] | true | none | The items in the order. | | status | [OrderStatus](https://pro-docs.svc.vinted.com/#schemaorderstatus) | true | none | none | GetOrderShipmentLabelNotFoundResponse ------------------------------------- { "error": "ORDER_NOT_FOUND" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | error | string | true | none | none | #### Enumerated Values | Property | Value | | --- | --- | | error | ORDER\_NOT\_FOUND | | error | LABEL\_CREATION\_IN\_PROGRESS | | error | LABEL\_CREATION\_FAILED | GetOrderShipmentResponse ------------------------ { "carrier": { "name": "Vinted Go" }, "currency": "EUR", "price_ex_vat": 0.01, "tracking_code": "string", "vat_amount": 0.01 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | carrier | object | true | none | none | | » name | string | false | none | none | | currency | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | false | none | The currency used for prices. | | price\_ex\_vat | number(float) | true | none | The price paid for the label, excluding VAT. | | tracking\_code | string | true | none | The tracking code for the shipment. Will be empty for orders containing items that are not managed via Vinted Pro Integrations. | | vat\_amount | number(float) | true | none | The VAT paid. | GetOrdersResponse ----------------- { "orders": [\ {\ "created_at": "2019-08-24T14:15:22Z",\ "id": 0,\ "status": "CREATED"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | orders | \[[OrderListElement](https://pro-docs.svc.vinted.com/#schemaorderlistelement)
\] | false | none | none | GetWebhooksResponse ------------------- [\ {\ "event_types": [\ "CREATE_ITEM_SUCCESS"\ ],\ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",\ "url": "string"\ }\ ] ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | \[[Webhook](https://pro-docs.svc.vinted.com/#schemawebhook)
\] | false | none | none | ImportedItem ------------ { "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "IN_PROGRESS", "title": "string", "url": "http://example.com" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | none | none | | id | string(uuid) | true | none | none | | status | [ItemStatus](https://pro-docs.svc.vinted.com/#schemaitemstatus) | true | none | The item status. | | title | string | true | none | none | | url | string(uri) | true | none | none | ItemAttribute ------------- { "id": "string", "is_required": true, "options": [\ {\ "id": 0,\ "title": "string"\ }\ ], "selection_limit": 0, "selection_type": "SINGLE", "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | string | true | none | The item attribute ID. | | is\_required | boolean | true | none | A boolean indicating if the item attribute is required. | | options | \[[ItemAttributeOption](https://pro-docs.svc.vinted.com/#schemaitemattributeoption)
\] | true | none | The item attribute options. | | selection\_limit | integer | true | none | The item attribute options selection limit. | | selection\_type | string | true | none | The item attribute selection type. | | title | string | true | none | The item attribute title. | #### Enumerated Values | Property | Value | | --- | --- | | selection\_type | SINGLE | | selection\_type | MULTIPLE | ItemAttributeInput ------------------ { "item_attribute_id": "string", "item_attribute_option_ids": [\ 0\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | item\_attribute\_id | string | false | none | The item attribute ID. | | item\_attribute\_option\_ids | \[integer\] | false | none | The item attribute option IDs. | ItemAttributeOption ------------------- { "id": 0, "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | integer | true | none | The item attribute option ID. | | title | string | true | none | The item attribute option title. | ItemDeletedEventData -------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ ItemIDAndReference ------------------ { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | item\_id | string(uuid) | true | none | The main item identifier. | | item\_reference | string | true | none | The item reference for the integrator to identify the item. | ItemIDAndReferenceWithErrors ---------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string", "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "message": "string" } ### Properties allOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | object | false | none | none | | » errors | \[[ValidationError](https://pro-docs.svc.vinted.com/#schemavalidationerror)
\] | false | none | none | | » message | string | false | none | none | ItemIsDraft ----------- { "is_draft": true } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | is\_draft | boolean | true | none | A boolean indicating whether the item is a draft. | ItemProperties -------------- { "brand": "string", "catalog_id": 0, "color_ids": [\ 0\ ], "currency": "EUR", "description": "string", "is_unisex": true, "isbn": "string", "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ], "manufacturer": "string", "manufacturer_labelling": "string", "measurement_length": 0, "measurement_width": 0, "package_size_id": 0, "photo_urls": [\ "http://example.com"\ ], "price": 1, "size_id": 0, "status_id": 0, "title": "string", "video_game_rating_id": 0 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | brand | string | true | none | The item brand. | | catalog\_id | integer(int) | true | none | The ID of item catalog. This must be a leaf catalog. Use the ontologies endpoint to get the catalog tree. | | color\_ids | \[integer\] | false | none | The item colors IDs. Use the ontologies endpoint to get the colors. | | currency | [Currency](https://pro-docs.svc.vinted.com/#schemacurrency) | true | none | The currency used for prices. | | description | string | true | none | The item description. Must be between 5 and 2000 characters. | | is\_unisex | boolean | false | none | A boolean indicating if item is unisex. | | isbn | string | false | none | The ISBN of the book. Applicable to book catalogs only. | | item\_attributes | \[[ItemAttributeInput](https://pro-docs.svc.vinted.com/#schemaitemattributeinput)
\] | false | none | The item attributes. | | manufacturer | string | false | none | Manufacturer credentials. E.g. "Mattel (USA)". | | manufacturer\_labelling | string | false | none | Labelling and marketing information. This should be general information on product safety and compliance such as safety warnings and instructions of use or safety marks/logo/certifications related to the product. | | measurement\_length | integer(int) | false | none | The item measurement length. | | measurement\_width | integer(int) | false | none | The item measurement width. | | package\_size\_id | integer(int) | true | none | The ID of item package size. Use the ontologies endpoint to get the package sizes. | | photo\_urls | \[string\] | true | none | The URLs of the item photos. Must be publicly accessible. At least one photo is required. The maximum size of a photo is 5MB. | | price | number(float) | true | none | The item price. | | size\_id | integer(int) | false | none | The ID of item size. This is required for catalogs that have a size group (i.e. a non-empty size\_group\_ids array). Use the ontologies endpoint to get the size groups. | | status\_id | integer(int) | true | none | The ID of item status (condition). Use the ontologies endpoint to get the statuses. | | title | string | true | none | The item title. Must be between 5 and 100 characters. | | video\_game\_rating\_id | integer(int) | false | none | The video game content rating ID. Applicable to video game catalogs only. | ItemPublishedEventData ---------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ ItemReference ------------- { "item_reference": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | item\_reference | string | true | none | The item reference for the integrator to identify the item. | ItemSoldEventData ----------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ ItemStatus ---------- "IN_PROGRESS" The item status. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | string | false | none | The item status. | #### Enumerated Values | Property | Value | | --- | --- | | _anonymous_ | IN\_PROGRESS | | _anonymous_ | ACTIVE | | _anonymous_ | SOLD | | _anonymous_ | DELETED | | _anonymous_ | DELETE\_INTERNAL\_ERROR | | _anonymous_ | VALIDATION\_ERROR | | _anonymous_ | UPDATE\_INTERNAL\_ERROR | | _anonymous_ | UPDATE\_VALIDATION\_ERROR | | _anonymous_ | INTERNAL\_ERROR | | _anonymous_ | SALE\_CANCELLED | ItemToUpdate ------------ { "brand": "string", "catalog_id": 0, "color_ids": [\ 0\ ], "currency": "EUR", "description": "string", "is_unisex": true, "isbn": "string", "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ], "manufacturer": "string", "manufacturer_labelling": "string", "measurement_length": 0, "measurement_width": 0, "package_size_id": 0, "photo_urls": [\ "http://example.com"\ ], "price": 1, "size_id": 0, "status_id": 0, "title": "string", "video_game_rating_id": 0, "is_draft": true, "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c" } ### Properties allOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemProperties](https://pro-docs.svc.vinted.com/#schemaitemproperties) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemIsDraft](https://pro-docs.svc.vinted.com/#schemaitemisdraft) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | object | false | none | none | | » item\_id | string(uuid) | true | none | The item ID. | ItemToValidate -------------- { "description": "string", "item_reference": "string", "manufacturer": "string", "manufacturer_labelling": "string", "price": 0.1, "title": "string" } An item to validate. Fields are intentionally loose (no length or presence constraints) so the validation rules, not the schema, report content problems. Only the fields currently validated are declared. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | false | none | The item description. | | item\_reference | string | true | none | The item reference for the integrator to identify the item in the response. | | manufacturer | string | false | none | Manufacturer credentials. | | manufacturer\_labelling | string | false | none | Labelling and marketing information. | | price | number(float) | false | none | The item price. Omitted price is treated as missing (blank); a submitted price is range-checked. | | title | string | false | none | The item title. | ItemUpdatedEventData -------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string", "brand_id": 0, "catalog_id": 0, "color1_id": 0, "color2_id": 0, "currency": "string", "description": "string", "package_size_id": 0, "price": 0.1, "size_id": 0, "status_id": 0, "title": "string", "updated_attributes": [\ "title"\ ] } ### Properties allOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | [ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference) | false | none | none | and | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | object | false | none | none | | » brand\_id | integer(int) | true | none | The brand ID of the item. | | » catalog\_id | integer(int) | true | none | The catalog ID of the item. | | » color1\_id | integer(int)¦null | false | none | The first color ID of the item. | | » color2\_id | integer(int)¦null | false | none | The second color ID of the item. | | » currency | string | true | none | The currency of the item price. | | » description | string | true | none | The description of the item. | | » package\_size\_id | integer(int) | true | none | The package size ID of the item. | | » price | number(float) | true | none | The price of the item. | | » size\_id | integer(int)¦null | false | none | The size ID of the item. | | » status\_id | integer(int) | true | none | The status ID of the item. | | » title | string | true | none | The title of the item. | | » updated\_attributes | \[string\] | true | none | List of attribute names that were updated. | ItemValidationError ------------------- { "code": "string", "field": "string", "message": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | code | string | true | none | A stable, machine-readable error code. Existing codes will not change, but new codes may be added over time, so consumers should tolerate unrecognised values. Known values: BLANK, TOO\_SHORT, TOO\_LONG, PRICE\_TOO\_LOW, CONTAINS\_EMAIL, EXCESSIVE\_UPPERCASE, EXCESSIVE\_SYMBOLS, UNALLOWED\_SYMBOLS, LONG\_WORDS. | | field | string | true | none | The field that failed validation. | | message | string | true | none | A human-readable error message. | ItemValidationResult -------------------- { "errors": [\ {\ "code": "string",\ "field": "string",\ "message": "string"\ }\ ], "item_reference": "string", "valid": true } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | errors | \[[ItemValidationError](https://pro-docs.svc.vinted.com/#schemaitemvalidationerror)
\] | false | none | none | | item\_reference | string | true | none | The item reference echoed from the request. | | valid | boolean | true | none | Whether the item passed all validation checks. | OrderCancelledEventData ----------------------- { "cancellation_status_code": 0, "cancellation_status_description": "string", "order_id": 0 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | cancellation\_status\_code | integer(int64) | true | none | The numeric cancellation status code from Core. | | cancellation\_status\_description | string | true | none | The human-readable cancellation status description. | | order\_id | integer(int64) | true | none | The order ID. | OrderCreatedEventData --------------------- { "items": [\ {\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "item_reference": "string"\ }\ ], "order_id": 0 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ItemIDAndReference](https://pro-docs.svc.vinted.com/#schemaitemidandreference)
\] | true | none | The items in the order. | | order\_id | integer(int64) | true | none | The order ID. | OrderItem --------- { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "item_reference": "string", "price": 0.01, "title": "White Hilfiger t-shirt" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | string(uuid) | true | none | The item ID. Will be 00000000-0000-0000-0000-000000000000 for items not managed via Vinted Pro Integrations. | | item\_reference | string | false | none | The item reference for the integrator to identify the item. | | price | [Price](https://pro-docs.svc.vinted.com/#schemaprice) | true | none | A price paid for something. | | title | string | true | none | The title under which the item was listed. | OrderListElement ---------------- { "created_at": "2019-08-24T14:15:22Z", "id": 0, "status": "CREATED" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | created\_at | string(date-time) | true | none | none | | id | integer(int64) | true | none | none | | status | [OrderStatus](https://pro-docs.svc.vinted.com/#schemaorderstatus) | true | none | none | OrderStatus ----------- "CREATED" ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | string | false | none | none | #### Enumerated Values | Property | Value | | --- | --- | | _anonymous_ | CREATED | | _anonymous_ | READY\_TO\_BE\_SHIPPED | | _anonymous_ | SHIPPED | | _anonymous_ | DELIVERED | | _anonymous_ | LOST | | _anonymous_ | RETURN\_REQUESTED | | _anonymous_ | RETURN\_INITIATED | | _anonymous_ | RETURN\_SHIPPED | | _anonymous_ | RETURN\_DELIVERED | | _anonymous_ | RETURN\_LOST | | _anonymous_ | CANCELED | | _anonymous_ | COMPLETED | | _anonymous_ | PARTIALLY\_COMPLETED | | _anonymous_ | CLOSED | PackageSize ----------- { "id": 0, "title": "string", "weight_description": "string" } The size of the package that the item will be shipped in. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | integer | true | none | The package size ID. | | title | string | true | none | The package size title. | | weight\_description | string | false | none | The package size weight description. | Price ----- 0.01 A price paid for something. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | number(float) | false | none | A price paid for something. | RelistOrdersResponse -------------------- { "orders": [\ {\ "accepted": true,\ "order_id": 0,\ "reason": "ORDER_NOT_FOUND"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | orders | \[[RelistOrdersResponseItem](https://pro-docs.svc.vinted.com/#schemarelistordersresponseitem)
\] | true | none | none | RelistOrdersResponseItem ------------------------ { "accepted": true, "order_id": 0, "reason": "ORDER_NOT_FOUND" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | accepted | boolean | true | none | Whether the order was accepted for relisting. | | order\_id | integer(int64) | true | none | none | | reason | string | false | none | The reason the order was not accepted for relisting. | #### Enumerated Values | Property | Value | | --- | --- | | reason | ORDER\_NOT\_FOUND | | reason | ORDER\_NOT\_CANCELLED | ShipmentLabelCreatedEventData ----------------------------- { "order_id": 0 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | order\_id | integer(int64) | true | none | The order ID. | Size ---- { "id": 0, "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | id | integer | true | none | The size ID. | | title | string | true | none | The size title. | SizeGroup --------- { "description": "string", "id": 0, "sizes": [\ {\ "id": 0,\ "title": "string"\ }\ ], "title": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | none | The size group description. | | id | integer | true | none | The size group ID. | | sizes | \[[Size](https://pro-docs.svc.vinted.com/#schemasize)
\] | true | none | The sizes in this size group. | | title | string | true | none | The size group title. | Status ------ { "description": "string", "id": 0, "title": "string" } Condition of an item/product. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | description | string | true | none | The status description. | | id | integer | true | none | The status ID. | | title | string | true | none | The status title. | UnauthorizedError ----------------- { "error": "INVALID_HMAC_SIGNATURE" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | error | string | true | none | Possible error values:
\- `INVALID_HMAC_SIGNATURE`: The HMAC signature provided is invalid.
\- `INVALID_ACCESS_KEY`: The access key provided is invalid.
\- `REAUTHORISATION_REQUIRED`: Your token is broken due to the associated Vinted OAuth token being revoked. Logging out and back into Vinted Pro Integrations Portal should fix this. | #### Enumerated Values | Property | Value | | --- | --- | | error | INVALID\_HMAC\_SIGNATURE | | error | INVALID\_ACCESS\_KEY | | error | REAUTHORISATION\_REQUIRED | UpdateItemFailureEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string", "errors": [\ {\ "field": "string",\ "message": "string"\ }\ ], "message": "string" } ### Properties _None_ UpdateItemReferencesResponse ---------------------------- { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "reason": "ITEM_NOT_FOUND"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[UpdateItemReferencesResponseItem](https://pro-docs.svc.vinted.com/#schemaupdateitemreferencesresponseitem)
\] | true | none | none | UpdateItemReferencesResponseItem -------------------------------- { "accepted": true, "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "reason": "ITEM_NOT_FOUND" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | accepted | boolean | true | none | A boolean indicating if the item reference update was accepted. | | item\_id | string(uuid) | true | none | none | | reason | string | false | none | The reason why the item reference update was not accepted. | #### Enumerated Values | Property | Value | | --- | --- | | reason | ITEM\_NOT\_FOUND | | reason | ITEM\_REFERENCE\_ALREADY\_IN\_USE | | reason | ITEM\_REFERENCE\_HAS\_RESERVED\_PREFIX | UpdateItemSuccessEventData -------------------------- { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" } ### Properties _None_ UpdateItems ----------- { "items": [\ {\ "brand": "string",\ "catalog_id": 0,\ "color_ids": [\ 0\ ],\ "currency": "EUR",\ "description": "string",\ "is_unisex": true,\ "isbn": "string",\ "item_attributes": [\ {\ "item_attribute_id": "string",\ "item_attribute_option_ids": [\ 0\ ]\ }\ ],\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "measurement_length": 0,\ "measurement_width": 0,\ "package_size_id": 0,\ "photo_urls": [\ "http://example.com"\ ],\ "price": 1,\ "size_id": 0,\ "status_id": 0,\ "title": "string",\ "video_game_rating_id": 0,\ "is_draft": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ItemToUpdate](https://pro-docs.svc.vinted.com/#schemaitemtoupdate)
\] | true | none | An array of items to update. When the items were created in VPI, you received an identifier for each item. Use that identifier to update the item. At most 100 items can be updated in a single request. | UpdateItemsResponse ------------------- { "items": [\ {\ "accepted": true,\ "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c",\ "reason": "ITEM_NOT_FOUND"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[UpdateItemsResponseItem](https://pro-docs.svc.vinted.com/#schemaupdateitemsresponseitem)
\] | true | none | none | UpdateItemsResponseItem ----------------------- { "accepted": true, "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "reason": "ITEM_NOT_FOUND" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | accepted | boolean | true | none | A boolean indicating if the update request for the item was accepted. Examples of reasons for an item update not to be accepted are that you do not own the item or the item was already sold. | | item\_id | string(uuid) | true | none | none | | reason | string | false | none | The reason why the update was not accepted. | #### Enumerated Values | Property | Value | | --- | --- | | reason | ITEM\_NOT\_FOUND | | reason | ITEM\_SOLD | | reason | ITEM\_DELETED | | reason | ITEM\_IN\_PROGRESS | | reason | ITEM\_NOT\_ACTIVE | UpdateWebhookError ------------------ { "error": "ONLY_HTTPS_URLS_ALLOWED" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | error | string | true | none | none | #### Enumerated Values | Property | Value | | --- | --- | | error | ONLY\_HTTPS\_URLS\_ALLOWED | ValidateItems ------------- { "items": [\ {\ "description": "string",\ "item_reference": "string",\ "manufacturer": "string",\ "manufacturer_labelling": "string",\ "price": 0.1,\ "title": "string"\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ItemToValidate](https://pro-docs.svc.vinted.com/#schemaitemtovalidate)
\] | true | none | An array of items to validate. At most 100 items can be validated in a single request. | ValidateItemsResponse --------------------- { "items": [\ {\ "errors": [\ {\ "code": "string",\ "field": "string",\ "message": "string"\ }\ ],\ "item_reference": "string",\ "valid": true\ }\ ] } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | items | \[[ItemValidationResult](https://pro-docs.svc.vinted.com/#schemaitemvalidationresult)
\] | true | none | none | ValidationError --------------- { "field": "string", "message": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | field | string | true | none | none | | message | string | true | none | none | ValidationRules --------------- { "max_photos": 0, "max_price": 0.1, "min_price": 0.1 } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | max\_photos | integer | true | none | The maximum number of photos allowed for an item. | | max\_price | number(float) | true | none | The maximum price allowed for an item. | | min\_price | number(float) | true | none | The minimum price allowed for an item. | VintedAuthenticationErrorEventData ---------------------------------- {} ### Properties _None_ Webhook ------- { "event_types": [\ "CREATE_ITEM_SUCCESS"\ ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string" } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | event\_types | \[[WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype)
\] | true | none | \[The event type of the webhook.\] | | id | string(uuid) | true | none | none | | url | string(url) | true | none | none | WebhookDeliveryResult --------------------- { "created_at": "2019-08-24T14:15:22Z", "error_msg": "string", "event_type": "CREATE_ITEM_SUCCESS", "http_status_code": 0, "success": true } ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | created\_at | string(date-time) | true | none | The date and time when the delivery result was created. | | error\_msg | string | false | none | The error message if the delivery was not successful. | | event\_type | [WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype) | true | none | The event type of the webhook. | | http\_status\_code | integer(int) | false | none | The HTTP status code of the response that Vinted received from the webhook endpoint. If a response was received at all. | | success | boolean | true | none | A boolean indicating if the delivery was successful. | WebhookEventData ---------------- { "event_data": { "item_id": "4d8cd62e-a579-4dae-af8c-3172f96f8f7c", "item_reference": "string" }, "event_type": "CREATE_ITEM_SUCCESS", "webhook_id": "a47606a1-5b39-4a81-9480-c2cb738ff675" } The event data sent to a webhook endpoint. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | event\_data | any | true | none | The data that is sent with the webhook. | oneOf | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [CreateItemSuccessEventData](https://pro-docs.svc.vinted.com/#schemacreateitemsuccesseventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [CreateItemFailureEventData](https://pro-docs.svc.vinted.com/#schemacreateitemfailureeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [UpdateItemSuccessEventData](https://pro-docs.svc.vinted.com/#schemaupdateitemsuccesseventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [UpdateItemFailureEventData](https://pro-docs.svc.vinted.com/#schemaupdateitemfailureeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [DeleteItemSuccessEventData](https://pro-docs.svc.vinted.com/#schemadeleteitemsuccesseventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [DeleteItemFailureEventData](https://pro-docs.svc.vinted.com/#schemadeleteitemfailureeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [ItemDeletedEventData](https://pro-docs.svc.vinted.com/#schemaitemdeletedeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [ItemSoldEventData](https://pro-docs.svc.vinted.com/#schemaitemsoldeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [ItemUpdatedEventData](https://pro-docs.svc.vinted.com/#schemaitemupdatedeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [OrderCreatedEventData](https://pro-docs.svc.vinted.com/#schemaordercreatedeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [CancelOrderFailureEventData](https://pro-docs.svc.vinted.com/#schemacancelorderfailureeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [ShipmentLabelCreatedEventData](https://pro-docs.svc.vinted.com/#schemashipmentlabelcreatedeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [ItemPublishedEventData](https://pro-docs.svc.vinted.com/#schemaitempublishedeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [OrderCancelledEventData](https://pro-docs.svc.vinted.com/#schemaordercancelledeventdata) | false | none | none | xor | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | » _anonymous_ | [VintedAuthenticationErrorEventData](https://pro-docs.svc.vinted.com/#schemavintedauthenticationerroreventdata) | false | none | none | continued | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | event\_type | [WebhookEventType](https://pro-docs.svc.vinted.com/#schemawebhookeventtype) | true | none | The event type of the webhook. | | webhook\_id | string(uuid) | true | none | none | WebhookEventType ---------------- "CREATE_ITEM_SUCCESS" The event type of the webhook. ### Properties | Name | Type | Required | Restrictions | Description | | --- | --- | --- | --- | --- | | _anonymous_ | string | false | none | The event type of the webhook. | #### Enumerated Values | Property | Value | | --- | --- | | _anonymous_ | CREATE\_ITEM\_SUCCESS | | _anonymous_ | CREATE\_ITEM\_FAILURE | | _anonymous_ | UPDATE\_ITEM\_SUCCESS | | _anonymous_ | UPDATE\_ITEM\_FAILURE | | _anonymous_ | DELETE\_ITEM\_SUCCESS | | _anonymous_ | DELETE\_ITEM\_FAILURE | | _anonymous_ | ITEM\_DELETED | | _anonymous_ | ITEM\_SOLD | | _anonymous_ | ITEM\_UPDATED | | _anonymous_ | ORDER\_CREATED | | _anonymous_ | CANCEL\_ORDER\_FAILURE | | _anonymous_ | SHIPMENT\_LABEL\_CREATED | | _anonymous_ | ITEM\_PUBLISHED | | _anonymous_ | ORDER\_CANCELLED | | _anonymous_ | VINTED\_AUTHENTICATION\_ERROR | --- # Unknown openapi: 3.0.3 info: title: Vinted Pro Integrations documentation version: v0.327.1 components: schemas: Address: properties: city: type: string country\_code: description: ISO 3166 alpha-2 country code. pattern: ^\[A-Z\]{2}$ type: string line\_1: type: string line\_2: type: string name: description: Name of the addressee. example: John Doe type: string postal\_code: type: string state: type: string required: - name - line\_1 - postal\_code - city - country\_code type: object CancelOrderFailureEventData: properties: error: description: The error message. type: string order\_id: description: The order ID. format: int64 type: integer x-go-name: OrderID required: - order\_id - error type: object Catalog: properties: catalogs: description: The child catalogs. Empty for leaf catalogs. items: $ref: '#/components/schemas/Catalog' type: array disabled\_fields: description: Fields that are disabled for this catalog. Empty for non-leaf catalogs. Disabled fields will be ignored on an item when the catalog is set to this catalog. items: enum: - brand - size\_id - color\_ids - status\_id - package\_size\_id - measurement\_length - measurement\_width type: string type: array id: description: The catalog ID. type: integer item\_attribute\_ids: description: The IDs of the item attributes associated with this catalog. items: type: string type: array size\_group\_ids: description: Only the provided size groups are valid for this catalog. Empty for non-leaf catalogs. items: type: integer type: array title: description: The catalog title. type: string required: - id - title type: object Color: properties: id: description: The color ID. type: integer title: description: The color title. type: string required: - id - title type: object CompleteItemToCreate: allOf: - $ref: '#/components/schemas/ItemProperties' - $ref: '#/components/schemas/ItemReference' - $ref: '#/components/schemas/ItemIsDraft' CreateItemFailureEventData: $ref: '#/components/schemas/ItemIDAndReferenceWithErrors' CreateItemSuccessEventData: $ref: '#/components/schemas/ItemIDAndReference' CreateItemValidationError: $ref: '#/components/schemas/ValidationError' CreateItems: properties: items: description: An array of items to create. At most 100 items can be created in a single request. items: $ref: '#/components/schemas/CompleteItemToCreate' maxItems: 100 minItems: 1 type: array required: - items type: object CreateItemsResponse: properties: items: items: $ref: '#/components/schemas/ItemIDAndReference' type: array required: - items type: object CreateItemsValidationErrorResponse: items: $ref: '#/components/schemas/CreateItemValidationError' type: array CreateUpdateWebhook: properties: event\_types: description: | The event types that the webhook should subscribe to. At least one event type is required. - \`CREATE\_ITEM\_SUCCESS\`: Triggered when an item is successfully created. - \`CREATE\_ITEM\_FAILURE\`: Triggered when an item creation fails. - \`UPDATE\_ITEM\_SUCCESS\`: Triggered when a requested item update succeeds. - \`UPDATE\_ITEM\_FAILURE\`: Triggered when a requested item update fails. - \`DELETE\_ITEM\_SUCCESS\`: Triggered when the requested deletion of an item succeeds. - \`DELETE\_ITEM\_FAILURE\`: Triggered when the requested deletion of an item fails. - \`ITEM\_DELETED\`: Triggered when an item is deleted outside of VPI. - \`ITEM\_SOLD\`: Triggered when an item is sold. - \`ITEM\_UPDATED\`: Triggered when an item is updated outside of VPI. - \`ORDER\_CREATED\`: Triggered when an escrow order is created for one or more items. Note that this excludes manually completed orders. - \`CANCEL\_ORDER\_FAILURE\`: Triggered when an order cancellation via VPI fails. - \`SHIPMENT\_LABEL\_CREATED\`: Triggered when a shipment label is created for an order. - \`ITEM\_PUBLISHED\`: Triggered when an item is published and visible on the marketplace. - \`ORDER\_CANCELLED\`: Triggered when an order is cancelled due to a transaction cancellation. Includes the cancellation status code and description. - \`VINTED\_AUTHENTICATION\_ERROR\`: Triggered when authentication with the Vinted Marketplace fails for this integration. Re-authenticate to restore access. items: $ref: '#/components/schemas/WebhookEventType' minItems: 1 type: array url: description: The URL to POST the webhook to when the event occurs. Must be between 9 and 255 characters and start with http:// or https://. format: url maxLength: 255 minLength: 9 pattern: ^https?://.\* type: string required: - event\_types - url type: object CreateWebhookError: properties: error: enum: - MAX\_WEBHOOKS\_EXCEEDED - ONLY\_HTTPS\_URLS\_ALLOWED type: string required: - error type: object CreateWebhookResponse: properties: signing\_key: type: string webhook: $ref: '#/components/schemas/Webhook' required: - webhook - signing\_key type: object Currency: description: The currency used for prices. enum: - EUR - GBP type: string x-go-type-skip-optional-pointer: true DeleteItemFailureEventData: $ref: '#/components/schemas/ItemIDAndReference' DeleteItemSuccessEventData: $ref: '#/components/schemas/ItemIDAndReference' DeleteItems: properties: item\_ids: description: An array of item identifiers. When the items were created in VPI, you received an identifier for each item. Use that identifier to delete the item. At most 100 items can be deleted in a single request. items: format: uuid type: string maxItems: 100 minItems: 1 type: array required: - item\_ids type: object DeleteItemsResponse: properties: items: items: $ref: '#/components/schemas/DeleteItemsResponseItem' type: array required: - items type: object DeleteItemsResponseItem: properties: accepted: description: A boolean indicating if the deletion request for the item was accepted. Examples of reasons for an item deletion not to be accepted are than you do not own the item, the item was already deleted or the item was already sold. type: boolean item\_id: format: uuid type: string x-go-name: ItemID required: - item\_id - accepted type: object GetImportedItemsResponse: properties: items: items: $ref: '#/components/schemas/ImportedItem' type: array required: - items type: object GetItemPriceSuggestionsResponse: properties: currency: $ref: '#/components/schemas/Currency' maximum: description: Upper bound of the suggested price range. format: float minimum: 0.01 type: number required: - currency - maximum type: object GetItemStatusResponse: properties: errors: items: $ref: '#/components/schemas/ValidationError' type: array x-go-type-skip-optional-pointer: true marketplace\_item\_id: description: The public integer item ID as used in the website URLs for Vinted. Note that VPI does not accept this ID on any of its endpoints, only the UUID. However, VPI provides this ID because it can be useful to cross-reference with the Vinted website. format: int64 type: integer status: $ref: '#/components/schemas/ItemStatus' required: - status - marketplace\_item\_id type: object GetItemsResponse: properties: items: items: $ref: '#/components/schemas/GetItemsResponseItem' type: array required: - items type: object GetItemsResponseItem: allOf: - $ref: '#/components/schemas/ItemIDAndReference' - $ref: '#/components/schemas/GetItemStatusResponse' GetOntologiesResponse: properties: enumerations: description: Ontologies enumerations. Only values from these enumerations are valid for sending as item data. However, not all values from these enumerations are valid for all items. The Catalog object dictates some subsets of valid values. properties: catalogs: items: $ref: '#/components/schemas/Catalog' type: array colors: items: $ref: '#/components/schemas/Color' type: array item\_attributes: items: $ref: '#/components/schemas/ItemAttribute' type: array package\_sizes: items: $ref: '#/components/schemas/PackageSize' type: array size\_groups: items: $ref: '#/components/schemas/SizeGroup' type: array statuses: items: $ref: '#/components/schemas/Status' type: array required: - catalogs - size\_groups - statuses - package\_sizes - colors - item\_attributes type: object validation\_rules: $ref: '#/components/schemas/ValidationRules' version: description: Although most of the ontologies data is static, it does vary based on country and currency, therefore the ontologies are versioned using those properties + a date-time reference to when it was last updated. properties: country: enum: - AT - BE - DE - ES - FR - IT - LU - NL - PT - UK type: string currency: $ref: '#/components/schemas/Currency' last\_updated\_on: format: date-time type: string required: - country - currency - last\_updated\_on type: object required: - version - enumerations - validation\_rules type: object GetOrderResponse: properties: amount: description: The amount you will receive for this order. format: float minimum: 0.01 type: number billing\_address: $ref: '#/components/schemas/Address' created\_at: format: date-time type: string currency: $ref: '#/components/schemas/Currency' delivery\_address: $ref: '#/components/schemas/Address' id: type: integer items: description: The items in the order. items: $ref: '#/components/schemas/OrderItem' type: array status: $ref: '#/components/schemas/OrderStatus' required: - id - created\_at - status - amount - currency - items - buyer - billing\_address - delivery\_address type: object GetOrderShipmentLabelNotFoundResponse: properties: error: enum: - ORDER\_NOT\_FOUND - LABEL\_CREATION\_IN\_PROGRESS - LABEL\_CREATION\_FAILED type: string required: - error type: object GetOrderShipmentResponse: properties: carrier: properties: name: example: Vinted Go type: string type: object currency: $ref: '#/components/schemas/Currency' price\_ex\_vat: description: The price paid for the label, excluding VAT. format: float minimum: 0.01 type: number tracking\_code: description: The tracking code for the shipment. Will be empty for orders containing items that are not managed via Vinted Pro Integrations. type: string vat\_amount: description: The VAT paid. format: float minimum: 0.01 type: number required: - carrier - status - tracking\_code - price\_ex\_vat - vat\_amount type: object GetOrdersResponse: properties: orders: items: $ref: '#/components/schemas/OrderListElement' maxItems: 250 type: array x-go-type-skip-optional-pointer: true type: object GetWebhooksResponse: items: $ref: '#/components/schemas/Webhook' type: array ImportedItem: properties: description: type: string id: format: uuid type: string status: $ref: '#/components/schemas/ItemStatus' title: type: string url: format: uri type: string required: - id - url - title - description - status type: object ItemAttribute: properties: id: description: The item attribute ID. type: string is\_required: description: A boolean indicating if the item attribute is required. type: boolean options: description: The item attribute options. items: $ref: '#/components/schemas/ItemAttributeOption' type: array selection\_limit: description: The item attribute options selection limit. type: integer selection\_type: description: The item attribute selection type. enum: - SINGLE - MULTIPLE type: string title: description: The item attribute title. type: string required: - id - title - is\_required - selection\_type - selection\_limit - options type: object ItemAttributeInput: properties: item\_attribute\_id: description: The item attribute ID. type: string item\_attribute\_option\_ids: description: The item attribute option IDs. items: format: int type: integer type: array type: object ItemAttributeOption: properties: id: description: The item attribute option ID. type: integer title: description: The item attribute option title. type: string required: - id - title type: object ItemDeletedEventData: $ref: '#/components/schemas/ItemIDAndReference' ItemIDAndReference: properties: item\_id: description: The main item identifier. format: uuid type: string x-go-name: ItemID item\_reference: description: The item reference for the integrator to identify the item. maxLength: 64 type: string required: - item\_id - item\_reference type: object ItemIDAndReferenceWithErrors: allOf: - $ref: '#/components/schemas/ItemIDAndReference' - properties: errors: items: $ref: '#/components/schemas/ValidationError' type: array x-go-type-skip-optional-pointer: true message: type: string type: object ItemIsDraft: properties: is\_draft: description: A boolean indicating whether the item is a draft. type: boolean x-go-type-skip-optional-pointer: true required: - is\_draft type: object ItemProperties: properties: brand: description: The item brand. maxLength: 256 type: string x-go-type-skip-optional-pointer: true catalog\_id: description: The ID of item catalog. This must be a leaf catalog. Use the ontologies endpoint to get the catalog tree. format: int type: integer x-go-name: CatalogID x-go-type-skip-optional-pointer: true color\_ids: description: The item colors IDs. Use the ontologies endpoint to get the colors. items: format: int type: integer maxItems: 2 type: array x-go-name: ColorIDs currency: $ref: '#/components/schemas/Currency' description: description: The item description. Must be between 5 and 2000 characters. maxLength: 2000 minLength: 5 type: string x-go-type-skip-optional-pointer: true is\_unisex: description: A boolean indicating if item is unisex. type: boolean isbn: description: The ISBN of the book. Applicable to book catalogs only. type: string x-go-name: ISBN item\_attributes: description: The item attributes. items: $ref: '#/components/schemas/ItemAttributeInput' type: array manufacturer: description: Manufacturer credentials. E.g. "Mattel (USA)". maxLength: 2000 minLength: 5 type: string manufacturer\_labelling: description: Labelling and marketing information. This should be general information on product safety and compliance such as safety warnings and instructions of use or safety marks/logo/certifications related to the product. maxLength: 2000 minLength: 5 type: string measurement\_length: description: The item measurement length. format: int type: integer measurement\_width: description: The item measurement width. format: int type: integer package\_size\_id: description: The ID of item package size. Use the ontologies endpoint to get the package sizes. format: int type: integer x-go-name: PackageSizeID photo\_urls: description: The URLs of the item photos. Must be publicly accessible. At least one photo is required. The maximum size of a photo is 5MB. items: format: uri maxLength: 640 minLength: 1 type: string minItems: 1 type: array x-go-type-skip-optional-pointer: true price: description: The item price. format: float minimum: 1 type: number x-go-type-skip-optional-pointer: true size\_id: description: The ID of item size. This is required for catalogs that have a size group (i.e. a non-empty size\_group\_ids array). Use the ontologies endpoint to get the size groups. format: int type: integer x-go-name: SizeID status\_id: description: The ID of item status (condition). Use the ontologies endpoint to get the statuses. format: int type: integer x-go-name: StatusID title: description: The item title. Must be between 5 and 100 characters. maxLength: 100 minLength: 5 type: string x-go-type-skip-optional-pointer: true video\_game\_rating\_id: description: The video game content rating ID. Applicable to video game catalogs only. format: int type: integer x-go-name: VideoGameRatingID required: - title - photo\_urls - currency - price - description - catalog\_id - status\_id - brand - package\_size\_id type: object ItemPublishedEventData: $ref: '#/components/schemas/ItemIDAndReference' ItemReference: properties: item\_reference: description: The item reference for the integrator to identify the item. maxLength: 64 type: string x-go-type-skip-optional-pointer: true required: - item\_reference type: object ItemSoldEventData: $ref: '#/components/schemas/ItemIDAndReference' ItemStatus: description: The item status. enum: - IN\_PROGRESS - ACTIVE - SOLD - DELETED - DELETE\_INTERNAL\_ERROR - VALIDATION\_ERROR - UPDATE\_INTERNAL\_ERROR - UPDATE\_VALIDATION\_ERROR - INTERNAL\_ERROR - SALE\_CANCELLED type: string ItemToUpdate: allOf: - $ref: '#/components/schemas/ItemProperties' - $ref: '#/components/schemas/ItemIsDraft' - properties: item\_id: description: The item ID. format: uuid type: string x-go-name: ItemID required: - item\_id type: object ItemToValidate: description: An item to validate. Fields are intentionally loose (no length or presence constraints) so the validation rules, not the schema, report content problems. Only the fields currently validated are declared. properties: description: description: The item description. type: string x-go-type-skip-optional-pointer: true item\_reference: description: The item reference for the integrator to identify the item in the response. maxLength: 64 type: string x-go-type-skip-optional-pointer: true manufacturer: description: Manufacturer credentials. type: string x-go-type-skip-optional-pointer: true manufacturer\_labelling: description: Labelling and marketing information. type: string x-go-type-skip-optional-pointer: true price: description: The item price. Omitted price is treated as missing (blank); a submitted price is range-checked. format: float type: number title: description: The item title. type: string x-go-type-skip-optional-pointer: true required: - item\_reference type: object ItemUpdatedEventData: allOf: - $ref: '#/components/schemas/ItemIDAndReference' - properties: brand\_id: description: The brand ID of the item. format: int type: integer catalog\_id: description: The catalog ID of the item. format: int type: integer color1\_id: description: The first color ID of the item. format: int nullable: true type: integer color2\_id: description: The second color ID of the item. format: int nullable: true type: integer currency: description: The currency of the item price. type: string description: description: The description of the item. type: string package\_size\_id: description: The package size ID of the item. format: int type: integer price: description: The price of the item. format: float type: number size\_id: description: The size ID of the item. format: int nullable: true type: integer status\_id: description: The status ID of the item. format: int type: integer title: description: The title of the item. type: string updated\_attributes: description: List of attribute names that were updated. items: enum: - title - description - brand\_id - catalog\_id - color1\_id - color2\_id - currency - package\_size\_id - price - size\_id - status\_id type: string type: array required: - title - description - brand\_id - catalog\_id - currency - price - package\_size\_id - status\_id - updated\_attributes type: object ItemValidationError: properties: code: description: 'A stable, machine-readable error code. Existing codes will not change, but new codes may be added over time, so consumers should tolerate unrecognised values. Known values: BLANK, TOO\_SHORT, TOO\_LONG, PRICE\_TOO\_LOW, CONTAINS\_EMAIL, EXCESSIVE\_UPPERCASE, EXCESSIVE\_SYMBOLS, UNALLOWED\_SYMBOLS, LONG\_WORDS.' type: string field: description: The field that failed validation. type: string message: description: A human-readable error message. type: string required: - field - code - message type: object ItemValidationResult: properties: errors: items: $ref: '#/components/schemas/ItemValidationError' type: array x-go-type-skip-optional-pointer: true item\_reference: description: The item reference echoed from the request. type: string valid: description: Whether the item passed all validation checks. type: boolean x-go-type-skip-optional-pointer: true required: - item\_reference - valid type: object OrderCancelledEventData: properties: cancellation\_status\_code: description: The numeric cancellation status code from Core. format: int64 type: integer cancellation\_status\_description: description: The human-readable cancellation status description. type: string order\_id: description: The order ID. format: int64 type: integer x-go-name: OrderID required: - order\_id - cancellation\_status\_code - cancellation\_status\_description type: object OrderCreatedEventData: properties: items: description: The items in the order. items: $ref: '#/components/schemas/ItemIDAndReference' type: array order\_id: description: The order ID. format: int64 type: integer required: - order\_id - items type: object OrderItem: properties: id: description: The item ID. Will be 00000000-0000-0000-0000-000000000000 for items not managed via Vinted Pro Integrations. format: uuid type: string item\_reference: description: The item reference for the integrator to identify the item. type: string price: $ref: '#/components/schemas/Price' title: description: The title under which the item was listed. example: White Hilfiger t-shirt type: string required: - id - title - price type: object OrderListElement: properties: created\_at: format: date-time type: string id: format: int64 type: integer status: $ref: '#/components/schemas/OrderStatus' required: - id - created\_at - status type: object OrderStatus: enum: - CREATED - READY\_TO\_BE\_SHIPPED - SHIPPED - DELIVERED - LOST - RETURN\_REQUESTED - RETURN\_INITIATED - RETURN\_SHIPPED - RETURN\_DELIVERED - RETURN\_LOST - CANCELED - COMPLETED - PARTIALLY\_COMPLETED - CLOSED type: string PackageSize: description: The size of the package that the item will be shipped in. properties: id: description: The package size ID. type: integer title: description: The package size title. type: string weight\_description: description: The package size weight description. type: string required: - id - title - description type: object Price: description: A price paid for something. format: float minimum: 0.01 type: number RelistOrdersResponse: properties: orders: items: $ref: '#/components/schemas/RelistOrdersResponseItem' type: array required: - orders type: object RelistOrdersResponseItem: properties: accepted: description: Whether the order was accepted for relisting. type: boolean order\_id: format: int64 type: integer x-go-name: OrderID reason: description: The reason the order was not accepted for relisting. enum: - ORDER\_NOT\_FOUND - ORDER\_NOT\_CANCELLED type: string required: - order\_id - accepted type: object ShipmentLabelCreatedEventData: properties: order\_id: description: The order ID. format: int64 type: integer required: - order\_id type: object Size: properties: id: description: The size ID. type: integer title: description: The size title. type: string required: - id - title type: object SizeGroup: properties: description: description: The size group description. type: string id: description: The size group ID. type: integer sizes: description: The sizes in this size group. items: $ref: '#/components/schemas/Size' type: array title: description: The size group title. type: string required: - id - title - description - sizes type: object Status: description: Condition of an item/product. properties: description: description: The status description. type: string id: description: The status ID. type: integer title: description: The status title. type: string required: - id - title - description type: object UnauthorizedError: properties: error: description: | Possible error values: - \`INVALID\_HMAC\_SIGNATURE\`: The HMAC signature provided is invalid. - \`INVALID\_ACCESS\_KEY\`: The access key provided is invalid. - \`REAUTHORISATION\_REQUIRED\`: Your token is broken due to the associated Vinted OAuth token being revoked. Logging out and back into Vinted Pro Integrations Portal should fix this. enum: - INVALID\_HMAC\_SIGNATURE - INVALID\_ACCESS\_KEY - REAUTHORISATION\_REQUIRED type: string required: - error type: object UpdateItemFailureEventData: $ref: '#/components/schemas/ItemIDAndReferenceWithErrors' UpdateItemReferencesResponse: properties: items: items: $ref: '#/components/schemas/UpdateItemReferencesResponseItem' type: array required: - items type: object UpdateItemReferencesResponseItem: properties: accepted: description: A boolean indicating if the item reference update was accepted. type: boolean item\_id: format: uuid type: string x-go-name: ItemID reason: description: The reason why the item reference update was not accepted. enum: - ITEM\_NOT\_FOUND - ITEM\_REFERENCE\_ALREADY\_IN\_USE - ITEM\_REFERENCE\_HAS\_RESERVED\_PREFIX type: string required: - item\_id - accepted type: object UpdateItemSuccessEventData: $ref: '#/components/schemas/ItemIDAndReference' UpdateItems: properties: items: description: An array of items to update. When the items were created in VPI, you received an identifier for each item. Use that identifier to update the item. At most 100 items can be updated in a single request. items: $ref: '#/components/schemas/ItemToUpdate' maxItems: 100 minItems: 1 type: array required: - items type: object UpdateItemsResponse: properties: items: items: $ref: '#/components/schemas/UpdateItemsResponseItem' type: array required: - items type: object UpdateItemsResponseItem: properties: accepted: description: A boolean indicating if the update request for the item was accepted. Examples of reasons for an item update not to be accepted are that you do not own the item or the item was already sold. type: boolean item\_id: format: uuid type: string x-go-name: ItemID reason: description: The reason why the update was not accepted. enum: - ITEM\_NOT\_FOUND - ITEM\_SOLD - ITEM\_DELETED - ITEM\_IN\_PROGRESS - ITEM\_NOT\_ACTIVE type: string required: - item\_id - accepted type: object UpdateWebhookError: properties: error: enum: - ONLY\_HTTPS\_URLS\_ALLOWED type: string required: - error type: object ValidateItems: properties: items: description: An array of items to validate. At most 100 items can be validated in a single request. items: $ref: '#/components/schemas/ItemToValidate' maxItems: 100 minItems: 1 type: array required: - items type: object ValidateItemsResponse: properties: items: items: $ref: '#/components/schemas/ItemValidationResult' type: array required: - items type: object ValidationError: properties: field: type: string message: type: string required: - field - message type: object ValidationRules: properties: max\_photos: description: The maximum number of photos allowed for an item. type: integer max\_price: description: The maximum price allowed for an item. format: float type: number min\_price: description: The minimum price allowed for an item. format: float type: number required: - max\_photos - min\_price - max\_price type: object VintedAuthenticationErrorEventData: properties: {} type: object Webhook: properties: event\_types: items: $ref: '#/components/schemas/WebhookEventType' type: array id: format: uuid type: string url: format: url maxLength: 255 pattern: ^https?://.\* type: string required: - id - event\_types - url type: object WebhookDeliveryResult: properties: created\_at: description: The date and time when the delivery result was created. format: date-time type: string error\_msg: description: The error message if the delivery was not successful. type: string event\_type: $ref: '#/components/schemas/WebhookEventType' http\_status\_code: description: The HTTP status code of the response that Vinted received from the webhook endpoint. If a response was received at all. format: int type: integer success: description: A boolean indicating if the delivery was successful. type: boolean required: - created\_at - event\_type - success type: object WebhookEventData: description: The event data sent to a webhook endpoint. properties: event\_data: description: The data that is sent with the webhook. oneOf: - $ref: '#/components/schemas/CreateItemSuccessEventData' - $ref: '#/components/schemas/CreateItemFailureEventData' - $ref: '#/components/schemas/UpdateItemSuccessEventData' - $ref: '#/components/schemas/UpdateItemFailureEventData' - $ref: '#/components/schemas/DeleteItemSuccessEventData' - $ref: '#/components/schemas/DeleteItemFailureEventData' - $ref: '#/components/schemas/ItemDeletedEventData' - $ref: '#/components/schemas/ItemSoldEventData' - $ref: '#/components/schemas/ItemUpdatedEventData' - $ref: '#/components/schemas/OrderCreatedEventData' - $ref: '#/components/schemas/CancelOrderFailureEventData' - $ref: '#/components/schemas/ShipmentLabelCreatedEventData' - $ref: '#/components/schemas/ItemPublishedEventData' - $ref: '#/components/schemas/OrderCancelledEventData' - $ref: '#/components/schemas/VintedAuthenticationErrorEventData' event\_type: $ref: '#/components/schemas/WebhookEventType' webhook\_id: format: uuid type: string required: - event\_type - webhook\_id - event\_data type: object WebhookEventType: description: The event type of the webhook. enum: - CREATE\_ITEM\_SUCCESS - CREATE\_ITEM\_FAILURE - UPDATE\_ITEM\_SUCCESS - UPDATE\_ITEM\_FAILURE - DELETE\_ITEM\_SUCCESS - DELETE\_ITEM\_FAILURE - ITEM\_DELETED - ITEM\_SOLD - ITEM\_UPDATED - ORDER\_CREATED - CANCEL\_ORDER\_FAILURE - SHIPMENT\_LABEL\_CREATED - ITEM\_PUBLISHED - ORDER\_CANCELLED - VINTED\_AUTHENTICATION\_ERROR type: string responses: Unauthorized: content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' description: User is not authorized to use API. parameters: HMACSignature: description: Signature header. Reference script in documentation. in: header name: X-Vpi-Hmac-Sha256 required: true schema: type: string securitySchemes: AccessKeyAuth: in: header name: X-Vpi-Access-Key type: apiKey requestBodies: CreateItemsBody: content: application/json: schema: $ref: '#/components/schemas/CreateItems' description: The request body for creating items. required: true CreateUpdateWebhookBody: content: application/json: schema: $ref: '#/components/schemas/CreateUpdateWebhook' description: The request body for creating or updating webhooks. required: true DeleteItemsBody: content: application/json: schema: $ref: '#/components/schemas/DeleteItems' description: The request body for deleting items. required: true RelistOrdersBody: content: application/json: schema: properties: order\_ids: description: The Core escrow order IDs to relist. items: format: int64 type: integer maxItems: 250 minItems: 1 type: array required: - order\_ids type: object description: The escrow order IDs to relist. required: true UpdateItemReferencesBody: content: application/json: schema: items: $ref: '#/components/schemas/ItemIDAndReference' type: array description: The request body for setting item references. required: true UpdateItemsBody: content: application/json: schema: $ref: '#/components/schemas/UpdateItems' description: The request body for updating items. required: true ValidateItemsBody: content: application/json: schema: $ref: '#/components/schemas/ValidateItems' description: The request body for validating items. required: true paths: /api/v1/items: delete: description: 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. operationId: DeleteItems parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/DeleteItemsBody' responses: 202: content: application/json: schema: $ref: '#/components/schemas/DeleteItemsResponse' description: 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. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 404: description: The item is not found. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API get: description: Lists items that were created in VPI. operationId: GetItems parameters: - $ref: '#/components/parameters/HMACSignature' - description: If set, returns only items after the item with this ID. Used for paging. in: query name: after\_item\_id schema: format: uuid type: string - description: The maximum number of items to return. in: query name: limit schema: format: int64 maximum: 250 minimum: 1 type: integer responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetItemsResponse' description: The items. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API post: description: 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. operationId: CreateItems parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/CreateItemsBody' responses: 202: content: application/json: schema: $ref: '#/components/schemas/CreateItemsResponse' description: Request accepted, items will be uploaded asynchronously. Receiving the item ID does not mean the item is listed. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 409: content: application/json: schema: properties: active\_items: description: Number of active items for this account. format: int64 type: integer attempted\_batch\_size: description: Number of items in the request. format: int64 type: integer slots: description: Maximum number of items allowed for this account. format: int64 type: integer required: - slots - active\_items - attempted\_batch\_size type: object description: Adding these items would exceed the maximum number of items allowed for this account, please reduce the number of active items before creating more. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API put: description: 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. operationId: UpdateItems parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/UpdateItemsBody' responses: 202: content: application/json: schema: $ref: '#/components/schemas/UpdateItemsResponse' description: 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. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/items/{id}/status: get: description: Retrieves the current status of an item on Vinted by its ID. operationId: GetItemStatus parameters: - $ref: '#/components/parameters/HMACSignature' - description: The item ID. in: path name: id required: true schema: format: uuid type: string responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetItemStatusResponse' description: Successfully retrieved the item status. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 404: description: The item could not be found. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/items/imported: get: description: Returns a list of items that were imported. VPI can import items that were added to Vinted in other ways than through VPI. operationId: GetImportedItems parameters: - $ref: '#/components/parameters/HMACSignature' - description: If set, returns only items after the item with this ID. Used for paging. in: query name: after\_item\_id schema: format: uuid type: string - description: The maximum number of items to return. in: query name: limit schema: format: int64 maximum: 250 minimum: 1 type: integer responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetImportedItemsResponse' description: The imported items list. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/items/item-references: put: description: Sets the item references for the items in the request. operationId: UpdateItemReferences parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/UpdateItemReferencesBody' responses: 200: content: application/json: schema: $ref: '#/components/schemas/UpdateItemReferencesResponse' description: Item references set successfully. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/items/validate: post: description: Validates a batch of items without creating them. Returns per-item validation results so integrators can check items before uploading. This endpoint has no side effects. operationId: ValidateItems parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/ValidateItemsBody' responses: 200: content: application/json: schema: $ref: '#/components/schemas/ValidateItemsResponse' description: Per-item validation results. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occurred. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/ontologies: get: description: 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. operationId: GetOntologies parameters: - $ref: '#/components/parameters/HMACSignature' responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetOntologiesResponse' description: Successfully retrieved ontologies. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Items API /api/v1/orders: get: description: Returns a list of orders. Use the \`after-id\` query parameter to iterate over the results. operationId: GetOrders parameters: - $ref: '#/components/parameters/HMACSignature' - description: If set, returns only orders created after the order with this ID. in: query name: after-id schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetOrdersResponse' description: The orders list. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/orders/{id}: get: description: Returns the order with the given ID. operationId: GetOrder parameters: - $ref: '#/components/parameters/HMACSignature' - description: The order ID in: path name: id required: true schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetOrderResponse' description: The order. 401: $ref: '#/components/responses/Unauthorized' 403: description: User is not authorized to use this endpoint. 404: description: Order not found. 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/orders/{id}/cancel: post: description: Cancels the order with the given ID asynchronously. operationId: CancelOrder parameters: - $ref: '#/components/parameters/HMACSignature' - description: The order ID in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: schema: properties: cancellation\_reason\_explanation: description: Explanation for the cancellation maxLength: 100 type: string required: - cancellation\_reason\_explanation type: object required: true responses: 200: description: Order will be cancelled asynchronously. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/orders/{id}/shipment: get: description: Returns the shipment for the order with the given ID. operationId: GetOrderShipment parameters: - $ref: '#/components/parameters/HMACSignature' - description: The order ID in: path name: id required: true schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetOrderShipmentResponse' description: The shipment. 401: $ref: '#/components/responses/Unauthorized' 404: description: Shipment not found. This can be because the shipment does not (yet) exist. 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/orders/{id}/shipment-label: get: description: Retrieves the shipment label shipment label by order ID. operationId: GetOrderShipmentLabel parameters: - $ref: '#/components/parameters/HMACSignature' - description: The order ID. in: path name: id required: true schema: format: int64 type: integer responses: 200: content: application/pdf: schema: format: binary type: string description: Successfully retrieved the order shipment label. 401: $ref: '#/components/responses/Unauthorized' 404: content: application/json: schema: $ref: '#/components/schemas/GetOrderShipmentLabelNotFoundResponse' description: The shipment label could not be found. Will also be returned for orders containing items that are not managed via Vinted Pro Integrations. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/orders/relist: post: description: 'Relists one or more cancelled escrow orders by proxying to Core''s transaction reupload. Each order is validated and, if eligible, relisted asynchronously. Reupload is order-scoped: every revoked item in the order is relisted.' operationId: RelistOrders parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/RelistOrdersBody' responses: 202: content: application/json: schema: $ref: '#/components/schemas/RelistOrdersResponse' description: Relist requests accepted for processing. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occurred. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] tags: - Orders API /api/v1/webhooks: get: description: Lists your registered webhooks. operationId: GetWebhooks parameters: - $ref: '#/components/parameters/HMACSignature' responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetWebhooksResponse' description: Successfully retrieved the webhooks. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Webhooks API post: description: Add a webhook to be called when events happen in Vinted. operationId: CreateWebhook parameters: - $ref: '#/components/parameters/HMACSignature' requestBody: $ref: '#/components/requestBodies/CreateUpdateWebhookBody' responses: 201: content: application/json: schema: $ref: '#/components/schemas/CreateWebhookResponse' description: The webhook was successfully created. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 422: content: application/json: schema: $ref: '#/components/schemas/CreateWebhookError' description: The request could not be processed. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Webhooks API /api/v1/webhooks/{id}: delete: description: Deletes a webhook. operationId: DeleteWebhook parameters: - $ref: '#/components/parameters/HMACSignature' - description: The webhook ID. in: path name: id required: true schema: format: uuid type: string responses: 200: description: Successfully deleted the webhook. 304: description: The webhook has already been deleted. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 404: description: The webhook could not be found. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Webhooks API put: description: Updates a webhook's URL and/or subscribed event types. operationId: UpdateWebhook parameters: - $ref: '#/components/parameters/HMACSignature' - description: The webhook ID. in: path name: id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreateUpdateWebhookBody' responses: 200: description: Successfully updated webhook. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 404: description: The webhook could not be found. 422: content: application/json: schema: $ref: '#/components/schemas/UpdateWebhookError' description: The request could not be processed. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Webhooks API /api/v1/webhooks/{id}/delivery-results: get: description: Gets the 100 latest delivery results (attempts, failures and successes) for a webhook. operationId: GetWebhookDeliveryResults parameters: - $ref: '#/components/parameters/HMACSignature' - description: The webhook ID. in: path name: id required: true schema: format: uuid type: string x-go-name: ID responses: 200: content: application/json: schema: items: $ref: '#/components/schemas/WebhookDeliveryResult' type: array description: Successfully retrieved the delivery results. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: $ref: '#/components/responses/Unauthorized' 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] tags: - Webhooks API /api/v2/item-price-suggestions: get: description: Returns the maximum suggested price for an item based on category, brand and condition, benchmarked against historical sold prices. operationId: GetItemPriceSuggestions parameters: - $ref: '#/components/parameters/HMACSignature' - description: The catalog (category) ID of the item. Use the ontologies endpoint to get the catalog tree. in: query name: catalog\_id required: true schema: format: int64 type: integer x-go-name: CatalogID - description: The brand ID of the item. in: query name: brand\_id schema: format: int64 type: integer x-go-name: BrandID - description: The condition (status) ID of the item. Use the ontologies endpoint to get the statuses. in: query name: status\_id schema: format: int64 type: integer x-go-name: StatusID responses: 200: content: application/json: schema: $ref: '#/components/schemas/GetItemPriceSuggestionsResponse' description: Successfully retrieved maximum price suggestion. 401: $ref: '#/components/responses/Unauthorized' 404: description: No price suggestion available for the given combination. 500: description: An unexpected error occurred. security: - AccessKeyAuth: \[\] summary: Get maximum price suggestion for an item. tags: - Items API /dev/v1/triggers/item-sold/{itemID}: post: description: Use this endpoint to simulate making a sale. Only available in dev mode. operationId: TriggerItemSold parameters: - $ref: '#/components/parameters/HMACSignature' - description: The item ID. in: path name: itemID required: true schema: format: uuid type: string responses: 200: description: The item sale was successfully triggered. 400: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: A validation error occured. 401: description: The request had invalid authentication. 404: description: The item is not found. 409: description: The item is already sold. 500: description: An unexpected error occured. security: - AccessKeyAuth: \[\] summary: Triggers the sale of an item tags: - Dev mode API --- # Unknown ```json { "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "items", "description": "", "item": [ { "id": "42015524-e1ad-4b9c-88a2-4b6e23b0284a", "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": "4fc10061-0d10-4f99-a4f5-5c8c5c3af185", "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": "c2b7d0d2-88e0-4da2-a897-1b47c42c7b1a", "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": "6ac1aa0a-06ae-498c-82dc-0859dc2da2bd", "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": "e4ae20d1-af14-4675-8a86-002f4146d3bf", "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": "20ce55a2-616b-470e-b3d6-6d54a44417b1", "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": "8dfa2d47-034a-4dc9-958e-daab48408648", "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": "d45f7ad4-5cbe-4a43-9d44-54f11f990d5a", "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\": \"DELETED\",\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\": \"IN_PROGRESS\",\n \"errors\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "298b6cbf-160b-41d4-a202-46a65b969cff", "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": "6077d6af-8844-42f7-bd4c-ef2b1bf5464d", "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": "23f40e11-500b-474c-872c-ad585a20ab7e", "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": "2fa9b4d5-c550-444a-8ab4-6bc0f8384433", "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\": \"EUR\",\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": "e21f5e4e-27a1-4f83-b8a1-4546cb665d2b", "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\": \"EUR\",\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": "621cc573-a870-49b4-b0f5-fb0ac7089129", "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\": \"EUR\",\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": "083a0e7b-8dce-4a74-af64-0ff83f10a645", "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\": \"EUR\",\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": "95c0a007-c459-42fe-8d37-76cfccb555f9", "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\": \"EUR\",\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": "2a51c339-222c-4d75-ac08-1b09926cbef2", "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\": \"EUR\",\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": "b23f9bab-e135-4fd7-9d11-080a70276fbc", "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": "d3e93633-44a0-4572-a342-5526fecf59d3", "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_IN_PROGRESS\"\n },\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_NOT_ACTIVE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc7490db-774d-4285-9030-f1eac5cf27ab", "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": "f2284f22-a1dc-4074-b66e-f762a5ee2b02", "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": "bdd44424-d7e2-43ad-835e-c420407d4fce", "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": "7828a5a2-e511-4599-8297-ff9d27a5d12d", "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": "fb7c8de5-010e-4873-905e-3d9d22a5c4f2", "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\": \"UPDATE_VALIDATION_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": "a9221f1a-3969-48fd-a04d-51b71e3abfe8", "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": "f637c921-e886-4c47-97e9-2eb50db004b5", "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": "f1aaaefd-82a1-47aa-91df-ab3a6525fa2e", "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": "29f37aaa-a9c9-4526-a9c8-8d7c0cb40a3f", "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": "aad93ab7-9e30-42ad-bb59-abecbf1c04f5", "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": "f0a51729-61a5-4425-91a9-6816dfa1658e", "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\": \"UPDATE_VALIDATION_ERROR\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"status\": \"INTERNAL_ERROR\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cde5e769-a320-4072-9400-105d3e6cb59f", "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": "c92e1764-e11d-4963-9826-43da4728b649", "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": "3cf95cc1-3cdb-445c-a27c-835362113e53", "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": "cba2062c-aa39-4f3c-b9bb-ab269d088d8d", "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": "2e72b1b0-99ee-46f5-9f72-8d2adc0db9e2", "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_NOT_FOUND\"\n },\n {\n \"item_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ITEM_REFERENCE_ALREADY_IN_USE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e47855-73d7-4279-8846-9524166d8dd6", "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": "00d531df-c3eb-4ede-b29f-83d285791cd1", "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": "a0b029cf-315f-4d0f-9a07-88bd2664fb50", "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": "validate", "description": "", "item": [ { "id": "3e9d4887-cfe6-4734-851b-17f28ff33048", "name": "Validate Items", "request": { "name": "Validate Items", "description": { "content": "Validates a batch of items without creating them. Returns per-item validation results so integrators can check items before uploading. This endpoint has no side effects.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "items", "validate" ], "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 \"item_reference\": \"\",\n \"description\": \"\",\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"price\": \"\",\n \"title\": \"\"\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": "0ac0ad4e-2a03-4992-8866-2fef10588b09", "name": "Per-item validation results.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "validate" ], "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 \"item_reference\": \"\",\n \"description\": \"\",\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"price\": \"\",\n \"title\": \"\"\n }\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_reference\": \"\",\n \"valid\": \"\",\n \"errors\": [\n {\n \"field\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n },\n {\n \"item_reference\": \"\",\n \"valid\": \"\",\n \"errors\": [\n {\n \"field\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24205239-cf0b-4faf-b96a-c575f8ce7b86", "name": "A validation error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "validate" ], "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 \"item_reference\": \"\",\n \"description\": \"\",\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"price\": \"\",\n \"title\": \"\"\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": "5a0f5e8f-f078-4d94-9230-c10d8800c8b4", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "validate" ], "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 \"item_reference\": \"\",\n \"description\": \"\",\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"price\": \"\",\n \"title\": \"\"\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": "453c87a0-14c3-4e8a-8a9f-275cb2657bcf", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "items", "validate" ], "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 \"item_reference\": \"\",\n \"description\": \"\",\n \"manufacturer\": \"\",\n \"manufacturer_labelling\": \"\",\n \"price\": \"\",\n \"title\": \"\"\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": "ontologies", "description": "", "item": [ { "id": "dd91d842-d9cf-4469-b3fe-67a12f596d2a", "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": "a93f866e-d521-4fac-be2b-3f770b32091e", "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\": \"NL\",\n \"currency\": \"EUR\",\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 \"color_ids\",\n \"measurement_width\"\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 \"measurement_length\",\n \"size_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\": \"SINGLE\",\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\": \"MULTIPLE\",\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": "9a78a799-75bc-4d4f-9fcf-3b7d7d96296f", "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": "c80bb2df-1ee8-4509-b005-b23cda263724", "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": "30f8fdbc-540a-485e-9b3f-652a94a1b457", "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": "64d67603-cdea-40ac-ab2f-22f3b5da7a46", "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": "af6edf91-f4b0-4163-9718-d086c0b00113", "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\": \"PARTIALLY_COMPLETED\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"status\": \"READY_TO_BE_SHIPPED\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b6de1ce-68e1-46d7-b8a5-e496b548b8df", "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": "e6fa988d-d655-49fe-badb-b6a918289414", "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": "cdbea787-681d-41ab-935e-87f49a633019", "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": "de5a2985-e977-4d9a-90d8-2768a7418bfb", "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": "29cc6e1e-527d-4d35-a17f-e01c959cb474", "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\": \"RETURN_LOST\",\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\": \"YF\",\n \"line_2\": \"\",\n \"state\": \"\"\n },\n \"delivery_address\": {\n \"name\": \"\",\n \"line_1\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"country_code\": \"OZ\",\n \"line_2\": \"\",\n \"state\": \"\"\n },\n \"buyer\": \"culpa dolor\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a0ae10-fd7f-4acb-8ed0-1f108f6459c8", "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": "5feb2748-749b-4208-b922-4c3de85d5811", "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": "6e12d68b-0a35-40b4-bb24-38c31fde524a", "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": "494c4e8c-17d6-4cc2-b7f1-301156c49fa8", "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": "efa1b8a0-d12c-43cb-a10e-22a112cc7fc1", "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": "921d6530-48f1-46d2-bf73-9abfcdeee966", "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": "5e55fb77-cfb1-4994-93d2-2efd053118dc", "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": "0fd54a48-470d-48d7-99a7-3538bf9424cf", "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": "43988514-87da-43a5-89d5-e38b333c75e6", "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": "21b481db-8123-4f22-a988-54c4b693782e", "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": "6359bc15-429b-4918-af4b-91d6b686b28d", "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": "5f397374-e38b-416e-89b2-1d1cdec5ea4f", "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": "c16b88d8-2aa6-4674-868b-2ad199a86328", "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": "10f49c67-05be-40f4-86e4-f472a4823f07", "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": "f82e8cf9-b4df-4e4f-8167-4bf60b8842db", "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": "0aaeebe4-c481-4988-b2c2-062b9536d0a3", "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": "fc9bb27f-153d-474e-b668-b4b68a739ccc", "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\": \"ORDER_NOT_FOUND\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7178b7ec-8b38-41a0-b12c-4b93bf7b0bee", "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": "relist", "description": "", "item": [ { "id": "b8bb702a-b4fd-4618-addf-46c0745ce108", "name": "Relist Orders", "request": { "name": "Relist Orders", "description": { "content": "Relists one or more cancelled escrow orders by proxying to Core's transaction reupload. Each order is validated and, if eligible, relisted asynchronously. Reupload is order-scoped: every revoked item in the order is relisted.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "orders", "relist" ], "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 \"order_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": "1bdd342f-7b78-4752-bcb2-6f300fae206f", "name": "Relist requests accepted for processing.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", "relist" ], "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 \"order_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"orders\": [\n {\n \"order_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ORDER_NOT_CANCELLED\"\n },\n {\n \"order_id\": \"\",\n \"accepted\": \"\",\n \"reason\": \"ORDER_NOT_CANCELLED\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03352134-fef1-40ef-a342-f03c61dfa708", "name": "A validation error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", "relist" ], "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 \"order_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": "f143a613-7769-447c-93c2-1db5f06ef907", "name": "User is not authorized to use API.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", "relist" ], "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 \"order_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": "24a003f7-3fb8-4ca9-bb48-407a1f52e206", "name": "An unexpected error occurred.", "originalRequest": { "url": { "path": [ "api", "v1", "orders", "relist" ], "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 \"order_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 } } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "d0d6e015-03f3-42a5-8188-739fdc6ba41b", "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": "06fffb3a-e51f-48c9-9be8-6d54528542da", "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 \"ITEM_DELETED\",\n \"UPDATE_ITEM_SUCCESS\"\n ],\n \"url\": \"https:// {M+(\"\n },\n {\n \"id\": \"\",\n \"event_types\": [\n \"DELETE_ITEM_SUCCESS\",\n \"UPDATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://(\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0d86870-6204-4f98-b09e-c978cfa493cc", "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": "26355862-2315-4dd2-ac78-fe479d4f050f", "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": "3179727a-a255-4917-a8a3-5aeb3dea837f", "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": "45ff2d0c-65b1-4625-8173-18583e530892", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "1b0a2e8c-1c46-4d16-a594-029a904929e6", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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 \"UPDATE_ITEM_FAILURE\",\n \"ITEM_SOLD\"\n ],\n \"url\": \"http://W\"\n },\n \"signing_key\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9e8f957-4aeb-490a-9749-a87cfb85ecdd", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "f29898b1-1476-45d4-b83e-dcfb4ec5fc74", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "1d531ffb-31ea-4cbd-8860-9024b7b2a9a9", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "81fc31c8-e55c-4fa5-bdac-ce9b9df05f0c", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "33b72f17-2086-4774-9467-891ec2e53367", "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": "785c034c-d666-4335-81de-5c05870d7a07", "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": "e53899f3-4816-4257-b17e-65db33baa1ab", "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": "56c0c553-e25f-4fb6-a3b3-08cdf88d9528", "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": "7ce939af-5636-4233-a415-bb7e8b57185d", "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": "b6d8d36b-3259-43ce-b29e-4466a9f7cb63", "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": "f7ab2693-110a-4391-b778-af25a8ecc9f0", "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": "f4ab1dc3-9370-407e-aa5a-d7af367982a7", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "3ef1465b-eddd-4ce7-bc9f-ba410aad7dd9", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cba5f1dd-c3ca-43d1-8baa-2bc8ac9690e6", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "b0d58e79-a8eb-4f6a-b58c-e488c19385b9", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "c35be21e-cee9-413a-840a-8639da4fa247", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fd917657-5ac3-4e19-9224-fc18cc6ae32a", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "2efe5bdf-c7fc-4429-bb1f-bfd70305c4bd", "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 \"CREATE_ITEM_SUCCESS\"\n ],\n \"url\": \"http://ClLNOAC\"\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": "ade6f800-9fb3-4fdb-9f3a-dcbee5e4c082", "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": "473113bc-3199-4355-b52c-4e5dacdae1a9", "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\": \"ITEM_DELETED\",\n \"success\": \"\",\n \"error_msg\": \"\",\n \"http_status_code\": \"\"\n },\n {\n \"created_at\": \"\",\n \"event_type\": \"ITEM_PUBLISHED\",\n \"success\": \"\",\n \"error_msg\": \"\",\n \"http_status_code\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce71e7aa-f0e8-476f-988a-dc9658786755", "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": "81466db1-f7a5-4a59-ba22-a3fb190cb169", "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": "15ee7267-951f-4c96-b449-53040e170a37", "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": "765cc12d-4ecb-49c4-83d1-c746c1d7efff", "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": "11b76ea4-725e-42b9-9f6e-8d49f04789fd", "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": "bb3299ce-6ac3-48c6-9910-5ce126a712a6", "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": "bfe074a3-e0ad-4858-bbeb-8851ca0cf1a5", "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": "f0ed42ee-d521-4599-9fef-2ce558e0fbe3", "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": "a568730b-1aef-460b-b6d0-6367048be2dd", "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": "025fff82-815c-425c-9dca-f793f6f3c42e", "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": "c231fee5-d509-477e-a5bd-f5d6404c9b18", "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": "71ffa8c7-66ef-4622-b268-1e1345e30a2b", "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": "82aafda5-e2dd-41b1-a7d6-c907ec7b4c9e", "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": "ddd87df5-1704-41c9-8ae6-2f971947981f", "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": "6eb52902-799c-4bf0-843b-496efc247ac0", "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": "5c5ecf4d-6330-414b-97d5-a3c94933d002", "name": "Vinted Pro Integrations documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } } ``` ---