> For the complete documentation index, see [llms.txt](https://seller-docs.flowwow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://seller-docs.flowwow.com/product-docs-eng/integrations-and-api/udora-seller-api.md).

# Udora Seller API

## Ping

*Methods for checking the API status.*

## API check

> Returns the response type based on the say parameter.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Ping","description":"Methods for checking the API status"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[],"paths":{"/apiseller/ping/check":{"get":{"tags":["Ping"],"summary":"API check","operationId":"post.ping.check","description":"Returns the response type based on the say parameter.\n","parameters":[{"in":"query","name":"say","required":false,"schema":{"type":"string","enum":["hello","error400","error401","error403","error404","error409","error429","error500"]},"description":"### Which response to receive\n| Request type | Description      | Action                       |\n|--------------|------------------|------------------------------|\n|   hello      | Campaign is active | regular server response (200) |\n|   error400   | Client error 400 | simulates client error 400    |\n|   error401   | Client error 401 | simulates client error 401    |\n|   error403   | Client error 403 | simulates client error 403    |\n|   error404   | Client error 404 | simulates client error 404    |\n|   error429   | Client error 429 | simulates client error 429    |\n|   error500   | Server error 500 | simulates server error 500    |\n"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"say":{"type":"string","description":"Server response"}},"required":["say"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}}}}
```

## Shop&#x20;

*Information about the holding company’s shops or warehouses.*

## View the list of shops

> Returns the list of shops for a holding, or one shop in all other cases.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Shop","description":"Information about shops or holding warehouses"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ShopStatus":{"type":"string","enum":["moderation","active","disabled"],"description":"Shop status:\n| Status     | Description  |\n|------------|--------------|\n| moderation | In moderation |\n| active     | Active       |\n| disabled   | Disabled     |\n"},"ShopId":{"type":"integer","format":"int32","description":"Udora platform shop identifier"},"PagingRequest":{"type":"object","description":"Pagination control for the returned collection\n","properties":{"page":{"type":"integer","description":"Page number. Numbering starts from 0.","minimum":0,"default":0},"limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Number of items in the response. Maximum — 50, minimum — 1."}}},"ShopItem":{"type":"object","description":"Shop on the Udora platform","properties":{"shopId":{"$ref":"#/components/schemas/ShopId"},"name":{"type":"string","description":"Shop name on the Udora platform"},"status":{"$ref":"#/components/schemas/ShopStatus"},"address":{"type":"string","description":"Shop address on the Udora platform"},"currency":{"type":"string","description":"Shop currency in ISO 4217 format."},"isVerified":{"type":"boolean","description":"Is the shop verified on the Udora platform?"},"workingDays":{"type":"array","items":{"type":"string","enum":["1","2","3","4","5","6","7"]},"description":"Working days (empty array if the source is not specified)."}},"required":["shopId","name","status"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/shops":{"post":{"tags":["Shop"],"summary":"View the list of shops","operationId":"shops","description":"Returns the list of shops for a holding, or one shop in all other cases.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/ShopStatus"},"shopIds":{"type":"array","description":"List of shop identifiers","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/ShopId"}}}},{"$ref":"#/components/schemas/PagingRequest"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"shops":{"type":"array","items":{"$ref":"#/components/schemas/ShopItem"}},"total":{"type":"integer","description":"Total number of shops"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Products&#x20;

*Adding, viewing, updating, and managing product visibility.*

<br>

## Get information about shop products

> Returns a list of shop products with filtering support.\
> Pagination is supported.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"ProductType":{"type":"integer","enum":[1,2,3],"description":"Product type: \n* `1` — regular product, \n* `2` — ready-made product,\n* `3` — additional product.\n"},"ProductShortDto":{"type":"object","description":"Brief product information","additionalProperties":false,"required":["offerId","productId","isActive","type","categoryId","subCategoryId","name","description","url","available","stock","minOrder","price","discount","currencyCode","images","productionTime","shipmentTime","canRent","originalId","isDeliveryPost","isStarred","vat"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"type":{"$ref":"#/components/schemas/ProductType"},"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":500,"description":"Product name"},"description":{"type":"string","nullable":true,"maxLength":20000,"description":"Detailed product description"},"url":{"type":"string","maxLength":20000,"description":"URL of the product page on Udora for customers"},"available":{"type":"integer","minimum":0,"description":"Product availability"},"stock":{"type":"integer","minimum":0,"description":"Product quantity in stock"},"minOrder":{"type":"integer","minimum":0,"description":"Minimum order"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"images":{"type":"array","description":"Image URLs","items":{"type":"string","format":"uri"}},"productionTime":{"type":"integer","minimum":0,"description":"Product production time in minutes"},"shipmentTime":{"type":"integer","minimum":0,"description":"Product delivery time in minutes"},"canRent":{"type":"integer","enum":[0,1,2],"description":"* `0` — the owner has prohibited rental \n* `1` — the owner has allowed rental \n* `2` — Udora has prohibited rental\n","default":0},"originalId":{"type":"integer","format":"int32","minimum":0,"default":0,"description":"Original product ID. If different from 0, the current product is rented"},"isDeliveryPost":{"type":"boolean","description":"Whether the product is delivered by post","default":false},"isStarred":{"type":"boolean","description":"Whether the product is starred. Promoted more actively by the shop","default":false},"vat":{"type":"string","default":"0","description":"VAT rate percentage for the product"}}},"isActive":{"type":"boolean","description":"Whether the product is active"},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products":{"post":{"tags":["Products"],"summary":"Get information about shop products","operationId":"products/list","description":"Returns a list of shop products with filtering support.\nPagination is supported.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"offerIds":{"type":"array","description":"List of product identifiers in the shop system","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/OfferId"}},"productIds":{"type":"array","description":"Product identifiers in the Udora system","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/ProductId"}},"categoryIds":{"type":"array","description":"Category identifiers in the Udora system","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/RangeGroupId"}},"type":{"$ref":"#/components/schemas/ProductType"},"page":{"type":"integer","description":"Page number. Numbering starts from 0.","minimum":0,"default":0},"limit":{"type":"integer","description":"Number of items in the response. Minimum — 1, maximum — 1000, default — 10.","minimum":1,"maximum":1000,"default":10}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"List of products","items":{"$ref":"#/components/schemas/ProductShortDto"}},"total":{"type":"integer","description":"Total number of products (excluding pagination)"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Create products

> Creates a new product in the shop catalog on Udora. \
> \
> \*\*Restrictions:\*\* \
> \- Ready-made products (\`productType=2\`) cannot be created via API. \
> \- Main product (\`productType=1\`) — requires \`subCategoryId\`. \
> \- Additional product (\`productType=3\`) — does not require \`subCategoryId\`. \
> \
> \*\*Product properties:\*\* \
> The set of required and allowed fields depends on the subcategory. \
> The current property schema, including dependencies between attributes (\`dependsOn\`), must be obtained via \`POST /apiseller/categories/subCategoryProperties\` — this is the single source of truth. \
> The \`dependsOn\` attribute is informational and is not sent in the create request. \
> \
> \*\*Images:\*\* \
> Images are uploaded asynchronously from the provided URLs. Their first appearance in the Udora interface may take up to 30 minutes.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferCreateRequest":{"type":"object","additionalProperties":false,"required":["products"],"properties":{"products":{"type":"array","description":"Array of products to create. Maximum 500 products per request.\nProducts are processed independently: an error in one product does not affect the others.\n","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/OfferCreateItem"}}}},"OfferCreateItem":{"type":"object","additionalProperties":false,"required":["offerId","productType","name","price","images"],"description":"Data for one product to create.\n\n**Subcategory fields:**\nIn addition to the basic fields listed below, each product may contain\nadditional fields that depend on the subcategory (`subCategoryId`).\nThe current set of fields, their types, and restrictions must be obtained via\n`POST /apiseller/categories/subCategoryProperties`.\n\n**Required fields for all product types:** `offerId`, `productType`, `name`, `price`.\n\n**Additionally for a main product** (`productType=1`): `subCategoryId` is required.\nOther required fields depend on the subcategory — obtain them via\n`POST /apiseller/categories/subCategoryProperties`.\n\n**For an additional product** (`productType=3`): the `subCategoryId` field is not sent.\n\n**Mutually exclusive fields:**\nSome fields cannot be sent simultaneously. Information about this is contained\nin the `dependsOn` attribute in the `subCategoryProperties` response. The `dependsOn`\nfield itself is not sent in the request — it is only an informational attribute.\n\nExamples of mutual exclusions:\n- `stock` and `productionTime` — send either stock quantity or production time\n- `approximateWeight` and the `postWidth`/`postHeight`/`postLength`/`postWeight` group —\n  send either approximate weight or exact postal dimensions\n\n**Images:**\nThe `images` field accepts an array of URLs. Images are uploaded asynchronously.\n\n**Field naming:** all fields are sent in camelCase format.\n\n**Duplicate offerId:** all duplicates by `offerId` will not be processed.\n","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productType":{"type":"integer","enum":[1,3],"description":"Product type: \n* `1` — regular product, \n* `3` — additional product.\n"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":255,"description":"Product name."},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"description":{"type":"string","nullable":true,"maxLength":5000,"description":"Product description."},"images":{"type":"array","description":"Array of product image URLs. Uploaded asynchronously.\nThe order in the array corresponds to the display order.\n","items":{"type":"string","format":"uri"}},"vat":{"type":"string","description":"VAT rate. If not sent, the default value for the shop holding is set."},"stock":{"type":"integer","minimum":1,"description":"Product quantity in stock, pcs.\n**Mutually exclusive with `productionTime`** — send either `stock` or `productionTime`.\n"},"productionTime":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Product production time.\n**Mutually exclusive with `stock`** — send either `productionTime` or `stock`.\n"},"minOrderCount":{"type":"integer","minimum":1,"description":"Minimum number of units in an order."},"height":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Product height."},"width":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Product width."},"volume":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Product volume or weight."},"isPostDelivery":{"type":"boolean","description":"Whether postal delivery is available for this product."},"postWidth":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Package width for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postHeight":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Package height for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postLength":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Package length for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postWeight":{"allOf":[{"$ref":"#/components/schemas/MeasureValue"}],"description":"Package weight for postal delivery (exact weight).\n**Mutually exclusive with `approximateWeight`.**\n"},"approximateWeight":{"type":"integer","description":"Approximate weight for postal delivery (selected from ranges).\n**Mutually exclusive with the group** `postWidth` / `postHeight` / `postLength` / `postWeight`.\nAllowed values are from `values` in the `subCategoryProperties` response.\n"},"isAdultsOnly":{"type":"boolean","description":"Product intended for persons over 18 years old."},"manufacturerName":{"type":"string","description":"Manufacturer name."},"manufacturerAddress":{"type":"string","description":"Manufacturer address."},"importerName":{"type":"string","description":"Importer name."},"importerAddress":{"type":"string","description":"Importer address."},"material":{"type":"array","description":"Materials from which the product is made.","items":{"type":"string"}},"consist":{"type":"array","description":"Product composition. Used for subcategories where the product has components\n(for example, candy bouquets or gift sets).\n","items":{"$ref":"#/components/schemas/ConsistItem"}},"thematicSelections":{"type":"array","description":"Thematic selections. Send an array of selection `id` values from `values`\nin the `subCategoryProperties` response.\n","items":{"type":"integer"}},"quantityInPackage":{"type":"integer","minimum":1,"description":"Quantity of product units in the package."},"gender":{"type":"integer","description":"Who the product is intended for (gender). Allowed values are from `values` in the `subCategoryProperties` response."},"textDimensions":{"type":"string","description":"Available sizes as text. For example, \"S, M, L, XL\" or \"39, 40, 41\"."},"kilocalories":{"type":"integer","description":"Calories, kcal."},"proteins":{"type":"integer","description":"Proteins, g"},"fats":{"type":"integer","description":"Fats, g"},"carbohydrates":{"type":"integer","description":"Carbohydrates, g"},"regionOfOrigin":{"type":"string","description":"Region of product origin. For example, \"Fujian, China\"."},"brand":{"type":"string","description":"Product brand."},"composition":{"type":"string","description":"Product composition as text (for example, for cosmetics)."},"author":{"type":"string","description":"Author (for books)."},"year":{"type":"integer","description":"Year of publication or release (for books, albums)."},"baloonType":{"type":"integer","description":"Balloon type. Allowed values are from `values` in the `subCategoryProperties` response.\n"},"certificatePurpose":{"type":"integer","description":"Certificate purpose. Allowed values are from `values`\nin the `subCategoryProperties` response.\n"},"certificateType":{"type":"array","description":"Certificate type (multiselect). Send an array of `id` values from `values`\nin the `subCategoryProperties` response.\n","items":{"type":"integer"}}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"MeasureValue":{"type":"object","description":"Value with a unit of measurement.\nUsed for fields of the `measure` type (height, weight, production time, etc.).\n","additionalProperties":false,"required":["val","measure"],"properties":{"val":{"type":"number","description":"Numeric value."},"measure":{"type":"integer","description":"Measurement unit identifier. Allowed values for each field\nare specified in the `measure` array in the `subCategoryProperties` response.\n"}}},"ConsistItem":{"type":"object","description":"One item of the product composition.\nUsed for fields of the `consist` type.\n","additionalProperties":false,"required":["name","quantity","measure"],"properties":{"name":{"type":"string","maxLength":255,"description":"Name of the component. Must be unique within the composition."},"quantity":{"type":"integer","minimum":1,"description":"Quantity of this component."},"measure":{"type":"integer","description":"Quantity measurement unit identifier. Allowed values are specified\nin the `measure` array of the `consist` field in the `subCategoryProperties` response.\n"}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/create":{"post":{"tags":["Products"],"summary":"Create products","operationId":"post.products.create","description":"Creates a new product in the shop catalog on Udora. \n\n**Restrictions:** \n- Ready-made products (`productType=2`) cannot be created via API. \n- Main product (`productType=1`) — requires `subCategoryId`. \n- Additional product (`productType=3`) — does not require `subCategoryId`. \n\n**Product properties:** \nThe set of required and allowed fields depends on the subcategory. \nThe current property schema, including dependencies between attributes (`dependsOn`), must be obtained via `POST /apiseller/categories/subCategoryProperties` — this is the single source of truth. \nThe `dependsOn` attribute is informational and is not sent in the create request. \n\n**Images:** \nImages are uploaded asynchronously from the provided URLs. Their first appearance in the Udora interface may take up to 30 minutes.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferCreateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Result of the create products operation","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"summary":{"type":"object","description":"Brief statistics for the number of processed records","properties":{"total":{"type":"integer","default":0,"description":"Total number of processed records"},"success":{"type":"integer","default":0,"description":"Number of successfully processed records"},"failed":{"type":"integer","default":0,"description":"Number of records with errors"}}},"data":{"type":"array","description":"Array of product identifiers without errors","items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"}}}},"errors":{"type":"array","description":"Array of products with errors; response items contain the same offerId and product as in the request","items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"product":{"type":"object","description":"Product properties from the request that were used to try to create the product"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update products

> Updates a product in the shop catalog on Udora. \
> \
> When updating, all current product fields must be sent (partial updates are not supported). \
> \
> \*\*Restrictions:\*\* \
> \- Changing \`productType\` and \`subCategoryId\` via API is prohibited. \
> \- Ready-made products (\`productType=2\`) cannot be created or updated via API. \
> \- For a main product (\`productType=1\`), the \`subCategoryId\` field is required. \
> \- For an additional product (\`productType=3\`), the \`subCategoryId\` field is not required. \
> \
> \*\*Product properties:\*\* \
> The set of required and allowed fields depends on the subcategory. \
> The current property schema, including dependencies between attributes (\`dependsOn\`), must be obtained via \`POST /apiseller/categories/subCategoryProperties\` — this is the single source of truth. \
> The \`dependsOn\` attribute is informational and is not sent in the update request.\
> \
> \*\*Images:\*\* \
> Images are uploaded asynchronously from the provided URIs. Their first appearance in the Udora interface may take up to 30 minutes.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferUpdateRequest":{"type":"object","additionalProperties":false,"required":["products"],"properties":{"products":{"type":"array","description":"Array of products to update. Maximum 500 products per request.\nProducts are processed independently: an error in one product does not affect the others.\n","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/OfferUpdateItem"}}}},"OfferUpdateItem":{"type":"object","additionalProperties":false,"required":["offerId","productType","name","price","images"],"description":"Data for one product to update.\n\n**All product fields must be sent** — partial updates are not supported.\nFields not sent in the request will be considered empty.\n\n**Restrictions:**\n- `productType` and `subCategoryId` cannot be changed — they must match the current product values.\n- The product is identified by `offerId`. If a product with this `offerId` is not found, an error will be returned.\n\nAll other rules are the same as for creation (mutual exclusions, camelCase, images).\n","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productType":{"type":"integer","enum":[1,3],"description":"Product type: \n* `1` — regular product, \n* `3` — additional product.\n"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":255,"description":"Product name."},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"description":{"type":"string","nullable":true,"maxLength":5000,"description":"Product description."},"images":{"type":"array","description":"Array of product image URLs. Uploaded asynchronously.\nThe order in the array corresponds to the display order.\n","items":{"type":"string","format":"uri"}},"vat":{"type":"string","description":"VAT rate. If not sent, the default value for the shop holding is set."},"stock":{"type":"integer","minimum":1,"description":"Product quantity in stock, pcs.\n**Mutually exclusive with `productionTime`** — send either `stock` or `productionTime`.\n"},"productionTime":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Product production time.\n**Mutually exclusive with `stock`** — send either `productionTime` or `stock`.\n"},"minOrderCount":{"type":"integer","minimum":1,"description":"Minimum number of units in an order."},"height":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Product height."},"width":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Product width."},"volume":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Product volume or weight."},"isPostDelivery":{"type":"boolean","description":"Whether postal delivery is available for this product."},"postWidth":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Package width for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postHeight":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Package height for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postLength":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Package length for postal delivery (exact size).\n**Mutually exclusive with `approximateWeight`.**\n"},"postWeight":{"allOf":[{"$ref":"#/components/schemas/schemas-MeasureValue"}],"description":"Package weight for postal delivery (exact weight).\n**Mutually exclusive with `approximateWeight`.**\n"},"approximateWeight":{"type":"integer","description":"Approximate weight for postal delivery (selected from ranges).\n**Mutually exclusive with the group** `postWidth` / `postHeight` / `postLength` / `postWeight`.\nAllowed values are from `values` in the `subCategoryProperties` response.\n"},"isAdultsOnly":{"type":"boolean","description":"Product intended for persons over 18 years old."},"manufacturerName":{"type":"string","description":"Manufacturer name."},"manufacturerAddress":{"type":"string","description":"Manufacturer address."},"importerName":{"type":"string","description":"Importer name."},"importerAddress":{"type":"string","description":"Importer address."},"material":{"type":"array","description":"Materials from which the product is made.","items":{"type":"string"}},"consist":{"type":"array","description":"Product composition. Used for subcategories where the product has components\n(for example, candy bouquets or gift sets).\n","items":{"$ref":"#/components/schemas/ConsistItem"}},"thematicSelections":{"type":"array","description":"Thematic selections. Send an array of selection `id` values from `values`\nin the `subCategoryProperties` response.\n","items":{"type":"integer"}},"quantityInPackage":{"type":"integer","minimum":1,"description":"Quantity of product units in the package."},"gender":{"type":"integer","description":"Who the product is intended for (gender). Allowed values are from `values` in the `subCategoryProperties` response."},"textDimensions":{"type":"string","description":"Available sizes as text. For example, \"S, M, L, XL\" or \"39, 40, 41\"."},"kilocalories":{"type":"integer","description":"Calories, kcal."},"proteins":{"type":"integer","description":"Proteins, g"},"fats":{"type":"integer","description":"Fats, g"},"carbohydrates":{"type":"integer","description":"Carbohydrates, g"},"regionOfOrigin":{"type":"string","description":"Region of product origin. For example, \"Fujian, China\"."},"brand":{"type":"string","description":"Product brand."},"composition":{"type":"string","description":"Product composition as text (for example, for cosmetics)."},"author":{"type":"string","description":"Author (for books)."},"year":{"type":"integer","description":"Year of publication or release (for books, albums)."},"baloonType":{"type":"integer","description":"Balloon type. Allowed values are from `values` in the `subCategoryProperties` response.\n"},"certificatePurpose":{"type":"integer","description":"Certificate purpose. Allowed values are from `values`\nin the `subCategoryProperties` response.\n"},"certificateType":{"type":"array","description":"Certificate type (multiselect). Send an array of `id` values from `values`\nin the `subCategoryProperties` response.\n","items":{"type":"integer"}}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"schemas-MeasureValue":{"type":"object","additionalProperties":false,"required":["val","measure"],"properties":{"val":{"type":"number","description":"Value"},"measure":{"type":"integer","description":"Measurement unit identifier"}}},"ConsistItem":{"type":"object","description":"One item of the product composition.\nUsed for fields of the `consist` type.\n","additionalProperties":false,"required":["name","quantity","measure"],"properties":{"name":{"type":"string","maxLength":255,"description":"Name of the component. Must be unique within the composition."},"quantity":{"type":"integer","minimum":1,"description":"Quantity of this component."},"measure":{"type":"integer","description":"Quantity measurement unit identifier. Allowed values are specified\nin the `measure` array of the `consist` field in the `subCategoryProperties` response.\n"}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/update":{"post":{"tags":["Products"],"summary":"Update products","operationId":"post.products.update","description":"Updates a product in the shop catalog on Udora. \n\nWhen updating, all current product fields must be sent (partial updates are not supported). \n\n**Restrictions:** \n- Changing `productType` and `subCategoryId` via API is prohibited. \n- Ready-made products (`productType=2`) cannot be created or updated via API. \n- For a main product (`productType=1`), the `subCategoryId` field is required. \n- For an additional product (`productType=3`), the `subCategoryId` field is not required. \n\n**Product properties:** \nThe set of required and allowed fields depends on the subcategory. \nThe current property schema, including dependencies between attributes (`dependsOn`), must be obtained via `POST /apiseller/categories/subCategoryProperties` — this is the single source of truth. \nThe `dependsOn` attribute is informational and is not sent in the update request.\n\n**Images:** \nImages are uploaded asynchronously from the provided URIs. Their first appearance in the Udora interface may take up to 30 minutes.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Result of the create products operation","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"summary":{"type":"object","description":"Brief statistics for the number of processed records","properties":{"total":{"type":"integer","default":0,"description":"Total number of processed records"},"success":{"type":"integer","default":0,"description":"Number of successfully processed records"},"failed":{"type":"integer","default":0,"description":"Number of records with errors"}}},"data":{"type":"array","description":"Array of products with brief information and no errors","items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"}}}},"errors":{"type":"array","description":"Array of products with errors; response items contain the same offerId and product as in the request","items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"product":{"type":"object","description":"Product properties from the request that were used to try to update the product"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Linking products from the seller's shop

> Links products from the seller's shop on the Udora marketplace with products from the seller's information system by identifiers.\
> If a product with the specified productId does not exist for the shop in the Udora system, an error will be returned for this product.\
> If one request contains pairs with the same offerId or productId, all such pairs are considered invalid and are not processed.\
> Partial processing is not performed for conflicting pairs; each of them will be returned in the errors array.\
> If ID pairs that were already linked earlier are sent, such pairs will not be changed.\
> Ready-made products on Udora cannot be linked; when attempting to link them, such products will not be found.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"ProductShortDto":{"type":"object","description":"Brief product information","additionalProperties":false,"required":["offerId","productId","isActive","type","categoryId","subCategoryId","name","description","url","available","stock","minOrder","price","discount","currencyCode","images","productionTime","shipmentTime","canRent","originalId","isDeliveryPost","isStarred","vat"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"type":{"$ref":"#/components/schemas/ProductType"},"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":500,"description":"Product name"},"description":{"type":"string","nullable":true,"maxLength":20000,"description":"Detailed product description"},"url":{"type":"string","maxLength":20000,"description":"URL of the product page on Udora for customers"},"available":{"type":"integer","minimum":0,"description":"Product availability"},"stock":{"type":"integer","minimum":0,"description":"Product quantity in stock"},"minOrder":{"type":"integer","minimum":0,"description":"Minimum order"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"images":{"type":"array","description":"Image URLs","items":{"type":"string","format":"uri"}},"productionTime":{"type":"integer","minimum":0,"description":"Product production time in minutes"},"shipmentTime":{"type":"integer","minimum":0,"description":"Product delivery time in minutes"},"canRent":{"type":"integer","enum":[0,1,2],"description":"* `0` — the owner has prohibited rental \n* `1` — the owner has allowed rental \n* `2` — Udora has prohibited rental\n","default":0},"originalId":{"type":"integer","format":"int32","minimum":0,"default":0,"description":"Original product ID. If different from 0, the current product is rented"},"isDeliveryPost":{"type":"boolean","description":"Whether the product is delivered by post","default":false},"isStarred":{"type":"boolean","description":"Whether the product is starred. Promoted more actively by the shop","default":false},"vat":{"type":"string","default":"0","description":"VAT rate percentage for the product"}}},"isActive":{"type":"boolean","description":"Whether the product is active"},"ProductType":{"type":"integer","enum":[1,2,3],"description":"Product type: \n* `1` — regular product, \n* `2` — ready-made product,\n* `3` — additional product.\n"},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/offersMappings":{"post":{"tags":["Products"],"summary":"Linking products from the seller's shop","operationId":"products/offersMappings","description":"Links products from the seller's shop on the Udora marketplace with products from the seller's information system by identifiers.\nIf a product with the specified productId does not exist for the shop in the Udora system, an error will be returned for this product.\nIf one request contains pairs with the same offerId or productId, all such pairs are considered invalid and are not processed.\nPartial processing is not performed for conflicting pairs; each of them will be returned in the errors array.\nIf ID pairs that were already linked earlier are sent, such pairs will not be changed.\nReady-made products on Udora cannot be linked; when attempting to link them, such products will not be found.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offers":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Link between a shop product and a Udora product.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"}},"required":["offerId","productId"],"additionalProperties":false},"description":"Links between shop products and Udora products."}},"required":["offers"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"shopId":{"type":"integer","description":"ID of the requested shop; offerId and productId pairs are processed only within this shop"},"summary":{"type":"object","description":"Summary statistics for processed records","properties":{"total":{"type":"integer","description":"Total number of processed records (success + failed)"},"success":{"type":"integer","description":"Number of successfully processed records (created + updated + relinked + unchanged)"},"failed":{"type":"integer","description":"Number of records with any processing errors"},"created":{"type":"integer","description":"Number of created links"},"updated":{"type":"integer","description":"Number of updated records without changing linked pairs"},"relinked":{"type":"integer","description":"Number of changed linked pairs"},"unchanged":{"type":"integer","description":"Number of unchanged records and links"}}},"data":{"type":"array","description":"Set of products with shortened information","items":{"$ref":"#/components/schemas/ProductShortDto"}},"errors":{"type":"array","description":"Set of products with errors","items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"message":{"type":"string","description":"Error message"}}}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Hide products

> Makes products invisible on the storefront and unavailable for sale without returning them from the archive.\
> If all products in the shop are hidden as a result of the request, the shop is forcibly\
> moved to inactive status.\
> The TOP-18 label is removed from hidden products.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"ChangeStatusRequest":{"type":"object","properties":{"offers":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Product identifiers in the seller's system.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}},"required":["offerId"],"additionalProperties":false},"description":"Product identifiers in the seller's system."}},"required":["offers"],"additionalProperties":false},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ChangeStatusResponse":{"type":"object","required":["shopId","data","errors"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ValidProductStatusResponseDto"},"description":"Products with successfully changed status or without errors"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/InvalidProductStatusResponseDto"},"description":"Products with errors"}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ValidProductStatusResponseDto":{"type":"object","description":"Successful attempt to hide/unhide one product","required":["offerId","productId","isActive","updated"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"updated":{"$ref":"#/components/schemas/Updated"}}},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isActive":{"type":"boolean","description":"Whether the product is active"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"InvalidProductStatusResponseDto":{"type":"object","description":"Attempt to hide/unhide one product with an error","required":["offerId","productId","isActive","message"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/hide":{"post":{"tags":["Products"],"summary":"Hide products","operationId":"products/hide","description":"Makes products invisible on the storefront and unavailable for sale without returning them from the archive.\nIf all products in the shop are hidden as a result of the request, the shop is forcibly\nmoved to inactive status.\nThe TOP-18 label is removed from hidden products.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Unhide products

> Makes products visible on the storefront and available for sale without moving them to the archive.\
> If a product has minimum order quantity and available quantity properties set, then to unhide the product\
> the available quantity must be greater than or equal to the minimum order quantity.\
> For products from wholesale categories, the available quantity is calculated as: available quantity × quantity in package.\
> If there were no unhidden products in the shop before the request and, as a result of the request,\
> at least one unhidden regular or ready-made product appears, the shop is moved to active status\
> (if the other shop activity conditions are met).\
> Product availability confirmation by a manager is not performed through this endpoint.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"ChangeStatusRequest":{"type":"object","properties":{"offers":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Product identifiers in the seller's system.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}},"required":["offerId"],"additionalProperties":false},"description":"Product identifiers in the seller's system."}},"required":["offers"],"additionalProperties":false},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ChangeStatusResponse":{"type":"object","required":["shopId","data","errors"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ValidProductStatusResponseDto"},"description":"Products with successfully changed status or without errors"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/InvalidProductStatusResponseDto"},"description":"Products with errors"}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ValidProductStatusResponseDto":{"type":"object","description":"Successful attempt to hide/unhide one product","required":["offerId","productId","isActive","updated"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"updated":{"$ref":"#/components/schemas/Updated"}}},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isActive":{"type":"boolean","description":"Whether the product is active"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"InvalidProductStatusResponseDto":{"type":"object","description":"Attempt to hide/unhide one product with an error","required":["offerId","productId","isActive","message"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/unhide":{"post":{"tags":["Products"],"summary":"Unhide products","operationId":"products/unhide","description":"Makes products visible on the storefront and available for sale without moving them to the archive.\nIf a product has minimum order quantity and available quantity properties set, then to unhide the product\nthe available quantity must be greater than or equal to the minimum order quantity.\nFor products from wholesale categories, the available quantity is calculated as: available quantity × quantity in package.\nIf there were no unhidden products in the shop before the request and, as a result of the request,\nat least one unhidden regular or ready-made product appears, the shop is moved to active status\n(if the other shop activity conditions are met).\nProduct availability confirmation by a manager is not performed through this endpoint.\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeStatusResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Move product to archive

> Moves one product to the archive<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isArchived":{"type":"boolean","description":"Whether the product is archived"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/archive":{"post":{"tags":["Products"],"summary":"Move product to archive","operationId":"post.products.archive","description":"Moves one product to the archive\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Product identifier in the seller's system","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Result of the move product to archive operation","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"updated":{"$ref":"#/components/schemas/Updated"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Return product from archive

> Returns one product from the archive<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Products","description":"Adding, viewing, editing, and managing product visibility"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isArchived":{"type":"boolean","description":"Whether the product is archived"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/products/unarchive":{"post":{"tags":["Products"],"summary":"Return product from archive","operationId":"post.products.unarchive","description":"Returns one product from the archive\n","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Product identifier in the seller's system","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Result of the return product from archive operation","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"updated":{"$ref":"#/components/schemas/Updated"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Stocks&#x20;

*Product stock levels in the shop’s warehouses.*

## View product stock

> Returns stock information in the seller's shop

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Stocks","description":"Product stock in shop warehouses"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"StocksRequest":{"type":"object","required":["offers"],"properties":{"offers":{"type":"array","minItems":1,"maxItems":1000,"description":"Information about products in warehouses.","items":{"type":"object","required":["offerId"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}}}}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"StocksResponse":{"type":"object","required":["shopId","data","errors"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"stock":{"$ref":"#/components/schemas/StockCount"}}}},"errors":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Information about retrieval errors.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"stock":{"$ref":"#/components/schemas/StockCount"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"StockCount":{"type":"integer","format":"int32","minimum":0,"description":"Quantity of product available, excluding reserved products."},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/stocks/get":{"post":{"tags":["Stocks"],"summary":"View product stock","operationId":"stocks/get","description":"Returns stock information in the seller's shop","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update product stock

> Updates stock information in the seller's shop. The product is hidden when stock is changed from > 0 to 0. If all products in the shop are hidden as a result of the request, the shop is forcibly moved to inactive status. The TOP-18 label is removed from hidden products. To hide a product without changing its stock, use the \`POST /apiseller/products/hide\` request

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Stocks","description":"Product stock in shop warehouses"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"UpdateStocksRequest":{"type":"object","properties":{"offers":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Stock information for one product in one of the warehouses.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"stock":{"$ref":"#/components/schemas/StockCount"}},"required":["offerId","stock"],"additionalProperties":false},"description":"Product stock data."}},"required":["offers"],"additionalProperties":false},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"StockCount":{"type":"integer","format":"int32","minimum":0,"description":"Quantity of product available, excluding reserved products."},"UpdateStocksResponse":{"type":"object","description":"Stock information for one product in one of the warehouses.","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","description":"Information about updated stock.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"stock":{"$ref":"#/components/schemas/StockCount"},"updated":{"$ref":"#/components/schemas/Updated"}}}},"errors":{"type":"array","minItems":0,"maxItems":1000,"items":{"type":"object","description":"Information about update errors.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"stock":{"$ref":"#/components/schemas/StockCount"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/stocks/put":{"put":{"tags":["Stocks"],"summary":"Update product stock","operationId":"stocks/put","description":"Updates stock information in the seller's shop. The product is hidden when stock is changed from > 0 to 0. If all products in the shop are hidden as a result of the request, the shop is forcibly moved to inactive status. The TOP-18 label is removed from hidden products. To hide a product without changing its stock, use the `POST /apiseller/products/hide` request","parameters":[{"$ref":"#/components/parameters/ShopId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStocksRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStocksResponse"}}}},"400":{"$ref":"#/components/responses/400"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Prices

*Product prices.*

## Get product prices and discounts

> Returns information about product prices and discounts in the shop

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Prices","description":"Product prices"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"PricesGetRequest":{"type":"object","properties":{"offers":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","description":"Get price/discount for a product. You can send and set only price, only discount, or both attributes for each product","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"}},"required":["offerId"]}}},"required":["offers"],"additionalProperties":false},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"PricesGetResponseData":{"type":"array","items":{"type":"object","description":"Product prices, discounts, and currencies","required":["offerId","productId","price","discount","currencyCode"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"}}}},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"PricesGetResponseErrors":{"type":"array","items":{"type":"object","description":"Products with errors","required":["offerId","productId","message"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/prices/get":{"post":{"tags":["Prices"],"summary":"Get product prices and discounts","operationId":"post.price.get","parameters":[{"$ref":"#/components/parameters/ShopId"}],"description":"Returns information about product prices and discounts in the shop","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesGetRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"$ref":"#/components/schemas/PricesGetResponseData"},"errors":{"$ref":"#/components/schemas/PricesGetResponseErrors"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Update product prices and discounts

> Updates product prices and/or discounts in the shop

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Prices","description":"Product prices"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"PricesSetRequest":{"type":"object","properties":{"offers":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","description":"Set price/discount for a product.","properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"}},"anyOf":[{"required":["price"]},{"required":["discount"]}]}}},"required":["offers"],"additionalProperties":false},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"PricesSetResponse":{"type":"object","description":"Results of changing price/discount for products","required":["shopId"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","items":{"type":"object","description":"Result of changing price/discount for a product","required":["offerId","productId","price","discount","updated"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"updated":{"$ref":"#/components/schemas/Updated"}}}},"errors":{"type":"array","items":{"type":"object","description":"Change errors.","required":["offerId","productId","price","discount","message"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"message":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"Updated":{"type":"boolean","description":"Whether product data was changed"},"ErrorMessage":{"type":"string","description":"Error message"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/prices/put":{"put":{"tags":["Prices"],"summary":"Update product prices and discounts","operationId":"post.price.put","parameters":[{"$ref":"#/components/parameters/ShopId"}],"description":"Updates product prices and/or discounts in the shop","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesSetRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesSetResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Categories

*Information about product categories and subcategories.*

## Product category and subcategory tree

> Returns a hierarchical tree of active categories (groups) with their subcategories (types).\
> The result is filtered by the shop country — categories and subcategories unavailable in the country are not included.\
> The result is not paginated (returned in full).\
> \
> \### The \`chestnyZnakMarkingRequirement\` field\
> The field is returned \*\*only for shops from the Russian Federation\*\*.\
> It indicates the product marking requirement in the Chestny Znak system:\
> \
> \| Value        | Description                                                        |\
> \|--------------|--------------------------------------------------------------------|\
> \| \`never\`      | Marking is not required for products in this subcategory            |\
> \| \`selectable\` | The shop decides whether marking is required for a specific product |\
> \| \`always\`     | All products in this subcategory must be marked                     |\
> \
> For shops from other countries, the field is not included in the response.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Categories","description":"Information about product categories and subcategories"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"RangeGroupItem":{"type":"object","description":"Data about one category","additionalProperties":false,"required":["categoryId","name","isDeliveryPhotoRequired","isPostcardEnabled","subCategories"],"properties":{"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"name":{"type":"string","description":"Category name"},"isDeliveryPhotoRequired":{"type":"boolean","description":"A before-delivery photo is required in an order containing a product from this subcategory"},"isPostcardEnabled":{"type":"boolean","description":"A Udora branded postcard is included in an order containing a product from this subcategory"},"subCategories":{"type":"array","description":"Child subcategories of this category","items":{"$ref":"#/components/schemas/RangeTypeItem"}}}},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"RangeTypeItem":{"type":"object","description":"Data about one subcategory","additionalProperties":false,"required":["subCategoryId","name","isPostDelivery","isAdultsOnlyDefault"],"properties":{"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","description":"Subcategory name"},"isPostDelivery":{"type":"boolean","description":"Products from this subcategory can be delivered by post"},"isAdultsOnlyDefault":{"type":"boolean","description":"All products from this subcategory are necessarily adult products"},"chestnyZnakMarkingRequirement":{"type":"string","enum":["never","selectable","always"],"description":"Marking requirement in the Chestny Znak system for products from this subcategory. Relevant only for Russia.\nPossible values:\n  * `never` — products from this subcategory are never marked\n  * `selectable` — the marking requirement is determined by the seller at the product level\n  (when creating/editing a product, explicitly set the flag “marking required” or “marking not required”;\n  the default value is “not required” (`false`))\n  * `always` — products from this subcategory are always marked\n"}}},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/categories/tree":{"post":{"tags":["Categories"],"summary":"Product category and subcategory tree","operationId":"post.categories.tree","description":"Returns a hierarchical tree of active categories (groups) with their subcategories (types).\nThe result is filtered by the shop country — categories and subcategories unavailable in the country are not included.\nThe result is not paginated (returned in full).\n\n### The `chestnyZnakMarkingRequirement` field\nThe field is returned **only for shops from the Russian Federation**.\nIt indicates the product marking requirement in the Chestny Znak system:\n\n| Value        | Description                                                        |\n|--------------|--------------------------------------------------------------------|\n| `never`      | Marking is not required for products in this subcategory            |\n| `selectable` | The shop decides whether marking is required for a specific product |\n| `always`     | All products in this subcategory must be marked                     |\n\nFor shops from other countries, the field is not included in the response.\n","parameters":[{"name":"shopId","in":"query","required":true,"schema":{"type":"integer","format":"int32","minimum":1},"description":"Shop identifier. Passed as a GET parameter.\nExample: ?shopId=260\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["shopId","data"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RangeGroupItem"},"description":"Array of categories with nested subcategories"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Subcategory properties

> Returns a list of properties for one product subcategory.

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Categories","description":"Information about product categories and subcategories"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"schemas-ShopId":{"type":"integer","description":"Shop identifier.","minimum":1,"format":"int32"},"RangeTypeItem":{"type":"object","description":"Data about one subcategory","additionalProperties":false,"required":["subCategoryId","name","isPostDelivery","isAdultsOnlyDefault"],"properties":{"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","description":"Subcategory name"},"isPostDelivery":{"type":"boolean","description":"Products from this subcategory can be delivered by post"},"isAdultsOnlyDefault":{"type":"boolean","description":"All products from this subcategory are necessarily adult products"},"chestnyZnakMarkingRequirement":{"type":"string","enum":["never","selectable","always"],"description":"Marking requirement in the Chestny Znak system for products from this subcategory. Relevant only for Russia.\nPossible values:\n  * `never` — products from this subcategory are never marked\n  * `selectable` — the marking requirement is determined by the seller at the product level\n  (when creating/editing a product, explicitly set the flag “marking required” or “marking not required”;\n  the default value is “not required” (`false`))\n  * `always` — products from this subcategory are always marked\n"}}},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"RangeTypeProperty":{"type":"object","description":"Subcategory property — a product attribute that must be filled in when creating or updating a product.\nFor example: name, price, weight, composition, images.\n\nEach property describes:\n- the field name (`field`) — this exact name is used when sending a product\n- whether it is required (`required`)\n- what value type is expected (`type`)\n- additional restrictions (`minValue`, `maxValue`, `maxDecimalPlaces`)\n- allowed options for selection (`values`)\n- allowed measurement units (`measure`)\n- which field it depends on (`dependsOn`) — a mutually exclusive pair\n","required":["name","field","required","type"],"properties":{"name":{"type":"string","description":"Human-readable property name. Used for display in the interface."},"field":{"type":"string","description":"Technical property name in camelCase format.\nUsed as the key when sending values to the create and update product endpoints.\n"},"required":{"type":"boolean","description":"Whether the field is required.\n\nIf `true` — the product will not be created without this field.\nIf the field has `dependsOn` — the field is required only when none of the fields in `dependsOn` is sent.\nIn other words: either this field or the field(s) from `dependsOn` must be sent.\n"},"type":{"type":"string","enum":["text","decimal","bool","measure","consist","select","multiselect","multitext","image"],"description":"Property value type. Defines the format of the value to send.\n\n* `text` — string of arbitrary length\n* `decimal` — number (integer or floating point). Restrictions: `minValue`, `maxValue`, `maxDecimalPlaces`\n* `bool` — Boolean value: `true` or `false`\n* `measure` — object with a numeric value and measurement unit: `{\"val\": 50, \"measure\": 3}`\n* `consist` — array of product composition objects: `[{\"name\": \"Rose\", \"quantity\": 5, \"measure\": 1}]`\n* `select` — one value from the `values` list. Send the selected item's `id`. Integer.\n* `multiselect` — several values from the `values` list. Send an array of `id` values. Integer.\n* `multitext` — array of strings: `[\"Cotton\", \"Linen\"]`\n* `image` — array of image URLs: `[\"https://example.com/img.jpg\"]`\n"},"minValue":{"type":"number","nullable":true,"description":"Minimum allowed value.\nApplies to the `decimal` and `measure` types (`val` field).\n"},"maxValue":{"type":"number","nullable":true,"description":"Maximum allowed value.\nApplies to the `decimal` and `measure` types (`val` field).\n"},"maxDecimalPlaces":{"type":"integer","nullable":true,"description":"Maximum number of decimal places.\nApplies to the `decimal` and `measure` types.\nIf `0` — the value must be an integer.\n"},"values":{"type":"array","nullable":true,"description":"Allowed options for selection.\nPresent only for the `select` and `multiselect` types.\nWhen sending a value, specify the required item's `id`.\n","items":{"$ref":"#/components/schemas/PropertyValue"}},"measure":{"type":"array","nullable":true,"description":"Allowed measurement units.\nPresent only for the `measure` and `consist` types.\nWhen sending a value, specify the required measurement unit's `id`.\n","items":{"$ref":"#/components/schemas/MeasureOption"}},"dependsOn":{"type":"array","nullable":true,"description":"Mutually exclusive fields. Informational only — not sent in create and update requests.\n\nIf `dependsOn` is present, it means that this field and the fields from the list are mutually exclusive:\nyou must send **either** the current field **or** the fields from `dependsOn` — but not both at the same time.\n\n**Example:** for the `stock` field, `dependsOn: [\"productionTime\"]` — you can send either the stock quantity\nor the production time, but not both fields at once. At the same time, at least one of the pair must be specified.\n","items":{"type":"string"}}}},"PropertyValue":{"type":"object","description":"One of the allowed options for `select` and `multiselect` fields.\nWhen sending a value, use `id`.\n","required":["id","name"],"additionalProperties":false,"properties":{"id":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Value identifier. This is the value sent in the request."},"name":{"type":"string","description":"Human-readable value name."}}},"MeasureOption":{"type":"object","description":"One of the allowed measurement units for fields of the `measure` and `consist` types.\nWhen sending a value, use `id` in the object's `measure` field.\n","required":["id"],"additionalProperties":false,"properties":{"id":{"type":"integer","description":"Measurement unit identifier.\n\n* `1` — pieces\n* `2` — grams\n* `3` — centimeters\n* `4` — milliliters\n* `5` — ounces\n* `6` — inches\n* `7` — minutes\n* `8` — hours\n* `9` — days\n* `10` — weeks\n* `11` — months\n* `12` — years\n","enum":[1,2,3,4,5,6,7,8,9,10,11,12]},"maxDecimalPlaces":{"type":"integer","nullable":true,"description":"Maximum number of decimal places for this unit."},"minValue":{"type":"number","nullable":true},"maxValue":{"type":"number","nullable":true}}},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/categories/subCategoryProperties":{"post":{"tags":["Categories"],"summary":"Subcategory properties","operationId":"post.category.typeProperties","description":"Returns a list of properties for one product subcategory.","parameters":[{"$ref":"#/components/parameters/ShopId"},{"in":"query","name":"subCategoryId","required":true,"description":"**Product subcategory identifier**\n\nIt can be obtained using the `POST /apiseller/categories/tree` request\n","schema":{"type":"integer","minimum":1,"maximum":4294967295}},{"in":"query","name":"productType","required":true,"schema":{"type":"integer","enum":[1,3],"description":"Product type identifier. Product properties depend on the product type.\nPossible values:\n  * `1` — regular product. Can remain in the catalog for a long time, can exist in many units, and has stock or production time\n  * `3` — additional product. Not displayed to customers in the product catalog or on the shop page; visible only in the cart. Can be added to an order together with one or several regular or ready-made products\n\nSettings for ready-made products (productType=2) are not provided through this endpoint because ready-made products cannot be created via API. Use the UDORA seller app for this.\n"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["shopId","subCategory","data"],"properties":{"shopId":{"$ref":"#/components/schemas/schemas-ShopId"},"subCategory":{"default":0,"description":"Subcategory information. 0 for additional products (productType=3, subCategoryId=0)","allOf":[{"$ref":"#/components/schemas/RangeTypeItem"}]},"data":{"type":"array","description":"Subcategory properties","items":{"$ref":"#/components/schemas/RangeTypeProperty"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Orders

*Order management.*<br>

## View the list of orders

> View the list of orders<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"deliveryType":{"nullable":false,"type":"integer","enum":[0,1,2,4,5,10,11,12,20,21,22,23,24,26,32,33,34],"description":"Delivery type\n- 0 — Courier is absent / Delivery method is not selected\n- 1 — Delivery by seller's courier\n- 2 — Seller's own delivery\n- 4 — Pickup\n- 5 — Udora delivery\n- 10 — Delivery by walking courier\n- 11 — Delivery by car courier\n- 12 — Delivery by courier using transport\n- 20 — Delivery by florist on foot\n- 21 — Delivery by florist by car\n- 22 — Delivery by florist using transport\n- 23 — Delivery by Yandex Delivery\n- 24 — Delivery by florist by bicycle\n- 26 — Delivery by Gett delivery\n- 32 — Delivery by SberMarket\n- 33 — Delivery by Magnit\n- 34 — Delivery of digital products (certificates)\n"},"status":{"type":"integer","nullable":false,"enum":[1,2,3,4,5,7,10,11,12],"description":"Order status\n- 1 — New\n- 2 — Accepted\n- 3 — Completed\n- 4 — Handed over for delivery\n- 5 — Before-delivery photo\n- 7 — Order is waiting for the customer to pick it up from the shop\n- 10 — Postal status. Order assembled\n- 11 — Postal status. Order is being delivered by post\n- 12 — Postal status. Order is waiting for pickup at the post office\n"},"deliveryTimeType":{"nullable":false,"type":"integer","enum":[0,1,2],"description":"Delivery time type\n- 0 — Agree the time with the recipient\n- 1 — As soon as possible\n- 2 — Within a time interval\n"},"orderItem":{"type":"object","properties":{"id":{"type":"integer","nullable":false,"description":"Order ID in the Udora system"},"shopId":{"type":"integer","nullable":false,"description":"Shop ID"},"createdDate":{"type":"integer","nullable":false,"description":"Order creation time"},"status":{"type":"integer","nullable":false,"enum":[1,2,3,4,5,7,10,11,12],"description":"Order status\n- 1 — New\n- 2 — Accepted\n- 3 — Completed\n- 4 — Handed over for delivery\n- 5 — Before-delivery photo\n- 7 — Order is waiting for the customer to pick it up from the shop\n- 10 — Postal status. Order assembled\n- 11 — Postal status. Order is being delivered by post\n- 12 — Postal status. Order is waiting for pickup at the post office\n"},"deliveryType":{"nullable":false,"type":"integer","enum":[0,1,2,4,5,10,11,12,20,21,22,23,24,26,32,33,34],"description":"Delivery type\n- 0 — Courier is absent / Delivery method is not selected\n- 1 — Delivery by seller's courier\n- 2 — Seller's own delivery\n- 4 — Pickup\n- 5 — Udora delivery\n- 10 — Delivery by walking courier\n- 11 — Delivery by car courier\n- 12 — Delivery by courier using transport\n- 20 — Delivery by florist on foot\n- 21 — Delivery by florist by car\n- 22 — Delivery by florist using transport\n- 23 — Delivery by Yandex Delivery\n- 24 — Delivery by florist by bicycle\n- 26 — Delivery by Gett delivery\n- 32 — Delivery by SberMarket\n- 33 — Delivery by Magnit\n- 34 — Delivery of digital products (certificates)\n"},"deliveryTimeType":{"nullable":false,"type":"integer","enum":[0,1,2],"description":"Delivery time type\n- 0 — Agree the time with the recipient\n- 1 — As soon as possible\n- 2 — Within a time interval\n"},"deliveryDateFrom":{"type":"integer","nullable":false,"description":"Delivery time from"},"deliveryDateTo":{"type":"integer","nullable":false,"description":"Delivery time to"},"address":{"type":"string","nullable":false,"description":"Delivery address. Separated from detailed address information by the ';' character"},"courierInfo":{"type":"string","nullable":false,"description":"Comment for the courier"},"shopAdditionalInfo":{"type":"string","nullable":false,"description":"Comment for the shop"},"comment":{"type":"string","nullable":true,"description":"Customer comment"},"photoBeforeUrl":{"type":"string","nullable":true,"description":"Before-delivery photo"},"photoAfterUrl":{"type":"string","nullable":true,"description":"After-delivery photo"},"message":{"type":"string","nullable":false,"description":"Postcard text. If present, the products section will contain an item with postcard data"},"products":{"type":"array","description":"Order products","items":{"allOf":[{"$ref":"#/components/schemas/ProductShortDto"},{"type":"object","properties":{"count":{"type":"integer","description":"Product quantity in the order"},"cost":{"type":"string","description":"Price within the order"}},"required":["count","cost"]}]}},"user":{"type":"object","nullable":true,"description":"Customer data","properties":{"name":{"type":"string","description":"Customer name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"recipient":{"type":"object","nullable":true,"description":"Recipient data","properties":{"name":{"type":"string","description":"Recipient name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"sourceHost":{"type":"string","nullable":true,"description":"Resource where the order was created\n- fmart — the order was created on the FMART website\n"}}},"ProductShortDto":{"type":"object","description":"Brief product information","additionalProperties":false,"required":["offerId","productId","isActive","type","categoryId","subCategoryId","name","description","url","available","stock","minOrder","price","discount","currencyCode","images","productionTime","shipmentTime","canRent","originalId","isDeliveryPost","isStarred","vat"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"type":{"$ref":"#/components/schemas/ProductType"},"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":500,"description":"Product name"},"description":{"type":"string","nullable":true,"maxLength":20000,"description":"Detailed product description"},"url":{"type":"string","maxLength":20000,"description":"URL of the product page on Udora for customers"},"available":{"type":"integer","minimum":0,"description":"Product availability"},"stock":{"type":"integer","minimum":0,"description":"Product quantity in stock"},"minOrder":{"type":"integer","minimum":0,"description":"Minimum order"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"images":{"type":"array","description":"Image URLs","items":{"type":"string","format":"uri"}},"productionTime":{"type":"integer","minimum":0,"description":"Product production time in minutes"},"shipmentTime":{"type":"integer","minimum":0,"description":"Product delivery time in minutes"},"canRent":{"type":"integer","enum":[0,1,2],"description":"* `0` — the owner has prohibited rental \n* `1` — the owner has allowed rental \n* `2` — Udora has prohibited rental\n","default":0},"originalId":{"type":"integer","format":"int32","minimum":0,"default":0,"description":"Original product ID. If different from 0, the current product is rented"},"isDeliveryPost":{"type":"boolean","description":"Whether the product is delivered by post","default":false},"isStarred":{"type":"boolean","description":"Whether the product is starred. Promoted more actively by the shop","default":false},"vat":{"type":"string","default":"0","description":"VAT rate percentage for the product"}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isActive":{"type":"boolean","description":"Whether the product is active"},"ProductType":{"type":"integer","enum":[1,2,3],"description":"Product type: \n* `1` — regular product, \n* `2` — ready-made product,\n* `3` — additional product.\n"},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/list":{"get":{"tags":["Orders"],"summary":"View the list of orders","operationId":"ordersList","description":"View the list of orders\n","parameters":[{"$ref":"#/components/parameters/ShopId"},{"in":"query","name":"id","schema":{"type":"integer","nullable":true},"description":"Order ID in the Udora system"},{"in":"query","name":"page","schema":{"type":"integer","nullable":true},"description":"Pagination page"},{"in":"query","name":"limit","schema":{"type":"integer","nullable":true,"minimum":1,"maximum":100},"description":"Number of records per page"},{"in":"query","name":"createdDate","schema":{"type":"string","format":"Y-m-d","nullable":true},"description":"Order creation date"},{"in":"query","name":"deliveryDateFrom","schema":{"type":"string","format":"Y-m-d","nullable":true},"description":"Delivery date from"},{"in":"query","name":"deliveryDateTo","schema":{"type":"string","format":"Y-m-d","nullable":true},"description":"Delivery date to"},{"in":"query","name":"deliveryType","schema":{"allOf":[{"$ref":"#/components/schemas/deliveryType"}],"nullable":true,"type":"integer"},"description":"Delivery type"},{"in":"query","name":"status","schema":{"allOf":[{"$ref":"#/components/schemas/status"}],"nullable":true,"type":"integer"},"description":"Order status"},{"in":"query","name":"deliveryTimeType","schema":{"allOf":[{"$ref":"#/components/schemas/deliveryTimeType"}],"nullable":true,"type":"integer"},"description":"Delivery time type"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"List of orders","items":{"$ref":"#/components/schemas/orderItem"}},"total":{"type":"integer","description":"Total number of orders (excluding pagination)"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## View order

> View order<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ShopId":{"name":"shopId","in":"query","required":true,"description":"**Warehouse or shop identifier.**\n\nIt can be obtained using the `POST /apiseller/shops` request\nor in the Udora seller account.\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}},"orderId":{"name":"orderId","in":"query","required":true,"description":"**Order identifier.**\n","schema":{"type":"integer","format":"int32","minimum":1,"maximum":4294967295}}},"schemas":{"orderItem":{"type":"object","properties":{"id":{"type":"integer","nullable":false,"description":"Order ID in the Udora system"},"shopId":{"type":"integer","nullable":false,"description":"Shop ID"},"createdDate":{"type":"integer","nullable":false,"description":"Order creation time"},"status":{"type":"integer","nullable":false,"enum":[1,2,3,4,5,7,10,11,12],"description":"Order status\n- 1 — New\n- 2 — Accepted\n- 3 — Completed\n- 4 — Handed over for delivery\n- 5 — Before-delivery photo\n- 7 — Order is waiting for the customer to pick it up from the shop\n- 10 — Postal status. Order assembled\n- 11 — Postal status. Order is being delivered by post\n- 12 — Postal status. Order is waiting for pickup at the post office\n"},"deliveryType":{"nullable":false,"type":"integer","enum":[0,1,2,4,5,10,11,12,20,21,22,23,24,26,32,33,34],"description":"Delivery type\n- 0 — Courier is absent / Delivery method is not selected\n- 1 — Delivery by seller's courier\n- 2 — Seller's own delivery\n- 4 — Pickup\n- 5 — Udora delivery\n- 10 — Delivery by walking courier\n- 11 — Delivery by car courier\n- 12 — Delivery by courier using transport\n- 20 — Delivery by florist on foot\n- 21 — Delivery by florist by car\n- 22 — Delivery by florist using transport\n- 23 — Delivery by Yandex Delivery\n- 24 — Delivery by florist by bicycle\n- 26 — Delivery by Gett delivery\n- 32 — Delivery by SberMarket\n- 33 — Delivery by Magnit\n- 34 — Delivery of digital products (certificates)\n"},"deliveryTimeType":{"nullable":false,"type":"integer","enum":[0,1,2],"description":"Delivery time type\n- 0 — Agree the time with the recipient\n- 1 — As soon as possible\n- 2 — Within a time interval\n"},"deliveryDateFrom":{"type":"integer","nullable":false,"description":"Delivery time from"},"deliveryDateTo":{"type":"integer","nullable":false,"description":"Delivery time to"},"address":{"type":"string","nullable":false,"description":"Delivery address. Separated from detailed address information by the ';' character"},"courierInfo":{"type":"string","nullable":false,"description":"Comment for the courier"},"shopAdditionalInfo":{"type":"string","nullable":false,"description":"Comment for the shop"},"comment":{"type":"string","nullable":true,"description":"Customer comment"},"photoBeforeUrl":{"type":"string","nullable":true,"description":"Before-delivery photo"},"photoAfterUrl":{"type":"string","nullable":true,"description":"After-delivery photo"},"message":{"type":"string","nullable":false,"description":"Postcard text. If present, the products section will contain an item with postcard data"},"products":{"type":"array","description":"Order products","items":{"allOf":[{"$ref":"#/components/schemas/ProductShortDto"},{"type":"object","properties":{"count":{"type":"integer","description":"Product quantity in the order"},"cost":{"type":"string","description":"Price within the order"}},"required":["count","cost"]}]}},"user":{"type":"object","nullable":true,"description":"Customer data","properties":{"name":{"type":"string","description":"Customer name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"recipient":{"type":"object","nullable":true,"description":"Recipient data","properties":{"name":{"type":"string","description":"Recipient name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"sourceHost":{"type":"string","nullable":true,"description":"Resource where the order was created\n- fmart — the order was created on the FMART website\n"}}},"ProductShortDto":{"type":"object","description":"Brief product information","additionalProperties":false,"required":["offerId","productId","isActive","type","categoryId","subCategoryId","name","description","url","available","stock","minOrder","price","discount","currencyCode","images","productionTime","shipmentTime","canRent","originalId","isDeliveryPost","isStarred","vat"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"type":{"$ref":"#/components/schemas/ProductType"},"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":500,"description":"Product name"},"description":{"type":"string","nullable":true,"maxLength":20000,"description":"Detailed product description"},"url":{"type":"string","maxLength":20000,"description":"URL of the product page on Udora for customers"},"available":{"type":"integer","minimum":0,"description":"Product availability"},"stock":{"type":"integer","minimum":0,"description":"Product quantity in stock"},"minOrder":{"type":"integer","minimum":0,"description":"Minimum order"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"images":{"type":"array","description":"Image URLs","items":{"type":"string","format":"uri"}},"productionTime":{"type":"integer","minimum":0,"description":"Product production time in minutes"},"shipmentTime":{"type":"integer","minimum":0,"description":"Product delivery time in minutes"},"canRent":{"type":"integer","enum":[0,1,2],"description":"* `0` — the owner has prohibited rental \n* `1` — the owner has allowed rental \n* `2` — Udora has prohibited rental\n","default":0},"originalId":{"type":"integer","format":"int32","minimum":0,"default":0,"description":"Original product ID. If different from 0, the current product is rented"},"isDeliveryPost":{"type":"boolean","description":"Whether the product is delivered by post","default":false},"isStarred":{"type":"boolean","description":"Whether the product is starred. Promoted more actively by the shop","default":false},"vat":{"type":"string","default":"0","description":"VAT rate percentage for the product"}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isActive":{"type":"boolean","description":"Whether the product is active"},"ProductType":{"type":"integer","enum":[1,2,3],"description":"Product type: \n* `1` — regular product, \n* `2` — ready-made product,\n* `3` — additional product.\n"},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/view":{"get":{"tags":["Orders"],"summary":"View order","operationId":"ordersView","description":"View order\n","parameters":[{"$ref":"#/components/parameters/ShopId"},{"$ref":"#/components/parameters/orderId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderItem"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Change order status to Accepted

> Moves the order to the Accepted status.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/accept":{"post":{"tags":["Orders"],"summary":"Change order status to Accepted","operationId":"ordersToAccept","description":"Moves the order to the Accepted status.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Change order status to Rejected

> Moves the order to the Rejected status.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/refuse":{"post":{"tags":["Orders"],"summary":"Change order status to Rejected","operationId":"ordersToRefuse","description":"Moves the order to the Rejected status.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId","reason"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"},"reason":{"type":"integer","description":"Reasons for order rejection by the shop.\n\nPossible values:\n\n1 — Product is out of stock  \n2 — Delivery cannot be completed on time  \n3 — Incorrect city  \n4 — Customer refusal  \n5 — CRM order refusal  \n6 — Other reason\n","enum":[1,2,3,4,5,6]},"reasonText":{"type":"string","maxLength":255,"description":"Reason text for the rejection.\nRequired if `reason = 6` (Other reason).\n"},"commentClient":{"type":"string","maxLength":700,"description":"Comment for the customer.\n"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Change order status to "Handed over for delivery"

> Moves the order to the Handed over for delivery status.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/courierLeft":{"post":{"tags":["Orders"],"summary":"Change order status to \"Handed over for delivery\"","operationId":"ordersToCourierLeft","description":"Moves the order to the Handed over for delivery status.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Change order status to "Order assembled" (postal status)

> Moves the order to the Order assembled status (postal status).<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/pack":{"post":{"tags":["Orders"],"summary":"Change order status to \"Order assembled\" (postal status)","operationId":"ordersToPack","description":"Moves the order to the Order assembled status (postal status).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Change order status to "Completed"

> Moves the order to the Completed status.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/finish":{"post":{"tags":["Orders"],"summary":"Change order status to \"Completed\"","operationId":"ordersToFinish","description":"Moves the order to the Completed status.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderId"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Upload before and after delivery photos

> Upload before and after delivery photos<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Orders","description":"Order actions"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"orderId":{"type":"integer","format":"int32","description":"Order identifier"},"orderItem":{"type":"object","properties":{"id":{"type":"integer","nullable":false,"description":"Order ID in the Udora system"},"shopId":{"type":"integer","nullable":false,"description":"Shop ID"},"createdDate":{"type":"integer","nullable":false,"description":"Order creation time"},"status":{"type":"integer","nullable":false,"enum":[1,2,3,4,5,7,10,11,12],"description":"Order status\n- 1 — New\n- 2 — Accepted\n- 3 — Completed\n- 4 — Handed over for delivery\n- 5 — Before-delivery photo\n- 7 — Order is waiting for the customer to pick it up from the shop\n- 10 — Postal status. Order assembled\n- 11 — Postal status. Order is being delivered by post\n- 12 — Postal status. Order is waiting for pickup at the post office\n"},"deliveryType":{"nullable":false,"type":"integer","enum":[0,1,2,4,5,10,11,12,20,21,22,23,24,26,32,33,34],"description":"Delivery type\n- 0 — Courier is absent / Delivery method is not selected\n- 1 — Delivery by seller's courier\n- 2 — Seller's own delivery\n- 4 — Pickup\n- 5 — Udora delivery\n- 10 — Delivery by walking courier\n- 11 — Delivery by car courier\n- 12 — Delivery by courier using transport\n- 20 — Delivery by florist on foot\n- 21 — Delivery by florist by car\n- 22 — Delivery by florist using transport\n- 23 — Delivery by Yandex Delivery\n- 24 — Delivery by florist by bicycle\n- 26 — Delivery by Gett delivery\n- 32 — Delivery by SberMarket\n- 33 — Delivery by Magnit\n- 34 — Delivery of digital products (certificates)\n"},"deliveryTimeType":{"nullable":false,"type":"integer","enum":[0,1,2],"description":"Delivery time type\n- 0 — Agree the time with the recipient\n- 1 — As soon as possible\n- 2 — Within a time interval\n"},"deliveryDateFrom":{"type":"integer","nullable":false,"description":"Delivery time from"},"deliveryDateTo":{"type":"integer","nullable":false,"description":"Delivery time to"},"address":{"type":"string","nullable":false,"description":"Delivery address. Separated from detailed address information by the ';' character"},"courierInfo":{"type":"string","nullable":false,"description":"Comment for the courier"},"shopAdditionalInfo":{"type":"string","nullable":false,"description":"Comment for the shop"},"comment":{"type":"string","nullable":true,"description":"Customer comment"},"photoBeforeUrl":{"type":"string","nullable":true,"description":"Before-delivery photo"},"photoAfterUrl":{"type":"string","nullable":true,"description":"After-delivery photo"},"message":{"type":"string","nullable":false,"description":"Postcard text. If present, the products section will contain an item with postcard data"},"products":{"type":"array","description":"Order products","items":{"allOf":[{"$ref":"#/components/schemas/ProductShortDto"},{"type":"object","properties":{"count":{"type":"integer","description":"Product quantity in the order"},"cost":{"type":"string","description":"Price within the order"}},"required":["count","cost"]}]}},"user":{"type":"object","nullable":true,"description":"Customer data","properties":{"name":{"type":"string","description":"Customer name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"recipient":{"type":"object","nullable":true,"description":"Recipient data","properties":{"name":{"type":"string","description":"Recipient name"},"phone":{"type":"string","description":"Phone"}},"required":["name","phone"]},"sourceHost":{"type":"string","nullable":true,"description":"Resource where the order was created\n- fmart — the order was created on the FMART website\n"}}},"ProductShortDto":{"type":"object","description":"Brief product information","additionalProperties":false,"required":["offerId","productId","isActive","type","categoryId","subCategoryId","name","description","url","available","stock","minOrder","price","discount","currencyCode","images","productionTime","shipmentTime","canRent","originalId","isDeliveryPost","isStarred","vat"],"properties":{"offerId":{"$ref":"#/components/schemas/OfferId"},"productId":{"$ref":"#/components/schemas/ProductId"},"isActive":{"$ref":"#/components/schemas/isActive"},"type":{"$ref":"#/components/schemas/ProductType"},"categoryId":{"$ref":"#/components/schemas/RangeGroupId"},"subCategoryId":{"$ref":"#/components/schemas/RangeTypeId"},"name":{"type":"string","maxLength":500,"description":"Product name"},"description":{"type":"string","nullable":true,"maxLength":20000,"description":"Detailed product description"},"url":{"type":"string","maxLength":20000,"description":"URL of the product page on Udora for customers"},"available":{"type":"integer","minimum":0,"description":"Product availability"},"stock":{"type":"integer","minimum":0,"description":"Product quantity in stock"},"minOrder":{"type":"integer","minimum":0,"description":"Minimum order"},"price":{"$ref":"#/components/schemas/PriceString"},"discount":{"$ref":"#/components/schemas/DiscountString"},"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"images":{"type":"array","description":"Image URLs","items":{"type":"string","format":"uri"}},"productionTime":{"type":"integer","minimum":0,"description":"Product production time in minutes"},"shipmentTime":{"type":"integer","minimum":0,"description":"Product delivery time in minutes"},"canRent":{"type":"integer","enum":[0,1,2],"description":"* `0` — the owner has prohibited rental \n* `1` — the owner has allowed rental \n* `2` — Udora has prohibited rental\n","default":0},"originalId":{"type":"integer","format":"int32","minimum":0,"default":0,"description":"Original product ID. If different from 0, the current product is rented"},"isDeliveryPost":{"type":"boolean","description":"Whether the product is delivered by post","default":false},"isStarred":{"type":"boolean","description":"Whether the product is starred. Promoted more actively by the shop","default":false},"vat":{"type":"string","default":"0","description":"VAT rate percentage for the product"}}},"OfferId":{"type":"string","maxLength":50,"nullable":true,"description":"Product identifier in the seller's system."},"ProductId":{"type":"integer","format":"int32","minimum":1,"nullable":true,"description":"Product identifier in the Udora system"},"isActive":{"type":"boolean","description":"Whether the product is active"},"ProductType":{"type":"integer","enum":[1,2,3],"description":"Product type: \n* `1` — regular product, \n* `2` — ready-made product,\n* `3` — additional product.\n"},"RangeGroupId":{"type":"integer","description":"Product category identifier","minimum":1},"RangeTypeId":{"type":"integer","description":"Product subcategory identifier","minimum":1},"PriceString":{"type":"string","description":"Price before discounts, with the fractional part separated by a dot.","pattern":"^[0-9]+(\\.[0-9]{1,2})?$"},"DiscountString":{"type":"string","description":"Discount percentage applied to the price. Integer number.","pattern":"^[0-9]+$"},"CurrencyCode":{"type":"string","description":"Shop currency code (ISO 4217).","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTC","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MTL","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XCD","XDR","XOF","XPD","XPF","XPT","YER","ZAR","ZMK","ZMW","ZWL"]},"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/apiseller/orders/uploadPhoto":{"post":{"tags":["Orders"],"summary":"Upload before and after delivery photos","operationId":"uploadPhoto","description":"Upload before and after delivery photos\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["orderId","shopId","type","photo"],"properties":{"orderId":{"$ref":"#/components/schemas/orderId"},"shopId":{"type":"integer","description":"Shop ID"},"type":{"type":"integer","enum":[0,1],"description":"Photo type (0 - before delivery, 1 - after delivery)","default":0},"photo":{"type":"string","format":"binary","description":"Photo in JPEG or PNG format"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderItem"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Webhook

*Webhook management and testing.*\
\
We will send HTTP POST requests to your endpoint in JSON format. Here is an example request body:

```js
{
  "uuid": "558e8b80-e29b-41dc-a716-44655448888",
  "event": "order.paid",
  "shopId": 1123,
  "order": {"id": 98765}
}
```

#### Fields

* <mark style="color:red;">uuid</mark> — the unique ID of this webhook delivery. The UUID remains unchanged across retry attempts.
* <mark style="color:red;">event</mark> — the event type, such as an order status change.
* <mark style="color:red;">order.id</mark> — the order ID in our system.

Each request will include the following headers:

* <mark style="color:$info;">**Content-Type: application/json**</mark> — always included.
* <mark style="color:$info;">**X-Webhook-Signature: sha256=**</mark> — included only if you have provided a secret key.

To verify that the request is authentic, calculate the `HMAC-SHA256` hash of the request body using your secret key and compare it with the value received in the `X-Webhook-Signature` header. If the values match, the request is authentic.

{% hint style="warning" %}

#### Important information about webhook processing

Our system guarantees delivery but does not guarantee that an event will be delivered only once. If your server does not return a successful response, we will retry the request every 5 minutes, up to 28 times.

The <mark style="color:red;">uuid</mark> field remains unchanged across all retry attempts.

Please implement duplicate protection on your side. Store the received <mark style="color:red;">uuid</mark> values and, if you receive the same <mark style="color:red;">uuid</mark> again, ignore the request without processing it again.
{% endhint %}

#### Supported event types

* <mark style="color:green;">order.paid</mark> — a new order. Sent when the customer has successfully paid for the order. The order must be accepted.
* <mark style="color:green;">order.cancelled</mark> — the order has been cancelled. Sent when the order is cancelled by the customer or by the system.
* <mark style="color:green;">order.finished</mark> — the order has been completed. Sent when the order has been successfully delivered and closed.
* <mark style="color:green;">test</mark> — a test event. Sent manually when testing the webhook connection.

## Test webhook operation

> Sends a test request to the configured holding webhook URL.\
> \
> The \`test\` event will be sent in the request body to the webhook address.\
> The method always returns HTTP 200; the sending result (response code\
> and error text in case of failure) is included in the response body.<br>

```json
{"openapi":"3.0.0","info":{"title":"Open API for sellers","version":"0.0.1"},"tags":[{"name":"Webhook","description":"Webhook management and testing"}],"servers":[{"description":"live","url":"https://apis.udora.com"}],"security":[{"bearerToken":[]}],"components":{"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"description":"Too Many Requests","headers":{"Retry-After":{"description":"How many seconds to wait before retrying the request","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"properties":{"message":{"type":"string","description":"General error description"},"fields":{"type":"array","description":"Array with additional field validation errors","title":"fields","items":{"properties":{"path":{"type":"string","description":"Error field"},"messages":{"type":"array","description":"Array with errors","items":{"type":"string"}}}}},"trace":{"type":"object","nullable":true,"description":"Error trace (not available for LIVE)"}},"required":["message"]}}},"paths":{"/apiseller/webhook/test":{"post":{"tags":["Webhook"],"summary":"Test webhook operation","operationId":"webhookTest","description":"Sends a test request to the configured holding webhook URL.\n\nThe `test` event will be sent in the request body to the webhook address.\nThe method always returns HTTP 200; the sending result (response code\nand error text in case of failure) is included in the response body.\n","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["message","httpCode"],"properties":{"message":{"type":"string","description":"Error text if sending fails; empty string on success"},"httpCode":{"type":"integer","description":"HTTP status of the webhook response; 0 if the connection was not established"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://seller-docs.flowwow.com/product-docs-eng/integrations-and-api/udora-seller-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
