KUPA-350%100 pamuk, regular fit.
", "DispatchPeriod": 2, "Volume": 1, "VariantName1": "Renk", "VariantName2": "Beden", "Images": [ { "Url": "https://cdn.example.com/tshirt-001-1.jpg" }, { "Url": "https://cdn.example.com/tshirt-001-2.jpg" } ], "Variants": [ { "Code": "TSHIRT-001-BLK-M", "Barcode": "8690000000024", "Quantity": 10, "Price": 249.9, "VariantValue1": "Siyah", "VariantValue2": "M" }, { "Code": "TSHIRT-001-BLK-L", "Barcode": "8690000000031", "Quantity": 20, "Price": 249.9, "VariantValue1": "Siyah", "VariantValue2": "L" } ], "Specs": [ { "Name": "Materyal", "Value": "Pamuk" } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Response": { "type": "integer", "description": "The new product's `ProductId`. With 70004 it is the ID of the existing product that has the same code." } } } } } ] }, "example": { "Result": true, "Response": 987654 } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProduct": { "post": { "operationId": "UpdateProduct", "tags": [ "Products" ], "summary": "Update a product", "description": "**Update a product** — Rewrites an existing product's data, variants and specs with the values you send. It does not change images or the product code.\n\nThis is not a partial update; it rewrites the whole product. Required fields and 00003 messages are the same as in `AddProduct` (`ProductSourceId`, `CurrencyId`, `Price` > 0, `Code`, `Name`, `Category`). Optional fields you omit are cleared: `Barcode`, `Brand`, `Model`, `Subtitle`, `Code2`, `Mpn`, `SellerNote` and `VariantName1`–`VariantName6` become empty; `TaxRate`, `MarketPrice`, `Volume`, `Width`, `Length`, `Height`, `Weight` become 0; `DispatchPeriod` becomes -1; `Description` becomes empty (unless you send `UpdateProductDescription: false`). Read the product with `GetProduct` first and send all fields back.\n\nSome values managed only in the StockMount panel are also reset on every update: sold count (`SoldCount`), minimum sale price, product page URL, meta/SEO fields, invoice name and warranty data. Updated variants also get their sold count reset to 0.\n\nNot changed: images (`Images` and variant image fields are ignored; use `UpdateProductImages`), `Price2`–`Price5`, and the product code (use `SetProductCode`).\n\nThe product is found by `ProductId`, and `Code` must be the product's current code in the source. If the code does not exist in the source, 70005 is returned (`Message`: `There is no product with the given ProductId`); if the code belongs to another product, 70004 is returned with `Result: false` (`Message`: `Product code does not exist`). With `UpdateProductByCode: true`, `ProductId` is not needed: the product is found by `ProductSourceId` + `Code`, and 70005 is returned if it does not exist. For these two errors the text is in `Message`, not `ErrorMessage`.\n\nThe status is recalculated from stock: `Quantity` below 1 gives 3 (stopped / out of stock), otherwise 2 (changed). So a product stopped with `StopProduct` becomes active again when you send stock above 0.\n\nIf you send `Variants`, they are matched by `Code`: matches are updated, new codes are added without an image, and existing variants missing from the list are made passive. Passive variants are not deleted and still appear in `GetProduct`. Empty or omitted `Variants` leaves variants untouched. If you send `Specs`, the whole spec list is replaced; if you omit it, stored specs are kept.\n\nOn success `Response` is the product's `ProductId`, and the product is queued for sync to the active stores where it is listed. This call never returns 70013 (not changed); the record is rewritten even if nothing changed. Category auto-creation, length limits and HTML cleaning work as in `AddProduct`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductId": { "type": "integer", "description": "ID of the product to update. Required unless `UpdateProductByCode` is `true`; a value below 1 returns 00003 (`ErrorMessage`: `ProductId is missing`)." }, "ProductSourceId": { "type": "integer", "description": "StockMount-type source that holds the product (`GetProductSources`). Returns 70002 if the source is not in your account and 70003 if it is not a StockMount-type source." }, "Code": { "type": "string", "description": "The product's current code in the source. It is used to verify the product; you cannot change the code with this call (use `SetProductCode`). Max 50 characters." }, "Name": { "type": "string", "description": "Product name. Max 400 characters." }, "Category": { "type": "string", "description": "Category name (not an ID). Created automatically if the source does not have it yet. See `GetProductCategories` for existing names." }, "Price": { "type": "number", "description": "Sale price. Must be greater than 0, otherwise 00003 (`Price is missing`) is returned. Stored with 2 decimals." }, "CurrencyId": { "type": "integer", "description": "Currency ID (`GetCurrencies`; e.g. 4 = TRY, 2 = USD, 3 = EUR). A value below 1 returns 00003. The API does not check that the ID exists, so send a valid one." }, "Quantity": { "type": "integer", "description": "Stock quantity. Defaults to 0. Negative values are not rejected. For products with variants, send the total yourself; it is not calculated from variant stock. The status is recalculated from it (below 1 gives 3, otherwise 2)." }, "MarketPrice": { "type": "number", "description": "Market (list) price, usually higher than `Price` and used to show a discount. Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "TaxRate": { "type": "number", "description": "VAT rate as a percentage (e.g. `20`). The API does not enforce a list of allowed values. Stored as 0 when omitted. In `UpdateProduct`, omitting it resets the value to 0." }, "Barcode": { "type": "string", "description": "Product barcode. Max 30 characters. No format or special-character check is done. In `UpdateProduct`, omitting it clears the stored value." }, "Brand": { "type": "string", "description": "Brand. Max 30 characters. In `UpdateProduct`, omitting it clears the stored value." }, "Model": { "type": "string", "description": "Model. Max 30 characters. In `UpdateProduct`, omitting it clears the stored value." }, "Code2": { "type": "string", "description": "Secondary product code. Max 50 characters. In `UpdateProduct`, omitting it clears the stored value." }, "Mpn": { "type": "string", "description": "Manufacturer part number (MPN). Max 50 characters. In `UpdateProduct`, omitting it clears the stored value." }, "Subtitle": { "type": "string", "description": "Subtitle. Max 400 characters. In `UpdateProduct`, omitting it clears the stored value." }, "Description": { "type": "string", "description": "Product description; may contain HTML. Unsafe HTML (e.g. scripts) is removed. Stored as empty when omitted. If `UpdateProductDescription` is `false`, the stored description is kept." }, "UpdateProductDescription": { "type": "boolean", "description": "Send `false` to leave the description unchanged. Default `true`." }, "DispatchPeriod": { "type": "integer", "description": "Dispatch (handling) time in days. Defaults to -1 (not set). In `UpdateProduct`, omitting it resets the value to -1." }, "Volume": { "type": "number", "description": "Volume / volumetric weight (desi). Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "Width": { "type": "number", "description": "Width. Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "Length": { "type": "number", "description": "Length. Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "Height": { "type": "number", "description": "Height. Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "Weight": { "type": "number", "description": "Weight. Defaults to 0. In `UpdateProduct`, omitting it resets the value to 0." }, "SellerNote": { "type": "string", "description": "Seller note. Max 150 characters. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName1": { "type": "string", "description": "Name of variant attribute 1 (e.g. `Color`). Max 30 characters. Required when any variant has `VariantValue1`; otherwise 00003 (`VariantName1 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName2": { "type": "string", "description": "Name of variant attribute 2 (e.g. `Size`). Max 30 characters. Required when any variant has `VariantValue2`; otherwise 00003 (`VariantName2 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName3": { "type": "string", "description": "Name of variant attribute 3 (e.g. `Size`). Max 30 characters. Required when any variant has `VariantValue3`; otherwise 00003 (`VariantName3 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName4": { "type": "string", "description": "Name of variant attribute 4 (e.g. `Size`). Max 30 characters. Required when any variant has `VariantValue4`; otherwise 00003 (`VariantName4 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName5": { "type": "string", "description": "Name of variant attribute 5 (e.g. `Size`). Max 30 characters. Required when any variant has `VariantValue5`; otherwise 00003 (`VariantName5 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "VariantName6": { "type": "string", "description": "Name of variant attribute 6 (e.g. `Size`). Max 30 characters. Required when any variant has `VariantValue6`; otherwise 00003 (`VariantName6 is missing`) is returned. In `UpdateProduct`, omitting it clears the stored value." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code. Updates match variants by this code, so send a non-empty value that is unique within the product. Max 50 characters." }, "Barcode": { "type": "string", "description": "Variant barcode. Leading and trailing spaces are trimmed. Max 30 characters." }, "Quantity": { "type": "integer", "description": "Variant stock. Negative values are stored as 0." }, "Price": { "type": "number", "description": "Variant price. Stored as 0 when omitted." }, "VariantValue1": { "type": "string", "description": "Value of variant attribute 1 (e.g. `Black`). Max 100 characters." }, "VariantValue2": { "type": "string", "description": "Value of variant attribute 2 (e.g. `M`). Max 100 characters." }, "VariantValue3": { "type": "string", "description": "Value of variant attribute 3 (e.g. `M`). Max 100 characters." }, "VariantValue4": { "type": "string", "description": "Value of variant attribute 4 (e.g. `M`). Max 100 characters." }, "VariantValue5": { "type": "string", "description": "Value of variant attribute 5 (e.g. `M`). Max 100 characters." }, "VariantValue6": { "type": "string", "description": "Value of variant attribute 6 (e.g. `M`). Max 100 characters." }, "Code2": { "type": "string", "description": "Secondary variant code. Max 50 characters. If empty, the variant's position in the array (`0`, `1`, `2`…) is stored." }, "Mpn": { "type": "string", "description": "Variant manufacturer part number. Max 50 characters." } } }, "description": "Variant list. When sent, variants are matched by `Code`: matches are updated, new codes are added without an image, and existing variants missing from the list are made passive. Empty or omitted leaves variants untouched. Image fields (`ImageUrl`, `ImageBase64`) are ignored." }, "Specs": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Spec name (e.g. `Material`). Max 50 characters." }, "Value": { "type": "string", "description": "Spec value (e.g. `Cotton`). Max 100 characters." } } }, "description": "Product specs. When sent, the whole stored spec list is replaced; when omitted, stored specs are kept." }, "UpdateProductByCode": { "type": "boolean", "description": "When `true`, `ProductId` is not needed; the product is found by `ProductSourceId` + `Code`. Returns 70005 if not found. Default `false`." } }, "required": [ "ApiCode", "ProductSourceId", "Code", "Name", "Category", "Price", "CurrencyId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 987654, "ProductSourceId": 1234, "Code": "TSHIRT-001", "Name": "Basic Pamuklu Tişört", "Category": "Tişört", "Price": 229.9, "MarketPrice": 299.9, "CurrencyId": 4, "TaxRate": 20, "Quantity": 25, "Barcode": "8690000000017", "Brand": "Örnek Marka", "Model": "BSC-01", "Description": "%100 pamuk, regular fit.
", "DispatchPeriod": 2, "Volume": 1, "VariantName1": "Renk", "VariantName2": "Beden", "Variants": [ { "Code": "TSHIRT-001-BLK-M", "Barcode": "8690000000024", "Quantity": 5, "Price": 229.9, "VariantValue1": "Siyah", "VariantValue2": "M" }, { "Code": "TSHIRT-001-BLK-L", "Barcode": "8690000000031", "Quantity": 20, "Price": 229.9, "VariantValue1": "Siyah", "VariantValue2": "L" } ], "Specs": [ { "Name": "Materyal", "Value": "Pamuk" } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Response": { "type": "integer", "description": "The updated product's `ProductId`." } } } } } ] }, "example": { "Result": true, "Response": 987654 } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/DeleteProduct": { "post": { "operationId": "DeleteProduct", "tags": [ "Products" ], "summary": "Delete a product (removed)", "description": "**Delete a product (removed)** — This endpoint was removed on 1 July 2025 and returns HTTP 410 for every call.\n\nAs long as the body is valid JSON, HTTP 410 (Gone) is returned without checking `ApiCode` or the package. An empty or malformed body gets the ASP.NET 400 error first. The response body has no `ErrorCode` and the message is Turkish only.\n\nProducts can no longer be deleted through the API. To take a product off sale, use `StopProduct` or send `Quantity: 0` with `UpdateProduct`.\n\n⚠ This endpoint changes real data in your account.\n\nhttps://outsample.stockmount.com/en/api/Product/DeleteProduct", "deprecated": true, "responses": { "410": { "description": "Removed" } } } }, "/api/Product/StopProduct": { "post": { "operationId": "StopProduct", "tags": [ "Products" ], "summary": "Stop a product", "description": "**Stop a product** — Sets the product status to 3 (stopped). The product is not deleted and its stock is not changed.\n\nOnly `ProductId` is read; other fields are ignored. The source type is not checked, so any product in your account can be stopped. Status 3 is also the status of products with zero stock.\n\nTo make the product active again, send `UpdateProduct` with `Quantity` above 0; the status becomes 2.\n\nIf the product is not found or is not yours, 99999 is returned with no `ErrorMessage`. A successful response has no `Response`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/StopProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductId": { "type": "integer", "description": "ID of the product to stop. A value below 1 returns 00003 (`ErrorMessage`: `ProductId`)." } }, "required": [ "ApiCode", "ProductId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 987654 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "nullable": true } } } ] }, "example": { "Result": true } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/GetProduct": { "post": { "operationId": "GetProduct", "tags": [ "Products" ], "summary": "Get a product", "description": "**Get a product** — Returns one product with its images, variants and specs. Find it by `ProductId` or by `ProductSourceId` + `Code`.\n\nIf `ProductId` is above 0, the product is looked up only by that ID across all your sources and `Code` is ignored. Without `ProductId`, `Code` and `ProductSourceId` are both required. If neither is sent, 00003 is returned (`ErrorMessage`: `ProductId`); `Code` without a source returns 00003 (`ErrorMessage`: `ProductSourceId`). An unknown product returns 70005 (`Product was not found!`). Stopped products (status 3) are returned; products deleted with the retired `DeleteProduct` are not.\n\nVariants and specs are loaded only when you query by `ProductId`. When you query by `Code`, `Variants` is an empty array and `Specs` is missing from the response.\n\n`Variants` also contains variants made passive by `UpdateProduct`, and the variant status is not returned; variants come in creation order.\n\nSome fields are not read and always come back with a fixed value: `Weight`, `StoreId`, `Price2`–`Price5` are 0; `UpdateProductByCode` and `SetProductQuantityFromVariants` are `false`; `UpdateProductDescription` is `true`; in variants, `CurrencyId`, `MinSalePrice` and `Price2`–`Price5` are 0. `VariantName5`, `VariantName6`, `VariantValue5`, `VariantValue6` and `Mpn` are not returned. Fields whose value is `null` are omitted from the response.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/GetProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductId": { "type": "integer", "description": "Product ID. When sent, the other lookup fields are ignored." }, "Code": { "type": "string", "description": "Product code. Used when `ProductId` is not sent; matched exactly." }, "ProductSourceId": { "type": "integer", "description": "Required when querying by `Code`: the source to search." } }, "required": [ "ApiCode" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 987654 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "Product ID." }, "ProductSourceId": { "type": "integer", "description": "Source of the product." }, "Code": { "type": "string", "description": "Product code." }, "Code2": { "type": "string", "description": "Secondary product code." }, "Name": { "type": "string", "description": "Product name." }, "Subtitle": { "type": "string", "description": "Subtitle." }, "Description": { "type": "string", "description": "Description (HTML, cleaned)." }, "Barcode": { "type": "string", "description": "Barcode. If a second (integration-level) barcode is set for the product, that one is returned." }, "Brand": { "type": "string", "description": "Brand." }, "Model": { "type": "string", "description": "Model." }, "Category": { "type": "string", "description": "Category name." }, "Price": { "type": "number", "description": "Sale price." }, "MarketPrice": { "type": "number", "description": "Market (list) price; 0 if none." }, "CurrencyId": { "type": "integer", "description": "Currency ID." }, "TaxRate": { "type": "number", "description": "VAT rate; 0 if none." }, "Quantity": { "type": "integer", "description": "Stock quantity." }, "SoldCount": { "type": "integer", "description": "Sold count." }, "Status": { "type": "integer", "description": "Product status.\n\n- `0`: Not changed\n- `1`: New (initial status of products added through the API)\n- `2`: Changed (after `UpdateProduct` when stock is above 0)\n- `3`: Stopped / out of stock (`StopProduct`, or stock below 1)\n- `4`: Re-added" }, "Volume": { "type": "number", "description": "Volume / desi (the second value if one is set)." }, "Width": { "type": "number", "description": "Width." }, "Length": { "type": "number", "description": "Length." }, "Height": { "type": "number", "description": "Height." }, "Weight": { "type": "number", "description": "Always 0 (the stored value is not returned)." }, "Url": { "type": "string", "description": "Product page URL; empty if none." }, "CreationTime": { "type": "string", "description": "Creation time without a time zone suffix (e.g. `2025-11-05T10:22:31.497`)." }, "VariantName1": { "type": "string", "description": "Name of variant attribute 1 (`VariantName2`–`VariantName4` are returned too; 5 and 6 are not)." }, "DispatchPeriod": { "type": "integer", "description": "Dispatch time in days; -1 = not set." }, "SellerNote": { "type": "string", "description": "Seller note." }, "Images": { "type": "array", "items": { "type": "object", "properties": { "Order": { "type": "integer", "description": "Zero-based position." }, "Url": { "type": "string", "description": "Image URL." } } }, "description": "Images, up to 12." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID." }, "Code": { "type": "string", "description": "Variant code." }, "Barcode": { "type": "string", "description": "Variant barcode." }, "Price": { "type": "number", "description": "Variant price." }, "Quantity": { "type": "integer", "description": "Variant stock." }, "ImageUrl": { "type": "string", "description": "Variant image URL." }, "VariantValue1": { "type": "string", "description": "Value of variant attribute 1." }, "VariantValue2": { "type": "string", "description": "Value of variant attribute 2." }, "VariantValue3": { "type": "string", "description": "Value of variant attribute 3." }, "VariantValue4": { "type": "string", "description": "Value of variant attribute 4." }, "CurrencyId": { "type": "integer", "description": "Always 0 (not read)." }, "MinSalePrice": { "type": "number", "description": "Always 0 (not read)." }, "Price2": { "type": "number", "description": "Always 0 (so are `Price3`, `Price4`, `Price5`)." } } }, "description": "Variants. Filled only when queried by `ProductId`; passive variants are included." }, "Specs": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Spec name." }, "Value": { "type": "string", "description": "Spec value." } } }, "description": "Specs. Returned only when queried by `ProductId`." }, "StoreId": { "type": "integer", "description": "Always 0 (request-only field)." }, "Price2": { "type": "number", "description": "Always 0 (so are `Price3`, `Price4`, `Price5`)." }, "UpdateProductByCode": { "type": "boolean", "description": "Always `false` (request-only field)." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "Always `false` (request-only field)." }, "UpdateProductDescription": { "type": "boolean", "description": "Always `true` (request-only field)." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 987654, "ProductSourceId": 1234, "Description": "%100 pamuk, regular fit.
", "Code": "TSHIRT-001", "Code2": "", "Barcode": "8690000000017", "Name": "Basic Pamuklu Tişört", "Subtitle": "", "Price": 249.9, "Quantity": 30, "Brand": "Örnek Marka", "TaxRate": 20.0, "Model": "BSC-01", "Category": "Tişört", "CurrencyId": 4, "Images": [ { "Order": 0, "Url": "https://cdn.example.com/tshirt-001-1.jpg" }, { "Order": 1, "Url": "https://cdn.example.com/tshirt-001-2.jpg" } ], "MarketPrice": 299.9, "Status": 1, "Volume": 1.0, "Height": 0.0, "Length": 0.0, "Width": 0.0, "VariantName1": "Renk", "VariantName2": "Beden", "Variants": [ { "ProductVariantId": 5550001, "Code": "TSHIRT-001-BLK-M", "Price": 249.9, "Price2": 0.0, "Price3": 0.0, "Price4": 0.0, "Price5": 0.0, "Quantity": 10, "Barcode": "8690000000024", "CurrencyId": 0, "ImageUrl": "", "VariantValue1": "Siyah", "VariantValue2": "M", "VariantValue3": "", "VariantValue4": "", "MinSalePrice": 0.0 } ], "Specs": [ { "Name": "Materyal", "Value": "Pamuk" } ], "Url": "", "StoreId": 0, "Weight": 0.0, "CreationTime": "2025-11-05T10:22:31.497", "UpdateProductByCode": false, "SetProductQuantityFromVariants": false, "DispatchPeriod": 2, "Price2": 0.0, "Price3": 0.0, "Price4": 0.0, "Price5": 0.0, "UpdateProductDescription": true, "SoldCount": 0, "SellerNote": "" } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/GetProducts": { "post": { "operationId": "GetProducts", "tags": [ "Products" ], "summary": "List products", "description": "**List products** — Returns the products of one source, filtered, sorted and paged.\n\n`PageIndex` starts at 1; values below 1 are treated as 1. `RowsByPage` is 100 when omitted or 0, and at most 100 (larger values become 100, negative values become 1). Compute the page count from `FilteredProductCount` and `RowsByPage`.\n\n`OrderBy` must be one of (case-insensitive): `Name`, `ProductId`, `Category`, `Price`, `Quantity`, `Status`, `CurrencyId`. An invalid value does not fail; `ProductId` is used. `OrderDirection` is `ASC` or `DESC`; invalid values fall back to `ASC`.\n\n0 in numeric filters and an empty value in text filters switch the filter off, so you cannot select zero-stock products with `QuantityFrom`/`QuantityTo`. `ProductCode` and `ProductCategory` match exactly. `Keywords` searches the product name (and the marketplace-specific name, if any); spaces act as wildcards: `red shirt` finds names containing `red` followed later by `shirt`.\n\n`CreationTimeFrom` and `CreationTimeTo` are applied only when their year is after 2010. Send them as `2025-01-31T00:00:00`, without a time zone suffix; they are compared as-is with the stored creation time. `CreationTime` in the response also has no time zone suffix.\n\n`TotalProductCount` is the number of products in the source regardless of filters; `FilteredProductCount` is the number matching the filters. Products deleted with the retired `DeleteProduct` are neither counted nor listed; stopped products (status 3) are listed. `ProductSourceId` can be any of your sources; the source type is not checked.\n\nList items carry fewer fields than `GetProduct`: no variants, image list or description. `Image` is the first image URL. `Currency` is the currency code; `NON` is returned as `TRY`. `Barcode` is the product's own barcode (`GetProduct` prefers the integration-level barcode).\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/GetProducts", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductSourceId": { "type": "integer", "description": "Source to list. A value below 1 returns 00003 (`ErrorMessage`: `ProductSourceId`)." }, "ProductId": { "type": "integer", "description": "Filter by one product ID. 0 = no filter." }, "ProductCode": { "type": "string", "description": "Product code, exact match. Max 50 characters." }, "Keywords": { "type": "string", "description": "Search in the product name; spaces act as wildcards." }, "ProductCategory": { "type": "string", "description": "Category name, exact match." }, "PriceFrom": { "type": "number", "description": "Minimum price (inclusive). 0 = no filter." }, "PriceTo": { "type": "number", "description": "Maximum price (inclusive). 0 = no filter." }, "QuantityFrom": { "type": "integer", "description": "Minimum stock (inclusive). 0 = no filter." }, "QuantityTo": { "type": "integer", "description": "Maximum stock (inclusive). 0 = no filter." }, "CurrencyId": { "type": "integer", "description": "Currency ID. 0 = no filter." }, "ProductStatus": { "type": "integer", "description": "Product status filter. Default -1 (all).\n\n- `-1`: All (default)\n- `0`: Not changed\n- `1`: New\n- `2`: Changed\n- `3`: Stopped / out of stock\n- `4`: Re-added\n- `99`: All except 3 (products that are not stopped)" }, "CreationTimeFrom": { "type": "string", "description": "Created at or after this time. `yyyy-MM-ddTHH:mm:ss`, no time zone suffix. Ignored if the year is 2010 or earlier." }, "CreationTimeTo": { "type": "string", "description": "Created at or before this time. Same format and rule as `CreationTimeFrom`." }, "PageIndex": { "type": "integer", "description": "Page number, starting at 1. Default 1." }, "RowsByPage": { "type": "integer", "description": "Page size. Default 100, max 100." }, "OrderBy": { "type": "string", "description": "Sort field. Default `ProductId`.\n\n- `Name`: Product name\n- `ProductId`: Product ID (default)\n- `Category`: Category name\n- `Price`: Price\n- `Quantity`: Stock\n- `Status`: Status\n- `CurrencyId`: Currency" }, "OrderDirection": { "type": "string", "description": "Sort direction. Default `ASC`.\n\n- `ASC`: Ascending (default)\n- `DESC`: Descending" } }, "required": [ "ApiCode", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductSourceId": 1234, "Keywords": "tişört", "ProductStatus": 99, "CreationTimeFrom": "2025-10-01T00:00:00", "PageIndex": 1, "RowsByPage": 50, "OrderBy": "Name", "OrderDirection": "ASC" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "TotalProductCount": { "type": "integer", "description": "Total products in the source (ignores filters)." }, "FilteredProductCount": { "type": "integer", "description": "Number of products matching the filters." }, "Products": { "type": "array", "items": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "Product ID." }, "ProductSourceId": { "type": "integer", "description": "Source ID." }, "Category": { "type": "string", "description": "Category name." }, "Code": { "type": "string", "description": "Product code." }, "Code2": { "type": "string", "description": "Secondary product code; empty if none." }, "Name": { "type": "string", "description": "Product name." }, "TaxRate": { "type": "number", "description": "VAT rate; 0 if none." }, "Quantity": { "type": "integer", "description": "Stock quantity." }, "SoldCount": { "type": "integer", "description": "Sold count." }, "Price": { "type": "number", "description": "Sale price." }, "Subtitle": { "type": "string", "description": "Subtitle." }, "Volume": { "type": "number", "description": "Volume / desi (the second value if one is set)." }, "Brand": { "type": "string", "description": "Brand." }, "Barcode": { "type": "string", "description": "The product's own barcode." }, "Status": { "type": "integer", "description": "Product status.\n\n- `0`: Not changed\n- `1`: New (initial status of products added through the API)\n- `2`: Changed (after `UpdateProduct` when stock is above 0)\n- `3`: Stopped / out of stock (`StopProduct`, or stock below 1)\n- `4`: Re-added" }, "CreationTime": { "type": "string", "description": "Creation time, no time zone suffix." }, "CurrencyId": { "type": "integer", "description": "Currency ID." }, "MarketPrice": { "type": "number", "description": "Market (list) price; 0 if none." }, "Image": { "type": "string", "description": "First image URL; empty if none." }, "Currency": { "type": "string", "description": "Currency code (e.g. `TRY`, `USD`); `NON` is returned as `TRY`." }, "SellerNote": { "type": "string", "description": "Seller note; empty if none." } } }, "description": "Products on this page." } } } } } ] }, "example": { "Result": true, "Response": { "TotalProductCount": 152, "FilteredProductCount": 1, "Products": [ { "ProductId": 987654, "ProductSourceId": 1234, "Category": "Tişört", "Code": "TSHIRT-001", "Code2": "", "Name": "Basic Pamuklu Tişört", "TaxRate": 20.0, "Quantity": 30, "SoldCount": 4, "Price": 249.9, "Subtitle": "", "Volume": 1.0, "Brand": "Örnek Marka", "Barcode": "8690000000017", "Status": 1, "CreationTime": "2025-11-05T10:22:31.497", "CurrencyId": 4, "MarketPrice": 299.9, "Image": "https://cdn.example.com/tshirt-001-1.jpg", "Currency": "TRY", "SellerNote": "" } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/GetProductSummary": { "post": { "operationId": "GetProductSummary", "tags": [ "Products" ], "summary": "Get the product summary", "description": "**Get the product summary** — Returns the ID, code, name, barcode and status of every product in a source in one response.\n\nThere is no paging or filtering; all products in the source come in one response, in no guaranteed order. Only `ProductSourceId` is read; the `GetProducts` filter and paging fields are ignored.\n\n`TotalProductCount` and `FilteredProductCount` are always equal to the number of returned products. Products deleted with the retired `DeleteProduct` are not returned; stopped products (status 3) are. Use this call to map products in your system to StockMount `ProductId` values.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/GetProductSummary", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductSourceId": { "type": "integer", "description": "Source ID. A value below 1 returns 00003 (`ErrorMessage`: `ProductSourceId`)." } }, "required": [ "ApiCode", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductSourceId": 1234 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "TotalProductCount": { "type": "integer", "description": "Number of returned products." }, "FilteredProductCount": { "type": "integer", "description": "Same as `TotalProductCount`." }, "Products": { "type": "array", "items": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "Product ID." }, "ProductSourceId": { "type": "integer", "description": "Source ID." }, "Code": { "type": "string", "description": "Product code." }, "Name": { "type": "string", "description": "Product name." }, "Barcode": { "type": "string", "description": "Barcode; empty string if none." }, "Status": { "type": "integer", "description": "Product status.\n\n- `0`: Not changed\n- `1`: New (initial status of products added through the API)\n- `2`: Changed (after `UpdateProduct` when stock is above 0)\n- `3`: Stopped / out of stock (`StopProduct`, or stock below 1)\n- `4`: Re-added" } } }, "description": "All products in the source." } } } } } ] }, "example": { "Result": true, "Response": { "TotalProductCount": 2, "FilteredProductCount": 2, "Products": [ { "ProductId": 987654, "ProductSourceId": 1234, "Code": "TSHIRT-001", "Name": "Basic Pamuklu Tişört", "Barcode": "8690000000017", "Status": 2 }, { "ProductId": 987655, "ProductSourceId": 1234, "Code": "PANT-002", "Name": "Chino Pantolon", "Barcode": "8690000000048", "Status": 3 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/SetProductCode": { "post": { "operationId": "SetProductCode", "tags": [ "Products" ], "summary": "Change a product code", "description": "**Change a product code** — Changes the `Code` of an existing product.\n\nWorks only for products in StockMount-type sources. If the new code is already used by another product in the same source, nothing is changed.\n\n`Code` is at most 50 characters; longer values return 70009 (`ErrorMessage`: `'Code' length must be at most 50 character.`).\n\nIf the product is not found, is not yours, is not in a StockMount-type source, or the code is used by another product, 99999 is returned with no `ErrorMessage`. A successful response has no `Response`.\n\nAfter the change, use the new code in `UpdateProduct`, `GetProduct` and other code-based calls.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/SetProductCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "ProductId": { "type": "integer", "description": "ID of the product whose code changes. A value below 1 returns 00003 (`ErrorMessage`: `ProductId`)." }, "Code": { "type": "string", "description": "New product code. Max 50 characters. Empty returns 00003 (`ErrorMessage`: `Code`)." } }, "required": [ "ApiCode", "ProductId", "Code" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 987654, "Code": "TSHIRT-001-V2" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "nullable": true } } } ] }, "example": { "Result": true } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductPrice": { "post": { "operationId": "UpdateProductPrice", "tags": [ "Products" ], "summary": "Update product price (by ProductId)", "description": "**Update product price (by ProductId)** — Updates the prices of the product found by `ProductId` and, optionally, of its variants.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified only by `ProductId`. To update by product code, use the `ByCode` endpoint.\n\n`Price`, `MarketPrice` and `Price2`–`Price5` are overwritten on every call with the values in the request; any field you omit becomes `0`. Send every price you use each time.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant gets its `Price` and `Price2`–`Price5` replaced by the request values (omitted ones become `0`). Variants not in the list are not touched. A variant-level `CurrencyId` is not read; the product-level `CurrencyId` is used.\n\nThis endpoint does not validate prices: `0`, negative values, or a `MarketPrice` lower than `Price` are accepted. Such problems surface as errors during marketplace synchronization, not in this call.\n\nThis endpoint does not change stock or name; `Quantity` and `Name` are ignored.\n\nThe price is written to the product in StockMount first. If any price actually changed, a price update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call. If an update of the same kind is already pending, no duplicate is queued.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. The product must belong to your account. `Code` is ignored by this endpoint." }, "Price": { "type": "number", "description": "Sale price of the product. Stored with 2 decimal places. If omitted, `0` is written." }, "MarketPrice": { "type": "number", "description": "Market (list) price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Product additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Product additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Product additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Product additional price 5. If omitted, `0` is written." }, "CurrencyId": { "type": "integer", "description": "Currency ID (`GetCurrencies`). If greater than 0, the currency of the product and of the updated variants is set to this value. If omitted or `0`, the currency is unchanged." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Price": { "type": "number", "description": "Variant sale price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Variant additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Variant additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Variant additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Variant additional price 5. If omitted, `0` is written." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "ProductId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 184522, "Price": 349.9, "MarketPrice": 449.9, "Price2": 329.9, "Price3": 0, "Price4": 0, "Price5": 0, "Variants": [ { "ProductVariantId": 9120344, "Price": 349.9, "Price2": 329.9 }, { "Code": "TSHIRT-RED-L", "Price": 359.9, "Price2": 339.9 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductPriceByCode": { "post": { "operationId": "UpdateProductPriceByCode", "tags": [ "Products" ], "summary": "Update product price (by product code)", "description": "**Update product price (by product code)** — Updates the prices of the product found by `Code` and `ProductSourceId` and, optionally, of its variants.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified by `Code` + `ProductSourceId`; any `ProductId` you send is ignored. If `Code` is empty, `ErrorMessage` says `ProductId`; this means the code is missing.\n\n`Price`, `MarketPrice` and `Price2`–`Price5` are overwritten on every call with the values in the request; any field you omit becomes `0`. Send every price you use each time.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant gets its `Price` and `Price2`–`Price5` replaced by the request values (omitted ones become `0`). Variants not in the list are not touched. A variant-level `CurrencyId` is not read; the product-level `CurrencyId` is used.\n\nThis endpoint does not validate prices: `0`, negative values, or a `MarketPrice` lower than `Price` are accepted. Such problems surface as errors during marketplace synchronization, not in this call.\n\nThis endpoint does not change stock or name; `Quantity` and `Name` are ignored.\n\nThe price is written to the product in StockMount first. If any price actually changed, a price update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call. If an update of the same kind is already pending, no duplicate is queued.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductPriceByCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "Code": { "type": "string", "description": "Product code (SKU), up to 50 characters. The product is looked up by `Code` together with `ProductSourceId`. `ProductId` is ignored by this endpoint." }, "ProductSourceId": { "type": "integer", "description": "ID of the product source the product belongs to (`GetProductSources`). `Code` is looked up within this source." }, "Price": { "type": "number", "description": "Sale price of the product. Stored with 2 decimal places. If omitted, `0` is written." }, "MarketPrice": { "type": "number", "description": "Market (list) price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Product additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Product additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Product additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Product additional price 5. If omitted, `0` is written." }, "CurrencyId": { "type": "integer", "description": "Currency ID (`GetCurrencies`). If greater than 0, the currency of the product and of the updated variants is set to this value. If omitted or `0`, the currency is unchanged." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Price": { "type": "number", "description": "Variant sale price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Variant additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Variant additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Variant additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Variant additional price 5. If omitted, `0` is written." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "Code", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "Price": 349.9, "MarketPrice": 449.9, "Price2": 329.9, "Price3": 0, "Price4": 0, "Price5": 0, "Variants": [ { "ProductVariantId": 9120344, "Price": 349.9, "Price2": 329.9 }, { "Code": "TSHIRT-RED-L", "Price": 359.9, "Price2": 339.9 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductQuantity": { "post": { "operationId": "UpdateProductQuantity", "tags": [ "Products" ], "summary": "Update product stock (by ProductId)", "description": "**Update product stock (by ProductId)** — Updates the stock quantity of the product found by `ProductId` and, optionally, of its variants.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified only by `ProductId`. To update by product code, use the `ByCode` endpoint.\n\nThe quantity you send replaces the product's available stock; the sold counter StockMount has kept so far is reset to zero. If the new product stock is below 1, the product's `Status` becomes `3`, otherwise `2`.\n\nThe product-level `Quantity` is written on every call. If you send only variant quantities without `Quantity` and do not set `SetProductQuantityFromVariants` to `true`, the product stock becomes `0`. For products with variants, sending `SetProductQuantityFromVariants: true` is recommended.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant's stock is replaced by `Quantity` (`0` if omitted). Variants not in the list are not touched.\n\nQuantities are not validated; negative values are not rejected.\n\nThis endpoint does not change prices; price fields are ignored. The one exception is `CurrencyId`: if you send a value greater than 0, the product currency changes too. Do not send it.\n\nThe stock is written to the product in StockMount first. If the stock changed, a stock update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call. If an update of the same kind is already pending, no duplicate is queued.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductQuantity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. The product must belong to your account. `Code` is ignored by this endpoint." }, "Quantity": { "type": "integer", "description": "New stock quantity of the product. If omitted, `0` is written. Ignored when `SetProductQuantityFromVariants` is `true` and `Variants` has at least one item. Negative values are not rejected." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "If `true`, the product stock is computed as the sum of its active variants: the new quantity for variants in the list, the current available stock for the other variants. Has no effect when `Variants` is empty. Default `false`." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Quantity": { "type": "integer", "description": "New stock quantity of the variant. If omitted, `0` is written. Negative values are not rejected." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "ProductId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 184522, "SetProductQuantityFromVariants": true, "Variants": [ { "ProductVariantId": 9120344, "Quantity": 15 }, { "Code": "TSHIRT-RED-L", "Quantity": 0 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductQuantityByCode": { "post": { "operationId": "UpdateProductQuantityByCode", "tags": [ "Products" ], "summary": "Update product stock (by product code)", "description": "**Update product stock (by product code)** — Updates the stock quantity of the product found by `Code` and `ProductSourceId` and, optionally, of its variants.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified by `Code` + `ProductSourceId`; any `ProductId` you send is ignored. If `Code` is empty, `ErrorMessage` says `ProductId`; this means the code is missing.\n\nThe quantity you send replaces the product's available stock; the sold counter StockMount has kept so far is reset to zero. If the new product stock is below 1, the product's `Status` becomes `3`, otherwise `2`.\n\nThe product-level `Quantity` is written on every call. If you send only variant quantities without `Quantity` and do not set `SetProductQuantityFromVariants` to `true`, the product stock becomes `0`. For products with variants, sending `SetProductQuantityFromVariants: true` is recommended.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant's stock is replaced by `Quantity` (`0` if omitted). Variants not in the list are not touched.\n\nQuantities are not validated; negative values are not rejected.\n\nThis endpoint does not change prices; price fields are ignored. The one exception is `CurrencyId`: if you send a value greater than 0, the product currency changes too. Do not send it.\n\nThe stock is written to the product in StockMount first. If the stock changed, a stock update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call. If an update of the same kind is already pending, no duplicate is queued.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductQuantityByCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "Code": { "type": "string", "description": "Product code (SKU), up to 50 characters. The product is looked up by `Code` together with `ProductSourceId`. `ProductId` is ignored by this endpoint." }, "ProductSourceId": { "type": "integer", "description": "ID of the product source the product belongs to (`GetProductSources`). `Code` is looked up within this source." }, "Quantity": { "type": "integer", "description": "New stock quantity of the product. If omitted, `0` is written. Ignored when `SetProductQuantityFromVariants` is `true` and `Variants` has at least one item. Negative values are not rejected." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "If `true`, the product stock is computed as the sum of its active variants: the new quantity for variants in the list, the current available stock for the other variants. Has no effect when `Variants` is empty. Default `false`." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Quantity": { "type": "integer", "description": "New stock quantity of the variant. If omitted, `0` is written. Negative values are not rejected." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "Code", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "SetProductQuantityFromVariants": true, "Variants": [ { "ProductVariantId": 9120344, "Quantity": 15 }, { "Code": "TSHIRT-RED-L", "Quantity": 0 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductQuantityByBarcode": { "post": { "operationId": "UpdateProductQuantityByBarcode", "tags": [ "Products" ], "summary": "Update variant stock by barcode", "description": "**Update variant stock by barcode** — Updates the stock of the product found by `Code` and `ProductSourceId`, and the stock of its variants matched by barcode.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified by `Code` + `ProductSourceId`, not by barcode; `ProductId` is ignored. The root-level `Barcode` field is not used. Barcodes are only used to match the variants in `Variants`.\n\nEach item in `Variants` is matched to this product's variants by `ProductVariantId`, or by `Barcode` when no ID is given. A matched variant's stock is replaced by `Quantity` (`0` if omitted). Variants not in the list are not touched.\n\nThe quantity you send replaces the product's available stock; the sold counter StockMount has kept so far is reset to zero. If the new product stock is below 1, the product's `Status` becomes `3`, otherwise `2`.\n\nThe product-level `Quantity` is written on every call. If you send only variant quantities without `Quantity` and do not set `SetProductQuantityFromVariants` to `true`, the product stock becomes `0`. For products with variants, sending `SetProductQuantityFromVariants: true` is recommended.\n\nWarning: although it is a stock endpoint, this endpoint overwrites the product's `Price2`–`Price5` with the request values; if you omit them they become `0`. If you use these prices, send their current values on every call. `Price` and `MarketPrice` are not changed.\n\n`CurrencyId` is ignored by this endpoint; the product currency does not change.\n\nQuantities are not validated; negative values are not rejected.\n\nAfter every successful call, a stock update is queued for each active marketplace listing of the product (unless one of the same kind is already pending). Marketplaces are updated by background jobs, not during this call.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductQuantityByBarcode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "Code": { "type": "string", "description": "Product code (SKU), up to 50 characters. The product is looked up by `Code` together with `ProductSourceId`. `ProductId` is ignored by this endpoint." }, "ProductSourceId": { "type": "integer", "description": "ID of the product source the product belongs to (`GetProductSources`). `Code` is looked up within this source." }, "Quantity": { "type": "integer", "description": "New stock quantity of the product. If omitted, `0` is written. Ignored when `SetProductQuantityFromVariants` is `true` and `Variants` has at least one item. Negative values are not rejected." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "If `true`, the product stock is computed as the sum of its variants: the new quantity for active variants in the list, the current available stock for all other variants (passive ones included). Has no effect when `Variants` is empty. Default `false`." }, "Price2": { "type": "number", "description": "Product additional price 2. Although this is a stock endpoint, it writes this field to the product; if omitted it becomes `0`. Send the current value." }, "Price3": { "type": "number", "description": "Product additional price 3. Although this is a stock endpoint, it writes this field to the product; if omitted it becomes `0`. Send the current value." }, "Price4": { "type": "number", "description": "Product additional price 4. Although this is a stock endpoint, it writes this field to the product; if omitted it becomes `0`. Send the current value." }, "Price5": { "type": "number", "description": "Product additional price 5. Although this is a stock endpoint, it writes this field to the product; if omitted it becomes `0`. Send the current value." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Barcode`." }, "Barcode": { "type": "string", "description": "Variant barcode. When `ProductVariantId` is not set, the variant is looked up by this barcode among this product's variants only. Leading and trailing spaces are trimmed." }, "Quantity": { "type": "integer", "description": "New stock quantity of the variant. If omitted, `0` is written. Negative values are not rejected." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "Code", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "SetProductQuantityFromVariants": true, "Price2": 329.9, "Price3": 0, "Price4": 0, "Price5": 0, "Variants": [ { "Barcode": "8690000000017", "Quantity": 15 }, { "Barcode": "8690000000024", "Quantity": 0 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductQuantityAndPrice": { "post": { "operationId": "UpdateProductQuantityAndPrice", "tags": [ "Products" ], "summary": "Update product stock and price (by ProductId)", "description": "**Update product stock and price (by ProductId)** — Updates stock and prices of the product found by `ProductId` and, optionally, of its variants in one call.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified only by `ProductId`. To update by product code, use the `ByCode` endpoint.\n\nThe quantity you send replaces the product's available stock; the sold counter StockMount has kept so far is reset to zero. If the new product stock is below 1, the product's `Status` becomes `3`, otherwise `2`.\n\nThe product-level `Quantity` is written on every call. If you send only variant quantities without `Quantity` and do not set `SetProductQuantityFromVariants` to `true`, the product stock becomes `0`. For products with variants, sending `SetProductQuantityFromVariants: true` is recommended.\n\n`Price`, `MarketPrice` and `Price2`–`Price5` are overwritten on every call with the values in the request; any field you omit becomes `0`. Send every price you use each time.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant gets its stock replaced by `Quantity` and its prices by `Price` and `Price2`–`Price5`; omitted fields become `0`. Variants not in the list are not touched. A variant-level `CurrencyId` is not read.\n\nThis endpoint does not validate prices: `0`, negative values, or a `MarketPrice` lower than `Price` are accepted. Such problems surface as errors during marketplace synchronization, not in this call.\n\nQuantities are not validated; negative values are not rejected.\n\nThe values are written to the product in StockMount first. If stock or price actually changed, the matching update (stock, price, or both) is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductQuantityAndPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. The product must belong to your account. `Code` is ignored by this endpoint." }, "Quantity": { "type": "integer", "description": "New stock quantity of the product. If omitted, `0` is written. Ignored when `SetProductQuantityFromVariants` is `true` and `Variants` has at least one item. Negative values are not rejected." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "If `true`, the product stock is computed as the sum of its active variants: the new quantity for variants in the list, the current available stock for the other variants. Has no effect when `Variants` is empty. Default `false`." }, "Price": { "type": "number", "description": "Sale price of the product. Stored with 2 decimal places. If omitted, `0` is written." }, "MarketPrice": { "type": "number", "description": "Market (list) price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Product additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Product additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Product additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Product additional price 5. If omitted, `0` is written." }, "CurrencyId": { "type": "integer", "description": "Currency ID (`GetCurrencies`). If greater than 0, the currency of the product and of the updated variants is set to this value. If omitted or `0`, the currency is unchanged." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Quantity": { "type": "integer", "description": "New stock quantity of the variant. If omitted, `0` is written. Negative values are not rejected." }, "Price": { "type": "number", "description": "Variant sale price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Variant additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Variant additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Variant additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Variant additional price 5. If omitted, `0` is written." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "ProductId" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 184522, "SetProductQuantityFromVariants": true, "Price": 349.9, "MarketPrice": 449.9, "Price2": 329.9, "Price3": 0, "Price4": 0, "Price5": 0, "Variants": [ { "ProductVariantId": 9120344, "Quantity": 15, "Price": 349.9, "Price2": 329.9 }, { "Code": "TSHIRT-RED-L", "Quantity": 0, "Price": 359.9, "Price2": 339.9 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductQuantityAndPriceByCode": { "post": { "operationId": "UpdateProductQuantityAndPriceByCode", "tags": [ "Products" ], "summary": "Update product stock and price (by product code)", "description": "**Update product stock and price (by product code)** — Updates stock and prices of the product found by `Code` and `ProductSourceId` and, optionally, of its variants in one call.\n\nEach call updates a single product; you cannot send several products in one call. You can update several variants of that product in the same call with `Variants`.\n\nThe product is identified by `Code` + `ProductSourceId`; any `ProductId` you send is ignored. If `Code` is empty, `ErrorMessage` says `ProductId`; this means the code is missing.\n\nThe quantity you send replaces the product's available stock; the sold counter StockMount has kept so far is reset to zero. If the new product stock is below 1, the product's `Status` becomes `3`, otherwise `2`.\n\nThe product-level `Quantity` is written on every call. If you send only variant quantities without `Quantity` and do not set `SetProductQuantityFromVariants` to `true`, the product stock becomes `0`. For products with variants, sending `SetProductQuantityFromVariants: true` is recommended.\n\n`Price`, `MarketPrice` and `Price2`–`Price5` are overwritten on every call with the values in the request; any field you omit becomes `0`. Send every price you use each time.\n\nEach item in `Variants` is matched to the product's variants by `ProductVariantId`, or by variant `Code` when no ID is given. A matched variant gets its stock replaced by `Quantity` and its prices by `Price` and `Price2`–`Price5`; omitted fields become `0`. Variants not in the list are not touched. A variant-level `CurrencyId` is not read.\n\nThis endpoint does not validate prices: `0`, negative values, or a `MarketPrice` lower than `Price` are accepted. Such problems surface as errors during marketplace synchronization, not in this call.\n\nQuantities are not validated; negative values are not rejected.\n\nThe values are written to the product in StockMount first. If stock or price actually changed, the matching update (stock, price, or both) is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductQuantityAndPriceByCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "Code": { "type": "string", "description": "Product code (SKU), up to 50 characters. The product is looked up by `Code` together with `ProductSourceId`. `ProductId` is ignored by this endpoint." }, "ProductSourceId": { "type": "integer", "description": "ID of the product source the product belongs to (`GetProductSources`). `Code` is looked up within this source." }, "Quantity": { "type": "integer", "description": "New stock quantity of the product. If omitted, `0` is written. Ignored when `SetProductQuantityFromVariants` is `true` and `Variants` has at least one item. Negative values are not rejected." }, "SetProductQuantityFromVariants": { "type": "boolean", "description": "If `true`, the product stock is computed as the sum of its active variants: the new quantity for variants in the list, the current available stock for the other variants. Has no effect when `Variants` is empty. Default `false`." }, "Price": { "type": "number", "description": "Sale price of the product. Stored with 2 decimal places. If omitted, `0` is written." }, "MarketPrice": { "type": "number", "description": "Market (list) price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Product additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Product additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Product additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Product additional price 5. If omitted, `0` is written." }, "CurrencyId": { "type": "integer", "description": "Currency ID (`GetCurrencies`). If greater than 0, the currency of the product and of the updated variants is set to this value. If omitted or `0`, the currency is unchanged." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "Quantity": { "type": "integer", "description": "New stock quantity of the variant. If omitted, `0` is written. Negative values are not rejected." }, "Price": { "type": "number", "description": "Variant sale price. If omitted, `0` is written." }, "Price2": { "type": "number", "description": "Variant additional price 2. If omitted, `0` is written." }, "Price3": { "type": "number", "description": "Variant additional price 3. If omitted, `0` is written." }, "Price4": { "type": "number", "description": "Variant additional price 4. If omitted, `0` is written." }, "Price5": { "type": "number", "description": "Variant additional price 5. If omitted, `0` is written." } } }, "description": "Variants to update. Only listed variants change; entries that do not match are skipped without an error." } }, "required": [ "ApiCode", "Code", "ProductSourceId" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "SetProductQuantityFromVariants": true, "Price": 349.9, "MarketPrice": 449.9, "Price2": 329.9, "Price3": 0, "Price4": 0, "Price5": 0, "Variants": [ { "ProductVariantId": 9120344, "Quantity": 15, "Price": 349.9, "Price2": 329.9 }, { "Code": "TSHIRT-RED-L", "Quantity": 0, "Price": 359.9, "Price2": 339.9 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [ { "Code": "TSHIRT-RED-M", "ProductVariantId": 9120344 }, { "Code": "TSHIRT-RED-L", "ProductVariantId": 9120345 } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductName": { "post": { "operationId": "UpdateProductName", "tags": [ "Products" ], "summary": "Update product name (by ProductId)", "description": "**Update product name (by ProductId)** — Changes the name of the product found by `ProductId`.\n\nEach call updates a single product; you cannot send several products in one call.\n\nThe product is identified only by `ProductId`. To update by product code, use the `ByCode` endpoint.\n\nOnly the product's main name (`Name`) changes. Stock, prices and variants are not changed; other fields are ignored. The one exception is `CurrencyId`: if you send a value greater than 0, the product currency changes too. Do not send it.\n\nIf the name actually changed, a product update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductName", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. The product must belong to your account. `Code` is ignored by this endpoint." }, "Name": { "type": "string", "description": "New product name. Must not be empty. Values longer than 400 characters are truncated." } }, "required": [ "ApiCode", "ProductId", "Name" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 184522, "Name": "Pamuklu Basic T-Shirt Kırmızı" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductNameByCode": { "post": { "operationId": "UpdateProductNameByCode", "tags": [ "Products" ], "summary": "Update product name (by product code)", "description": "**Update product name (by product code)** — Changes the name of the product found by `Code` and `ProductSourceId`.\n\nEach call updates a single product; you cannot send several products in one call.\n\nThe product is identified by `Code` + `ProductSourceId`; any `ProductId` you send is ignored. If `Code` is empty, `ErrorMessage` says `ProductId`; this means the code is missing.\n\nOnly the product's main name (`Name`) changes. Stock, prices and variants are not changed; other fields are ignored. The one exception is `CurrencyId`: if you send a value greater than 0, the product currency changes too. Do not send it.\n\nIf the name actually changed, a product update is queued for each active marketplace listing of the product. Marketplaces are updated by background jobs, not during this call.\n\nIf the product is not found or does not belong to your account, the response is `Result: false` with `ErrorCode: \"70005\"` and `ErrorMessage: \"ProductNotFound\"`. Database errors return `ErrorCode` `99999`.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductNameByCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "Code": { "type": "string", "description": "Product code (SKU), up to 50 characters. The product is looked up by `Code` together with `ProductSourceId`. `ProductId` is ignored by this endpoint." }, "ProductSourceId": { "type": "integer", "description": "ID of the product source the product belongs to (`GetProductSources`). `Code` is looked up within this source." }, "Name": { "type": "string", "description": "New product name. Must not be empty. Values longer than 400 characters are truncated." } }, "required": [ "ApiCode", "Code", "ProductSourceId", "Name" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "Name": "Pamuklu Basic T-Shirt Kırmızı" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "ID of the updated product." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Variant code." }, "ProductVariantId": { "type": "integer", "description": "Variant ID." } } }, "description": "Variants updated by this call. Empty array if you sent no variants." } } } } } ] }, "example": { "Result": true, "Response": { "ProductId": 184522, "Variants": [] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductImages": { "post": { "operationId": "UpdateProductImages", "tags": [ "Products" ], "summary": "Update product images", "description": "**Update product images** — Replaces the product's image list (up to 12) and, optionally, its variant images.\n\nThe product is identified by `ProductId`; if `ProductId` is less than 1, by `Code` + `ProductSourceId`. `UpdateProductImages` and `UpdateProductImagesByCode` run the same code and accept the same fields; they behave identically.\n\nEach call updates a single product; you cannot send several products in one call.\n\nThe image list is replaced as a whole: existing images that are not in the request are removed, new ones are added, and the product's image slots 1–12 are rewritten in request order. Unused slots are cleared.\n\nIf any item after the first has neither `Url` nor `Base64`, the call fails with `99999`.\n\nBase64 images are uploaded to the StockMount image server and the stored URL starts with `http://`. If the upload fails, the image is stored with an empty URL and no error is returned.\n\nThis call does not check image format or protocol. Some marketplaces reject non-`http(s)` URLs or `.webp` images when a listing is sent (`70016`, `70015`); those errors appear during marketplace submission, not in this call.\n\nThe response does not reflect whether variant images were saved: `Result: true` can be returned even if a variant image could not be stored.\n\nThis call does not queue a marketplace update. The images are marked as manually edited, so later imports from the product source (XML/feed) do not overwrite them.\n\nThe application enforces no separate request-size limit for this endpoint. Base64 images make the request large; prefer `Url` where you can.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductImages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. If less than 1, the product is looked up by `Code` + `ProductSourceId`." }, "Code": { "type": "string", "description": "Product code. Required when `ProductId` is not sent." }, "ProductSourceId": { "type": "integer", "description": "Product source ID (`GetProductSources`). Required when looking up by `Code`." }, "Images": { "type": "array", "items": { "type": "object", "properties": { "Url": { "type": "string", "description": "Image URL, up to 512 characters. If it starts with `//`, `http:` is prepended. Format and protocol are not checked by this call." }, "Base64": { "type": "string", "description": "Used when `Url` is empty. Raw Base64 image data without a `data:` prefix. PNG and JPEG are recognised; anything else is saved with a `.png` extension." } } }, "description": "The product's new image list. At least one item is required and the first item must have `Url` or `Base64`. At most 12 images are used; the rest are ignored. Order is the array order; the first image is the main image. The `Order` field on items is not read." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "ImageUrl": { "type": "string", "description": "Variant image URL, up to 512 characters. If it contains XML-special characters such as `&` or `<`, the variant image is not saved and no error is returned." }, "ImageBase64": { "type": "string", "description": "Used when `ImageUrl` is empty. Raw Base64 image data without a `data:` prefix." } } }, "description": "Optional variant images. A listed variant with no image gets its image cleared. Variants not in the list are not touched." } }, "required": [ "ApiCode", "Images" ] }, "example": { "ApiCode": "{{apiCode}}", "ProductId": 184522, "Images": [ { "Url": "https://cdn.example.com/p/184522-1.jpg" }, { "Url": "https://cdn.example.com/p/184522-2.jpg" } ], "Variants": [ { "Code": "TSHIRT-RED-M", "ImageUrl": "https://cdn.example.com/p/184522-red-m.jpg" } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Response": { "type": "integer", "description": "`Response` is the ID of the updated product itself (a number)." } } } } } ] }, "example": { "Result": true, "Response": 184522 } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Product/UpdateProductImagesByCode": { "post": { "operationId": "UpdateProductImagesByCode", "tags": [ "Products" ], "summary": "Update product images (by product code)", "description": "**Update product images (by product code)** — Replaces the product's image list (up to 12) and, optionally, its variant images; works exactly like `UpdateProductImages`.\n\nThe product is identified by `ProductId`; if `ProductId` is less than 1, by `Code` + `ProductSourceId`. `UpdateProductImages` and `UpdateProductImagesByCode` run the same code and accept the same fields; they behave identically.\n\nEach call updates a single product; you cannot send several products in one call.\n\nThe image list is replaced as a whole: existing images that are not in the request are removed, new ones are added, and the product's image slots 1–12 are rewritten in request order. Unused slots are cleared.\n\nIf any item after the first has neither `Url` nor `Base64`, the call fails with `99999`.\n\nBase64 images are uploaded to the StockMount image server and the stored URL starts with `http://`. If the upload fails, the image is stored with an empty URL and no error is returned.\n\nThis call does not check image format or protocol. Some marketplaces reject non-`http(s)` URLs or `.webp` images when a listing is sent (`70016`, `70015`); those errors appear during marketplace submission, not in this call.\n\nThe response does not reflect whether variant images were saved: `Result: true` can be returned even if a variant image could not be stored.\n\nThis call does not queue a marketplace update. The images are marked as manually edited, so later imports from the product source (XML/feed) do not overwrite them.\n\nThe application enforces no separate request-size limit for this endpoint. Base64 images make the request large; prefer `Url` where you can.\n\n⚠ This endpoint changes real data in your account.\n\nAccounts without an active Product package get error 70018; if the package cannot be verified, 99999 is returned.\n\nhttps://outsample.stockmount.com/en/api/Product/UpdateProductImagesByCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "The API code returned by `User/DoLogin`." }, "ProductId": { "type": "integer", "description": "StockMount product ID. If less than 1, the product is looked up by `Code` + `ProductSourceId`." }, "Code": { "type": "string", "description": "Product code. Required when `ProductId` is not sent." }, "ProductSourceId": { "type": "integer", "description": "Product source ID (`GetProductSources`). Required when looking up by `Code`." }, "Images": { "type": "array", "items": { "type": "object", "properties": { "Url": { "type": "string", "description": "Image URL, up to 512 characters. If it starts with `//`, `http:` is prepended. Format and protocol are not checked by this call." }, "Base64": { "type": "string", "description": "Used when `Url` is empty. Raw Base64 image data without a `data:` prefix. PNG and JPEG are recognised; anything else is saved with a `.png` extension." } } }, "description": "The product's new image list. At least one item is required and the first item must have `Url` or `Base64`. At most 12 images are used; the rest are ignored. Order is the array order; the first image is the main image. The `Order` field on items is not read." }, "Variants": { "type": "array", "items": { "type": "object", "properties": { "ProductVariantId": { "type": "integer", "description": "Variant ID. If omitted or `0`, the variant is matched by `Code`." }, "Code": { "type": "string", "description": "Variant code. Used for matching when `ProductVariantId` is not set." }, "ImageUrl": { "type": "string", "description": "Variant image URL, up to 512 characters. If it contains XML-special characters such as `&` or `<`, the variant image is not saved and no error is returned." }, "ImageBase64": { "type": "string", "description": "Used when `ImageUrl` is empty. Raw Base64 image data without a `data:` prefix." } } }, "description": "Optional variant images. A listed variant with no image gets its image cleared. Variants not in the list are not touched." } }, "required": [ "ApiCode", "Images" ] }, "example": { "ApiCode": "{{apiCode}}", "Code": "TSHIRT-RED", "ProductSourceId": 3051, "Images": [ { "Url": "https://cdn.example.com/p/184522-1.jpg" }, { "Base64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==" } ], "Variants": [ { "ProductVariantId": 9120344, "ImageUrl": "https://cdn.example.com/p/184522-red-m.jpg" } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Response": { "type": "integer", "description": "`Response` is the ID of the updated product itself (a number)." } } } } } ] }, "example": { "Result": true, "Response": 184522 } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/General/GetCurrencies": { "post": { "operationId": "GetCurrencies", "tags": [ "General and lookups" ], "summary": "List currencies", "description": "**List currencies** — Returns the active currencies with their ID, code and name.\n\nThe list is the same for every account. There is no paging and the order is not guaranteed.\n\nOnly active currencies are returned. The internal \"unknown\" entry (`CurrencyId` 1) is not listed.\n\nUse these values wherever a currency ID (`CurrencyId`) is expected. Some IDs defined as constants in code: 2 = US dollar, 3 = Euro, 4 = Turkish lira.\n\nOnly `ApiCode` is read from the request body.\n\nhttps://outsample.stockmount.com/en/api/General/GetCurrencies", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." } }, "required": [ "ApiCode" ] }, "example": { "ApiCode": "{{apiCode}}" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "array", "items": { "type": "object", "properties": { "CurrencyId": { "type": "integer", "description": "Currency ID." }, "Code": { "type": "string", "description": "Currency code." }, "Name": { "type": "string", "description": "Currency name." } } } } } } ] }, "example": { "Result": true, "Response": [ { "CurrencyId": 2, "Code": "USD", "Name": "Amerikan Doları" }, { "CurrencyId": 3, "Code": "EUR", "Name": "Euro" }, { "CurrencyId": 4, "Code": "TRY", "Name": "Türk Lirası" } ] } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetStores": { "post": { "operationId": "GetStores", "tags": [ "General and lookups" ], "summary": "List stores", "description": "**List stores** — Returns the marketplace and e-commerce stores connected to your account, with their `StoreId`.\n\n`StoreId` is the ID you use to refer to a store in other endpoints. `IntegrationId` identifies the marketplace or platform the store belongs to.\n\nOnly stores that are active in the panel are listed. If you send `IntegrationId`, only that integration's stores are returned. An unknown `IntegrationId` is not an error; it returns an empty list.\n\nThere is no paging; all stores come in one response. The order is not guaranteed. `StoreName` can be empty.\n\nThe `StoreId` request field in the model is ignored. `Integration/GetStore` is an old alias that does the same thing; use `GetStores` in new integrations.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetStores", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "IntegrationId": { "type": "integer", "description": "Optional. Returns only this integration's stores. If omitted or 0, all stores are returned." } }, "required": [ "ApiCode" ] }, "example": { "ApiCode": "{{apiCode}}", "IntegrationId": 14 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "array", "items": { "type": "object", "properties": { "StoreId": { "type": "integer", "description": "Store ID." }, "StoreName": { "type": "string", "description": "Store name as shown in the panel. Can be empty." }, "IntegrationId": { "type": "integer", "description": "ID of the integration the store belongs to." }, "IntegrationName": { "type": "string", "description": "Integration name (e.g. `Trendyol`)." } } } } } } ] }, "example": { "Result": true, "Response": [ { "StoreId": 1234, "StoreName": "Örnek Mağaza", "IntegrationId": 14, "IntegrationName": "Trendyol" }, { "StoreId": 1240, "StoreName": "Örnek Mağaza Outlet", "IntegrationId": 14, "IntegrationName": "Trendyol" } ] } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetIntegrationShipmentCompanies": { "post": { "operationId": "GetIntegrationShipmentCompanies", "tags": [ "General and lookups" ], "summary": "List shipment companies", "description": "**List shipment companies** — Returns the shipment companies accepted by the marketplaces, with their codes.\n\nWhen you send shipment information (`SetOrderShipmentInformation`), put the `Code` value from this list in the `ShipmentCompany` field.\n\nIf you send `IntegrationId`, only that integration's companies are returned. If omitted or 0, companies of all integrations are returned; that list is long.\n\nThe list contains the integration's general companies plus companies defined only for your stores. It is sorted by `Name`. There is no paging.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetIntegrationShipmentCompanies", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "IntegrationId": { "type": "integer", "description": "Optional. ID of the integration whose shipment companies you want (`IntegrationId` from `GetStores`). If omitted or 0, all are returned." } }, "required": [ "ApiCode" ] }, "example": { "ApiCode": "{{apiCode}}", "IntegrationId": 2 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "array", "items": { "type": "object", "properties": { "IntegrationShipmentId": { "type": "integer", "description": "StockMount ID of the shipment company entry." }, "IntegrationId": { "type": "integer", "description": "ID of the integration the company belongs to." }, "Code": { "type": "string", "description": "Shipment company code on the marketplace. Send it as `ShipmentCompany` in `SetOrderShipmentInformation`." }, "Name": { "type": "string", "description": "Shipment company name." }, "ShortName": { "type": "string", "description": "Short name. Can be empty." } } } } } } ] }, "example": { "Result": true, "Response": [ { "IntegrationShipmentId": 57, "IntegrationId": 2, "Code": "345", "Name": "Aras Kargo", "ShortName": "Aras" }, { "IntegrationShipmentId": 61, "IntegrationId": 2, "Code": "349", "Name": "Yurtiçi Kargo", "ShortName": "Yurtiçi" } ] } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetIntegrationOrderListingStatus": { "post": { "operationId": "GetIntegrationOrderListingStatus", "tags": [ "General and lookups" ], "summary": "List order status codes", "description": "**List order status codes** — Returns the order status codes used by integrations and stores, with their descriptions.\n\nThe result comes in groups. Each group has `IntegrationId`, `StoreId` and a `ListingStatuses` list. In an integration-wide list `StoreId` is 0; in a store-specific list it is the store's ID.\n\nIf you send `StoreId`, only that store's statuses are returned and `IntegrationId` is ignored. For marketplaces with a fixed status set you get the marketplace's list; for e-commerce sites that define their own statuses you get the store's own list.\n\nIf you send only `IntegrationId`, that integration's statuses are returned. If you send neither, statuses of all integrations and stores you use are returned. Integration-wide groups come first, then store groups. An integration-wide group can also repeat store-specific statuses of the same integration.\n\n`Code` is the status value that appears on order lines (e.g. `OrderStatus` in `GetOrderDetailStatus`). `Description` is always in Turkish. If `Erp` is 1, orders in this status are eligible for ERP/accounting transfer.\n\nA `StoreId` that is not in your account returns `10001`. An unknown `IntegrationId` is not an error; it returns an empty list. There is no paging.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetIntegrationOrderListingStatus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "IntegrationId": { "type": "integer", "description": "Optional. Returns only this integration's statuses. Ignored when `StoreId` is set." }, "StoreId": { "type": "integer", "description": "Optional. Returns only this store's statuses (`StoreId` from `GetStores`)." } }, "required": [ "ApiCode" ] }, "example": { "ApiCode": "{{apiCode}}", "StoreId": 1234 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "array", "items": { "type": "object", "properties": { "IntegrationId": { "type": "integer", "description": "Integration ID." }, "StoreId": { "type": "integer", "description": "Store ID. 0 for an integration-wide list." }, "ListingStatuses": { "type": "array", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "Status code." }, "Description": { "type": "string", "description": "Turkish description of the status." }, "Erp": { "type": "integer", "description": "1: orders in this status are eligible for ERP/accounting transfer. 0: not eligible.\n\n- `0`: No ERP transfer\n- `1`: Eligible for ERP transfer" } } }, "description": "Statuses in this group." } } } } } } ] }, "example": { "Result": true, "Response": [ { "IntegrationId": 14, "StoreId": 1234, "ListingStatuses": [ { "Code": "Created", "Description": "Yeni Sipariş", "Erp": 1 }, { "Code": "Shipped", "Description": "Kargoya Verildi", "Erp": 1 }, { "Code": "Cancelled", "Description": "İptal Edildi", "Erp": 0 } ] } ] } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetOrderDetailStatus": { "post": { "operationId": "GetOrderDetailStatus", "tags": [ "General and lookups" ], "summary": "Get order line statuses", "description": "**Get order line statuses** — Returns the current status codes of the order lines you specify.\n\nOnly `OrderDetailId` is read from each item of `OrderDetails`; other fields are ignored.\n\nOnly lines that belong to your stores are returned. IDs that are not found or belong to another account are skipped without an error. The response order is not guaranteed.\n\nThere is no list length limit in code. Use `GetIntegrationOrderListingStatus` for the meaning of `OrderStatus` values. A line without a status has an empty `OrderStatus`.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetOrderDetailStatus", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "OrderDetails": { "type": "array", "items": { "type": "object", "properties": { "OrderDetailId": { "type": "integer", "description": "Order line ID (`OrderDetailId` from order responses)." } }, "required": [ "OrderDetailId" ] }, "description": "Order lines to query. At least one item is required." } }, "required": [ "ApiCode", "OrderDetails" ] }, "example": { "ApiCode": "{{apiCode}}", "OrderDetails": [ { "OrderDetailId": 9876543 }, { "OrderDetailId": 9876544 } ] } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "array", "items": { "type": "object", "properties": { "OrderId": { "type": "integer", "description": "StockMount order ID." }, "OrderDetailId": { "type": "integer", "description": "Order line ID." }, "StoreId": { "type": "integer", "description": "ID of the store the line belongs to." }, "OrderStatus": { "type": "string", "description": "Current status code of the line. Can be empty." } } } } } } ] }, "example": { "Result": true, "Response": [ { "OrderId": 4567890, "OrderDetailId": 9876543, "StoreId": 1234, "OrderStatus": "Shipped" }, { "OrderId": 4567890, "OrderDetailId": 9876544, "StoreId": 1234, "OrderStatus": "Created" } ] } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetUserMessages": { "post": { "operationId": "GetUserMessages", "tags": [ "Messages" ], "summary": "List messages", "description": "**List messages** — Returns a store's messages from the marketplace by type, newest first, 20 at a time.\n\nMessages are records imported from the marketplace into StockMount. In code, message import exists only for N11 (`IntegrationId` 2) and GittiGidiyor (1) stores; for other stores the list is empty.\n\nEach call returns at most 20 messages, newest first by `Time`. The page size cannot be changed.\n\nPaging is by ID. For older messages, send the smallest `UserMessageId` you have as `SmallestIntegrationMessageId`; messages with a smaller ID are returned. For new messages, send the largest `UserMessageId` you know as `BiggestIntegrationMessageId`; messages with a larger ID are returned. Both fields can be combined.\n\nNote: if you send only `BiggestIntegrationMessageId` and there are more than 20 new messages, you get the newest 20 and the ones in between are skipped. Keep `BiggestIntegrationMessageId` and send the smallest ID from the last batch as `SmallestIntegrationMessageId` to continue backwards.\n\n`MessageCount` is the total number of messages matching the filter. A `StoreId` that belongs to another account is not an error; it returns an empty list.\n\n`Integration/GetUserMessage` is an alias that does the same thing.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetUserMessages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "StoreId": { "type": "integer", "description": "ID of the store whose messages you want (`GetStores`)." }, "MessageTypeId": { "type": "integer", "description": "Message type.\n\n- `1`: Inbox\n- `2`: Sent\n- `3`: Deleted inbox\n- `4`: Deleted sent" }, "SmallestIntegrationMessageId": { "type": "integer", "description": "Optional. Returns only messages whose `UserMessageId` is smaller (older) than this." }, "BiggestIntegrationMessageId": { "type": "integer", "description": "Optional. Returns only messages whose `UserMessageId` is larger (newer) than this." } }, "required": [ "ApiCode", "StoreId", "MessageTypeId" ] }, "example": { "ApiCode": "{{apiCode}}", "StoreId": 1234, "MessageTypeId": 1, "SmallestIntegrationMessageId": 88120 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "MessageCount": { "type": "integer", "description": "Total number of messages matching the filter (not the number returned)." }, "Messages": { "type": "array", "items": { "type": "object", "properties": { "UserMessageId": { "type": "integer", "description": "StockMount message ID. Used for paging and `SetMessageRead`." }, "Code": { "type": "string", "description": "Message code on the marketplace. For N11 questions it is the question ID; send it as `UserMessageCode` when replying." }, "Subject": { "type": "string", "description": "Message subject." }, "From": { "type": "string", "description": "Sender (for incoming messages, the buyer's marketplace username)." }, "To": { "type": "string", "description": "Recipient." }, "MessageTypeId": { "type": "integer", "description": "Message type.\n\n- `1`: Inbox\n- `2`: Sent\n- `3`: Deleted inbox\n- `4`: Deleted sent" }, "Avatar": { "type": "string", "description": "Buyer's image. Usually empty." }, "Body": { "type": "string", "description": "Message text." }, "Time": { "type": "string", "description": "Message time in UTC, ISO 8601 (e.g. `2026-11-05T08:42:10Z`)." }, "Unread": { "type": "boolean", "description": "`true`: the message is unread." }, "Surname": { "type": "string", "description": "Buyer's last name. Can be empty." }, "Name": { "type": "string", "description": "Buyer's first name. If no first and last name are stored, the full name from the message is returned." } } }, "description": "Messages, newest first." } } } } } ] }, "example": { "Result": true, "Response": { "MessageCount": 57, "Messages": [ { "UserMessageId": 88119, "Code": "301245678", "Subject": "Ürün sorusu", "From": "alici_123", "To": "ornekmagaza", "MessageTypeId": 1, "Avatar": "", "Body": "Bu ürün stokta var mı?", "Time": "2026-11-05T08:42:10Z", "Unread": true, "Surname": "", "Name": "Mehmet K." } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/GetAllUserMessage": { "post": { "operationId": "GetAllUserMessage", "tags": [ "Messages" ], "summary": "Get the conversation with a buyer", "description": "**Get the conversation with a buyer** — Returns the messages received from and sent to one buyer in a store, in a single list.\n\nTwo queries are merged: incoming messages (type 1) whose `From` matches `User`, and sent messages (type 2) whose `To` matches `User`. Deleted messages are not included.\n\nEach query returns at most 20 messages, so the response has at most 40 messages, newest first. There is no paging. `MessageCount` is the sum of the total counts of both queries.\n\n`User` is matched with a full-text search, not exact equality; similar usernames can also match. `MessageTypeId`, `BiggestIntegrationMessageId` and `SmallestIntegrationMessageId` are ignored on this endpoint.\n\nMessages are imported only for N11 and GittiGidiyor stores. A `StoreId` that belongs to another account returns an empty list.\n\nhttps://outsample.stockmount.com/en/api/Integration/GetAllUserMessage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "StoreId": { "type": "integer", "description": "Store ID (`GetStores`)." }, "User": { "type": "string", "description": "Buyer's marketplace username (the `From`/`To` value in messages)." } }, "required": [ "ApiCode", "StoreId", "User" ] }, "example": { "ApiCode": "{{apiCode}}", "StoreId": 1234, "User": "alici_123" } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "type": "object", "properties": { "MessageCount": { "type": "integer", "description": "Total number of messages matching the filter (not the number returned)." }, "Messages": { "type": "array", "items": { "type": "object", "properties": { "UserMessageId": { "type": "integer", "description": "StockMount message ID. Used for paging and `SetMessageRead`." }, "Code": { "type": "string", "description": "Message code on the marketplace. For N11 questions it is the question ID; send it as `UserMessageCode` when replying." }, "Subject": { "type": "string", "description": "Message subject." }, "From": { "type": "string", "description": "Sender (for incoming messages, the buyer's marketplace username)." }, "To": { "type": "string", "description": "Recipient." }, "MessageTypeId": { "type": "integer", "description": "Message type.\n\n- `1`: Inbox\n- `2`: Sent\n- `3`: Deleted inbox\n- `4`: Deleted sent" }, "Avatar": { "type": "string", "description": "Buyer's image. Usually empty." }, "Body": { "type": "string", "description": "Message text." }, "Time": { "type": "string", "description": "Message time in UTC, ISO 8601 (e.g. `2026-11-05T08:42:10Z`)." }, "Unread": { "type": "boolean", "description": "`true`: the message is unread." }, "Surname": { "type": "string", "description": "Buyer's last name. Can be empty." }, "Name": { "type": "string", "description": "Buyer's first name. If no first and last name are stored, the full name from the message is returned." } } }, "description": "Messages, newest first." } } } } } ] }, "example": { "Result": true, "Response": { "MessageCount": 2, "Messages": [ { "UserMessageId": 88131, "Code": "301245678_ANSWER_14", "Subject": "Ürün sorusu", "From": "ornekmagaza", "To": "alici_123", "MessageTypeId": 2, "Avatar": "", "Body": "Merhaba, ürün stoktadır.", "Time": "2026-11-05T09:10:14Z", "Unread": false, "Surname": "", "Name": "Mehmet K." }, { "UserMessageId": 88119, "Code": "301245678", "Subject": "Ürün sorusu", "From": "alici_123", "To": "ornekmagaza", "MessageTypeId": 1, "Avatar": "", "Body": "Bu ürün stokta var mı?", "Time": "2026-11-05T08:42:10Z", "Unread": true, "Surname": "", "Name": "Mehmet K." } ] } } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/SetMessageRead": { "post": { "operationId": "SetMessageRead", "tags": [ "Messages" ], "summary": "Mark a message as read", "description": "**Mark a message as read** — Marks a message as read in StockMount.\n\nThe supported integration is N11 (`IntegrationId` 2). The message is marked as read only in StockMount; nothing is sent to N11.\n\nAny `IntegrationId` other than 1 (GittiGidiyor) and 2 (N11) returns `99999` with an empty `ErrorMessage`.\n\nSpecify the message with `UserMessageId`. The response is successful (`Result: true`) even if the message is not found; check `Unread` in `GetUserMessages` to confirm.\n\nA successful response has no `Response` field.\n\n⚠ This endpoint changes real data in your account.\n\nhttps://outsample.stockmount.com/en/api/Integration/SetMessageRead", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "StoreId": { "type": "integer", "description": "ID of the store the message belongs to." }, "IntegrationId": { "type": "integer", "description": "The store's integration ID. 2 for N11." }, "UserMessageId": { "type": "integer", "description": "`UserMessageId` of the message to mark as read. Not validated; if omitted, no message changes but the response is still successful." } }, "required": [ "ApiCode", "StoreId", "IntegrationId" ] }, "example": { "ApiCode": "{{apiCode}}", "StoreId": 1234, "IntegrationId": 2, "UserMessageId": 88119 } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "nullable": true } } } ] }, "example": { "Result": true } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } }, "/api/Integration/SendUserMessage": { "post": { "operationId": "SendUserMessage", "tags": [ "Messages" ], "summary": "Reply to a message", "description": "**Reply to a message** — Answers a buyer question on the marketplace and stores the answer in StockMount as a sent message.\n\nThe supported integration is N11 (`IntegrationId` 2). Only an existing product question can be answered; you cannot start a new conversation. Send the question's `Code` in `UserMessageCode`; it must be numeric.\n\nAfter sending, the answer is stored as a sent message (type 2) with a code in the form `{questionCode}_ANSWER_{n}`. The answered question is closed.\n\nIf `SetMessageRead` is `true`, the question given by `UserMessageId` is also marked as read.\n\nAlso send `Subject` and `From`. If they are missing, the answer may reach N11 but cannot be stored in StockMount and the call returns `99999`; in that case check the answer on N11 before retrying.\n\nA successful response does not guarantee that N11 accepted the answer: the request to N11 is started but its result is not awaited. Errors on the N11 side are not reported by this endpoint.\n\nAny `IntegrationId` other than 1 and 2 returns `99999` with an empty `ErrorMessage`. A successful response has no `Response` field.\n\n⚠ This endpoint changes real data in your account.\n\nhttps://outsample.stockmount.com/en/api/Integration/SendUserMessage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ApiCode": { "type": "string", "description": "Session code returned by `DoLogin`." }, "StoreId": { "type": "integer", "description": "ID of the store the question belongs to." }, "IntegrationId": { "type": "integer", "description": "The store's integration ID. 2 for N11." }, "UserMessageCode": { "type": "string", "description": "`Code` of the question to answer (N11 question ID, numeric). Required for N11." }, "Message": { "type": "string", "description": "Answer text." }, "To": { "type": "string", "description": "Buyer's username (the question's `From` value). Stored as the recipient." }, "From": { "type": "string", "description": "Value stored as the sender (e.g. your store name). If omitted, storing fails." }, "Subject": { "type": "string", "description": "Subject to store (e.g. the question's `Subject`). If omitted, storing fails." }, "SetMessageRead": { "type": "boolean", "description": "Optional. If `true`, the question is also marked as read. Default `false`." }, "UserMessageId": { "type": "integer", "description": "`UserMessageId` of the question being answered. Used when `SetMessageRead` is `true`." } }, "required": [ "ApiCode", "StoreId", "IntegrationId", "UserMessageCode", "Message", "To" ] }, "example": { "ApiCode": "{{apiCode}}", "StoreId": 1234, "IntegrationId": 2, "UserMessageCode": "301245678", "UserMessageId": 88119, "To": "alici_123", "From": "ornekmagaza", "Subject": "Ürün sorusu", "Message": "Merhaba, ürün stoktadır.", "SetMessageRead": true } } } }, "responses": { "200": { "description": "Business errors also return HTTP 200; check the Result field.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResultInfo" }, { "type": "object", "properties": { "Response": { "nullable": true } } } ] }, "example": { "Result": true } } } }, "400": { "description": "The body is not valid JSON (ProblemDetails)." } } } } }, "components": { "schemas": { "ResultInfo": { "type": "object", "properties": { "Result": { "type": "boolean" }, "Message": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true }, "ErrorCode": { "type": "string", "nullable": true }, "Response": { "nullable": true } } } } } }